git_pre_commit_debugger_points_checker 1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9fc7f1c124181436ddb52b71e53789c2b29594e392365715eabdf9e9f22a7ef
+  data.tar.gz: a63dbe533d5646f20dfaf39d2df79a8463140d7baa7bc1bb07579724965db5a5
+SHA512:
+  metadata.gz: a9c38dff7bcc493397ce5a987488b8a5acb71fdec050f25142991bf78af36e47b812ec166c6941bf6851beba3725a6725598333c7cf284550e33fecba4fbc891
+  data.tar.gz: c7e439cc45b1db8b08227da3121508bc1a2c1b588d05a2707e49b2ef3c319fc127dd4199ab5ff5df8e8e16ffb9c785dcb6fe7b6bdb2970aa1972e894f21a2c12

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "git_pre_commit_debugger_points_checker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/git_pre_commit_debugger_points_checker.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require_relative "lib/git_pre_commit_debugger_points_checker/version"
+# git_pre_commit_debugger_points_checker.gemspec
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_pre_commit_debugger_points_checker"
+  spec.version = GitPreCommitDebuggerPointsChecker::VERSION
+  spec.authors = ["Harish Reddy"]
+  spec.email = ["v.harish831@gmail.com"]
+  spec.summary       = %q{A Git pre-commit hook for checking debugging statements.}
+  spec.description   = %q{A Git pre-commit hook that checks for debugging statements before allowing a commit.}
+  spec.files = [
+    "lib/git_pre_commit_debugger_points_checker/version.rb",
+    "lib/git_pre_commit_debugger_points_checker.rb",
+    "git_pre_commit_debugger_points_checker.gemspec"
+  ] + Dir["bin/*"]
+  spec.homepage      = "https://github.com/harshareddyharish/git_pre_commit_debugger_points_checker"
+  spec.license       = "MIT"
+  spec.add_runtime_dependency "git", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 2.0"
+end

data/lib/git_pre_commit_debugger_points_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GitPreCommitDebuggerPointsChecker
+  VERSION = "1.8"
+end

data/lib/git_pre_commit_debugger_points_checker.rb

@@ -0,0 +1,70 @@
+# lib/git_pre_commit_debugger_points_checker/runner.rb
+module GitPreCommitDebuggerPointsChecker
+  class Runner
+    def self.enable!
+      new.enable
+    end
+
+    def self.disable!
+      system('rm -rf ./.git/hooks/pre-commit')
+    end
+
+    def enable
+      system('mkdir -p ./.git/hooks')
+      write_pre_commit_hook
+      create_pre_commit_ignore
+    end
+
+    private
+
+    def write_pre_commit_hook
+      File.open('.git/hooks/pre-commit', 'w') do |file|
+        file.puts(pre_commit_script)
+      end
+      system('chmod +x .git/hooks/pre-commit')
+    end
+
+    def create_pre_commit_ignore
+      ignore_file_path = '.pre-commit-ignore'
+      unless File.exist?(ignore_file_path)
+        File.open(ignore_file_path, 'w') do |file|
+          file.puts("# Include files here to ignore git pre-commit checker")
+          file.puts("# - filename1.rb")
+          file.puts("# - filename2.rb")
+        end
+      end
+    end
+
+    def pre_commit_script
+      <<~SCRIPT
+        # hooks/pre-commit
+        # This script verifies if a list of "undesired" words are presented in the files you are
+        # intended to commit such, debugging information or keys/tokens/passwords.
+        LIST="byebug\\|debugger\\|binding.pry"
+
+        PROJECT_ROOT=$(git rev-parse --show-toplevel)
+        IGNORED_FILES="$PROJECT_ROOT/.pre-commit-ignore"
+
+        if git rev-parse --verify HEAD >/dev/null 2>&1; then
+            against=HEAD
+        fi
+
+        for FILE in `git diff-index --name-status --cached $against -- | cut -c3-` ; do
+            # Skip checks on any ignored files
+            if [[ -f "$IGNORED_FILES" ]]; then
+                if grep -q "$FILE" "$IGNORED_FILES"; then
+                    continue
+                fi
+            fi
+
+            # Check if the file contains one of the words in LIST
+            if grep -w $LIST $FILE; then
+                echo "$FILE has one of the debugging statements that you don't want to commit! Please remove it or run git commit with the --no-verify flag."
+                exit 1
+            fi
+        done
+        exit
+      SCRIPT
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: git_pre_commit_debugger_points_checker
+version: !ruby/object:Gem::Version
+  version: '1.8'
+platform: ruby
+authors:
+- Harish Reddy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Git pre-commit hook that checks for debugging statements before allowing
+  a commit.
+email:
+- v.harish831@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- git_pre_commit_debugger_points_checker.gemspec
+- lib/git_pre_commit_debugger_points_checker.rb
+- lib/git_pre_commit_debugger_points_checker/version.rb
+homepage: https://github.com/harshareddyharish/git_pre_commit_debugger_points_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A Git pre-commit hook for checking debugging statements.
+test_files: []