rails_git_hooks 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ad75b3fc1e2570a89d2feec9dd121d561531ffd323bd039d8376d1aec7250c6
-  data.tar.gz: 9e4ad0399f71ce3e8bedc120413b4fcbd4a23f5c8bbc0c3fe104c47165728a79
+  metadata.gz: '039dc0fb243e8ce670d6cadeb3c3e398cc6441276953c9a0c1e8f8541864256e'
+  data.tar.gz: 26a46c6776054ec41554c60ad4ea06f48c14f703cd9c396735f2888b6b0f329b
 SHA512:
-  metadata.gz: 0d924d665a075d1ab0d4918ed4b9b270df1341acf66b0d2beea8f6763d2d6483e128d1ad59c2896f72381d6bad587beac8a51258043d88286a9120631f083bfa
-  data.tar.gz: 4e00fdde7a52b52734f2ee919c8f651f2a1740f156ec8c491d4d0081720a4058f6989f46eeb8bd8f4d1fa658e3efd45f1b45e42ac5bfc36cf34f0352aa550a1b
+  metadata.gz: 589952d05b4bbc277efc18f59a02bdd51ba2edeae20b26fb1b093186bdd57413a4949e25987b291b546b06f29b2c81cff394901cd6c6dd9527a1fd1c0f3f0101
+  data.tar.gz: d79a92159cd66cf640b1fc80a29ade822fd6e3215be50915aec2609301f7edd71a13b1b83252e4b94adbb95feed759f1dfb78eb80e1f23abd800419992a6a24f

data/CHANGELOG.md

@@ -4,9 +4,20 @@ 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/).
 
-## [Unreleased]
+## [0.6.1] (latest)
 
-## [0.5.0] (latest)
+### Changed
+
+- **Default install** now installs **commit-msg** and **pre-commit** only (Jira ticket prefix + default-branch protection + RuboCop). Pre-push remains opt-in: `rails_git_hooks install pre-push`.
+- README: quick start and commands table updated for default (commit-msg + pre-commit); Jira project key / `JIRA_PROJECT_KEY` for manual install; pre-push install instruction.
+
+## [0.6.0]
+
+### Added
+
+- **Trailing whitespace / conflict markers** check in pre-commit (disabled by default): rejects commits that add trailing spaces/tabs or `<<<<<<<` / `=======` / `>>>>>>>` in staged files. Enable with `rails_git_hooks enable whitespace-check`; disable with `rails_git_hooks disable whitespace-check`.
+
+## [0.5.0]
 
 ### Added
 

data/README.md

@@ -41,7 +41,11 @@ bundle install
 bundle exec rails_git_hooks install
 ```
 
-**2. (Optional) Set your Jira project key**
+This installs **commit-msg** (Jira ticket prefix) and **pre-commit** (blocks commits on `master`/`main` + RuboCop on staged `.rb` files) by default.
+
+**2. Set your Jira project key**
+
+Replace the default by passing your project key at install time or via env:
 
 ```bash
 rails_git_hooks install --jira MYPROJ
@@ -50,7 +54,10 @@ export GIT_HOOKS_JIRA_PROJECT=MYPROJ
 rails_git_hooks install
 ```
 
-Default is `APD` if not set.
+Default is `APD` if not set. For manual install: replace `JIRA_PROJECT_KEY` in the commit-msg script with your key (e.g. `APD`).
+
+To also run the full test suite before push:  
+`rails_git_hooks install pre-push`
 
 > **Tip:** If the pre-commit hook doesn’t run, make it executable: `chmod +x .git/hooks/pre-commit`
 
@@ -62,10 +69,10 @@ Run from your project root (inside a git repo).
 
 | Command | Description |
 |---------|-------------|
-| `rails_git_hooks install [HOOK...] [--jira PROJECT]` | Install hooks. No args = install all. |
+| `rails_git_hooks install [HOOK...] [--jira PROJECT]` | Install hooks. No args = install default (commit-msg + pre-commit). |
 | `rails_git_hooks list` | List available hook names. |
-| `rails_git_hooks disable HOOK [HOOK...]` | Disable hooks (use `*` for all). |
-| `rails_git_hooks enable HOOK [HOOK...]` | Re-enable disabled hooks. |
+| `rails_git_hooks disable HOOK [HOOK...] [whitespace-check]` | Disable hooks (use `*` for all) or the whitespace-check. |
+| `rails_git_hooks enable HOOK [HOOK...] [whitespace-check]` | Re-enable hooks or enable whitespace-check. |
 | `rails_git_hooks disabled` | Show which hooks are currently disabled. |
 
 **Examples**
@@ -85,6 +92,9 @@ rails_git_hooks disable *
 
 # Turn them back on
 rails_git_hooks enable pre-commit
+
+# Enable rejection of trailing whitespace and conflict markers in staged files (off by default)
+rails_git_hooks enable whitespace-check
 ```
 
 Disabled state is stored in `.git/rails_git_hooks_disabled` and persists until you run `enable`.
@@ -111,6 +121,7 @@ Set the Jira project key at install time with `--jira PROJECT` or `GIT_HOOKS_JIR
 
 1. **Blocks commits on `master` / `main`** — You must commit from a feature branch; direct commits to the default branch are rejected.
 2. **Runs RuboCop** on staged `.rb` files. If there are offenses, the commit is aborted.
+3. **Trailing whitespace / conflict markers** (off by default) — When enabled, rejects commits that add trailing spaces/tabs or `<<<<<<<` / `=======` / `>>>>>>>` in staged files. Enable with: `rails_git_hooks enable whitespace-check`. Disable with: `rails_git_hooks disable whitespace-check`.
 
 Requires the `rubocop` gem in your project. If the hook doesn’t run, ensure it’s executable: `chmod +x .git/hooks/pre-commit`.
 

data/lib/rails_git_hooks/cli.rb

@@ -53,30 +53,36 @@ module GitHooks
       puts "Available hooks: #{hooks.join(', ')}"
     end
 
-    def run_disable(args)
-      hooks = args.reject { |a| a.start_with?('-') }
-      if hooks.empty?
-        warn 'Usage: rails_git_hooks disable HOOK [HOOK...]'
+    def run_disable(args) # rubocop:disable Metrics/AbcSize
+      tokens = args.reject { |a| a.start_with?('-') }
+      if tokens.empty?
+        warn 'Usage: rails_git_hooks disable HOOK [HOOK...] [whitespace-check]'
         warn "Use '*' to disable all hooks."
         exit 1
       end
       installer = Installer.new
-      installer.disable(*hooks)
-      puts "Disabled: #{hooks.join(', ')}"
+      hook_names = tokens - ['whitespace-check']
+      installer.disable_whitespace_check if tokens.include?('whitespace-check')
+      installer.disable(*hook_names) if hook_names.any?
+      disabled = hook_names + (tokens.include?('whitespace-check') ? ['whitespace-check'] : [])
+      puts "Disabled: #{disabled.join(', ')}"
     rescue GitHooks::Error => e
       warn "Error: #{e.message}"
       exit 1
     end
 
     def run_enable(args)
-      hooks = args.reject { |a| a.start_with?('-') }
-      if hooks.empty?
-        warn 'Usage: rails_git_hooks enable HOOK [HOOK...]'
+      tokens = args.reject { |a| a.start_with?('-') }
+      if tokens.empty?
+        warn 'Usage: rails_git_hooks enable HOOK [HOOK...] [whitespace-check]'
         exit 1
       end
       installer = Installer.new
-      installer.enable(*hooks)
-      puts "Enabled: #{hooks.join(', ')}"
+      hook_names = tokens - ['whitespace-check']
+      installer.enable_whitespace_check if tokens.include?('whitespace-check')
+      installer.enable(*hook_names) if hook_names.any?
+      enabled = hook_names + (tokens.include?('whitespace-check') ? ['whitespace-check'] : [])
+      puts "Enabled: #{enabled.join(', ')}"
     rescue GitHooks::Error => e
       warn "Error: #{e.message}"
       exit 1
@@ -101,24 +107,25 @@ module GitHooks
 
         Usage:
           rails_git_hooks install [HOOK...] [--jira PROJECT_KEY]
-          rails_git_hooks disable HOOK [HOOK...]   (use * for all)
-          rails_git_hooks enable HOOK [HOOK...]
+          rails_git_hooks disable HOOK [HOOK...] [whitespace-check]   (use * for all hooks)
+          rails_git_hooks enable HOOK [HOOK...] [whitespace-check]
           rails_git_hooks disabled
           rails_git_hooks list
           rails_git_hooks --help
 
         Commands:
-          install    Install hooks into current repo's .git/hooks.
-          disable    Disable hooks (they no-op until enabled).
-          enable     Re-enable disabled hooks.
-          disabled   List currently disabled hooks.
-          list       List available hook names.
+          install   Install hooks into current repo's .git/hooks.
+          disable   Disable hooks or whitespace-check (trailing ws/conflict markers in pre-commit).
+          enable    Re-enable disabled hooks or enable whitespace-check.
+          disabled  List currently disabled hooks.
+          list      List available hook names.
 
         Examples:
           rails_git_hooks install
           rails_git_hooks disable pre-commit
-          rails_git_hooks disable *              # disable all
+          rails_git_hooks disable *                    # disable all hooks
           rails_git_hooks enable pre-commit
+          rails_git_hooks enable whitespace-check      # reject trailing ws/conflict markers (off by default)
           rails_git_hooks install commit-msg pre-commit --jira MYPROJ
       HELP
     end

data/lib/rails_git_hooks/installer.rb

@@ -3,6 +3,9 @@
 module GitHooks
   class Installer
     HOOKS_DIR = File.expand_path('templates', __dir__).freeze
+    # Default: Jira commit-msg + pre-commit (default-branch protection + RuboCop).
+    # Use install(*available_hooks) or pass names for more.
+    DEFAULT_HOOKS = %w[commit-msg pre-commit].freeze
 
     def initialize(git_dir: nil, jira_project: nil)
       @git_dir = git_dir || find_git_dir
@@ -13,7 +16,7 @@ module GitHooks
       target_dir = File.join(@git_dir, 'hooks')
       raise GitHooks::Error, "Not a git repository or .git/hooks not found: #{@git_dir}" unless Dir.exist?(target_dir)
 
-      hooks = hook_names.empty? ? available_hooks : hook_names
+      hooks = hook_names.empty? ? DEFAULT_HOOKS : hook_names
       installed = []
 
       hooks.each do |name|
@@ -68,6 +71,22 @@ module GitHooks
       hook_names
     end
 
+    WHITESPACE_CHECK_FILE = 'rails_git_hooks_whitespace_check'
+
+    def enable_whitespace_check
+      path = File.join(@git_dir, WHITESPACE_CHECK_FILE)
+      File.write(path, '')
+    end
+
+    def disable_whitespace_check
+      path = File.join(@git_dir, WHITESPACE_CHECK_FILE)
+      FileUtils.rm_f(path)
+    end
+
+    def whitespace_check_enabled?
+      File.exist?(File.join(@git_dir, WHITESPACE_CHECK_FILE))
+    end
+
     private
 
     def find_git_dir

data/lib/rails_git_hooks/templates/pre-commit

@@ -14,6 +14,27 @@ if File.exist?(disabled_file)
   exit 0 if disabled.include?('*') || disabled.include?('pre-commit')
 end
 
+# Trailing whitespace / conflict markers check (disabled by default; enable with .git/rails_git_hooks_whitespace_check)
+whitespace_check_file = File.join(git_dir, 'rails_git_hooks_whitespace_check')
+if File.exist?(whitespace_check_file)
+  staged = `git diff --cached --name-only`.split("\n").map(&:strip).reject(&:empty?)
+  errors = []
+  staged.each do |path|
+    next unless File.file?(path)
+
+    File.read(path).lines.each_with_index do |line, i|
+      errors << "#{path}:#{i + 1}: trailing whitespace" if line.match?(/[ \t]\z/)
+      stripped = line.strip
+      errors << "#{path}:#{i + 1}: conflict marker" if stripped.start_with?('<<<<<<<', '=======', '>>>>>>>')
+    end
+  end
+  unless errors.empty?
+    warn 'Commit rejected (whitespace/conflict check):'
+    errors.uniq.each { |e| warn "  #{e}" }
+    exit 1
+  end
+end
+
 # Prevent commits on default branch (master/main)
 branch = `git rev-parse --abbrev-ref HEAD`.strip
 if %w[master main].include?(branch)

data/lib/rails_git_hooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHooks
-  VERSION = '0.5.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_git_hooks
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Nikita Nazarov