gitingest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472ca8e21d2bb9e48eeeada768679586b002087a9253f966eb164fd6118236d2
-  data.tar.gz: 1dddc890f5c380fb7ca2ca93db050473569dd1dd75c307f2d532857fc0f9ceaa
+  metadata.gz: 65bac565322a3c782e5a3da91648fbe1aef905af80344b7ab81d8223e7a39c08
+  data.tar.gz: ae9c73bc2df91ba61b10a01e36a15c2de7238104627c296408cfcc273851e885
 SHA512:
-  metadata.gz: 1105676c81a389ea20a80a7be5ed2ea25c52fa2460c1672b0d5c45e19d2daf92c552a3d551cc71c196a9d0e2cbf96d779dc8e6b04f81965d323b31fff374f66a
-  data.tar.gz: 9b565545bfbfc1f983109cbdf08470b6399471f46dbcb651173ab5ab97a806b5ac992eb5affd1b58f71f2d71788d971aba9fde1aead94f779453636392253684
+  metadata.gz: ba151945b20e7c5b4ce51af89a724f8673ec4b8928700b8922eecc8aeb7089fbe86e172d41289d308caff4ce1e88603be87416b1f743537c6b3f4e64d21515de
+  data.tar.gz: ce1aaff5e55cca369d8eeb6e3fd68a92e63b5258f35b5edd8698b505c5c6d84363189eedeb483c5553d62ce2b9011ecf9b119f222dbc51e91a28b5f7e5e369e1

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 2025-03-02
+- Added support for quiet and verbose modes in the command-line interface
+- Added the ability to specify a custom output file for the prompt
+- Enhanced error handling with logging support
+- Added logging functionality with custom loggers
+- Introduced rate limit handling with retries for file fetching
+- Added repository branch support
+- Exclude specific file patterns via command-line arguments
+- Enforced a 1000 file limit to prevent memory overload
+- Updated version to 0.2.0
+
 ## [0.1.0] - 2025-03-02
 
 ### Added
@@ -15,4 +26,4 @@ All notable changes to this project will be documented in this file.
 - Automatic rate limit handling with retry mechanism
 - Repository prompt generation with file separation markers
 - Support for custom branch selection
-- Custom output file naming options
+- Custom output file naming options

data/README.md

@@ -24,7 +24,26 @@ bundle exec rake install
 ### Command Line
 
 ```bash
-gitingest --repository username/repo --token YOUR_GITHUB_TOKEN --output output.txt
+# Basic usage (public repository)
+gitingest --repository user/repo 
+
+# With GitHub token for private repositories
+gitingest --repository user/repo --token YOUR_GITHUB_TOKEN
+
+# Specify a custom output file
+gitingest --repository user/repo --output my_prompt.txt
+
+# Specify a different branch
+gitingest --repository user/repo --branch develop
+
+# Exclude additional patterns
+gitingest --repository user/repo --exclude "*.md,docs/"
+
+# Quiet mode
+gitingest --repository user/repo --quiet
+
+# Verbose mode
+gitingest --repository user/repo --verbose
 ```
 
 #### Available Options
@@ -39,17 +58,32 @@ gitingest --repository username/repo --token YOUR_GITHUB_TOKEN --output output.t
 ### As a Library
 
 ```ruby
-require 'gitingest'
+require "gitingest"
 
-options = {
-  repository: 'davidesantangelo/gitingest',
-  token: 'your_github_token', # Optional
-  output_file: 'output.txt', # Optional
-  branch: 'master', # Optional
-  exclude: ['node_modules', '.*\.png$'] # Optional
-}
+# Basic usage
+generator = Gitingest::Generator.new(
+  repository: "user/repo",
+  token: "YOUR_GITHUB_TOKEN" # optional
+)
+generator.run
 
-generator = Gitingest::Generator.new(options)
+# With custom options
+generator = Gitingest::Generator.new(
+  repository: "user/repo",
+  token: "YOUR_GITHUB_TOKEN",
+  output_file: "my_prompt.txt",
+  branch: "develop",
+  exclude: ["*.md", "docs/"], 
+  quiet: true # or verbose: true
+)
+generator.run
+
+# With custom logger
+custom_logger = Logger.new("gitingest.log")
+generator = Gitingest::Generator.new(
+  repository: "user/repo",
+  logger: custom_logger
+)
 generator.run
 ```
 
@@ -64,19 +98,30 @@ generator.run
 
 ## Default Exclusion Patterns
 
-By default, Gitingest excludes the following files and directories:
+By default, the generator excludes files and directories commonly ignored in repositories, such as:
+
+- Version control files (`.git/`, `.svn/`)
+- System files (`.DS_Store`, `Thumbs.db`)
+- Log files (`*.log`, `*.bak`)
+- Images and media files (`*.png`, `*.jpg`, `*.mp3`)
+- Archives (`*.zip`, `*.tar.gz`)
+- Dependency directories (`node_modules/`, `vendor/`)
+- Compiled and binary files (`*.pyc`, `*.class`, `*.exe`)
 
-- `.git/`, `.github/`, `.gitignore`, `.DS_Store`
-- Log files: `.*\.log$`
-- Image files: `.*\.png$`, `.*\.jpg$`, `.*\.jpeg$`, `.*\.gif$`, `.*\.svg$`
-- Document files: `.*\.pdf$`
-- Archive files: `.*\.zip$`, `.*\.tar\.gz$`
-- Dependency directories: `node_modules/`, `vendor/`
+## Limitations
+
+- To prevent memory overload, only the first 1000 files will be processed
+- API requests are subject to GitHub limits (60 requests/hour without token, 5000 requests/hour with token)
+- Private repositories require a GitHub personal access token
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/davidesantangelo/gitingest.
 
+## Acknowledgements
+
+Inspired by [`cyclotruc/gitingest`](https://github.com/cyclotruc/gitingest).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/gitingest

@@ -6,15 +6,38 @@ require "gitingest"
 
 options = {}
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: gitingest [options]"
+  opts.banner = "Usage: gitingest [OPTIONS]"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-r", "--repository REPO", "GitHub repository (username/repo) [Required]") do |repo|
+    options[:repository] = repo
+  end
+
+  opts.on("-t", "--token TOKEN", "GitHub personal access token") do |token|
+    options[:token] = token
+  end
+
+  opts.on("-o", "--output FILE", "Output file for the prompt") do |file|
+    options[:output_file] = file
+  end
+
+  opts.on("-b", "--branch BRANCH", "Repository branch") do |branch|
+    options[:branch] = branch
+  end
 
-  opts.on("-r", "--repository REPO", "GitHub repository (username/repo)") { |repo| options[:repository] = repo }
-  opts.on("-t", "--token TOKEN", "GitHub personal access token") { |token| options[:token] = token }
-  opts.on("-o", "--output FILE", "Output file for the prompt") { |file| options[:output_file] = file }
   opts.on("-e", "--exclude PATTERN", "File patterns to exclude (comma separated)") do |pattern|
-    options[:exclude] = pattern.split(",").map(&:strip)
+    options[:exclude] = pattern.split(",")
   end
-  opts.on("-b", "--branch BRANCH", "Repository branch (default: main)") { |branch| options[:branch] = branch }
+
+  opts.on("-q", "--quiet", "Disable all output except errors") do
+    options[:quiet] = true
+  end
+
+  opts.on("-v", "--verbose", "Enable verbose output") do
+    options[:verbose] = true
+  end
+
   opts.on("-h", "--help", "Show this help message") do
     puts opts
     exit
@@ -23,9 +46,16 @@ end
 
 begin
   parser.parse!
+
+  if options[:repository].nil?
+    puts "Error: Repository option is required"
+    puts parser
+    exit 1
+  end
+
   generator = Gitingest::Generator.new(options)
   generator.run
-rescue ArgumentError => e
+rescue OptionParser::InvalidOption => e
   puts "Error: #{e.message}"
   puts parser
   exit 1

data/lib/gitingest/generator.rb

@@ -4,6 +4,7 @@ require "octokit"
 require "base64"
 require "fileutils"
 require "concurrent"
+require "logger"
 
 module Gitingest
   class Generator
@@ -67,17 +68,31 @@ module Gitingest
     # Maximum number of files to process to prevent memory overload
     MAX_FILES = 1000
 
-    attr_reader :options, :client, :repo_files, :excluded_patterns
+    attr_reader :options, :client, :repo_files, :excluded_patterns, :logger
 
     def initialize(options = {})
       @options = options
       @repo_files = []
       @excluded_patterns = []
+      setup_logger
       validate_options
       configure_client
       compile_excluded_patterns
     end
 
+    def setup_logger
+      @logger = @options[:logger] || Logger.new($stdout)
+      @logger.level = if @options[:quiet]
+                        Logger::ERROR
+                      elsif @options[:verbose]
+                        Logger::DEBUG
+                      else
+                        Logger::INFO
+                      end
+      # Semplifica il formato del logger per la riga di comando
+      @logger.formatter = proc { |severity, _, _, msg| "#{severity == "INFO" ? "" : "[#{severity}] "}#{msg}\n" }
+    end
+
     ### Option Validation
     def validate_options
       raise ArgumentError, "Repository is required" unless @options[:repository]
@@ -93,10 +108,10 @@ module Gitingest
       @client = @options[:token] ? Octokit::Client.new(access_token: @options[:token]) : Octokit::Client.new
 
       if @options[:token]
-        puts "Using provided GitHub token for authentication"
+        @logger.info "Using provided GitHub token for authentication"
       else
-        puts "Warning: No token provided. API rate limits will be restricted and private repositories will be inaccessible."
-        puts "For better results, provide a GitHub token with the --token option."
+        @logger.warn "Warning: No token provided. API rate limits will be restricted and private repositories will be inaccessible."
+        @logger.warn "For better results, provide a GitHub token with the --token option."
       end
     end
 
@@ -106,7 +121,7 @@ module Gitingest
 
     ### Fetch Repository Contents
     def fetch_repository_contents
-      puts "Fetching repository: #{@options[:repository]} (branch: #{@options[:branch]})"
+      @logger.info "Fetching repository: #{@options[:repository]} (branch: #{@options[:branch]})"
       begin
         # First validate authentication and repository access
         validate_repository_access
@@ -115,10 +130,10 @@ module Gitingest
         @repo_files = repo_tree.tree.select { |item| item.type == "blob" && !excluded_file?(item.path) }
 
         if @repo_files.size > MAX_FILES
-          puts "Warning: Found #{@repo_files.size} files, limited to #{MAX_FILES}."
+          @logger.warn "Warning: Found #{@repo_files.size} files, limited to #{MAX_FILES}."
           @repo_files = @repo_files.first(MAX_FILES)
         end
-        puts "Found #{@repo_files.size} files after exclusion filters"
+        @logger.info "Found #{@repo_files.size} files after exclusion filters"
       rescue Octokit::Unauthorized
         raise "Authentication error: Invalid or expired GitHub token. Please provide a valid token."
       rescue Octokit::NotFound
@@ -154,7 +169,7 @@ module Gitingest
 
     ### Generate Prompt
     def generate_prompt
-      puts "Generating prompt..."
+      @logger.info "Generating prompt..."
       Concurrent::Array.new(@repo_files)
       buffer = []
       buffer_size = 100 # Write every 100 files to reduce I/O
@@ -177,14 +192,14 @@ module Gitingest
             write_buffer(file, buffer) if buffer.size >= buffer_size
             print "\rProcessing: #{index + 1}/#{@repo_files.size} files"
           rescue Octokit::Error => e
-            puts "\nError fetching #{repo_file.path}: #{e.message}"
+            @logger.error "Error fetching #{repo_file.path}: #{e.message}"
           end
         end
         pool.shutdown
         pool.wait_for_termination
         write_buffer(file, buffer) unless buffer.empty?
       end
-      puts "\nPrompt generated and saved to #{@options[:output_file]}"
+      @logger.info "\nPrompt generated and saved to #{@options[:output_file]}"
     end
 
     def fetch_file_content_with_retry(path, retries = 3)
@@ -194,7 +209,7 @@ module Gitingest
       raise unless retries.positive?
 
       sleep_time = 60 / retries
-      puts "Rate limit exceeded, waiting #{sleep_time} seconds..."
+      @logger.warn "Rate limit exceeded, waiting #{sleep_time} seconds..."
       sleep(sleep_time)
       fetch_file_content_with_retry(path, retries - 1)
     end

data/lib/gitingest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitingest
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitingest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Davide Santangelo