rails_git_hooks 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 109ffcd87e2ce426eba039b823d0ff33826a3dbed17551aa064bd2102af0e0eb
+  data.tar.gz: 8669d08859c06afc5aa43b6e3476b6fec3f1fb2edcdf93a1eb0e437ee30ca8d0
+SHA512:
+  metadata.gz: bbe3c679e9cb4d71be001cb02ce82a80d16a36764aff795a1d3d1cffeca86a14a6036b9f55a86679afebf70acb16f797f6952f87e4900d29bf22c615cb3ac840
+  data.tar.gz: 482cda03ee82f8aee5caad95611eec7deaf190136d97be665b74de5a89d842bcdae5a7086ceeb65fb5d74d8e7cc1ef41ecab3d7b05a708dd60e34d6d890aeedf

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+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.4.0] - (latest)
+
+### Changed
+
+- Gem and project renamed to **rails_git_hooks** (from `git_hooks`)
+- Library: `lib/git_hooks/` → `lib/rails_git_hooks/`; entry point `lib/rails_git_hooks.rb`
+- CLI executable: `rails_git_hooks` (replaces `git_hooks`)
+- Disabled state file: `.git/rails_git_hooks_disabled` (was `.git/git_hooks_disabled`)
+- README, docs, and in-repo paths updated for `rails_git_hooks`
+
+### Added
+
+- RuboCop `Lint/ScriptPermission` exclusion for `lib/rails_git_hooks/templates/*` (templates are made executable at install time)
+
+## [0.3.0]
+
+### Fixed
+
+- fixed versioning
+
+## [0.2.0]
+
+### Added
+
+- RSpec test suite for CLI and Installer
+- `rake sync_hooks` task to copy templates from `lib/git_hooks/templates` to `hooks/` for manual install
+- Gemspec metadata: `source_code_uri`, `changelog_uri`; author email
+- CHANGELOG.md (Keep a Changelog format)
+- Default Rake task runs specs (`rake` = `rake spec`)
+
+### Changed
+
+- **Single source of truth:** `lib/git_hooks/templates/` is canonical; `hooks/` kept in sync via `rake sync_hooks`
+- CLI install: `--jira` parsed with OptionParser instead of manual loop
+- Installer `#disable`: simplified to `(disabled_hooks + hook_names).uniq`
+- Hooks: commit-msg and pre-commit now include disable check (`.git/rails_git_hooks_disabled`); commit-msg uses `JIRA_PROJECT_KEY` placeholder for manual install
+- pre-commit: use `warn` instead of `$stderr.puts` for default-branch message
+- README: manual install points to `hooks/` and `JIRA_PROJECT_KEY`; development section documents `rake`, `rake sync_hooks`
+
+### Fixed
+
+- (none)
+
+## [0.1.0] - (initial release)
+
+- commit-msg hook: Jira ticket prefix in commit messages
+- pre-commit hook: RuboCop on staged Ruby files, block commits on default branch (master/main)
+- `rails_git_hooks install`, `disable`, `enable`, `disabled`, `list` CLI commands

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nikita Nazarov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# Git Hooks
+
+[![Gem Version](https://badge.fury.io/rb/rails_git_hooks.svg)](https://badge.fury.io/rb/rails_git_hooks)
+[![Build Status](https://github.com/NikitaNazarov1/rails_git_hooks/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/NikitaNazarov1/rails_git_hooks/actions/workflows/tests.yml?query=branch%3Amain)
+[![RuboCop](https://github.com/NikitaNazarov1/rails_git_hooks/actions/workflows/rubocop.yml/badge.svg?branch=main)](https://github.com/NikitaNazarov1/rails_git_hooks/actions/workflows/rubocop.yml?query=branch%3Amain)
+
+> Automate Jira ticket prefixes and RuboCop checks with git hooks. Built for Rails and Ruby projects.
+
+---
+
+## What you get
+
+| Hook | What it does |
+|------|--------------|
+| **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. |
+
+Hooks can be disabled temporarily (e.g. for quick WIP commits or CI) without uninstalling.
+
+---
+
+## Quick start
+
+**1. Install the gem**
+
+```bash
+gem install rails_git_hooks
+```
+
+Or with Bundler — add to your `Gemfile`:
+
+```ruby
+gem "rails_git_hooks"
+```
+
+Then:
+
+```bash
+bundle install
+bundle exec rails_git_hooks install
+```
+
+**2. (Optional) Set your Jira project key**
+
+```bash
+rails_git_hooks install --jira MYPROJ
+# or
+export GIT_HOOKS_JIRA_PROJECT=MYPROJ
+rails_git_hooks install
+```
+
+Default is `APD` if not set.
+
+> **Tip:** If the pre-commit hook doesn’t run, make it executable: `chmod +x .git/hooks/pre-commit`
+
+---
+
+## Commands
+
+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 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 disabled` | Show which hooks are currently disabled. |
+
+**Examples**
+
+```bash
+# Install everything with custom Jira key
+rails_git_hooks install --jira MYPROJ
+
+# Install only specific hooks
+rails_git_hooks install pre-commit commit-msg --jira APD
+
+# Temporarily disable pre-commit (e.g. for a quick fix)
+rails_git_hooks disable pre-commit
+
+# Disable all hooks
+rails_git_hooks disable *
+
+# Turn them back on
+rails_git_hooks enable pre-commit
+```
+
+Disabled state is stored in `.git/rails_git_hooks_disabled` and persists until you run `enable`.
+
+---
+
+## Hooks in detail
+
+### commit-msg — Jira ticket prefix
+
+If your branch name contains a Jira ticket (e.g. `task/APD-1234/fix-bug`), the hook prepends `[APD-1234] ` to the commit message unless it’s already there.
+
+**Example**
+
+- Branch: `task/APD-1234/fix-bug`
+- You run: `git commit -m 'fix bug'`
+- Result: **`[APD-1234] fix bug`**
+
+Set the Jira project key at install time with `--jira PROJECT` or `GIT_HOOKS_JIRA_PROJECT`.
+
+---
+
+### pre-commit — Default branch protection + RuboCop
+
+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.
+
+Requires the `rubocop` gem in your project. If the hook doesn’t run, ensure it’s executable: `chmod +x .git/hooks/pre-commit`.
+
+---
+
+## 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.
+
+| File | Notes |
+|------|--------|
+| [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. |
+
+---
+
+## Development
+
+```bash
+bundle install
+bundle exec rake              # run specs (default task)
+bundle exec rake build        # build the gem
+bundle exec rake install      # install the gem locally
+bundle exec rake sync_hooks   # copy templates to hooks/
+```
+
+---
+
+## License
+
+MIT. See [LICENSE](LICENSE).

data/bin/rails_git_hooks

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'rails_git_hooks/cli'
+
+GitHooks::CLI.run(ARGV)

data/lib/rails_git_hooks/cli.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'rails_git_hooks'
+require 'optparse'
+
+module GitHooks
+  class CLI
+    def self.run(argv = ARGV)
+      new.run(argv)
+    end
+
+    def run(argv)
+      case argv[0]
+      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'
+        print_help
+      else
+        warn "Unknown command: #{argv[0]}"
+        print_help
+        exit 1
+      end
+    end
+
+    private
+
+    def run_install(args)
+      jira = nil
+      OptionParser.new do |opts|
+        opts.on('--jira PROJECT', 'Jira project key (e.g. APD)') { |v| jira = v }
+      end.parse!(args)
+      hooks = args
+
+      installer = Installer.new(jira_project: jira)
+      installed = installer.install(*hooks)
+      puts "Installed hooks: #{installed.join(', ')}"
+    rescue GitHooks::Error => e
+      warn "Error: #{e.message}"
+      exit 1
+    end
+
+    def run_list
+      dir = GitHooks::Installer::HOOKS_DIR
+      hooks = Dir.children(dir).select { |f| File.file?(File.join(dir, f)) }
+      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...]'
+        warn "Use '*' to disable all hooks."
+        exit 1
+      end
+      installer = Installer.new
+      installer.disable(*hooks)
+      puts "Disabled: #{hooks.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...]'
+        exit 1
+      end
+      installer = Installer.new
+      installer.enable(*hooks)
+      puts "Enabled: #{hooks.join(', ')}"
+    rescue GitHooks::Error => e
+      warn "Error: #{e.message}"
+      exit 1
+    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
+    end
+
+    def print_help
+      puts <<~HELP
+        rails_git_hooks - Install git hooks for Jira commit prefix and RuboCop
+
+        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 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.
+
+        Examples:
+          rails_git_hooks install
+          rails_git_hooks disable pre-commit
+          rails_git_hooks disable *              # disable all
+          rails_git_hooks enable pre-commit
+          rails_git_hooks install commit-msg pre-commit --jira MYPROJ
+      HELP
+    end
+  end
+end

data/lib/rails_git_hooks/installer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module GitHooks
+  class Installer
+    HOOKS_DIR = File.expand_path('templates', __dir__).freeze
+
+    def initialize(git_dir: nil, jira_project: nil)
+      @git_dir = git_dir || find_git_dir
+      @jira_project = jira_project || ENV['GIT_HOOKS_JIRA_PROJECT'] || 'APD'
+    end
+
+    def install(*hook_names)
+      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
+      installed = []
+
+      hooks.each do |name|
+        src = File.join(HOOKS_DIR, name)
+        next unless File.file?(src)
+
+        dest = File.join(target_dir, name)
+        content = read_template(name)
+        content = content.gsub('JIRA_PROJECT_KEY', @jira_project) if name == 'commit-msg'
+        write_hook(dest, content)
+        make_executable(dest)
+        installed << name
+      end
+
+      installed
+    end
+
+    def available_hooks
+      Dir.children(HOOKS_DIR).select { |f| File.file?(File.join(HOOKS_DIR, f)) }
+    end
+
+    DISABLED_FILE = 'rails_git_hooks_disabled'
+
+    def disabled_file_path
+      File.join(@git_dir, DISABLED_FILE)
+    end
+
+    def disabled_hooks
+      path = disabled_file_path
+      return [] unless File.exist?(path)
+
+      File.read(path).split("\n").map(&:strip).reject(&:empty?)
+    end
+
+    def disable(*hook_names)
+      path = disabled_file_path
+      current = (disabled_hooks + hook_names).uniq
+      File.write(path, "#{current.join("\n")}\n")
+      hook_names
+    end
+
+    def enable(*hook_names)
+      path = disabled_file_path
+      return [] unless File.exist?(path)
+
+      current = disabled_hooks - hook_names
+      if current.empty?
+        File.delete(path)
+      else
+        File.write(path, "#{current.join("\n")}\n")
+      end
+      hook_names
+    end
+
+    private
+
+    def find_git_dir
+      dir = Dir.pwd
+      loop do
+        git = File.join(dir, '.git')
+        return git if File.directory?(git)
+
+        parent = File.dirname(dir)
+        raise GitHooks::Error, 'Not inside a git repository' if parent == dir
+
+        dir = parent
+      end
+    end
+
+    def read_template(name)
+      path = File.join(HOOKS_DIR, name)
+      File.read(path)
+    end
+
+    def write_hook(path, content)
+      File.write(path, content)
+    end
+
+    def make_executable(path)
+      File.chmod(0o755, path)
+    end
+  end
+end

data/lib/rails_git_hooks/templates/commit-msg

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Git commit-msg hook: if branch name contains a Jira ticket (e.g. APD-1234),
+# prepends "[APD-1234] " to commit messages unless already present.
+# JIRA_PROJECT_KEY is replaced at install time by git_hooks; for manual install, replace it with your project key.
+
+# 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?('commit-msg')
+end
+
+commit_message_file = ARGV[0]
+branch_name = `git branch --no-color 2> /dev/null`[/^\* (.+)/, 1].to_s
+original_commit_message = File.read(commit_message_file).strip
+
+pattern = /(JIRA_PROJECT_KEY-\d+)/i
+
+if (m = branch_name.match(pattern))
+  jira_number = m.captures.first
+
+  exit 0 if original_commit_message.include?(jira_number)
+
+  message = "[#{jira_number}] #{original_commit_message}"
+  File.open(commit_message_file, 'w') { |f| f.write message }
+end

data/lib/rails_git_hooks/templates/pre-commit

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Runs RuboCop on staged .rb files. Commit is aborted if RuboCop reports offenses.
+
+# 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-commit')
+end
+
+# Prevent commits on default branch (master/main)
+branch = `git rev-parse --abbrev-ref HEAD`.strip
+if %w[master main].include?(branch)
+  warn "Commits on '#{branch}' are not allowed. Create a feature branch."
+  exit 1
+end
+
+require 'english'
+require 'rubocop'
+
+ADDED_OR_MODIFIED = /A|AM|^M/.freeze
+
+changed_files = `git status --porcelain`.split(/\n/)
+                                        .select { |file_name_with_status| file_name_with_status =~ ADDED_OR_MODIFIED }
+                                        .map { |file_name_with_status| file_name_with_status.split(' ')[1] }
+                                        .select { |file_name| File.extname(file_name) == '.rb' }
+                                        .join(' ')
+
+system("rubocop #{changed_files}") unless changed_files.empty?
+
+exit $CHILD_STATUS.to_s[-1].to_i

data/lib/rails_git_hooks/version.rb

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

data/lib/rails_git_hooks.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'rails_git_hooks/version'
+require_relative 'rails_git_hooks/installer'
+
+module GitHooks
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rails_git_hooks
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Nikita Nazarov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Installs commit-msg (Jira ticket prefix) and pre-commit (RuboCop) hooks
+  into your git repository.
+email:
+- nikenor11@gmail.com
+executables:
+- rails_git_hooks
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/rails_git_hooks
+- lib/rails_git_hooks.rb
+- lib/rails_git_hooks/cli.rb
+- lib/rails_git_hooks/installer.rb
+- lib/rails_git_hooks/templates/commit-msg
+- lib/rails_git_hooks/templates/pre-commit
+- lib/rails_git_hooks/version.rb
+homepage: https://github.com/NikitaNazarov1/rails_git_hooks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/NikitaNazarov1/rails_git_hooks
+  source_code_uri: https://github.com/NikitaNazarov1/rails_git_hooks
+  changelog_uri: https://github.com/NikitaNazarov1/rails_git_hooks/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Git hooks for Jira commit prefix and RuboCop on staged files
+test_files: []