rails_git_hooks 0.7.0 → 0.7.2

data/lib/rails_git_hooks/checks/pre_commit/rubocop.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class RuboCop < Base
+        check_definition key: 'rubocop-check',
+                         hook: :pre_commit,
+                         description: 'Run RuboCop on staged Ruby files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['bundle'], 'libraries' => ['rubocop'] },
+                         command: %w[bundle exec rubocop],
+                         install_hint: 'Add `gem "rubocop"` to your Gemfile and run bundle install'
+
+        def run
+          ruby_files = applicable_files.select { |path| File.extname(path) == '.rb' && File.file?(path) }
+          return CheckResult.pass if ruby_files.empty?
+
+          output, status = capture(*Array(config['command']), *ruby_files)
+          return CheckResult.pass if status.success?
+
+          messages = output.split("\n").map(&:rstrip).reject(&:empty?)
+          CheckResult.fail(messages: messages)
+        end
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/checks/pre_commit/whitespace_check.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class WhitespaceCheck < Base
+        check_definition key: 'whitespace-check',
+                         hook: :pre_commit,
+                         description: 'Reject trailing whitespace and conflict markers',
+                         file_based: true,
+                         enabled: false
+
+        def run
+          errors = []
+
+          applicable_files.each do |path|
+            next unless File.file?(path)
+
+            File.read(path).lines.each_with_index do |line, index|
+              errors << "#{path}:#{index + 1}: trailing whitespace" if line.match?(/[ \t]\z/)
+              stripped = line.strip
+              errors << "#{path}:#{index + 1}: conflict marker" if stripped.start_with?('<<<<<<<', '=======', '>>>>>>>')
+            end
+          end
+
+          errors.empty? ? CheckResult.pass : CheckResult.fail(messages: errors.uniq)
+        end
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/checks/pre_commit/yaml_format_check.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class YAMLFormatCheck < Base
+        check_definition key: 'yaml-format-check',
+                         hook: :pre_commit,
+                         description: 'Warn on invalid YAML',
+                         file_based: true,
+                         on_fail: :warn
+
+        def run
+          warnings = []
+
+          applicable_files.each do |path|
+            next unless File.file?(path)
+            next unless %w[.yml .yaml].include?(File.extname(path))
+
+            YAML.load_file(path)
+          rescue Psych::SyntaxError => e
+            location = e.line ? "#{path}:#{e.line}" : path
+            warnings << "#{location}: #{e.message}"
+          end
+
+          warnings.empty? ? CheckResult.pass : CheckResult.fail(messages: warnings)
+        end
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/checks/pre_commit.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+    end
+  end
+end
+
+require_relative 'pre_commit/default_branch'
+require_relative 'pre_commit/debugger_check'
+require_relative 'pre_commit/yaml_format_check'
+require_relative 'pre_commit/json_format_check'
+require_relative 'pre_commit/migrations_check'
+require_relative 'pre_commit/whitespace_check'
+require_relative 'pre_commit/rubocop'

data/lib/rails_git_hooks/checks/pre_push/run_tests.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PrePush
+      class RunTests < Base
+        check_definition key: 'run-tests',
+                         hook: :pre_push,
+                         description: 'Run test suite before push',
+                         dependencies: { 'executables' => ['bundle'] },
+                         command: %w[bundle exec rspec],
+                         install_hint: 'Install test dependencies and ensure `bundle exec rspec` runs successfully'
+
+        def run
+          output, status = capture(*Array(config['command']))
+          return CheckResult.pass if status.success?
+
+          messages = output.split("\n").map(&:rstrip).reject(&:empty?)
+          CheckResult.fail(messages: messages)
+        end
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/checks/pre_push.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PrePush
+    end
+  end
+end
+
+require_relative 'pre_push/run_tests'

data/lib/rails_git_hooks/checks/shared/bundle_install_check.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    # Shared logic and options for "run bundle install when Gemfile/Gemfile.lock changed"
+    # (post-checkout and post-merge). Each hook has its own class that passes hook + description.
+    module BundleInstallCheck
+      DEFINITION_OPTIONS = {
+        file_based: true,
+        enabled: false,
+        include: %w[Gemfile Gemfile.lock],
+        dependencies: { executables: ['bundle'] },
+        command: %w[bundle install],
+        install_hint: 'Ensure bundle is available'
+      }.freeze
+
+      def run
+        return CheckResult.pass if applicable_files.empty?
+
+        output, status = capture(*Array(config['command']))
+        return CheckResult.pass if status.success?
+
+        messages = output.split("\n").map(&:rstrip).reject(&:empty?)
+        CheckResult.fail(messages: messages)
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/checks/shared/db_migrate_check.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    # Shared logic and options for "run db:migrate when migrations or schema changed"
+    # (post-checkout and post-merge). Each hook has its own class that passes hook + description.
+    module DbMigrateCheck
+      DEFINITION_OPTIONS = {
+        file_based: true,
+        enabled: false,
+        include: ['db/migrate/*.rb', 'db/schema.rb', 'db/structure.sql'],
+        dependencies: { executables: ['bundle'] },
+        command: %w[bundle exec rails db:migrate],
+        install_hint: 'Rails app with db:migrate (or override command in config)'
+      }.freeze
+
+      def run
+        return CheckResult.pass if applicable_files.empty?
+
+        output, status = capture(*Array(config['command']))
+        return CheckResult.pass if status.success?
+
+        messages = output.split("\n").map(&:rstrip).reject(&:empty?)
+        CheckResult.fail(messages: messages)
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/checks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'checks/base'
+require_relative 'checks/pre_commit'
+require_relative 'checks/commit_msg'
+require_relative 'checks/pre_push'
+require_relative 'checks/shared/bundle_install_check'
+require_relative 'checks/shared/db_migrate_check'
+require_relative 'checks/post_checkout'
+require_relative 'checks/post_merge'

data/lib/rails_git_hooks/cli.rb

@@ -4,25 +4,18 @@ require 'rails_git_hooks'
 
 module GitHooks
   class CLI
-    FEATURE_FLAG_TOKENS = GitHooks::Constants::FEATURE_FLAG_FILES.keys.freeze
-
     def self.run(argv = ARGV)
       new.run(argv)
     end
 
     def run(argv)
-      case argv[0]
+      cmd = argv[0].to_s.strip.tr('_', '-')
+      case cmd
       when 'install'
-        run_install(argv[1..])
-      when 'list'
-        run_list
-      when 'disable'
-        run_disable(argv[1..])
-      when 'enable'
-        run_enable(argv[1..])
-      when 'disabled'
-        run_disabled
-      when nil, '-h', '--help'
+        run_install
+      when 'init'
+        run_init
+      when '', '-h', '--help'
         print_help
       else
         warn "Unknown command: #{argv[0]}"
@@ -33,102 +26,36 @@ module GitHooks
 
     private
 
-    def run_install(args)
+    def run_install
       installer = Installer.new
-      installed = installer.install(*args)
+      installed = installer.install
       puts "Installed hooks: #{installed.join(', ')}"
     rescue GitHooks::Error => e
       warn "Error: #{e.message}"
       exit 1
     end
 
-    def run_list
-      puts "Available hooks: #{Installer.available_hook_names.join(', ')}"
-    end
-
-    def run_disable(args)
-      tokens = parse_tokens(args)
-      if tokens.empty?
-        warn 'Usage: rails_git_hooks disable HOOK [HOOK...] [whitespace-check] [rubocop-check]'
-        warn "Use '*' to disable all hooks."
-        exit 1
-      end
-      installer = Installer.new
-      hook_names, feature_flags = split_tokens(tokens)
-      feature_flags.each { |name| installer.public_send(:"disable_#{name.tr('-', '_')}") }
-      installer.disable(*hook_names) if hook_names.any?
-      puts "Disabled: #{(hook_names + feature_flags).join(', ')}"
-    rescue GitHooks::Error => e
-      warn "Error: #{e.message}"
-      exit 1
-    end
-
-    def run_enable(args)
-      tokens = parse_tokens(args)
-      if tokens.empty?
-        warn 'Usage: rails_git_hooks enable HOOK [HOOK...] [whitespace-check] [rubocop-check]'
-        exit 1
-      end
-      installer = Installer.new
-      hook_names, feature_flags = split_tokens(tokens)
-      feature_flags.each { |name| installer.public_send(:"enable_#{name.tr('-', '_')}") }
-      installer.enable(*hook_names) if hook_names.any?
-      puts "Enabled: #{(hook_names + feature_flags).join(', ')}"
-    rescue GitHooks::Error => e
-      warn "Error: #{e.message}"
-      exit 1
-    end
-
-    def parse_tokens(args)
-      args.reject { |a| a.start_with?('-') }
-    end
-
-    def split_tokens(tokens)
-      feature_flags = tokens & FEATURE_FLAG_TOKENS
-      hook_names = tokens - FEATURE_FLAG_TOKENS
-      [hook_names, feature_flags]
-    end
-
-    def run_disabled
-      installer = Installer.new
-      list = installer.disabled_hooks
-      if list.empty?
-        puts 'No hooks disabled.'
-      else
-        puts "Disabled hooks: #{list.join(', ')}"
-      end
-    rescue GitHooks::Error => e
-      warn "Error: #{e.message}"
-      exit 1
+    def run_init
+      config = OverrideConfig.new(repo: Repository.new)
+      config.init
+      puts "Initialized #{Constants::CONFIG_FILE}"
     end
 
     def print_help
       puts <<~HELP
-        rails_git_hooks - Install git hooks for Jira commit prefix and RuboCop
+        rails_git_hooks - Install configurable Git hooks
 
         Usage:
-          rails_git_hooks install [HOOK...]
-          rails_git_hooks disable HOOK [HOOK...] [whitespace-check] [rubocop-check]   (use * for all hooks)
-          rails_git_hooks enable HOOK [HOOK...] [whitespace-check] [rubocop-check]
-          rails_git_hooks disabled
-          rails_git_hooks list
+          rails_git_hooks install
+          rails_git_hooks init
           rails_git_hooks --help
 
         Commands:
-          install   Install hooks into current repo's .git/hooks.
-          disable   Disable hooks or whitespace-check / rubocop-check (pre-commit options).
-          enable    Re-enable disabled hooks or enable whitespace-check / rubocop-check.
-          disabled  List currently disabled hooks.
-          list      List available hook names.
+          install   Install hooks that have at least one enabled check (merged config: defaults + .rails_git_hooks.yml + .rails_git_hooks.local.yml).
+          init      Create a sparse #{Constants::CONFIG_FILE} override file.
 
         Examples:
           rails_git_hooks install
-          rails_git_hooks disable pre-commit
-          rails_git_hooks disable *                    # disable all hooks
-          rails_git_hooks enable pre-commit
-          rails_git_hooks enable whitespace-check      # trailing ws/conflict markers (off by default)
-          rails_git_hooks enable rubocop-check         # RuboCop on staged .rb files (off by default)
-          rails_git_hooks install commit-msg pre-commit
       HELP
     end
   end

data/lib/rails_git_hooks/config/constants.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GitHooks
+  # Paths and default config (single source of truth).
+  module Constants
+    GEM_ROOT = File.expand_path('../../..', __dir__)
+    HOOKS_DIR = File.expand_path('templates/hooks', GEM_ROOT).freeze
+    RUNTIME_SOURCE_DIR = File.expand_path('lib/rails_git_hooks', GEM_ROOT).freeze
+    RUNTIME_DIR_NAME = 'rails_git_hooks'
+    CONFIG_FILE = '.rails_git_hooks.yml'
+    CONFIG_FILE_LOCAL = '.rails_git_hooks.local.yml'
+
+    # Default hooks when install is run with no arguments.
+    DEFAULT_HOOKS = %w[commit-msg pre-commit].freeze
+    HOOK_CONFIG_NAMES = {
+      pre_commit: 'PreCommit',
+      commit_msg: 'CommitMsg',
+      pre_push: 'PrePush',
+      post_checkout: 'PostCheckout',
+      post_merge: 'PostMerge'
+    }.freeze
+
+    # Section name (from YAML) -> hook script name (e.g. for install)
+    SECTION_TO_HOOK = HOOK_CONFIG_NAMES.invert.transform_values { |sym| sym.to_s.tr('_', '-') }.freeze
+  end
+end

data/lib/rails_git_hooks/config/defaults.yml

@@ -0,0 +1,190 @@
+# Default config for each check. Overrides live in .rails_git_hooks.yml (sparse).
+# Structure matches .rails_git_hooks.yml: hook section -> check config_name -> options.
+
+PreCommit:
+  DefaultBranch:
+    enabled: true
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Prevent commits on default branch
+    file_based: false
+
+  DebuggerCheck:
+    enabled: true
+    quiet: false
+    on_fail: warn
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Warn on debugger statements
+    file_based: true
+
+  YAMLFormatCheck:
+    enabled: true
+    quiet: false
+    on_fail: warn
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Warn on invalid YAML
+    file_based: true
+
+  JSONFormatCheck:
+    enabled: true
+    quiet: false
+    on_fail: warn
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Warn on invalid JSON
+    file_based: true
+
+  MigrationsCheck:
+    enabled: true
+    quiet: false
+    on_fail: warn
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Warn on missing schema files after migrations
+    file_based: true
+
+  WhitespaceCheck:
+    enabled: false
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Reject trailing whitespace and conflict markers
+    file_based: true
+
+  RuboCop:
+    enabled: false
+    quiet: true
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies:
+      executables: [bundle]
+      libraries: [rubocop]
+    command: [bundle, exec, rubocop]
+    description: Run RuboCop on staged Ruby files
+    file_based: true
+    install_hint: Add `gem "rubocop"` to your Gemfile and run bundle install
+
+CommitMsg:
+  JiraPrefix:
+    enabled: true
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies: {}
+    command: []
+    description: Prefix commit messages with ticket id from branch
+    file_based: false
+
+PrePush:
+  RunTests:
+    enabled: false
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: []
+    exclude: []
+    dependencies:
+      executables: [bundle]
+      libraries: [rspec]
+    command: [bundle, exec, rspec]
+    description: Run test suite before push
+    file_based: false
+    install_hint: Install test dependencies and ensure `bundle exec rspec` runs successfully
+
+PostCheckout:
+  BundleInstall:
+    enabled: true
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: [Gemfile, Gemfile.lock]
+    exclude: []
+    dependencies:
+      executables: [bundle]
+    command: [bundle, install]
+    description: Run bundle install when Gemfile or Gemfile.lock changed (branch checkout)
+    file_based: true
+    install_hint: Ensure bundle is available
+
+  DbMigrate:
+    enabled: true
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: [db/migrate/*.rb, db/schema.rb, db/structure.sql]
+    exclude: []
+    dependencies:
+      executables: [bundle]
+    command: [bundle, exec, rails, db:migrate]
+    description: Run db:migrate when migrations or schema changed (branch checkout)
+    file_based: true
+    install_hint: Rails app with db:migrate (or override command in config)
+
+PostMerge:
+  BundleInstall:
+    enabled: true
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: [Gemfile, Gemfile.lock]
+    exclude: []
+    dependencies:
+      executables: [bundle]
+    command: [bundle, install]
+    description: Run bundle install when Gemfile or Gemfile.lock changed (after merge)
+    file_based: true
+    install_hint: Ensure bundle is available
+
+  DbMigrate:
+    enabled: true
+    quiet: false
+    on_fail: fail
+    on_warn: warn
+    on_missing_dependency: warn
+    include: [db/migrate/*.rb, db/schema.rb, db/structure.sql]
+    exclude: []
+    dependencies:
+      executables: [bundle]
+    command: [bundle, exec, rails, db:migrate]
+    description: Run db:migrate when migrations or schema changed (after merge)
+    file_based: true
+    install_hint: Rails app with db:migrate (or override command in config)

data/lib/rails_git_hooks/config/defaults_loader.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module GitHooks
+  class DefaultsLoader
+    DEFAULTS_PATH = File.expand_path('defaults.yml', __dir__)
+
+    class << self
+      def config_for(hook_section, config_name)
+        section = data.fetch(hook_section, {})
+        return nil if section.empty?
+
+        section.fetch(config_name, nil)
+      end
+
+      private
+
+      def data
+        @data ||= load
+      end
+
+      def load
+        return {} unless File.exist?(DEFAULTS_PATH)
+
+        raw = YAML.safe_load(File.read(DEFAULTS_PATH), aliases: true) || {}
+        deep_stringify(raw)
+      end
+
+      def deep_stringify(value)
+        case value
+        when Hash
+          value.each_with_object({}) { |(k, v), out| out[k.to_s] = deep_stringify(v) }
+        when Array
+          value.map { |v| deep_stringify(v) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/rails_git_hooks/core/check_definition.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module GitHooks
+  class CheckDefinition
+    DEFAULTS = {
+      enabled: true,
+      quiet: false,
+      on_fail: :fail,
+      on_warn: :warn,
+      on_missing_dependency: :warn,
+      include: [],
+      exclude: [],
+      dependencies: {},
+      command: nil,
+      file_based: false
+    }.freeze
+
+    attr_reader :key, :config_name, :hook, :klass, :description
+
+    def initialize(key:, config_name:, hook:, klass:, description:, **options)
+      @key = key
+      @config_name = config_name
+      @hook = hook
+      @klass = klass
+      @description = description
+      @options = DEFAULTS.merge(options)
+    end
+
+    def default_config
+      {
+        'enabled' => @options[:enabled],
+        'quiet' => @options[:quiet],
+        'on_fail' => @options[:on_fail].to_s,
+        'on_warn' => @options[:on_warn].to_s,
+        'on_missing_dependency' => @options[:on_missing_dependency].to_s,
+        'include' => Array(@options[:include]),
+        'exclude' => Array(@options[:exclude]),
+        'dependencies' => deep_stringify(@options[:dependencies]),
+        'command' => Array(@options[:command]).compact,
+        'description' => description,
+        'file_based' => @options[:file_based],
+        'install_hint' => @options[:install_hint]
+      }.compact
+    end
+
+    def hook_section
+      Constants::HOOK_CONFIG_NAMES.fetch(hook)
+    end
+
+    private
+
+    def deep_stringify(value)
+      case value
+      when Hash
+        value.each_with_object({}) { |(key, nested), out| out[key.to_s] = deep_stringify(nested) }
+      when Array
+        value.map { |nested| deep_stringify(nested) }
+      else
+        value
+      end
+    end
+  end
+end