rubocop-pixelforce 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16bc89330d3996087dffc1f7e3ec8e3b50d8965ba6190d643e9177befe1ccf6f
-  data.tar.gz: 901f067575c85f4a2d5b3556ca8e99a834ac7323997e991cd1e5c4c00245d55e
+  metadata.gz: cd94f0a6e83044823c99b918495faa1a159e902995a358d642760eb89383140e
+  data.tar.gz: 254b7384bd4c79bea3e4406815619c0c96ad34efea1991934bd4827e2b854620
 SHA512:
-  metadata.gz: 619e39e98a72ccd21a93dd177b9b28b6353eae540a03f9417ffff3f1d44426ee38aa9d790b5bcec172ea4248ffc35f9b03ab2afe79bf8afa76b111ee148f91b3
-  data.tar.gz: bd417a44a6b93879987cf76a238318faa6fd7c89c282ceeb68185d82389e18217dfe1378138ae03ad25eb8570adb73baf3499d91231d48f2f84c0726ee8ac0fa
+  metadata.gz: 778cece340e324267da10f497def005ecc4dffbdad1d10c69aedf491e051c558cd9d83211c207238fd73173caea65448b2b960c4e96ffbfd86bbf9856a90944e
+  data.tar.gz: 1cf1db1efbb5fd26f86b1b7121bde6f31a6d3f33e96404549dcb08daaa2b8cd334c066fbb04cd142aa5fa522a0175805fd5282fc6273fbff3e9b939601d32a8f

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop-pixelforce (2.0.0)
-      rubocop (~> 1.21)
+    rubocop-pixelforce (2.3.0)
+      rubocop (~> 1.75)
       rubocop-performance
       rubocop-rails
 

data/README.md

@@ -1,7 +1,6 @@
 # Rubocop::Pixelforce
 
-Custom Rubocop cop for PixlForce
-
+Custom Rubocop cop for PixelForce
 
 ## Installation
 
@@ -15,14 +14,24 @@ And then execute:
 
     $ bundle
 
-and create .rubocop file like this
+Create a `.rubocop.yml` file in your project root:
 
-```
+```yaml
 inherit_gem:
   rubocop-pixelforce: default.yml
 ```
 
-## Pixelforce/ClassStructure: Don't Use empty lines between same categories.
+### Dependencies
+
+This gem automatically includes the following dependencies:
+- `rubocop-performance` - for performance-related cops
+- `rubocop-rails` - for Rails-specific cops
+
+If you encounter any issues with missing cops, make sure these gems are properly installed.
+
+## Usage
+
+### Pixelforce/EmptyLineBetweenCategories: Don't Use empty lines between same categories.
 
 ```ruby
 # bad
@@ -39,7 +48,7 @@ belongs_to :category
 after_commit :update_geo_location
 ```
 
-## Pixelforce/ClassStructure: Use empty lines between categories.
+### Pixelforce/EmptyLineBetweenCategories: Use empty lines between categories.
 
 ```ruby
 # bad
@@ -57,6 +66,27 @@ belongs_to :category
 after_commit :update_geo_location
 ```
 
+## Troubleshooting
+
+### Error: "Rails cops have been extracted to the rubocop-rails gem"
+
+If you see this error, it means the `rubocop-rails` plugin is not properly loaded. This gem automatically includes `rubocop-rails` as a dependency, but if you're still seeing this error:
+
+1. Make sure you're using the latest version of this gem
+2. Run `bundle update rubocop-pixelforce` to update to the latest version
+3. Ensure your `.rubocop.yml` inherits from this gem's configuration:
+   ```yaml
+   inherit_gem:
+     rubocop-pixelforce: default.yml
+   ```
+
+### Error: "unrecognized cop or department"
+
+If you see errors about unrecognized cops, make sure you have the latest version of RuboCop and this gem installed:
+
+```bash
+bundle update rubocop rubocop-pixelforce
+```
 
 ## Development
 
@@ -66,4 +96,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-pixelforce.
+Bug reports and pull requests are welcome on GitHub at https://github.com/BenZhang/rubocop-pixelforce.

data/default.yml

@@ -1,3 +1,13 @@
+# RuboCop Pixelforce Configuration
+# 
+# This configuration requires the following gems to be installed:
+# - rubocop-performance
+# - rubocop-rails
+# 
+# Make sure these are included in your Gemfile:
+# gem 'rubocop-performance', require: false
+# gem 'rubocop-rails', require: false
+
 plugins:
   - rubocop-performance
   - rubocop-rails
@@ -13,19 +23,6 @@ AllCops:
     - 'config/**/*'
     - 'test/**/*'
 
-Rails/UnknownEnv:
-  Environments:
-    - production
-    - development
-    - test
-    - staging
-
-Rails/HasManyOrHasOneDependent:
-  Enabled: false
-
-Rails/FilePath:
-  Enabled: false
-
 Layout/ClassStructure: &class_structures
   Enabled: true
   ExpectedOrder:
@@ -80,7 +77,7 @@ Layout/ClassStructure: &class_structures
       - prepend
       - extend
 
-Pixelforce/EmptyLineBwteenCategories:
+Pixelforce/EmptyLineBetweenCategories:
   <<: *class_structures
   Enabled: true
 
@@ -142,4 +139,21 @@ Style/GlobalVars:
   Enabled: false
 
 Metrics/ParameterLists:
+  Enabled: false
+
+# Rails cops - these require the rubocop-rails plugin to be installed
+# If you get an error about Rails cops being extracted, make sure you have
+# 'rubocop-rails' gem installed and listed in the plugins section above
+
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - development
+    - test
+    - staging
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Rails/FilePath:
   Enabled: false

data/lib/rubocop/cop/pixelforce/empty_line_between_categories.rb

@@ -3,16 +3,19 @@ module RuboCop
     module Pixelforce
       class EmptyLineBetweenCategories < Base
         include RangeHelp
+        extend AutoCorrector
 
         HUMANIZED_NODE_TYPE = {
           casgn: :constants,
           defs: :class_methods,
           def: :public_methods,
-          sclass: :class_singleton
+          sclass: :class_singleton,
+          send: :method_calls
         }.freeze
 
         VISIBILITY_SCOPES = %i[private protected public].freeze
-        MSG = 'Use empty lines between categories.'
+        MSG_EMPTY_LINE_BETWEEN_CATEGORIES = 'Use empty lines between categories.'.freeze
+        MSG_EMPTY_LINE_BETWEEN_SAME_CATEGORIES = "Don't Use empty lines between same categories.".freeze
 
         def_node_matcher :visibility_block?, <<~PATTERN
           (send nil? { :private :protected :public })
@@ -22,41 +25,46 @@ module RuboCop
         # Add offense when find a node out of expected order.
         def on_class(class_node)
           previous_category = nil
-          previous_node_end_line = -1
-          previous_method_name = nil
-          walk_over_nested_class_definition(class_node) do |node, category|
-            next unless node.respond_to?(:method_name)
 
-            if previous_category && category != previous_category && node.loc.first_line - previous_node_end_line < 2
-              add_offense(node, message: MSG)
+          walk_over_nested_class_definition(class_node) do |node, category|
+            # Skip empty line enforcement for method definitions
+            next if method_definition?(node)
+
+            if previous_category && previous_category != category
+              count = blank_lines_count_between(prev_node(node), node)
+              if count < 2
+                add_offense(node, message: MSG_EMPTY_LINE_BETWEEN_CATEGORIES) do |corrector|
+                  prev_category = prev_node(node)
+                  end_pos = end_position_for(prev_category)
+                  newline_pos = buffer.source.index("\n", end_pos)
+                  where_to_insert = range_between(newline_pos, newline_pos + 1)
+                  corrector.insert_after(where_to_insert, "\n")
+                end
+              end
+            elsif previous_category && previous_category == category
+              count = blank_lines_count_between(prev_node(node), node)
+              if count > 1
+                add_offense(node, message: MSG_EMPTY_LINE_BETWEEN_SAME_CATEGORIES) do |corrector|
+                  prev_category = prev_node(node)
+                  end_pos = end_position_for(prev_category)
+                  newline_pos = buffer.source.index("\n", end_pos)
+                  range_to_remove = range_between(newline_pos, newline_pos + 1)
+                  corrector.remove(range_to_remove)
+                end
+              end
             end
 
-            if previous_method_name && previous_method_name == node.method_name && node.loc.first_line - previous_node_end_line > 1
-              add_offense(node, message: "Don't Use empty lines between same categories.")
-            end
             previous_category = category
-            previous_node_end_line = node.loc.last_line
-            previous_method_name = node.method_name
           end
         end
 
-        def autocorrect(node)
-          prev_category = prev_node(node)
-          # finds position of first newline
-          end_pos = end_position_for(prev_category)
-          newline_pos = buffer.source.index("\n", end_pos)
-
-          count = blank_lines_count_between(prev_category, node)
+        private
 
-          if count > 1
-            autocorrect_remove_lines(newline_pos, count)
-          else
-            autocorrect_insert_lines(newline_pos, count)
-          end
+        # Check if a node is a method definition
+        def method_definition?(node)
+          node.def_type? || node.defs_type?
         end
 
-        private
-
         # Classifies a node to match with something in the {expected_order}
         # @param node to be analysed
         # @return String when the node type is a `:block` then
@@ -221,20 +229,6 @@ module RuboCop
         def categories
           cop_config['Categories']
         end
-
-        def autocorrect_remove_lines(newline_pos, _count)
-          range_to_remove = range_between(newline_pos, newline_pos + 1)
-          lambda do |corrector|
-            corrector.remove(range_to_remove)
-          end
-        end
-
-        def autocorrect_insert_lines(newline_pos, _count)
-          where_to_insert = range_between(newline_pos, newline_pos + 1)
-          lambda do |corrector|
-            corrector.insert_after(where_to_insert, "\n")
-          end
-        end
       end
     end
   end

data/lib/rubocop/pixelforce/version.rb

@@ -1,5 +1,5 @@
 module Rubocop
   module Pixelforce
-    VERSION = '2.0.0'
+    VERSION = '2.3.0'
   end
 end

data/rubocop-pixelforce.gemspec

@@ -1,35 +1,35 @@
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubocop/pixelforce/version"
+require 'rubocop/pixelforce/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rubocop-pixelforce"
+  spec.name          = 'rubocop-pixelforce'
   spec.version       = Rubocop::Pixelforce::VERSION
-  spec.authors       = ["Ben Zhang"]
-  spec.email         = ["bzbnhang@gmail.com"]
+  spec.authors       = ['Ben Zhang']
+  spec.email         = ['bzbnhang@gmail.com']
 
-  spec.summary       = %q{Custom Rubocop cop for PixelForce.}
-  spec.description   = %q{Use empty lines between categories and Don't Use empty lines between same categories.}
-  spec.homepage      = "https://github.com/BenZhang/rubocop-pixelforce"
+  spec.summary       = 'Custom Rubocop cop for PixelForce.'
+  spec.description   = "Use empty lines between categories and Don't Use empty lines between same categories."
+  spec.homepage      = 'https://github.com/BenZhang/rubocop-pixelforce'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/BenZhang/rubocop-pixelforce"
-  spec.metadata["changelog_uri"] = "https://github.com/BenZhang/rubocop-pixelforce"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/BenZhang/rubocop-pixelforce'
+  spec.metadata['changelog_uri'] = 'https://github.com/BenZhang/rubocop-pixelforce'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency "rubocop", "~> 1.21"
-  spec.add_runtime_dependency "rubocop-performance"
-  spec.add_runtime_dependency "rubocop-rails"
+  spec.add_runtime_dependency 'rubocop', '~> 1.75'
+  spec.add_runtime_dependency 'rubocop-performance'
+  spec.add_runtime_dependency 'rubocop-rails'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-pixelforce
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Ben Zhang
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.75'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement