pretty-git 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd982eee724a56adcb2aa941fdecc2c95309c1bf681a5c3b9a1be0b8bf0306f
-  data.tar.gz: 1ef12cd144493563bbe99a869e81fe6aa9436136dc7aac52b713d5436975a48a
+  metadata.gz: 00b27dd7b14328c3aa2e5d3bf865dd778d512131d3f3b1c7d9fe1ca76939c5e6
+  data.tar.gz: 36c9f80ac26f1982bf2a4b2f1616bf5d309dec2c9dcda12603e2e2422500e3a4
 SHA512:
-  metadata.gz: fba3dc59a53571d80cf38e13a555b2ad62b44964f29039a1fe68000349f642d024bb854542d62d58608dd8f9a8169548b0444a0fc8488cccc9a8e3497ba68ade
-  data.tar.gz: 1f8037f3e7ef97e13b60be37c6d447c684586ffb78017d1905fc6b75d4d055ce533d4a87f04baf6e15fa734fa20fcbfe8854f5f4ef429c402106cbbf4a9a70b5
+  metadata.gz: 8518117f9b018c89a31db647920d871fe68f1ba1a2ddb90e43f58ec08342c4d345393617144ba29705ef6a13f86c184123c72b99ee2de81ada45824df875593d
+  data.tar.gz: 59505cbed77cdf230c6b5c2960caa1bde851a4a17820d886b788b409a04f5b042cfe51e5a4e060471e90a303743369df335206f3fc51b97759c637086775abcf

data/CHANGELOG.md

@@ -5,87 +5,144 @@ All notable changes to this project will be documented in this file.
 The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
 
 ## [Unreleased]
+
+## [0.1.6] - 2025-10-10
+
+### Security
+
+- Git::Provider: added input validation for `--author` and `--branch` parameters to prevent command injection attacks
+- Git::Provider: `validate_safe_string` method checks for shell metacharacters (`; & | \` $ ( ) < >`)
+- Git::Provider: `validate_git_ref` method validates git reference format and rejects refs starting with `-`
+
 ### Added
+
+- Render::ConsoleRenderer: named constants for ANSI color codes (`Colors::AnsiCodes` module)
+- Render::ReportSchema: centralized module for report headers (eliminates duplication across CSV/Markdown renderers)
+- CLI: verbose mode now includes full backtrace for `StandardError` exceptions (helps with debugging)
+- Analytics::Languages: `safe_file_size` and `safe_count_lines` now log warnings to stderr when `verbose=true`
+- Tests: 20+ negative test cases for input validation (`spec/pretty_git/git/provider_validation_spec.rb`)
+- Tests: CLI error handling coverage (`spec/pretty_git/cli_error_handling_spec.rb`)
+
+### Changed
+
+- CLI: enhanced error handling with specific exit codes: `ArgumentError` → 1, file system errors (`ENOENT`, `EACCES`) → 2, other errors → 99
+- CLI: improved error messages for `ArgumentError`, `Errno::ENOENT`, and `Errno::EACCES`
+- Render::CsvRenderer: refactored to use `ReportSchema.headers_for` instead of local `HEADERS` constant
+- Render::MarkdownRenderer: refactored to use `ReportSchema.headers_for` instead of local `HEADERS` constant
+
+### Fixed
+
+- Security: command injection vulnerabilities via `--author` and `--branch` parameters accepting unvalidated shell input
+
+### Documentation
+
 - Docs: `docs/testing.md` covering the golden workflow, snapshot update/validation; linked from `README.md`, `README.ru.md`, and `CONTRIBUTING.md`.
 - Tests: determinism invariants for YAML/XML renderers (stable output regardless of input order).
+- Scripts: `scripts/release.sh` automated release workflow with validation, testing, and git operations
+
+### Refactoring
+
+- Code quality: eliminated ~40 lines of duplicated `HEADERS` definitions across renderers
+- Readability: replaced magic numbers (`'1;35'`, `'1;36'`) with descriptive constant names (`BRIGHT_TITLE`, `BASIC_TITLE`)
+
+### Changed (from previous Unreleased)
 
-### Changed
 - Completions: refreshed bash/zsh completions — added short flags `-f`/`-o`/`-l`, values for `--time-bucket` (`day|week|month`), and repo path completion as the 2nd positional argument.
 
 ## [0.1.5] - 2025-08-17
+
 ### Added
+
 - CLI: warn to stderr when `--theme`/`--no-color` are used with non-console `--format` values.
 - Docs: expanded Filters documentation (branches, authors, paths, time semantics, verbose diagnostics), schemas/examples pointers, performance and CI usage.
 - Tests: unit tests for `PrettyGit::Utils::TimeUtils`.
 
 ### Changed
+
 - Internals: extracted time parsing/normalization to `PrettyGit::Utils::TimeUtils` and centralized verbose logging via `PrettyGit::Logger`. `Git::Provider` routes verbose messages through the centralized logger (stderr).
 - Verbose mode: documentation clarified to note that diagnostics are printed to stderr for easier CI parsing.
 
 ### Deprecated
+
 - Filters: legacy `:until` keyword in `PrettyGit::Filters` initialization is accepted for backward compatibility and emits a deprecation warning; use `:until_at` instead.
 
 ### Fixed
+
 - Filters: allow initialization via a single Hash argument (legacy call sites) while preserving `Struct` keyword semantics.
 
 ## [0.1.4] - 2025-08-17
+
 ### Added
+
 - Integration tests for new reports exports: CSV/Markdown/YAML/XML for `hotspots`, `churn`, `ownership`.
 - Schema validations: `rake validate:json`, `rake validate:xml` to ensure format compatibility.
 - CI: expanded matrix to include macOS; smoke test for installed binary (`--help`, `--version`).
 
 ### Changed
+
 - Renderers (`MarkdownRenderer`, `YamlRenderer`, `XmlRenderer`): deterministic sorting for all new reports according to `docs/determinism.md`.
 - XML: per-report root elements in XML exports to match XSDs (`hotspotsReport`, `churnReport`, `ownershipReport`, `languagesReport`, etc.).
 - Documentation: `README.md` and `README.ru.md` updated with sections and examples for new reports and all export formats.
 - CLI: keep `--time-bucket` permissive; default `time_bucket=nil`.
 
 ### Fixed
+
 - Time parsing: interpret date-only inputs (`YYYY-MM-DD`) as UTC midnight and normalize to UTC ISO8601.
 - CLI UX: error when `--metric` is used outside `languages` report.
 - Tests/specs: updated XML specs to per-report roots; added timezone edge cases; fixed Open3 `popen3` stubs (`chdir:`) and integration requires.
 
-
 ## [0.1.3] - 2025-08-14
+
 ### Added
+
 - New analytics reports: `hotspots`, `churn`, `ownership` with sorting, scoring, and limits.
 - Exporters: CSV and Markdown support for new reports with dynamic headers via mapping constants.
 - Docs: Detailed sections for new reports in `README.md` and `README.ru.md` with usage and examples (CSV/JSON/YAML/XML).
 
 ### Changed
+
 - Console: dispatching and rendering wired for new reports; consistent theming and width handling.
 - CLI/App: unified analytics dispatch for all reports.
-- Docs: public READMEs cleaned up from internal DR-* mentions; anchors and headings aligned (CSV).
+- Docs: public READMEs cleaned up from internal DR-\* mentions; anchors and headings aligned (CSV).
 
 ### Fixed
-- Minor documentation inaccuracies and anchor mismatches.
 
+- Minor documentation inaccuracies and anchor mismatches.
 
 ## [0.1.2] - 2025-08-13
+
 ### Added
+
 - Languages report: support multiple metrics — `bytes`, `files`, `loc`; dynamic columns in Console/CSV/Markdown; color and percent fields in output.
 - CLI: `--metric` option for the `languages` report with value validation.
 
 ### Changed
+
 - Languages: JSON language reinstated in the mapping and color scheme; sorting and percent calculations are based on the selected metric; percentages rounded to two decimals.
 - Renderers: updated `csv`, `markdown`, and console renderers to work with dynamic metrics.
 - Internal specs updated: `docs/output_formats.md`, `docs/cli_spec.md`, `docs/languages_map.md`.
 
 ### Fixed
+
 - Git provider: correct commit counting — emit a new commit when a header is read and remove the record separator from the subject (`lib/pretty_git/git/provider.rb`).
 - RuboCop: targeted suppressions for complex methods/classes and style fixes in `cli_helpers.rb`.
 
 ## [0.1.1] - 2025-08-13
+
 ### Changed
+
 - Release automation: added GitHub Actions workflow to publish gem on tags and open PR to Homebrew tap (`.github/workflows/release.yml`).
 - Documentation: README badges and installation instructions for Homebrew and RubyGems in `README.md` and `README.ru.md`.
 - Gemspec: bounded runtime dependencies for `csv` and `rexml` to satisfy RubyGems recommendations.
 
 ### Fixed
+
 - Homebrew formula installation stability: formula installs gem into `libexec/vendor` and wraps `pretty-git` binary to avoid file collisions on reinstall.
 
 ## [0.1.0] - 2025-08-13
+
 ### Added
+
 - Languages report: bytes per language, percentages, sorting, limit.
 - Console: colorized languages section; terminal width handling via `TerminalWidth`.
 - Export: languages in Markdown/CSV/JSON/YAML/XML.
@@ -96,10 +153,12 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
 - Docs: Added screenshot `PrettyGitConsoleLanguages.png`.
 
 ### Changed
+
 - Analytics: exclude JSON from language mapping by default to avoid data skew.
 - Analytics: ignore Python env/cache directories by default.
 - Refactor: `ConsoleRenderer` split (LanguagesSection, TerminalWidth); reduced complexity.
 - App: extracted `analytics_for` from `App#run`.
 
 ### Fixed
+
 - RuboCop violations in new specs and minor guard clause spacing.

data/lib/pretty_git/analytics/languages.rb

@@ -112,6 +112,7 @@ module PrettyGit
       # rubocop:disable Metrics/AbcSize
       def self.calculate(repo_path, include_globs:, exclude_globs:, metric: 'bytes')
         by_lang = Hash.new { |h, k| h[k] = { bytes: 0, files: 0, loc: 0 } }
+        verbose = ENV['PG_VERBOSE'] == '1'
         Dir.chdir(repo_path) do
           each_source_file(include_globs, exclude_globs) do |path|
             basename = File.basename(path)
@@ -119,8 +120,8 @@ module PrettyGit
             lang = FILENAME_TO_LANG[basename] || EXT_TO_LANG[ext]
             next unless lang
 
-            size = safe_file_size(path)
-            lines = metric == 'loc' ? safe_count_lines(path) : 0
+            size = safe_file_size(path, verbose: verbose)
+            lines = metric == 'loc' ? safe_count_lines(path, verbose: verbose) : 0
             agg = by_lang[lang]
             agg[:bytes] += size
             agg[:files] += 1
@@ -159,17 +160,19 @@ module PrettyGit
       end
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-      def self.safe_file_size(path)
+      def self.safe_file_size(path, verbose: false)
         File.size(path)
-      rescue StandardError
+      rescue StandardError => e
+        warn("Warning: failed to read size of #{path}: #{e.message}") if verbose
         0
       end
 
-      def self.safe_count_lines(path)
+      def self.safe_count_lines(path, verbose: false)
         count = 0
         File.foreach(path) { |_l| count += 1 }
         count
-      rescue StandardError
+      rescue StandardError => e
+        warn("Warning: failed to count lines in #{path}: #{e.message}") if verbose
         0
       end
 

data/lib/pretty_git/cli.rb

@@ -53,11 +53,24 @@ module PrettyGit
       filters = CLIHelpers.build_filters(options)
       CLIHelpers.execute(options[:report], filters, options, out, err)
     rescue ArgumentError => e
-      err.puts e.message
+      err.puts "Error: #{e.message}"
       1
-    rescue StandardError => e
-      err.puts e.message
+    rescue Errno::ENOENT => e
+      # Repository not found is user input error (exit 1), file write error is system error (exit 2)
+      if e.message.include?('chdir') || options[:repo]
+        err.puts "Not a git repository: #{e.message}"
+        1
+      else
+        err.puts "File system error: #{e.message}"
+        2
+      end
+    rescue Errno::EACCES => e
+      err.puts "Permission denied: #{e.message}"
       2
+    rescue StandardError => e
+      err.puts "Unexpected error: #{e.message}"
+      err.puts e.backtrace.first(5).join("\n") if options[:_verbose]
+      99
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
   end

data/lib/pretty_git/cli_helpers.rb

@@ -269,6 +269,9 @@ module PrettyGit
           File.open(options[:out], 'w') do |f|
             return PrettyGit::App.new.run(report, filters, out: f, err: err)
           end
+        rescue Errno::EISDIR
+          err.puts "Cannot write to: #{options[:out]} (is a directory)"
+          return 2
         rescue Errno::EACCES
           err.puts "Cannot write to: #{options[:out]} (permission denied)"
           return 2

data/lib/pretty_git/git/provider.rb

@@ -57,7 +57,14 @@ module PrettyGit
             status = wait_thr.value
             unless status.success?
               err = stderr.read
-              raise StandardError, (err && !err.empty? ? err : "git log failed with status #{status.exitstatus}")
+              error_msg = err && !err.empty? ? err : "git log failed with status #{status.exitstatus}"
+              # Repository errors are ArgumentError (invalid input), other git errors are StandardError
+              if error_msg.include?('not a git repository') || error_msg.include?('Not a git repository')
+                raise ArgumentError, error_msg
+              end
+
+              raise StandardError, error_msg
+
             end
           end
 
@@ -146,9 +153,15 @@ module PrettyGit
       end
 
       def add_author_and_branch_filters(args)
-        @filters.authors&.each { |a| args << "--author=#{a}" }
+        @filters.authors&.each do |a|
+          validate_safe_string(a, 'author')
+          args << "--author=#{a}"
+        end
         # Treat branches as explicit revisions to include
-        @filters.branches&.each { |b| args << b }
+        @filters.branches&.each do |b|
+          validate_git_ref(b)
+          args << b
+        end
       end
 
       def add_path_filters(args)
@@ -183,6 +196,31 @@ module PrettyGit
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
+
+      # Validates that a string doesn't contain shell metacharacters that could be exploited
+      def validate_safe_string(value, name)
+        return if value.nil? || value.empty?
+
+        # Check for dangerous shell metacharacters
+        return unless value.to_s =~ /[;&|`$()<>]/
+
+        raise ArgumentError, "Invalid #{name}: contains shell metacharacters"
+      end
+
+      # Validates git references (branch names, tags, commit SHAs)
+      # Allows alphanumeric, dash, underscore, slash, dot, @, ^, ~, and :
+      def validate_git_ref(ref)
+        return if ref.nil? || ref.empty?
+
+        # Git ref naming rules are complex, but we allow a safe subset
+        # See: https://git-scm.com/docs/git-check-ref-format
+        raise ArgumentError, "Invalid git ref: #{ref}" unless ref.to_s =~ %r{\A[a-zA-Z0-9/_.\-@^~:]+\z}
+
+        # Additional safety: reject refs that look like options
+        return unless ref.to_s.start_with?('-')
+
+        raise ArgumentError, "Invalid git ref: #{ref} (looks like an option)"
+      end
     end
   end
 end

data/lib/pretty_git/render/console_renderer.rb

@@ -7,6 +7,24 @@ module PrettyGit
   module Render
     # Simple color helpers used by console components.
     module Colors
+      # ANSI color codes for different themes
+      module AnsiCodes
+        # Title colors
+        BRIGHT_TITLE = '1;35'    # Bright magenta
+        BASIC_TITLE = '1;36'     # Cyan
+
+        # Header colors
+        BRIGHT_HEADER = '1;36'   # Bright cyan
+        BASIC_HEADER = '1;34'    # Blue
+
+        # Text styles
+        DIM = '2;37'             # Dim white
+        GREEN = '32'             # Green
+        RED = '31'               # Red
+        YELLOW = '33'            # Yellow
+        BOLD = '1'               # Bold
+      end
+
       module_function
 
       def apply(code, text, enabled)
@@ -16,33 +34,33 @@ module PrettyGit
       end
 
       def title(text, enabled, theme = 'basic')
-        code = theme == 'bright' ? '1;35' : '1;36'
+        code = theme == 'bright' ? AnsiCodes::BRIGHT_TITLE : AnsiCodes::BASIC_TITLE
         apply(code, text, enabled)
       end
 
       def header(text, enabled, theme = 'basic')
-        code = theme == 'bright' ? '1;36' : '1;34'
+        code = theme == 'bright' ? AnsiCodes::BRIGHT_HEADER : AnsiCodes::BASIC_HEADER
         apply(code, text, enabled)
       end
 
       def dim(text, enabled)
-        apply('2;37', text, enabled)
+        apply(AnsiCodes::DIM, text, enabled)
       end
 
       def green(text, enabled)
-        apply('32', text, enabled)
+        apply(AnsiCodes::GREEN, text, enabled)
       end
 
       def red(text, enabled)
-        apply('31', text, enabled)
+        apply(AnsiCodes::RED, text, enabled)
       end
 
       def yellow(text, enabled)
-        apply('33', text, enabled)
+        apply(AnsiCodes::YELLOW, text, enabled)
       end
 
       def bold(text, enabled)
-        apply('1', text, enabled)
+        apply(AnsiCodes::BOLD, text, enabled)
       end
     end
 

data/lib/pretty_git/render/csv_renderer.rb

@@ -1,37 +1,26 @@
 # frozen_string_literal: true
 
 require 'csv'
+require_relative 'report_schema'
 
 module PrettyGit
   module Render
     # Renders CSV according to docs/output_formats.md and DR-001
     class CsvRenderer
-      HEADERS = {
-        'activity' => %w[bucket timestamp commits additions deletions],
-        'authors' => %w[author author_email commits additions deletions avg_commit_size],
-        'files' => %w[path commits additions deletions changes],
-        'heatmap' => %w[dow hour commits],
-        'hotspots' => %w[path score commits additions deletions changes],
-        'churn' => %w[path churn commits additions deletions],
-        'ownership' => %w[path owner owner_share authors]
-      }.freeze
       def initialize(io: $stdout)
         @io = io
       end
 
       def call(report, result, _filters)
-        headers = headers_for(report, result)
+        headers = ReportSchema.headers_for(report, result)
         write_csv(headers, result[:items])
       end
 
       private
 
       def headers_for(report, result)
-        return ['language', (result[:metric] || 'bytes').to_s, 'percent', 'color'] if report == 'languages'
-
-        HEADERS.fetch(report) do
-          raise ArgumentError, "CSV output for report '#{report}' is not supported yet"
-        end
+        # Deprecated: use ReportSchema.headers_for instead
+        ReportSchema.headers_for(report, result)
       end
 
       def write_csv(headers, rows)

data/lib/pretty_git/render/markdown_renderer.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'report_schema'
+
 module PrettyGit
   module Render
     # Renders Markdown tables and sections per docs/output_formats.md
-    # rubocop:disable Metrics/ClassLength
     class MarkdownRenderer
       TITLES = {
         'activity' => 'Activity',
@@ -16,15 +17,6 @@ module PrettyGit
         'ownership' => 'Ownership'
       }.freeze
 
-      HEADERS = {
-        'activity' => %w[bucket timestamp commits additions deletions],
-        'authors' => %w[author author_email commits additions deletions avg_commit_size],
-        'files' => %w[path commits additions deletions changes],
-        'heatmap' => %w[dow hour commits],
-        'hotspots' => %w[path score commits additions deletions changes],
-        'churn' => %w[path churn commits additions deletions],
-        'ownership' => %w[path owner owner_share authors]
-      }.freeze
       def initialize(io: $stdout)
         @io = io
       end
@@ -32,7 +24,7 @@ module PrettyGit
       def call(report, result, _filters)
         return render_summary(result) if report == 'summary'
 
-        headers = headers_for(report, result)
+        headers = ReportSchema.headers_for(report, result)
         title = title_for(report)
         rows = sort_rows(report, result[:items], result)
         render_table(title, headers, rows)
@@ -41,9 +33,8 @@ module PrettyGit
       private
 
       def headers_for(report, result)
-        return ['language', (result[:metric] || 'bytes').to_s, 'percent', 'color'] if report == 'languages'
-
-        HEADERS.fetch(report, [])
+        # Deprecated: use ReportSchema.headers_for instead
+        ReportSchema.headers_for(report, result)
       end
 
       def title_for(report)
@@ -131,6 +122,5 @@ module PrettyGit
         (val || '').to_s
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/pretty_git/render/report_schema.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrettyGit
+  module Render
+    # Centralized schema definitions for report headers and structure.
+    # Used by all renderers (CSV, Markdown, etc.) to ensure consistency.
+    module ReportSchema
+      # Standard headers for each report type
+      HEADERS = {
+        'activity' => %w[bucket timestamp commits additions deletions],
+        'authors' => %w[author author_email commits additions deletions avg_commit_size],
+        'files' => %w[path commits additions deletions changes],
+        'heatmap' => %w[dow hour commits],
+        'hotspots' => %w[path score commits additions deletions changes],
+        'churn' => %w[path churn commits additions deletions],
+        'ownership' => %w[path owner owner_share authors],
+        'summary' => %w[metric value] # not typically tabular but defined for completeness
+      }.freeze
+
+      module_function
+
+      # Returns headers for the given report type
+      # @param report [String] Report name
+      # @param result [Hash] Result hash (used for languages metric detection)
+      # @return [Array<String>] Array of header names
+      def headers_for(report, result = nil)
+        return languages_headers(result) if report == 'languages'
+
+        HEADERS[report] || raise(ArgumentError, "Unknown report type: #{report}")
+      end
+
+      # Languages report has dynamic headers based on metric
+      def languages_headers(result)
+        metric = result&.dig(:metric) || 'bytes'
+        ['language', metric.to_s, 'percent', 'color']
+      end
+    end
+  end
+end

data/lib/pretty_git/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrettyGit
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pretty-git
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Pretty Git Authors
@@ -83,6 +83,7 @@ files:
 - lib/pretty_git/render/json_renderer.rb
 - lib/pretty_git/render/languages_section.rb
 - lib/pretty_git/render/markdown_renderer.rb
+- lib/pretty_git/render/report_schema.rb
 - lib/pretty_git/render/terminal_width.rb
 - lib/pretty_git/render/xml_renderer.rb
 - lib/pretty_git/render/yaml_renderer.rb