rubocop-metz 0.5.3

data/lib/rubocop/cop/metz/methods_too_many_parameters.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require_relative "../../../metz/cop_metadata"
+
+module RuboCop
+  module Cop
+    module Metz
+      # Flags methods whose parameter list exceeds the configured `Max`.
+      # Counts positional, optional, rest, keyword, and keyword-rest
+      # parameters using the same rule as core's `Metrics/ParameterLists`,
+      # with a stricter Metz default of 4.
+      class MethodsTooManyParameters < RuboCop::Cop::Base
+        extend RuboCop::ExcludeLimit
+        extend ::Metz::CopMetadata
+
+        why_it_matters "Long parameter lists hide coupling and make callers responsible for too many decisions."
+        fix_safety :manual
+        suggested_next_moves [
+          "Group related parameters into a parameter object or value object.",
+          "Replace flag arguments with separate, well-named methods.",
+          "Inject collaborators through the constructor so action methods stay narrow."
+        ]
+
+        MSG = "Avoid parameter lists longer than %<max>d parameters. [%<count>d/%<max>d]"
+
+        exclude_limit "Max"
+
+        def on_args(node)
+          return unless method_definition_args?(node)
+
+          register_offense(node, args_count(node))
+        end
+
+        private
+
+        def register_offense(node, count)
+          return unless count > max_params
+
+          add_offense(node, message: format(MSG, max: max_params, count: count)) do
+            self.max = count
+          end
+        end
+
+        def method_definition_args?(node)
+          parent = node.parent
+          return false unless parent
+
+          parent.def_type? || parent.defs_type?
+        end
+
+        def args_count(node)
+          node.children.count { |arg| !arg.blockarg_type? }
+        end
+
+        def max_params
+          cop_config["Max"]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/metz/on_send_csend_bridge.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Metz
+      # Gives a cop identical `send` and `csend` dispatch when it defines
+      # `on_send`, preserving the project-wide safe-navigation invariant.
+      module OnSendCsendBridge
+        def self.included(base)
+          base.extend(ClassMethods)
+          base.alias_method(:on_csend, :on_send) if base.method_defined?(:on_send)
+        end
+
+        module ClassMethods
+          def method_added(name)
+            super
+            alias_method(:on_csend, :on_send) if name == :on_send
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/metz/views_deep_navigation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "demeter_train_wreck"
+require_relative "../../../metz/file_classifier"
+
+module RuboCop
+  module Cop
+    module Metz
+      # Flags Rails view templates whose ERB / HAML / SLIM expressions
+      # traverse the object graph deeper than `MaxChainLength`. Reuses
+      # `Metz/DemeterTrainWreck`'s chain walker and value-object skip logic,
+      # so a chain like `name.upcase.strip.split(' ').first` (every link a
+      # recognised value-object call) stays silent. Path-classified through
+      # `Metz::FileClassifier.view?`: a deep chain inside an `.erb` file
+      # outside `app/views/` will not fire.
+      # DDR: docs/ddrs/2026-06-24-views-deep-navigation-inherits-demeter.md
+      # explains why this specialization uses inheritance instead of composition.
+      class ViewsDeepNavigation < DemeterTrainWreck
+        include OnSendCsendBridge
+
+        MSG = "View object-graph traversal of %<count>d exceeds MaxChainLength (%<max>d). " \
+              "Push the lookup into the controller or expose it via a presenter."
+
+        why_it_matters "Deep object-graph chains in views couple templates to the internal " \
+                       "structure of every collaborator they touch, making refactors and " \
+                       "test setup painful."
+        fix_safety :manual
+        suggested_next_moves [
+          "Compute the value in the controller and expose it via an instance variable.",
+          "Wrap the chain in a presenter or view model that exposes one explicit method.",
+          "Use Rails `delegate :foo, to: :collaborator` to flatten the chain at the model boundary."
+        ]
+
+        # RuboCop's dispatcher needs the subclass to own the callback, while the
+        # inherited implementation remains the shared chain analyzer.
+        # rubocop:disable Lint/UselessMethodDefinition -- required for subclass callback registration.
+        def on_send(node)
+          super
+        end
+        # rubocop:enable Lint/UselessMethodDefinition
+
+        def relevant_file?(file)
+          return super if file.nil? || file.empty? || file == "(string)"
+
+          !file_name_matches_any?(file, "Exclude", false) &&
+            ::Metz::FileClassifier.view?(file)
+        end
+
+        private
+
+        def max
+          cop_config["MaxChainLength"] || 3
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/metz_cops.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Central require point for every Metz cop. Keep one
+# `require_relative "metz/<cop_name>"` line per cop so registry wiring stays in
+# a single discoverable location.
+
+require_relative "metz/classes_too_long"
+require_relative "metz/methods_too_long"
+require_relative "metz/methods_too_many_parameters"
+require_relative "metz/demeter_train_wreck"
+require_relative "metz/controllers_too_many_direct_collaborators"
+require_relative "metz/views_deep_navigation"

data/lib/rubocop/formatter/metz_json_formatter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Formatter
+    # Wraps RuboCop's standard JSON formatter and enriches every offense whose
+    # `cop_name` starts with `Metz/` with the metadata DSL fields published by
+    # `Metz::CopMetadata`. Non-Metz offenses are passed through unchanged so the
+    # top-level JSON shape and any consumer expecting standard RuboCop output
+    # keeps working.
+    class MetzJsonFormatter < JSONFormatter
+      METZ_PREFIX = "Metz/"
+
+      EMPTY_METADATA = {
+        why_it_matters: nil,
+        fix_safety: nil,
+        suggested_next_moves: []
+      }.freeze
+
+      def hash_for_offense(offense)
+        hash = super
+        return hash unless offense.cop_name.to_s.start_with?(METZ_PREFIX)
+
+        hash.merge!(metz_metadata_for(offense.cop_name))
+      end
+
+      private
+
+      def metz_metadata_for(cop_name)
+        cop_class = RuboCop::Cop::Registry.global.find_by_cop_name(cop_name)
+        return EMPTY_METADATA.dup unless cop_class.respond_to?(:metz_metadata)
+
+        format_metadata(cop_class.metz_metadata)
+      end
+
+      def format_metadata(meta)
+        {
+          why_it_matters: stringify_or_nil(meta[:why_it_matters]),
+          fix_safety: stringify_or_nil(meta[:fix_safety]),
+          suggested_next_moves: Array(meta[:suggested_next_moves]).map(&:to_s)
+        }
+      end
+
+      def stringify_or_nil(value)
+        value&.to_s
+      end
+    end
+  end
+end

data/lib/rubocop/metz/plugin.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+require "pathname"
+
+require_relative "version"
+
+module RuboCop
+  module Metz
+    class Plugin < LintRoller::Plugin
+      ABOUT = LintRoller::About.new(
+        name: "rubocop-metz",
+        version: RuboCop::Metz::VERSION,
+        homepage: "https://github.com/users/fuentesjr/packages/rubygems/package/rubocop-metz",
+        description: "Sandi-Metz-inspired RuboCop cops."
+      ).freeze
+      private_constant :ABOUT
+
+      def about
+        ABOUT
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml").expand_path
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/metz/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Metz
+    VERSION = "0.5.3"
+  end
+end

data/lib/rubocop-metz.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop-ast"
+
+require_relative "rubocop/metz/version"
+require_relative "rubocop/metz/plugin"
+require_relative "metz/cop_metadata"
+require_relative "metz/file_classifier"
+require_relative "metz/erb_ruby_extractor"
+require_relative "metz/haml_ruby_extractor"
+require_relative "metz/slim_ruby_extractor"
+require_relative "rubocop/cop/metz/on_send_csend_bridge"
+require_relative "rubocop/cop/metz_cops"
+require_relative "rubocop/formatter/metz_json_formatter"
+
+Metz::ErbRubyExtractor.install!
+Metz::HamlRubyExtractor.install!
+Metz::SlimRubyExtractor.install!

data/rubocop-metz.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/metz/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "rubocop-metz"
+  spec.version     = RuboCop::Metz::VERSION
+  spec.authors     = ["Salvador Fuentes Jr"]
+  spec.email       = ["fuentesjr@duck.com"]
+
+  spec.summary     = "Sandi-Metz-inspired RuboCop cops."
+  spec.description = "A RuboCop plugin that ships custom cops capturing " \
+                     "Sandi-Metz-style design heuristics for Ruby and Rails code."
+  spec.homepage    = "https://github.com/fuentesjr/metz-scan"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = ">= 3.3"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["github_repo"] = "ssh://github.com/fuentesjr/metz-scan"
+  spec.metadata["github_package_uri"] = "https://github.com/users/fuentesjr/packages/rubygems/package/rubocop-metz"
+  spec.metadata["default_lint_roller_plugin"] = "RuboCop::Metz::Plugin"
+
+  spec.files = Dir.glob("{lib,config}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) } +
+               ["LICENSE", "rubocop-metz.gemspec"].select { |f| File.exist?(f) }
+  # This gemspec's Dir.glob is relative to the build CWD, so building from the
+  # repo root (`gem build rubocop-metz/rubocop-metz.gemspec`) would silently
+  # package the wrapper's lib/metz_scan files instead of these cops. Fail loudly
+  # instead of shipping a corrupt gem. Build from this directory:
+  #   cd rubocop-metz && gem build rubocop-metz.gemspec
+  unless spec.files.include?("lib/rubocop-metz.rb")
+    raise "rubocop-metz.gemspec: lib/rubocop-metz.rb missing from packaged files; " \
+          "build from rubocop-metz/ (cd rubocop-metz && gem build rubocop-metz.gemspec)."
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "lint_roller", "~> 1.1"
+  spec.add_dependency "rubocop", "~> 1.80"
+  spec.add_dependency "rubocop-ast", "~> 1.49"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-metz
+version: !ruby/object:Gem::Version
+  version: 0.5.3
+platform: ruby
+authors:
+- Salvador Fuentes Jr
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.80'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.49'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.49'
+description: A RuboCop plugin that ships custom cops capturing Sandi-Metz-style design
+  heuristics for Ruby and Rails code.
+email:
+- fuentesjr@duck.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- config/default.yml
+- lib/metz/cop_metadata.rb
+- lib/metz/erb_ruby_extractor.rb
+- lib/metz/file_classifier.rb
+- lib/metz/haml_ruby_extractor.rb
+- lib/metz/slim_ruby_extractor.rb
+- lib/metz/template_ruby_extractor.rb
+- lib/rubocop-metz.rb
+- lib/rubocop/cop/metz/classes_too_long.rb
+- lib/rubocop/cop/metz/controllers_too_many_direct_collaborators.rb
+- lib/rubocop/cop/metz/demeter_train_wreck.rb
+- lib/rubocop/cop/metz/demeter_train_wreck/type_inference.rb
+- lib/rubocop/cop/metz/methods_too_long.rb
+- lib/rubocop/cop/metz/methods_too_many_parameters.rb
+- lib/rubocop/cop/metz/on_send_csend_bridge.rb
+- lib/rubocop/cop/metz/views_deep_navigation.rb
+- lib/rubocop/cop/metz_cops.rb
+- lib/rubocop/formatter/metz_json_formatter.rb
+- lib/rubocop/metz/plugin.rb
+- lib/rubocop/metz/version.rb
+- rubocop-metz.gemspec
+homepage: https://github.com/fuentesjr/metz-scan
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/fuentesjr/metz-scan
+  changelog_uri: https://github.com/fuentesjr/metz-scan/releases
+  bug_tracker_uri: https://github.com/fuentesjr/metz-scan/issues
+  github_repo: ssh://github.com/fuentesjr/metz-scan
+  github_package_uri: https://github.com/users/fuentesjr/packages/rubygems/package/rubocop-metz
+  default_lint_roller_plugin: RuboCop::Metz::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.8
+specification_version: 4
+summary: Sandi-Metz-inspired RuboCop cops.
+test_files: []