code_quality_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edb86571d044e7e3a130c8f2c0c560956b58dc06c336d6cb1f9cda8b2cff431f
+  data.tar.gz: b7c498902c58ebd212f9672c94a462d4582738fdba2612f56f987b6afd9a6ec8
+SHA512:
+  metadata.gz: 5e8a5a900428d2edfe59b5a316fd2644783e60fb1d101fc042be6516cbb0967892464238901c0099447700123c9cab7bb301534ed0b01813545124b60b314731
+  data.tar.gz: c360645a474d5b2d657d8fc29c40bf1d6fcc890889a211349ceab772c8086d58e5d342f3189cd873080452e5208c5f09e11e5d0d36b430c47e82ad805681614e

data/lib/code_quality_check/version.rb

@@ -0,0 +1,3 @@
+module CodeQualityCheck
+  VERSION = "0.1.0".freeze
+end

data/lib/code_quality_check.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'code_quality_check/version'
+module CodeQualityCheck
+  class Error < StandardError; end
+end

data/lib/generators/code_quality_check/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module CodeQualityCheck
+  module Generators
+    # Define a generator class that inherits from Rails::Generators::Base
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      desc 'This generator creates an initializer file for Overcommit'
+
+      # 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'
+
+        # Copy the Overcommit configuration file to the root directory
+        template '.overcommit.yml', '.overcommit.yml'
+
+        # Copy the RuboCop configuration file to the root directory
+        template '.rubocop.yml', '.rubocop.yml'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# config/initializers/overcommit.rb
+
+if Rails.env.development? || Rails.env.test?
+  begin
+    # Check if Overcommit is already installed by verifying the pre-commit hook
+    if File.exist?(File.join(Rails.root, '.git/hooks/pre-commit'))
+      puts 'Overcommit is already installed.'
+    else
+      puts 'Installing Overcommit hooks...'
+      system('bundle exec overcommit --install')
+      system('overcommit --sign')
+      system('overcommit --sign pre-commit')
+    end
+  rescue StandardError => e
+    # Log or print any error that occurs
+    Rails.logger.error "Overcommit installation failed: #{e.message}"
+  end
+end

data/lib/generators/code_quality_check/uninstall_generator.rb

@@ -0,0 +1,33 @@
+# lib/generators/code_quality_check/uninstall_generator.rb
+require 'rails/generators/base'
+
+module CodeQualityCheck
+  module Generators
+    class UninstallGenerator < Rails::Generators::Base
+      desc 'This generator removes 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.each do |file|
+          if File.exist?(file)
+            remove_file file
+            say_status('removed', file)
+          else
+            say_status('not found', file, :yellow)
+          end
+        end
+      end
+
+      def uninstall_overcommit
+        # uninstall overcommit
+        run 'bundle exec overcommit --uninstall'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: code_quality_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aniruddha Mirajkar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Integrates Overcommit with RuboCop, Rails Best Practices, and Brakeman
+  for automated code quality checks.
+email:
+- mirajkaraniruddha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/code_quality_check.rb
+- lib/code_quality_check.rb:Zone.Identifier
+- lib/code_quality_check/version.rb
+- lib/code_quality_check/version.rb:Zone.Identifier
+- lib/generators/code_quality_check/install_generator.rb
+- lib/generators/code_quality_check/install_generator.rb:Zone.Identifier
+- lib/generators/code_quality_check/templates/overcommit.rb
+- lib/generators/code_quality_check/templates/overcommit.rb:Zone.Identifier
+- lib/generators/code_quality_check/uninstall_generator.rb
+- lib/generators/code_quality_check/uninstall_generator.rb:Zone.Identifier
+homepage: https://github.com/yourusername/code_quality_check
+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.4.1
+signing_key:
+specification_version: 4
+summary: A gem to enforce code quality checks using Git hooks
+test_files: []