code_quality_check 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb86571d044e7e3a130c8f2c0c560956b58dc06c336d6cb1f9cda8b2cff431f
-  data.tar.gz: b7c498902c58ebd212f9672c94a462d4582738fdba2612f56f987b6afd9a6ec8
+  metadata.gz: 13d4abebe3b16f63c43f487c77c60a7e6ecfc235e793b44f54126110665f4e17
+  data.tar.gz: c4f9db62d2a4ffeae2800b3af5e5f76f0f60f01e7c783f3e549fea7533fd7021
 SHA512:
-  metadata.gz: 5e8a5a900428d2edfe59b5a316fd2644783e60fb1d101fc042be6516cbb0967892464238901c0099447700123c9cab7bb301534ed0b01813545124b60b314731
-  data.tar.gz: c360645a474d5b2d657d8fc29c40bf1d6fcc890889a211349ceab772c8086d58e5d342f3189cd873080452e5208c5f09e11e5d0d36b430c47e82ad805681614e
+  metadata.gz: 6f63bf1be24459df898346a3287688e9746512a901a6080bc52935e0fcbeff4cc4212332dda79aa380240d2eb7fb3e7dba087435a7603896c2ad0c96f438daf1
+  data.tar.gz: a65a9bca1cdf9aae4341b487a05ff55ef4b73b87e32f7f0b780ff270c9b61e09c8b8723b12ceee751bdd7fb14ca7f01bb3ed4bb7a99c54adf646b5618465e576

data/lib/code_quality_check/version.rb

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

data/lib/generators/code_quality_check/install_generator.rb

@@ -15,10 +15,10 @@ module CodeQualityCheck
         template 'overcommit.rb', 'config/initializers/overcommit.rb'
 
         # Copy the Overcommit configuration file to the root directory
-        template '.overcommit.yml', '.overcommit.yml'
+        template 'overcommit.yml', '.overcommit.yml'
 
         # Copy the RuboCop configuration file to the root directory
-        template '.rubocop.yml', '.rubocop.yml'
+        template 'rubocop.yml', '.rubocop.yml'
       end
     end
   end

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

@@ -0,0 +1,60 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# 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.
+#
+# 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:
+    enabled: true
+    description: 'Analyzing Ruby code style with RuboCop'
+    required_executable: 'rubocop'
+    command: ['bundle', 'exec', 'rubocop']
+    flags: ['--force-exclusion']
+    problem_on_unmodified_line: ignore
+
+  # RailsBestPractices is a code metric tool to check the quality of Rails code.
+  RailsBestPractices:
+    enabled: true
+    on_warn: fail
+    exclude:
+      - '**/lib/**/*'
+
+  # Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications.
+  Brakeman:
+    enabled: true
+    command: ['brakeman', '--skip-libs', '-w3']
+
+  TrailingWhitespace:
+    enabled: true
+    exclude:
+      - '**/lib/**/*' # Ignore trailing whitespace in generated files
+
+  AuthorName:
+    enabled: true
+  AuthorEmail:
+    enabled: true
+  BrokenSymlinks:
+    enabled: true
+  CaseConflicts:
+    enabled: true
+  MergeConflicts:
+    enabled: true
+
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

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

@@ -0,0 +1,43 @@
+Style/Encoding:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Layout/LineLength:
+  Max: 300
+Metrics/ClassLength:
+  Max: 400
+Metrics/AbcSize:
+  Max: 150
+Metrics/MethodLength:
+  Max: 40
+Metrics/PerceivedComplexity:
+  Max: 30
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 30
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  SupportedStyles:
+    - nested
+    - compact
+Layout/EndOfLine:
+   Enabled: False
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+  Exclude:
+    - 'db/schema.rb'
+    - 'db/migrate/**/*'
+    - 'bin/*'
+    - 'config/**/*'
+    - 'config.ru'
+    - 'Rakefile'
+    - 'test/**'

data/lib/generators/code_quality_check/uninstall_generator.rb

@@ -1,29 +1,27 @@
-# lib/generators/code_quality_check/uninstall_generator.rb
+# frozen_string_literal: true
+
 require 'rails/generators/base'
 
 module CodeQualityCheck
   module Generators
+    # Uninstall generator to remove Overcommit and RuboCop configuration files
     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/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
 
+      # Uninstall Overcommit
       def uninstall_overcommit
         # uninstall overcommit
         run 'bundle exec overcommit --uninstall'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_quality_check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aniruddha Mirajkar
@@ -52,6 +52,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.23.1
 description: Integrates Overcommit with RuboCop, Rails Best Practices, and Brakeman
   for automated code quality checks.
 email:
@@ -61,19 +81,21 @@ 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/templates/overcommit.yml
+- lib/generators/code_quality_check/templates/rubocop.yml
 - 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
+homepage: https://github.com/aniruddhami/code_quality_check
 licenses:
 - MIT
-metadata: {}
+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/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -82,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A gem to enforce code quality checks using Git hooks