rails_git_hooks 0.7.1 → 0.7.3

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class Golint < Base
+        check_definition key: 'golint-check',
+                         hook: :pre_commit,
+                         description: 'Run golint on staged Go files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['golint'] },
+                         command: %w[golint],
+                         install_hint: 'Install golint or override command in config'
+
+        def run
+          go_files = applicable_files.select { |path| File.file?(path) && File.extname(path) == '.go' }
+          return CheckResult.pass if go_files.empty?
+
+          output, status = capture(*Array(config['command']), *go_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/haml_lint.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class HamlLint < Base
+        check_definition key: 'haml-lint-check',
+                         hook: :pre_commit,
+                         description: 'Run haml-lint on staged HAML files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['bundle'], 'libraries' => ['haml_lint'] },
+                         command: %w[bundle exec haml-lint],
+                         install_hint: 'Add `gem "haml_lint"` to your Gemfile and run bundle install'
+
+        def run
+          haml_files = applicable_files.select { |path| path.end_with?('.haml') && File.file?(path) }
+          return CheckResult.pass if haml_files.empty?
+
+          output, status = capture(*Array(config['command']), *haml_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/jslint.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class Jslint < Base
+        JS_EXTENSIONS = %w[.js .jsx .mjs .cjs].freeze
+
+        check_definition key: 'jslint-check',
+                         hook: :pre_commit,
+                         description: 'Run jslint on staged JavaScript files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['jslint'] },
+                         command: %w[jslint],
+                         install_hint: 'Install jslint or override command in config'
+
+        def run
+          js_files = applicable_files.select do |path|
+            File.file?(path) && JS_EXTENSIONS.include?(File.extname(path))
+          end
+          return CheckResult.pass if js_files.empty?
+
+          output, status = capture(*Array(config['command']), *js_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/php_lint.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class PhpLint < Base
+        check_definition key: 'php-lint-check',
+                         hook: :pre_commit,
+                         description: 'Run php -l (syntax check) on staged PHP files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['php'] },
+                         command: %w[php -l],
+                         install_hint: 'Ensure PHP is installed and on PATH'
+
+        def run
+          php_files = applicable_files.select { |path| path.end_with?('.php') && File.file?(path) }
+          return CheckResult.pass if php_files.empty?
+
+          output, status = capture(*Array(config['command']), *php_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/pylint.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class Pylint < Base
+        check_definition key: 'pylint-check',
+                         hook: :pre_commit,
+                         description: 'Run pylint on staged Python files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['pylint'] },
+                         command: %w[pylint],
+                         install_hint: 'Install pylint (e.g. pip install pylint) or override command in config'
+
+        def run
+          py_files = applicable_files.select { |path| path.end_with?('.py') && File.file?(path) }
+          return CheckResult.pass if py_files.empty?
+
+          output, status = capture(*Array(config['command']), *py_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/rails_best_practices.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class RailsBestPractices < Base
+        check_definition key: 'rails-best-practices',
+                         hook: :pre_commit,
+                         description: 'Warn on Rails best practices violations',
+                         file_based: true,
+                         enabled: false,
+                         on_fail: :warn,
+                         quiet: true,
+                         dependencies: { 'executables' => ['bundle'], 'libraries' => ['rails_best_practices'] },
+                         command: %w[bundle exec rails_best_practices],
+                         install_hint: 'Add `gem "rails_best_practices"` 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/scss_lint.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PreCommit
+      class ScssLint < Base
+        check_definition key: 'scss-lint-check',
+                         hook: :pre_commit,
+                         description: 'Run scss-lint on staged SCSS files',
+                         file_based: true,
+                         enabled: false,
+                         quiet: true,
+                         dependencies: { 'executables' => ['bundle'], 'libraries' => ['scss_lint'] },
+                         command: %w[bundle exec scss-lint],
+                         install_hint: 'Add `gem "scss_lint"` to your Gemfile and run bundle install'
+
+        def run
+          scss_files = applicable_files.select { |path| path.end_with?('.scss') && File.file?(path) }
+          return CheckResult.pass if scss_files.empty?
+
+          output, status = capture(*Array(config['command']), *scss_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.rb

@@ -14,3 +14,13 @@ require_relative 'pre_commit/json_format_check'
 require_relative 'pre_commit/migrations_check'
 require_relative 'pre_commit/whitespace_check'
 require_relative 'pre_commit/rubocop'
+require_relative 'pre_commit/rails_best_practices'
+require_relative 'pre_commit/erblint'
+require_relative 'pre_commit/eslint'
+require_relative 'pre_commit/golint'
+require_relative 'pre_commit/haml_lint'
+require_relative 'pre_commit/jslint'
+require_relative 'pre_commit/php_lint'
+require_relative 'pre_commit/pylint'
+require_relative 'pre_commit/scss_lint'
+require_relative 'pre_commit/go_vet'

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PrePush
+      class RunGoTest < Base
+        check_definition key: 'run-go-test',
+                         hook: :pre_push,
+                         description: 'Run go test suite before push',
+                         dependencies: { 'executables' => ['go'] },
+                         command: %w[go test ./...],
+                         install_hint: 'Ensure Go toolchain is installed and `go test ./...` 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/run_pytest.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    module PrePush
+      class RunPytest < Base
+        check_definition key: 'run-pytest',
+                         hook: :pre_push,
+                         description: 'Run pytest test suite before push',
+                         dependencies: { 'executables' => ['pytest'] },
+                         command: %w[pytest],
+                         install_hint: 'Install pytest (e.g. pip install pytest) and ensure pytest 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

@@ -8,3 +8,5 @@ module GitHooks
 end
 
 require_relative 'pre_push/run_tests'
+require_relative 'pre_push/run_pytest'
+require_relative 'pre_push/run_go_test'

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/shared/npm_install_check.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    # Shared logic and options for "run npm install when package.json/package-lock.json changed"
+    # (post-checkout and post-merge). Each hook has its own class that passes hook + description.
+    module NpmInstallCheck
+      DEFINITION_OPTIONS = {
+        file_based: true,
+        enabled: false,
+        include: %w[package.json package-lock.json],
+        dependencies: { executables: ['npm'] },
+        command: %w[npm install],
+        install_hint: 'Ensure npm 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/yarn_install_check.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GitHooks
+  module Checks
+    # Shared logic and options for "run yarn install when package.json/yarn.lock changed"
+    # (post-checkout and post-merge). Each hook has its own class that passes hook + description.
+    module YarnInstallCheck
+      DEFINITION_OPTIONS = {
+        file_based: true,
+        enabled: false,
+        include: %w[package.json yarn.lock],
+        dependencies: { executables: ['yarn'] },
+        command: %w[yarn install],
+        install_hint: 'Ensure yarn 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.rb

@@ -4,3 +4,9 @@ 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/shared/npm_install_check'
+require_relative 'checks/shared/yarn_install_check'
+require_relative 'checks/post_checkout'
+require_relative 'checks/post_merge'

data/lib/rails_git_hooks/cli.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rails_git_hooks'
-require 'yaml'
 
 module GitHooks
   class CLI
@@ -10,22 +9,13 @@ module GitHooks
     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
+        run_install
       when 'init'
         run_init
-      when 'disable'
-        run_disable(argv[1..])
-      when 'enable'
-        run_enable(argv[1..])
-      when 'set'
-        run_set(argv[1..])
-      when 'show-config'
-        run_show_config
-      when nil, '-h', '--help'
+      when '', '-h', '--help'
         print_help
       else
         warn "Unknown command: #{argv[0]}"
@@ -36,118 +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
-      repo = Repository.new
-      config = OverrideConfig.new(repo: repo)
-
-      puts 'Available hooks:'
-      Installer.available_hook_names.each { |name| puts "  #{name}" }
-      puts
-      puts 'Available checks:'
-      CheckRegistry.all.each do |definition|
-        check_config = config.config_for(definition)
-        puts "  #{definition.key} (#{definition.hook_section}/#{definition.config_name}, enabled=#{check_config['enabled']})"
-      end
-    rescue GitHooks::Error
-      puts 'Available hooks:'
-      Installer.available_hook_names.each { |name| puts "  #{name}" }
-      puts
-      puts 'Available checks:'
-      CheckRegistry.all.each do |definition|
-        puts "  #{definition.key} (#{definition.hook_section}/#{definition.config_name})"
-      end
-    end
-
     def run_init
       config = OverrideConfig.new(repo: Repository.new)
       config.init
       puts "Initialized #{Constants::CONFIG_FILE}"
     end
 
-    def run_disable(args)
-      key = args.first
-      if key.nil?
-        warn 'Usage: rails_git_hooks disable CHECK_NAME'
-        exit 1
-      end
-
-      repo = Repository.new
-      definition = CheckRegistry.find!(key)
-      OverrideConfig.new(repo: repo).set_option(definition, 'enabled', false)
-      puts "Disabled: #{key}"
-    end
-
-    def run_enable(args)
-      key = args.first
-      if key.nil?
-        warn 'Usage: rails_git_hooks enable CHECK_NAME'
-        exit 1
-      end
-
-      repo = Repository.new
-      definition = CheckRegistry.find!(key)
-      OverrideConfig.new(repo: repo).set_option(definition, 'enabled', true)
-      puts "Enabled: #{key}"
-    end
-
-    def run_set(args)
-      key, option, value = args
-      if key.nil? || option.nil? || value.nil?
-        warn 'Usage: rails_git_hooks set CHECK_NAME OPTION VALUE'
-        exit 1
-      end
-
-      definition = CheckRegistry.find!(key)
-      OverrideConfig.new(repo: Repository.new).set_option(definition, option, value)
-      puts "Updated: #{key} #{option}=#{value}"
-    end
-
-    def run_show_config
-      repo = Repository.new
-      config = OverrideConfig.new(repo: repo).effective_config(CheckRegistry.all)
-      puts YAML.dump(config)
-    end
-
     def print_help
       puts <<~HELP
         rails_git_hooks - Install configurable Git hooks
 
         Usage:
-          rails_git_hooks install [HOOK...]
-          rails_git_hooks list
+          rails_git_hooks install
           rails_git_hooks init
-          rails_git_hooks enable CHECK_NAME
-          rails_git_hooks disable CHECK_NAME
-          rails_git_hooks set CHECK_NAME OPTION VALUE
-          rails_git_hooks show-config
           rails_git_hooks --help
 
         Commands:
-          install   Install hooks into current repo's .git/hooks.
-          list      List available hooks and checks.
+          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.
-          enable    Enable a check in #{Constants::CONFIG_FILE}.
-          disable   Disable a check in #{Constants::CONFIG_FILE}.
-          set       Set a check option like on_fail/on_warn/quiet.
-          show-config Print effective merged configuration.
 
         Examples:
           rails_git_hooks install
-          rails_git_hooks enable rubocop-check
-          rails_git_hooks disable migrations-check
-          rails_git_hooks set debugger-check on_fail fail
-          rails_git_hooks set rubocop-check quiet true
-          rails_git_hooks show-config
-          rails_git_hooks install commit-msg pre-commit
       HELP
     end
   end

data/lib/rails_git_hooks/config/constants.rb

@@ -8,13 +8,19 @@ module GitHooks
     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'
+      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