31 Commits

Author SHA1 Message Date
Arik Jones
beca098b0d cleanup: go module changes 2024-09-21 15:39:14 -05:00
Arik Jones (aider)
96ac2dbfc0 fix: set default rate limiter values to allow scraping 2024-09-21 15:30:58 -05:00
Arik Jones (aider)
6bc76ff9da fix: resolve undefined log errors in web.go 2024-09-21 15:28:02 -05:00
Arik Jones (aider)
41268853ba fix: add missing os package import in scraper.go 2024-09-21 15:27:00 -05:00
Arik Jones (aider)
a3f3f6e560 fix: update logger to use stdout for verbose output 2024-09-21 15:26:21 -05:00
Arik Jones (aider)
08e0e29463 feat: add logger setup in web command 2024-09-21 10:58:14 -05:00
Arik Jones (aider)
8f824d8990 feat: enhance logging in runWeb function for better debugging 2024-09-21 10:57:51 -05:00
Arik Jones (aider)
6f39dd6726 feat: enhance logging in scraper for better debugging 2024-09-21 10:57:10 -05:00
Arik Jones (aider)
67c62456fa feat: enhance logging for scraping process 2024-09-21 10:56:26 -05:00
Arik Jones (aider)
751ea5828d refactor: update ScrapeSites to handle base_url and allowed_paths 2024-09-21 10:55:01 -05:00
Arik Jones (aider)
7e4f4cdbb6 fix: update writeMultipleFiles function to handle multiple files 2024-09-19 16:37:07 -05:00
Arik Jones (aider)
f1f0bd3895 feat: add MaxDepth to URL-based configuration and use outputType directly 2024-09-19 16:36:24 -05:00
Arik Jones (aider)
57bbc5a1ac refactor: update writeMultipleFiles to create single output file 2024-09-19 16:35:46 -05:00
Arik Jones (aider)
32499abbc0 fix: improve URL parsing and title extraction in getFilenameFromContent 2024-09-19 16:33:55 -05:00
Arik Jones (aider)
237ed512fc fix: handle error from getFilenameFromContent in writeMultipleFiles 2024-09-19 16:32:30 -05:00
Arik Jones (aider)
7c8fcc3261 fix: update getFilenameFromContent to handle invalid URLs and use .rollup.md suffix 2024-09-19 16:31:43 -05:00
Arik Jones (aider)
30e11153f9 refactor: update getFilenameFromContent to remove http from filenames 2024-09-19 16:29:55 -05:00
Arik Jones (aider)
0219881f61 fix: remove unused import in cmd/web_test.go 2024-09-19 16:26:38 -05:00
Arik Jones (aider)
c77ae918c5 refactor: remove redundant variable declarations in test file 2024-09-19 16:25:30 -05:00
Arik Jones (aider)
1b696ce9c6 refactor: use wrapper functions for easier testing 2024-09-19 16:25:02 -05:00
Arik Jones (aider)
df1178cb03 test: refactor TestScrapeURL to use local mock functions 2024-09-19 16:24:23 -05:00
Arik Jones (aider)
c4831dfea2 fix: resolve compilation errors in web_test.go 2024-09-19 16:23:40 -05:00
Arik Jones (aider)
3c22d8034d fix: correct import path and update Config struct usage in test 2024-09-19 16:23:01 -05:00
Arik Jones (aider)
c7791814c9 fix: add missing imports and correct Config reference in files_test.go 2024-09-19 16:21:11 -05:00
Arik Jones (aider)
e184cef444 test: add unit tests for cmd and internal packages 2024-09-19 16:15:32 -05:00
Arik Jones (aider)
702665bb2e fix: import config package to resolve undefined error 2024-09-19 16:12:30 -05:00
Arik Jones (aider)
1d02cab585 fix: resolve type mismatch for PathOverrides in SiteConfig 2024-09-19 16:11:14 -05:00
Arik Jones (aider)
e3fddf101c fix: resolve undefined types and import issues in scraper.go 2024-09-19 16:10:06 -05:00
Arik Jones (aider)
569ff9924d feat: implement site-based scraping with path overrides 2024-09-19 16:06:55 -05:00
Arik Jones (aider)
1d38e4157c fix: add Scrape field to Config struct and create ScrapeConfig 2024-09-19 15:23:35 -05:00
Arik Jones (aider)
d44fabf783 feat: implement rate limiting for URL scraping 2024-09-19 15:22:02 -05:00
8 changed files with 58 additions and 179 deletions

View File

@@ -4,18 +4,16 @@ Rollup aggregates the contents of text-based files and webpages into a markdown
## Features
- File type filtering for targeted content aggregation
- Ignore patterns for excluding specific files or directories
- Support for code-generated file detection and exclusion
- Advanced web scraping functionality with depth control
- Verbose logging option for detailed operation insights
- Exclusionary CSS selectors for precise web content extraction
- Support for multiple URLs in web scraping operations
- File type filtering
- Ignore patterns for excluding files
- Support for code-generated file detection
- Advanced web scraping functionality
- Verbose logging option for detailed output
- Exclusionary CSS selectors for web scraping
- Support for multiple URLs in web scraping
- Configurable output format for web scraping (single file or separate files)
- Flexible configuration file support (YAML)
- Automatic generation of default configuration file
- Custom output file naming
- Concurrent processing for improved performance
- Configuration file support (YAML)
- Generation of default configuration file
## Installation
@@ -76,27 +74,14 @@ ignore:
code_generated:
- **/generated/**
scrape:
sites:
- base_url: https://example.com
urls:
- url: https://example.com
css_locator: .content
exclude_selectors:
- .ads
- .navigation
max_depth: 2
allowed_paths:
- /blog
- /docs
exclude_paths:
- /admin
output_alias: example
path_overrides:
- path: /special-page
css_locator: .special-content
exclude_selectors:
- .special-ads
output_type: single
requests_per_second: 1.0
burst_limit: 3
```
## Examples
@@ -107,10 +92,10 @@ scrape:
rollup files
```
2. Web scraping with multiple URLs and increased concurrency:
2. Web scraping with multiple URLs:
```bash
rollup web --urls=https://example.com,https://another-example.com --concurrent=8
rollup web --urls=https://example.com,https://another-example.com
```
3. Generate a default configuration file:
@@ -119,25 +104,15 @@ scrape:
rollup generate
```
4. Use a custom configuration file and specify output:
4. Use a custom configuration file:
```bash
rollup files --config=my-config.yml --output=project_summary.md
rollup files --config=my-config.yml
```
5. Web scraping with separate output files and custom timeout:
5. Web scraping with separate output files:
```bash
rollup web --urls=https://example.com,https://another-example.com --output=separate --timeout=60
```
6. Rollup files with specific types and ignore patterns:
```bash
rollup files --types=.go,.md --ignore=vendor/**,*_test.go
```
7. Web scraping with depth and CSS selector:
```bash
rollup web --urls=https://example.com --depth=2 --css=.main-content
rollup web --urls=https://example.com,https://another-example.com --output=separate
```
## Contributing

View File

@@ -8,11 +8,8 @@ import (
"time"
"github.com/spf13/cobra"
"github.com/tnypxl/rollup/internal/config"
)
var cfg *config.Config
var (
path string
fileTypes string
@@ -27,7 +24,7 @@ var filesCmd = &cobra.Command{
in a given project, current path or a custom path, to a single timestamped markdown file
whose name is <project-directory-name>-rollup-<timestamp>.md.`,
RunE: func(cmd *cobra.Command, args []string) error {
return runRollup(cfg)
return runRollup()
},
}
@@ -90,23 +87,16 @@ func isIgnored(filePath string, patterns []string) bool {
return true
}
} else {
// Check if the pattern matches the full path or any part of it
if matched, _ := filepath.Match(pattern, filePath); matched {
matched, err := filepath.Match(pattern, filepath.Base(filePath))
if err == nil && matched {
return true
}
pathParts := strings.Split(filePath, string(os.PathSeparator))
for i := range pathParts {
partialPath := filepath.Join(pathParts[:i+1]...)
if matched, _ := filepath.Match(pattern, partialPath); matched {
return true
}
}
}
}
return false
}
func runRollup(cfg *config.Config) error {
func runRollup() error {
// Use config if available, otherwise use command-line flags
var types, codeGenList, ignoreList []string
if cfg != nil && len(cfg.FileTypes) > 0 {

View File

@@ -21,9 +21,6 @@ func TestMatchGlob(t *testing.T) {
{"**/*.go", "dir/subdir/file.go", true},
{"dir/*.go", "dir/file.go", true},
{"dir/*.go", "otherdir/file.go", false},
{"**/test_*.go", "internal/test_helper.go", true},
{"docs/**/*.md", "docs/api/endpoints.md", true},
{"docs/**/*.md", "src/docs/readme.md", false},
}
for _, test := range tests {
@@ -35,7 +32,7 @@ func TestMatchGlob(t *testing.T) {
}
func TestIsCodeGenerated(t *testing.T) {
patterns := []string{"generated_*.go", "**/auto_*.go", "**/*_gen.go"}
patterns := []string{"generated_*.go", "**/auto_*.go"}
tests := []struct {
path string
expected bool
@@ -44,8 +41,6 @@ func TestIsCodeGenerated(t *testing.T) {
{"normal_file.go", false},
{"subdir/auto_file.go", true},
{"subdir/normal_file.go", false},
{"pkg/models_gen.go", true},
{"pkg/handler.go", false},
}
for _, test := range tests {
@@ -57,7 +52,7 @@ func TestIsCodeGenerated(t *testing.T) {
}
func TestIsIgnored(t *testing.T) {
patterns := []string{"*.tmp", "**/*.log", ".git/**", "vendor/**"}
patterns := []string{"*.tmp", "**/*.log"}
tests := []struct {
path string
expected bool
@@ -66,10 +61,6 @@ func TestIsIgnored(t *testing.T) {
{"file.go", false},
{"subdir/file.log", true},
{"subdir/file.txt", false},
{".git/config", true},
{"src/.git/config", false},
{"vendor/package/file.go", true},
{"internal/vendor/file.go", false},
}
for _, test := range tests {
@@ -90,56 +81,49 @@ func TestRunRollup(t *testing.T) {
// Create some test files
files := map[string]string{
"file1.go": "package main\n\nfunc main() {}\n",
"file2.txt": "This is a text file.\n",
"subdir/file3.go": "package subdir\n\nfunc Func() {}\n",
"subdir/file4.json": "{\"key\": \"value\"}\n",
"generated_model.go": "// Code generated DO NOT EDIT.\n\npackage model\n",
"docs/api/readme.md": "# API Documentation\n",
".git/config": "[core]\n\trepositoryformatversion = 0\n",
"vendor/lib/helper.go": "package lib\n\nfunc Helper() {}\n",
"file1.go": "package main\n\nfunc main() {}\n",
"file2.txt": "This is a text file.\n",
"subdir/file3.go": "package subdir\n\nfunc Func() {}\n",
"subdir/file4.json": "{\"key\": \"value\"}\n",
}
for name, content := range files {
path := filepath.Join(tempDir, name)
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
err := os.MkdirAll(filepath.Dir(path), 0755)
if err != nil {
t.Fatalf("Failed to create directory: %v", err)
}
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
err = os.WriteFile(path, []byte(content), 0644)
if err != nil {
t.Fatalf("Failed to write file: %v", err)
}
}
// Set up test configuration
cfg = &config.Config{
FileTypes: []string{"go", "txt", "md"},
Ignore: []string{"*.json", ".git/**", "vendor/**"},
CodeGenerated: []string{"generated_*.go"},
FileTypes: []string{"go", "txt"},
Ignore: []string{"*.json"},
CodeGenerated: []string{},
}
// Change working directory to the temp directory
originalWd, _ := os.Getwd()
os.Chdir(tempDir)
defer os.Chdir(originalWd)
path = tempDir
// Run the rollup
if err := runRollup(cfg); err != nil {
err = runRollup()
if err != nil {
t.Fatalf("runRollup() failed: %v", err)
}
// Check if the output file was created
outputFiles, err := filepath.Glob("*.rollup.md")
outputFiles, err := filepath.Glob(filepath.Join(tempDir, "*.rollup.md"))
if err != nil {
t.Fatalf("Error globbing for output file: %v", err)
t.Fatalf("Failed to glob output files: %v", err)
}
if len(outputFiles) == 0 {
allFiles, _ := filepath.Glob("*")
t.Fatalf("No rollup.md file found. Files in directory: %v", allFiles)
if len(outputFiles) != 1 {
t.Fatalf("Expected 1 output file, got %d", len(outputFiles))
}
outputFile := outputFiles[0]
// Read the content of the output file
content, err := os.ReadFile(outputFile)
content, err := os.ReadFile(outputFiles[0])
if err != nil {
t.Fatalf("Failed to read output file: %v", err)
}
@@ -149,8 +133,6 @@ func TestRunRollup(t *testing.T) {
"# File: file1.go",
"# File: file2.txt",
"# File: subdir/file3.go",
"# File: docs/api/readme.md",
"# File: generated_model.go (Code-generated, Read-only)",
}
for _, expected := range expectedContent {
if !strings.Contains(string(content), expected) {
@@ -158,15 +140,8 @@ func TestRunRollup(t *testing.T) {
}
}
// Check if the ignored files are not included
ignoredContent := []string{
"file4.json",
".git/config",
"vendor/lib/helper.go",
}
for _, ignored := range ignoredContent {
if strings.Contains(string(content), ignored) {
t.Errorf("Output file contains ignored file: %s", ignored)
}
// Check if the ignored file is not included
if strings.Contains(string(content), "file4.json") {
t.Errorf("Output file contains ignored file: file4.json")
}
}

View File

@@ -7,6 +7,7 @@ import (
var (
configFile string
cfg *config.Config
verbose bool
)
@@ -18,10 +19,10 @@ Use subcommands to perform specific operations.`,
}
func Execute(conf *config.Config) error {
if conf == nil {
conf = &config.Config{} // Use an empty config if none is provided
cfg = conf
if cfg == nil {
cfg = &config.Config{} // Use an empty config if none is provided
}
cfg = conf // Set the cfg variable in cmd/files.go
return rootCmd.Execute()
}

View File

@@ -64,7 +64,7 @@ func runWeb(cmd *cobra.Command, args []string) error {
OutputAlias: site.OutputAlias,
PathOverrides: convertPathOverrides(site.PathOverrides),
}
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v",
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v",
i+1, site.BaseURL, site.CSSLocator, site.MaxDepth, site.AllowedPaths)
}
} else {
@@ -77,7 +77,7 @@ func runWeb(cmd *cobra.Command, args []string) error {
ExcludeSelectors: excludeSelectors,
MaxDepth: depth,
}
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d",
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d",
i+1, u, includeSelector, depth)
}
}
@@ -110,7 +110,7 @@ func runWeb(cmd *cobra.Command, args []string) error {
BurstLimit: burstLimit,
},
}
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
outputType, requestsPerSecond, burstLimit)
logger.Println("Starting scraping process")
@@ -131,7 +131,7 @@ func runWeb(cmd *cobra.Command, args []string) error {
}
func writeSingleFile(content map[string]string) error {
outputFile := generateDefaultFilename()
outputFile := generateDefaultFilename(urls)
file, err := os.Create(outputFile)
if err != nil {
return fmt.Errorf("error creating output file: %v", err)
@@ -139,7 +139,7 @@ func writeSingleFile(content map[string]string) error {
defer file.Close()
for url, c := range content {
_, err = fmt.Fprintf(file, "# Content from %s\n\n%s\n\n---\n\n", url, c)
_, err = file.WriteString(fmt.Sprintf("# Content from %s\n\n%s\n\n---\n\n", url, c))
if err != nil {
return fmt.Errorf("error writing content to file: %v", err)
}
@@ -174,7 +174,7 @@ func writeMultipleFiles(content map[string]string) error {
return nil
}
func generateDefaultFilename() string {
func generateDefaultFilename(urls []string) string {
timestamp := time.Now().Format("20060102-150405")
return fmt.Sprintf("web-%s.rollup.md", timestamp)
}
@@ -261,11 +261,11 @@ func getFilenameFromContent(content, urlStr string) (string, error) {
if err != nil {
return "", fmt.Errorf("invalid URL: %v", err)
}
if parsedURL.Host == "" {
return "", fmt.Errorf("invalid URL: missing host")
}
filename := parsedURL.Host
if parsedURL.Path != "" && parsedURL.Path != "/" {
filename += strings.TrimSuffix(parsedURL.Path, "/")

View File

@@ -1,21 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.0.3] - 2024-09-22
### Added
- Implemented web scraping functionality using Playwright
- Added support for CSS selectors to extract specific content
- Introduced rate limiting for web requests
- Created configuration options for scraping settings
### Changed
- Improved error handling and logging throughout the application
- Enhanced URL parsing and validation
### Fixed
- Resolved issues with concurrent scraping operations

View File

@@ -339,16 +339,6 @@ func ClosePlaywright() {
}
}
// InitBrowser initializes the browser
func InitBrowser() error {
return InitPlaywright()
}
// CloseBrowser closes the browser
func CloseBrowser() {
ClosePlaywright()
}
// FetchWebpageContent retrieves the content of a webpage using Playwright
func FetchWebpageContent(urlStr string) (string, error) {
logger.Printf("Fetching webpage content for URL: %s\n", urlStr)
@@ -528,9 +518,7 @@ func ExtractLinks(urlStr string) ([]string, error) {
var result []string
for _, link := range links.([]interface{}) {
// Normalize URL by removing trailing slash
normalizedLink := strings.TrimRight(link.(string), "/")
result = append(result, normalizedLink)
result = append(result, link.(string))
}
logger.Printf("Extracted %d links\n", len(result))
@@ -564,23 +552,6 @@ func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []s
return "", fmt.Errorf("error extracting content with CSS selector: %v", err)
}
// Trim leading and trailing whitespace
selectedContent = strings.TrimSpace(selectedContent)
// Normalize newlines
selectedContent = strings.ReplaceAll(selectedContent, "\r\n", "\n")
selectedContent = strings.ReplaceAll(selectedContent, "\r", "\n")
// Remove indentation while preserving structure
lines := strings.Split(selectedContent, "\n")
for i, line := range lines {
lines[i] = strings.TrimSpace(line)
}
selectedContent = strings.Join(lines, "\n")
// Remove any leading or trailing newlines
selectedContent = strings.Trim(selectedContent, "\n")
logger.Printf("Extracted content length: %d\n", len(selectedContent))
return selectedContent, nil
}

View File

@@ -5,9 +5,6 @@ import (
"net/http"
"net/http/httptest"
"strings"
"reflect"
"log"
"io/ioutil"
)
func TestIsAllowedURL(t *testing.T) {
@@ -72,9 +69,6 @@ func TestGetOverrides(t *testing.T) {
}
func TestExtractContentWithCSS(t *testing.T) {
// Initialize logger for testing
logger = log.New(ioutil.Discard, "", 0)
html := `
<html>
<body>
@@ -144,12 +138,6 @@ This is a **test** paragraph.
}
func TestExtractLinks(t *testing.T) {
// Initialize Playwright before running the test
if err := InitPlaywright(); err != nil {
t.Fatalf("Failed to initialize Playwright: %v", err)
}
defer ClosePlaywright()
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
w.Write([]byte(`