rails_git_hooks 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94f388ff518dfa6ca8a80d6a4cfaac1639682e7a8e2535da52929bc5ea34862b
-  data.tar.gz: 7bb6f56263591ffc1925fee536341e4b2c7c29e6c0cef865779a0d73ac796b6a
+  metadata.gz: ec622102778f161f06cc57a88c9a749044554a83a7a8c4abdbcc1e423eb287f3
+  data.tar.gz: e03e9d4ca6b32fbb1c29fb40422096bdd013712e564df3b8bbefb6c358703d93
 SHA512:
-  metadata.gz: 4e77a5d7f9b321a34e1cceb269ae590c6ffd8db816794fac5a775090614f46c58b275429a106046459df8407f6344a4dbf4c1421051891ac02ad73981b3177af
-  data.tar.gz: 1bb5be50035416d37ea8b3a256753c47dd21fd92baadb3e0063c18c22149ee1a94cb0f7945a3075fdc3ba7707da1c3fab4b4108c0bc5d1fbf4c08535eae525cf
+  metadata.gz: 15701ccb101a859a300bec674cf5290fdaa9f86f6fa08555d07d64622b3536cc99b60085b057095753d3ac7d7ae5bbec46f650510b7ccfea7fbcb47b87a40170
+  data.tar.gz: c5f315f7fd2ae74107c85f18dab6f344010394a3263fe3e8ab1dcdb4e5ae12f2332a34f15687ba07b08f0fe5e27ef37efa1e750743855d4e90b2a3d3d2b26ec1

data/CHANGELOG.md

@@ -4,7 +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/).
 
-## [0.4.1] - (latest)
+## [0.6.0] (latest)
+
+### 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
+
+- **pre-push** hook: runs `bundle exec rspec` before every push; aborts push if tests fail. Respects `rails_git_hooks_disabled`.
+- RuboCop `Lint/ScriptPermission` exclusion for `hooks/*` (same as templates).
+
+## [0.4.1]
 
 ### Changed
 

data/README.md

@@ -14,6 +14,7 @@
 |------|--------------|
 | **commit-msg** | Prepends `[TICKET-123]` to commit messages when your branch name contains a Jira ticket. |
 | **pre-commit** | Blocks commits to `master`/`main` and runs RuboCop on staged `.rb` files. |
+| **pre-push** | Runs the full test suite (`bundle exec rspec`) before push; aborts push if tests fail. |
 
 Hooks can be disabled temporarily (e.g. for quick WIP commits or CI) without uninstalling.
 
@@ -63,8 +64,8 @@ Run from your project root (inside a git repo).
 |---------|-------------|
 | `rails_git_hooks install [HOOK...] [--jira PROJECT]` | Install hooks. No args = install all. |
 | `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**
@@ -84,6 +85,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`.
@@ -110,11 +114,20 @@ 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`.
 
 ---
 
+### pre-push — Run tests before push
+
+Runs `bundle exec rspec` before every `git push`. If the test suite fails, the push is aborted so you don’t break CI.
+
+Requires the `rspec` gem (or for Minitest, edit the hook to use `bundle exec rake test`). If the hook doesn’t run, ensure it’s executable: `chmod +x .git/hooks/pre-push`.
+
+---
+
 ## Manual installation (without the gem)
 
 If you don’t want to use the gem, copy the scripts from `hooks/` into `.git/hooks`. The `hooks/` directory is synced from the gem templates via `rake sync_hooks` in development.
@@ -123,6 +136,7 @@ If you don’t want to use the gem, copy the scripts from `hooks/` into `.git/ho
 |------|--------|
 | [commit-msg](hooks/commit-msg) | Replace `JIRA_PROJECT_KEY` in the script with your Jira project key (e.g. `APD`). |
 | [pre-commit](hooks/pre-commit) | Requires the `rubocop` gem in the repo where you use it. |
+| [pre-push](hooks/pre-push) | Runs `bundle exec rspec`; edit to use `bundle exec rake test` for Minitest. |
 
 ---
 

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

@@ -68,6 +68,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/templates/pre-push

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Runs the full test suite before push. Push is aborted if tests fail.
+# Uses `bundle exec rspec`. For Minitest, edit to use `bundle exec rake test`.
+
+# Git runs hooks with CWD = repo root; find .git from here
+repo_root = Dir.pwd
+git_dir = File.join(repo_root, '.git')
+git_dir = File.expand_path(File.read(git_dir).strip.sub(/\Agitdir: \s*/, ''), repo_root) if File.file?(git_dir)
+disabled_file = File.join(git_dir, 'rails_git_hooks_disabled')
+if File.exist?(disabled_file)
+  disabled = File.read(disabled_file).split("\n").map(&:strip)
+  exit 0 if disabled.include?('*') || disabled.include?('pre-push')
+end
+
+require 'english'
+
+system('bundle exec rspec')
+exit $CHILD_STATUS.to_s[-1].to_i

data/lib/rails_git_hooks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_git_hooks
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Nikita Nazarov
@@ -51,8 +51,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Installs commit-msg (Jira ticket prefix) and pre-commit (RuboCop) hooks
-  into your git repository.
+description: Installs most useful git hooks for Rails and Ruby projects
 email:
 - nikenor11@gmail.com
 executables:
@@ -69,6 +68,7 @@ files:
 - lib/rails_git_hooks/installer.rb
 - lib/rails_git_hooks/templates/commit-msg
 - lib/rails_git_hooks/templates/pre-commit
+- lib/rails_git_hooks/templates/pre-push
 - lib/rails_git_hooks/version.rb
 homepage: https://github.com/NikitaNazarov1/rails_git_hooks
 licenses: