rubocop-vicenzo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b430ab160562cd140cd498e015dbf4e2c03a6bd99189ae24adc00881a3bbab48
-  data.tar.gz: 3757afc640413d2ed6548319003ecf62be4cc84658673d430e5ff8236936f2d6
+  metadata.gz: 685f19680a9d5721ed006772467155092d9d441c95c035191e3fa9dc449eac65
+  data.tar.gz: 22fa73c161855ced3561903c9a901ca19beec2904fe326402f426ec93040dd78
 SHA512:
-  metadata.gz: 4b2cbdc348b8faa2dd97e722e78e5c8956b67da26df8541314990331a645b156c758540d6602960e8f96340a6294bf0a35a833b4f2d5a1a237349bbb91f58ba6
-  data.tar.gz: 88b77a6119a722404ad6d263f61ed53423e4991ae216bd8ea2295712fa72c5536b902948bea8c61e2f32e832444e356c2a0b16ae2f4a8727993acd063db40130
+  metadata.gz: 8ea51ee079b7a796cb1f76c8630f9e78a8c8e4fe191f06e7096d4813744a8623a8b35b43288c7b24a671383d65b1ec4a76db72601bc32484ad5945009bb6a1d0
+  data.tar.gz: 795995a84e448e543fbc5d68a6c0434fd0f7ad62dc19e57727d6da251bcfc0bc9624c7eaa78e40a802d5e08d924dc85a2a3512b3d7a868388bb62e22df7447ce

data/.rubocop.yml

@@ -6,8 +6,20 @@ plugins:
   - rubocop-internal_affairs
 
 AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
   NewCops: enable
 
+InternalAffairs/UndefinedConfig: # False positive because conflicts with Rubocop Layout namespace
+  Exclude:
+    - 'lib/rubocop/cop/vicenzo/layout/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'rakelib/**/*'
+    - 'Rakefile'
+
 Naming/FileName:
   Exclude:
     - lib/rubocop-vicenzo.rb

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-12-17
+
+- Add RuboCop::Cop::Vicenzo::Layout::MultilineMethodCallLineBreaks #12;
+- Add RuboCop::Cop::Vicenzo::Style::MultilineMethodCallParentheses #13;
+- Add `AllowedMethods` configuration to `Vicenzo/Style/MultilineMethodCallParentheses` to allow excluding specific methods (e.g., RSpec DSLs like `to` and `change`) from the rule #15;
+
 ## [0.2.0] - 2025-11-27
 
 - Remove RuboCop::Cop::Vicenzo::RSpec::MixedExampleGroups in favor of InconsistentSiblingStructure #10;

data/README.md

@@ -55,6 +55,14 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Generate binstubs
+
+If you want is possible change the command `bundle exec something` by `bin/something` generating binstubs
+
+```bash
+bundle binstubs rake rspec-core rubocop
+```
+
 ### Creating a new cop
 
 ```bash

data/config/default.yml

@@ -1,3 +1,10 @@
+Vicenzo/Layout/MultilineMethodCallLineBreaks:
+  Description: 'Enforces that method calls in a multiline chain must each be on their own line.'
+  Enabled: true
+  Severity: convention
+  IndentationWidth: 2
+  VersionAdded: '0.3.0'
+
 Vicenzo/Rails/EnumInclusionOfValidation:
   Description: 'Check if the enum has the inclusion of validation defined.'
   Enabled: true
@@ -38,3 +45,9 @@ Vicenzo/RSpec/LeakyDefinition:
   Exclude:
     - '**/spec/support/**/*'
     - '**/spec/factories/**/*'
+
+Vicenzo/Style/MultilineMethodCallParentheses:
+  Description: 'Enforces parentheses for method calls with arguments that span multiple lines.'
+  Enabled: true
+  AllowedMethods: []
+  VersionAdded: '0.3.0'

data/lib/rubocop/cop/vicenzo/layout/multiline_method_call_line_breaks.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vicenzo
+      module Layout
+        # Enforces that method calls in a multiline chain are each on their own line.
+        #
+        # If a method chain spans more than one line, this cop ensures that every
+        # call in the chain is placed on a new line. It prevents "mixed" styles
+        # where some methods are on the same line as the receiver while others are broken.
+        #
+        # @example
+        #   # bad
+        #   object.method_one
+        #     .method_two
+        #
+        #   # bad
+        #   object
+        #     .method_one.method_two
+        #     .method_three
+        #
+        #   # good - single line chain
+        #   object.method_one.method_two
+        #
+        #   # good - multiline chain
+        #   object
+        #     .method_one
+        #     .method_two
+        #
+        #   # good - arguments causing the break (if configured implicitly)
+        #   object.method_one(
+        #     arg1,
+        #     arg2
+        #   ).method_two
+        #
+        # ## Configuration
+        #
+        # This cop allows you to customize the indentation width used during auto-correction.
+        # The default width is 2 spaces relative to the previous line.
+        #
+        # ```yaml
+        # CustomCops/MultilineMethodCallLineBreaks:
+        #   IndentationWidth: 4 # (default is 2)
+        # ```
+        #
+        class MultilineMethodCallLineBreaks < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Method calls in a multiline chain must each be on their own line.'
+          DEFAULT_INDENTATION_WIDTH = 2
+          LEADING_SPACES_PATTERN = /\A */
+          CHAIN_START_PATTERN = /\A\s*&?\./
+
+          OPERATOR_METHODS = %i[[] []= + - * / % ** << >>].freeze
+
+          def on_send(node)
+            check_node(node)
+          end
+          alias on_csend on_send
+
+          private
+
+          def check_node(node)
+            return if part_of_larger_chain?(node)
+            return if single_line_chain?(node)
+
+            check_chain_structure(node)
+          end
+
+          def check_chain_structure(node)
+            current = node
+
+            while current.call_type?
+              receiver = current.receiver
+              break unless receiver
+
+              check_violation(current, receiver)
+              current = receiver
+            end
+          end
+
+          def check_violation(node, receiver)
+            return unless same_line?(receiver, node)
+            return if valid_same_line_exception?(node)
+
+            add_offense(offense_range(node)) do |corrector|
+              break_line_before_dot(corrector, node, receiver)
+            end
+          end
+
+          def valid_same_line_exception?(node)
+            arguments_cause_multiline?(node) || operator_method?(node)
+          end
+
+          def operator_method?(node)
+            OPERATOR_METHODS.include?(node.method_name)
+          end
+
+          def part_of_larger_chain?(node)
+            parent = node.parent
+            parent&.call_type? && parent.receiver == node
+          end
+
+          def single_line_chain?(node)
+            root = root_node(node)
+            root.loc.last_line == node.loc.last_line
+          end
+
+          def root_node(node)
+            current = node
+            current = current.receiver while current.respond_to?(:receiver) && current.receiver
+            current
+          end
+
+          def same_line?(receiver, node)
+            receiver.loc.last_line == call_start_line(node)
+          end
+
+          def call_start_line(node)
+            node.loc.dot ? node.loc.dot.line : node.loc.selector.line
+          end
+
+          def arguments_cause_multiline?(node)
+            return false if node.arguments.empty?
+            return false if node.receiver.loc.last_line != call_start_line(node)
+
+            return false if node.receiver.call_type? && node.receiver.loc.dot
+
+            node.multiline?
+          end
+
+          def offense_range(node)
+            return node.loc.selector unless node.loc.dot
+            return node.loc.dot unless node.loc.selector
+
+            node.loc.dot.join(node.loc.selector)
+          end
+
+          def break_line_before_dot(corrector, node, receiver)
+            dot = node.loc.dot
+            return unless dot
+
+            last_line_index = receiver.loc.last_line - 1
+            last_line_source = processed_source.lines[last_line_index]
+
+            current_indentation = last_line_source[LEADING_SPACES_PATTERN].length
+
+            previous_line_is_chain = last_line_source.match?(CHAIN_START_PATTERN)
+            extra_indent = previous_line_is_chain ? 0 : indentation_width
+
+            indentation = ' ' * (current_indentation + extra_indent)
+
+            corrector.insert_before(dot, "\n#{indentation}")
+          end
+
+          def indentation_width
+            cop_config.fetch('IndentationWidth', DEFAULT_INDENTATION_WIDTH)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vicenzo/style/multiline_method_call_parentheses.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vicenzo
+      module Style
+        # Enforces parentheses for method calls with arguments that span multiple lines.
+        # Single-line calls are ignored (parentheses are optional).
+        #
+        # This cop accepts an `AllowedMethods` configuration to exempt specific methods
+        # from this rule. This is particularly useful for Fluent DSLs (like RSpec's
+        # `to`, `change`, etc.) where parentheses might hurt readability or conflict
+        # with layout rules.
+        #
+        # @example
+        #   # bad
+        #   method_name arg1,
+        #               arg2
+        #
+        #   # good
+        #   method_name(arg1,
+        #               arg2)
+        #
+        #   # good (single line is always allowed)
+        #   method_name arg1, arg2
+        #
+        # @example AllowedMethods: ['to']
+        #   # good (allowed by configuration)
+        #   expect { action }.to change {
+        #     model.attribute
+        #   }
+        #
+        class MultilineMethodCallParentheses < Base
+          extend RuboCop::Cop::AutoCorrector
+          include RuboCop::Cop::RangeHelp
+
+          MSG = 'Use parentheses for method calls with arguments that span multiple lines.'
+
+          def on_send(node)
+            check_node(node)
+          end
+          alias on_csend on_send
+
+          private
+
+          def check_node(node)
+            return unless node.arguments?
+            return unless node.multiline?
+            return if node.parenthesized? || node.operator_method? || node.setter_method? || allowed_method?(node)
+
+            add_offense(node) do |corrector|
+              autocorrect(corrector, node)
+            end
+          end
+
+          def allowed_method?(node)
+            allowed_methods.include?(node.method_name.to_s)
+          end
+
+          def allowed_methods
+            cop_config.fetch('AllowedMethods', [])
+          end
+
+          def autocorrect(corrector, node)
+            if node.loc.selector
+              gap_range = range_between(node.loc.selector.end_pos, node.first_argument.source_range.begin_pos)
+              corrector.replace(gap_range, '(')
+            else
+              corrector.insert_before(node.first_argument, '(')
+            end
+
+            corrector.insert_after(node.last_argument, ')')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vicenzo_cops.rb

@@ -6,3 +6,5 @@ require_relative 'vicenzo/rspec/nested_let_redefinition'
 require_relative 'vicenzo/rspec/nested_subject_redefinition'
 require_relative 'vicenzo/rspec/leaky_definition'
 require_relative 'vicenzo/rails/enum_inclusion_of_validation'
+require_relative 'vicenzo/layout/multiline_method_call_line_breaks'
+require_relative 'vicenzo/style/multiline_method_call_parentheses'

data/lib/rubocop/vicenzo/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Vicenzo
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/rakelib/release.rake

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'date'
+
+desc 'Prepare release: update config, version file, and changelog'
+task :cut_release, [:version] do |_t, args|
+  version = args[:version]
+
+  # 1. Validation
+  abort 'Error: You must provide a version. Example: rake cut_release[0.3.0]' unless version
+
+  config_file    = 'config/default.yml'
+  version_file   = 'lib/rubocop/vicenzo/version.rb'
+  changelog_file = 'CHANGELOG.md'
+
+  # Check if files exist
+  [config_file, version_file, changelog_file].each do |file|
+    abort "Error: File not found at #{file}" unless File.exist?(file)
+  end
+
+  puts "✂️  Cutting release for version #{version}..."
+
+  # -------------------------------------------------------
+  # 2. Update config/default.yml (<<next>> -> version)
+  # -------------------------------------------------------
+  config_content = File.read(config_file)
+  if config_content.include?("'<<next>>'")
+    updated_config = config_content.gsub("'<<next>>'", "'#{version}'")
+    File.write(config_file, updated_config)
+    puts "   ✅ Updated 'VersionAdded' in #{config_file}"
+  else
+    puts "   ⚠️  No '<<next>>' found in #{config_file} (skipping)"
+  end
+
+  # -------------------------------------------------------
+  # 3. Update lib/rubocop/vicenzo/version.rb
+  # -------------------------------------------------------
+  version_content = File.read(version_file)
+  # Regex looks for: VERSION = '...' or VERSION = "..."
+  if version_content.match?(/VERSION\s*=\s*['"](.+)['"]/)
+    updated_version = version_content.gsub(/VERSION\s*=\s*['"](.+)['"]/, "VERSION = '#{version}'")
+    File.write(version_file, updated_version)
+    puts "   ✅ Updated VERSION constant in #{version_file}"
+  else
+    puts "   ❌ Could not find VERSION constant in #{version_file}"
+  end
+
+  # -------------------------------------------------------
+  # 4. Update CHANGELOG.md
+  # -------------------------------------------------------
+  changelog_content = File.read(changelog_file)
+  unreleased_header = '## [Unreleased]'
+  date = Date.today.to_s # YYYY-MM-DD
+
+  # We replace "## [Unreleased]" with:
+  # ## [Unreleased]
+  #
+  # ## [version] - date
+  #
+  # This pushes the existing unreleased items down under the new version header.
+  new_entry_header = "#{unreleased_header}\n\n## [#{version}] - #{date}"
+
+  if changelog_content.include?(unreleased_header)
+    # We use 'sub' to replace only the first occurrence (the top one)
+    updated_changelog = changelog_content.sub(unreleased_header, new_entry_header)
+    File.write(changelog_file, updated_changelog)
+    puts "   ✅ Updated #{changelog_file} (moved items to [#{version}])"
+  else
+    puts "   ❌ Could not find '#{unreleased_header}' in #{changelog_file}"
+  end
+
+  puts "\n🎉 Release preparation complete! Don't forget to commit."
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-vicenzo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bruno Vicenzo
@@ -68,16 +68,19 @@ files:
 - Rakefile
 - config/default.yml
 - lib/rubocop-vicenzo.rb
+- lib/rubocop/cop/vicenzo/layout/multiline_method_call_line_breaks.rb
 - lib/rubocop/cop/vicenzo/rails/enum_inclusion_of_validation.rb
 - lib/rubocop/cop/vicenzo/rspec/inconsistent_sibling_structure.rb
 - lib/rubocop/cop/vicenzo/rspec/leaky_definition.rb
 - lib/rubocop/cop/vicenzo/rspec/nested_context_improper_start.rb
 - lib/rubocop/cop/vicenzo/rspec/nested_let_redefinition.rb
 - lib/rubocop/cop/vicenzo/rspec/nested_subject_redefinition.rb
+- lib/rubocop/cop/vicenzo/style/multiline_method_call_parentheses.rb
 - lib/rubocop/cop/vicenzo_cops.rb
 - lib/rubocop/vicenzo.rb
 - lib/rubocop/vicenzo/plugin.rb
 - lib/rubocop/vicenzo/version.rb
+- rakelib/release.rake
 - sig/rubocop/vicenzo.rbs
 homepage: https://github.com/bvicenzo/rubocop-vicenzo
 licenses: