code_quality_check 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d7ae4cff95b35c9f984ce1578f97675f6febe7ca1b9c1d37f9c46ece5164c90
-  data.tar.gz: b823b189b8dc85ed5296162efd4fb3fdcf8bbd6e92a075aa41393b6dc56c5043
+  metadata.gz: 0db4bd2bc7348adfe3bbd706fba3b0d079d8ac50d889ce58bb616506145b43f5
+  data.tar.gz: 162015c6573caf0aed76c5c54c514db53454ecbb55013642c2c9c35fad541955
 SHA512:
-  metadata.gz: 57b50c71709df027071bfc5f727d698cece3179a471963169c16ebe27895538b972e76e0f16d20e10e8ca3b12f2cd810d0610fbd4a18836d4cfde17f73e0971d
-  data.tar.gz: b712522bc8f6d26643d1504ff130547557b7f67cf38d6dfea60d8d3179d12b726bc6bdfd2d87da4b3d019224d36c133ab58f2f6aee21c979e9710b354501d7e6
+  metadata.gz: 2a5b7282e7702df72d7846d30a7c20836012158362a37d15f106410a8e522447752cec77cc82dac18f105ca2413ac6978135d54b3ec880f0ea66d786e7484a7b
+  data.tar.gz: 69c14673a15f335936e3c98e83271ad72ed972a44a0b50b0e479f090fbd367654e7a9709e731af547a5c92f408dd52d5fe3916af3813034ccc42b22cdc1ea595

data/lib/code_quality_check/version.rb

@@ -2,5 +2,5 @@
 
 # Version Module.
 module CodeQualityCheck
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end

data/lib/code_quality_check.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 require_relative 'code_quality_check/version'
+
+# CodeQualityCheck integrates RuboCop, Brakeman, and Rails Best Practices
+# with Overcommit to enforce automated code quality checks on every Git commit.
+#
+# @see https://github.com/aniruddhami/code_quality_check
 module CodeQualityCheck
+  # Base error class for CodeQualityCheck gem.
   class Error < StandardError; end
 end

data/lib/generators/code_quality_check/install_generator.rb

@@ -4,7 +4,17 @@ require 'rails/generators/base'
 
 module CodeQualityCheck
   module Generators
-    # Define a generator class that inherits from Rails::Generators::Base
+    # Rails generator that installs Overcommit, RuboCop, Brakeman, and Rails Best
+    # Practices configuration files into a Rails project.
+    #
+    # Run with: +rails generate code_quality_check:install+
+    #
+    # Creates:
+    # - config/initializers/code_quality_check.rb
+    # - .overcommit.yml
+    # - .rubocop.yml
+    # - .git/hooks/pre-commit
+    # - .git/hooks/post-checkout
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
       desc 'This generator creates an initializer file for Overcommit'
@@ -17,7 +27,7 @@ module CodeQualityCheck
       # Define a method that copies the initializer file to the config/initializers directory
       def copy_required_files
         # Copy the initializer file to the config/initializers directory
-        template 'overcommit.rb', 'config/initializers/overcommit.rb'
+        template 'code_quality_check.rb', 'config/initializers/code_quality_check.rb'
 
         # Copy the Overcommit configuration file to the root directory
         template 'overcommit.yml', '.overcommit.yml'

data/lib/generators/code_quality_check/templates/{overcommit.rb → code_quality_check.rb}

@@ -1,4 +1,20 @@
-# config/initializers/overcommit.rb
+# config/initializers/code_quality_check.rb
+
+# Ensure code_quality_check gem is installed before setting up hooks
+begin
+  Gem::Specification.find_by_name('code_quality_check')
+rescue Gem::MissingSpecError
+  raise <<~MSG
+    The code_quality_check gem is not installed.
+
+    Add to your Gemfile:
+      gem 'code_quality_check'
+
+    Then run:
+      bundle install
+      rails generate code_quality_check:install
+  MSG
+end
 
 if Rails.env.development? || Rails.env.test?
   begin

data/lib/generators/code_quality_check/templates/overcommit.yml

@@ -2,18 +2,21 @@
 # extend the default configuration defined in:
 # https://github.com/sds/overcommit/blob/master/config/default.yml
 #
-# At the topmost level of this YAML file is a key representing type of hook
-# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
-# customize each hook, such as whether to only run it on certain files (via
-# `include`), whether to only display output if it fails (via `quiet`), etc.
+# Required gems (add to your Gemfile; code_quality_check provides most):
+#   - overcommit
+#   - rubocop, rubocop-performance, rubocop-rails
+#   - brakeman
+#   - rails_best_practices
+#   - bundler-audit (for BundleAudit security check)
+#
+# Optional code quality gems (enable hooks below to use):
+#   - reek (code smells)
+#   - flay (code duplication)
+#   - fasterer (performance)
 #
 # For a complete list of hooks, see:
 # https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
-#
-# For a complete list of options that you can use to customize hooks, see:
-# https://github.com/sds/overcommit#configuration
-#
-# Uncomment the following lines to make the configuration take effect.
+#-------------------------------------------------------------------------------
 
 PreCommit:
   RuboCop:
@@ -38,10 +41,43 @@ PreCommit:
   # Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications.
   Brakeman:
     enabled: true
-    command: ['brakeman', '--skip-libs', '-w3']
+    required_executable: 'brakeman'
+    command: ['bundle', 'exec', 'brakeman', '--skip-libs', '-w3']
+    description: 'Scanning for security vulnerabilities with Brakeman'
 
-  TrailingWhitespace:
+  # BundleAudit checks Gemfile.lock for known vulnerable gem versions (CVE database).
+  BundleAudit:
+    enabled: true
+    required_executable: 'bundle-audit'
+    description: 'Checking for vulnerable gem versions'
+    include:
+      - 'Gemfile.lock'
+
+  # Reek analyzes Ruby code for code smells (add gem 'reek' to enable).
+  Reek:
     enabled: false
+    required_executable: 'reek'
+    description: 'Detecting code smells with Reek'
+    flags: ['--single-line', '--no-color', '--force-exclusion']
+    include: '**/*.rb'
+
+  # Flay finds structural code duplication (add gem 'flay' to enable).
+  Flay:
+    enabled: false
+    required_executable: 'flay'
+    description: 'Finding code duplication with Flay'
+    mass_threshold: 16
+    include: '**/*.rb'
+
+  # Fasterer suggests Ruby performance improvements (add gem 'fasterer' to enable).
+  Fasterer:
+    enabled: false
+    required_executable: 'fasterer'
+    description: 'Analyzing for potential speed improvements'
+    include: '**/*.rb'
+
+  TrailingWhitespace:
+    enabled: true
     exclude:
       - '**/lib/**/*' # Ignore trailing whitespace in generated files
 

data/lib/generators/code_quality_check/uninstall_generator.rb

@@ -4,14 +4,20 @@ require 'rails/generators/base'
 
 module CodeQualityCheck
   module Generators
-    # Uninstall generator to remove Overcommit and RuboCop configuration files
+    # Rails generator that removes CodeQualityCheck configuration and uninstalls
+    # Overcommit hooks.
+    #
+    # Run with: +rails generate code_quality_check:uninstall+
+    #
+    # Removes: config/initializers/code_quality_check.rb, .overcommit.yml, .rubocop.yml
+    # Runs: bundle exec overcommit --uninstall
     class UninstallGenerator < Rails::Generators::Base
       desc 'This generator removes Overcommit and RuboCop configuration files'
 
       # Remove Overcommit and RuboCop configuration files
       def remove_files
         # List of files to be removed
-        files_to_remove = ['config/initializers/overcommit.rb', '.overcommit.yml', '.rubocop.yml']
+        files_to_remove = ['config/initializers/code_quality_check.rb', '.overcommit.yml', '.rubocop.yml']
 
         files_to_remove.each do |file|
           if File.exist?(file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_quality_check
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Aniruddha Mirajkar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rails_best_practices
   requirement: !ruby/object:Gem::Requirement
@@ -72,8 +86,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.23.1
-description: Integrates Overcommit with RuboCop, Rails Best Practices, and Brakeman
-  for automated code quality checks.
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: |
+  Code Quality Check is a Ruby on Rails gem that runs automated quality and security
+  checks on every commit using Overcommit and Git hooks. It bundles and configures
+  RuboCop (style and lint), Brakeman (security), Rails Best Practices, and
+  BundleAudit (CVE checks). The installer sets up a Rails initializer that verifies
+  the gem is installed and ensures Overcommit hooks are present, so teams don't
+  silently skip checks. Optional support for Reek, Flay, and Fasterer via
+  .overcommit.yml. Requires Overcommit in your Gemfile; add the gem and run
+  `rails generate code_quality_check:install` to get started.
 email:
 - mirajkaraniruddha@gmail.com
 executables: []
@@ -83,7 +124,7 @@ files:
 - lib/code_quality_check.rb
 - lib/code_quality_check/version.rb
 - lib/generators/code_quality_check/install_generator.rb
-- lib/generators/code_quality_check/templates/overcommit.rb
+- lib/generators/code_quality_check/templates/code_quality_check.rb
 - lib/generators/code_quality_check/templates/overcommit.yml
 - lib/generators/code_quality_check/templates/post-checkout
 - lib/generators/code_quality_check/templates/pre-commit
@@ -96,6 +137,7 @@ metadata:
   homepage_uri: https://github.com/aniruddhami/code_quality_check
   source_code_uri: https://github.com/aniruddhami/code_quality_check
   changelog_uri: https://github.com/aniruddhami/code_quality_check/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/aniruddhami/code_quality_check#readme
   github_repo: https://github.com/aniruddhami/code_quality_check
   rubygems_mfa_required: 'true'
 post_install_message: 
@@ -116,5 +158,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
-summary: A gem to enforce code quality checks using Git hooks
+summary: Enforce code quality on every commit via Overcommit and Git hooks
 test_files: []