flatten scrape config to 'sites:'. Update unit tests and readme.

internal/config/config.go

@@ -8,34 +8,63 @@ import (
 )
 
 type Config struct {
-	FileTypes     []string     `yaml:"file_types"`
-	Ignore        []string     `yaml:"ignore"`
-	CodeGenerated []string     `yaml:"code_generated"`
-	Scrape        ScrapeConfig `yaml:"scrape"`
-}
+	// FileExtensions is a list of file extensions to include in the rollup
+	FileExtensions []string `yaml:"file_extensions"`
 
-type ScrapeConfig struct {
-    Sites             []SiteConfig `yaml:"sites"`
-    OutputType        string       `yaml:"output_type"`
-    RequestsPerSecond float64      `yaml:"requests_per_second"`
-    BurstLimit        int          `yaml:"burst_limit"`
+	// IgnorePaths is a list of glob patterns for paths to ignore
+	IgnorePaths []string `yaml:"ignore_paths"`
+
+	// CodeGeneratedPaths is a list of glob patterns for code-generated files
+	CodeGeneratedPaths []string `yaml:"code_generated_paths"`
+
+	// Sites is a list of site configurations for web scraping
+	Sites []SiteConfig `yaml:"sites"`
+
+	// OutputType specifies how the output should be generated
+	OutputType string `yaml:"output_type"`
+
+	// RequestsPerSecond limits the rate of web requests
+	RequestsPerSecond *float64 `yaml:"requests_per_second,omitempty"`
+
+	// BurstLimit sets the maximum burst size for rate limiting
+	BurstLimit *int `yaml:"burst_limit,omitempty"`
 }
 
 type SiteConfig struct {
-    BaseURL          string            `yaml:"base_url"`
-    CSSLocator       string            `yaml:"css_locator"`
-    ExcludeSelectors []string          `yaml:"exclude_selectors"`
-    MaxDepth         int               `yaml:"max_depth"`
-    AllowedPaths     []string          `yaml:"allowed_paths"`
-    ExcludePaths     []string          `yaml:"exclude_paths"`
-    OutputAlias      string            `yaml:"output_alias"`
-    PathOverrides    []PathOverride    `yaml:"path_overrides"`
+	// BaseURL is the starting point for scraping this site
+	BaseURL string `yaml:"base_url"`
+
+	// CSSLocator is used to extract specific content
+	CSSLocator string `yaml:"css_locator"`
+
+	// ExcludeSelectors lists CSS selectors for content to exclude
+	ExcludeSelectors []string `yaml:"exclude_selectors"`
+
+	// MaxDepth sets the maximum depth for link traversal
+	MaxDepth int `yaml:"max_depth"`
+
+	// AllowedPaths lists paths that are allowed to be scraped
+	AllowedPaths []string `yaml:"allowed_paths"`
+
+	// ExcludePaths lists paths that should not be scraped
+	ExcludePaths []string `yaml:"exclude_paths"`
+
+	// OutputAlias provides an alternative name for output files
+	OutputAlias string `yaml:"output_alias"`
+
+	// PathOverrides allows for path-specific configurations
+	PathOverrides []PathOverride `yaml:"path_overrides"`
 }
 
 type PathOverride struct {
-    Path             string   `yaml:"path"`
-    CSSLocator       string   `yaml:"css_locator"`
-    ExcludeSelectors []string `yaml:"exclude_selectors"`
+	// Path is the URL path this override applies to
+	Path string `yaml:"path"`
+
+	// CSSLocator overrides the site-wide CSS locator for this path
+	CSSLocator string `yaml:"css_locator"`
+
+	// ExcludeSelectors overrides the site-wide exclude selectors for this path
+	ExcludeSelectors []string `yaml:"exclude_selectors"`
 }
 
 func Load(configPath string) (*Config, error) {
@@ -50,15 +79,34 @@ func Load(configPath string) (*Config, error) {
 		return nil, fmt.Errorf("error parsing config file: %v", err)
 	}
 
+	if err := config.Validate(); err != nil {
+		return nil, fmt.Errorf("invalid configuration: %v", err)
+	}
+
 	return &config, nil
 }
 
-func DefaultConfigPath() string {
-	return "rollup.yml"
-}
+func (c *Config) Validate() error {
+	if len(c.FileExtensions) == 0 {
+		return fmt.Errorf("at least one file extension must be specified")
+	}
 
-func FileExists(filename string) bool {
-	_, err := os.Stat(filename)
-	return err == nil
-}
+	if c.RequestsPerSecond != nil && *c.RequestsPerSecond <= 0 {
+		return fmt.Errorf("requests_per_second must be positive")
+	}
 
+	if c.BurstLimit != nil && *c.BurstLimit <= 0 {
+		return fmt.Errorf("burst_limit must be positive")
+	}
+
+	for _, site := range c.Sites {
+		if site.BaseURL == "" {
+			return fmt.Errorf("base_url must be specified for each site")
+		}
+		if site.MaxDepth < 0 {
+			return fmt.Errorf("max_depth must be non-negative")
+		}
+	}
+
+	return nil
+}

internal/config/config_test.go

@@ -9,34 +9,33 @@ import (
 func TestLoad(t *testing.T) {
 	// Create a temporary config file
 	content := []byte(`
-file_types:
-  - go
-  - md
-ignore:
+file_extensions:
+  - .go
+  - .md
+ignore_paths:
   - "*.tmp"
   - "**/*.log"
-code_generated:
+code_generated_paths:
   - "generated_*.go"
-scrape:
-  sites:
-    - base_url: "https://example.com"
-      css_locator: "main"
-      exclude_selectors:
-        - ".ads"
-      max_depth: 2
-      allowed_paths:
-        - "/blog"
-      exclude_paths:
-        - "/admin"
-      output_alias: "example"
-      path_overrides:
-        - path: "/special"
-          css_locator: ".special-content"
-          exclude_selectors:
-            - ".sidebar"
-  output_type: "single"
-  requests_per_second: 1.0
-  burst_limit: 5
+sites:
+  - base_url: "https://example.com"
+    css_locator: "main"
+    exclude_selectors:
+      - ".ads"
+    max_depth: 2
+    allowed_paths:
+      - "/blog"
+    exclude_paths:
+      - "/admin"
+    output_alias: "example"
+    path_overrides:
+      - path: "/special"
+        css_locator: ".special-content"
+        exclude_selectors:
+          - ".sidebar"
+output_type: "single"
+requests_per_second: 1.0
+burst_limit: 5
 `)
 
 	tmpfile, err := os.CreateTemp("", "config*.yml")
@@ -59,33 +58,33 @@ scrape:
 	}
 
 	// Check if the loaded config matches the expected values
+	rps := 1.0
+	bl := 5
 	expectedConfig := &Config{
-		FileTypes:     []string{"go", "md"},
-		Ignore:        []string{"*.tmp", "**/*.log"},
-		CodeGenerated: []string{"generated_*.go"},
-		Scrape: ScrapeConfig{
-			Sites: []SiteConfig{
-				{
-					BaseURL:          "https://example.com",
-					CSSLocator:       "main",
-					ExcludeSelectors: []string{".ads"},
-					MaxDepth:         2,
-					AllowedPaths:     []string{"/blog"},
-					ExcludePaths:     []string{"/admin"},
-					OutputAlias:      "example",
-					PathOverrides: []PathOverride{
-						{
-							Path:             "/special",
-							CSSLocator:       ".special-content",
-							ExcludeSelectors: []string{".sidebar"},
-						},
+		FileExtensions:     []string{".go", ".md"},
+		IgnorePaths:        []string{"*.tmp", "**/*.log"},
+		CodeGeneratedPaths: []string{"generated_*.go"},
+		Sites: []SiteConfig{
+			{
+				BaseURL:          "https://example.com",
+				CSSLocator:       "main",
+				ExcludeSelectors: []string{".ads"},
+				MaxDepth:         2,
+				AllowedPaths:     []string{"/blog"},
+				ExcludePaths:     []string{"/admin"},
+				OutputAlias:      "example",
+				PathOverrides: []PathOverride{
+					{
+						Path:             "/special",
+						CSSLocator:       ".special-content",
+						ExcludeSelectors: []string{".sidebar"},
 					},
 				},
 			},
-			OutputType:        "single",
-			RequestsPerSecond: 1.0,
-			BurstLimit:        5,
 		},
+		OutputType:        "single",
+		RequestsPerSecond: &rps,
+		BurstLimit:        &bl,
 	}
 
 	if !reflect.DeepEqual(config, expectedConfig) {
@@ -93,28 +92,67 @@ scrape:
 	}
 }
 
-func TestDefaultConfigPath(t *testing.T) {
-	expected := "rollup.yml"
-	result := DefaultConfigPath()
-	if result != expected {
-		t.Errorf("DefaultConfigPath() = %q, want %q", result, expected)
-	}
-}
-
-func TestFileExists(t *testing.T) {
-	// Test with an existing file
-	tmpfile, err := os.CreateTemp("", "testfile")
-	if err != nil {
-		t.Fatalf("Failed to create temp file: %v", err)
-	}
-	defer os.Remove(tmpfile.Name())
-
-	if !FileExists(tmpfile.Name()) {
-		t.Errorf("FileExists(%q) = false, want true", tmpfile.Name())
-	}
-
-	// Test with a non-existing file
-	if FileExists("non_existing_file.txt") {
-		t.Errorf("FileExists(\"non_existing_file.txt\") = true, want false")
+func TestValidate(t *testing.T) {
+	tests := []struct {
+		name    string
+		config  Config
+		wantErr bool
+	}{
+		{
+			name: "Valid config",
+			config: Config{
+				FileExtensions: []string{".go"},
+				Sites: []SiteConfig{
+					{BaseURL: "https://example.com", MaxDepth: 2},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name:    "No file extensions",
+			config:  Config{},
+			wantErr: true,
+		},
+		{
+			name: "Invalid requests per second",
+			config: Config{
+				FileExtensions:    []string{".go"},
+				RequestsPerSecond: func() *float64 { f := -1.0; return &f }(),
+			},
+			wantErr: true,
+		},
+		{
+			name: "Invalid burst limit",
+			config: Config{
+				FileExtensions: []string{".go"},
+				BurstLimit:     func() *int { i := -1; return &i }(),
+			},
+			wantErr: true,
+		},
+		{
+			name: "Site without base URL",
+			config: Config{
+				FileExtensions: []string{".go"},
+				Sites:          []SiteConfig{{}},
+			},
+			wantErr: true,
+		},
+		{
+			name: "Negative max depth",
+			config: Config{
+				FileExtensions: []string{".go"},
+				Sites:          []SiteConfig{{BaseURL: "https://example.com", MaxDepth: -1}},
+			},
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := tt.config.Validate()
+			if (err != nil) != tt.wantErr {
+				t.Errorf("Validate() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
 	}
 }