fastererer 0.12.0 → 1.1.0

data/lib/fastererer/rule_catalog.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Fastererer
+  class UnknownRuleError < StandardError; end
+
+  # Loads, validates, memoizes and looks up the rule catalog from the i18n locale.
+  module RuleCatalog
+    LOCALE_PATH = File.expand_path('../../config/locales/en.yml', __dir__)
+    KEY_SHAPE = /\A[a-z0-9_]+\z/
+    private_constant :KEY_SHAPE
+
+    class << self
+      def all
+        @all ||= load
+      end
+
+      def fetch(offense_name)
+        all.fetch(offense_name.to_s) do
+          raise UnknownRuleError, "Unknown rule: #{offense_name.inspect}"
+        end
+      end
+
+      # Guard-only: raises for an unknown rule, returns nil otherwise.
+      def validate!(offense_name)
+        fetch(offense_name)
+        nil
+      end
+
+      private
+
+      def load
+        rows = read_rows
+        rows.each { |key, row| validate_row!(key, row) }
+        rows.transform_values { |row| row.transform_values(&:freeze).freeze }.freeze
+      end
+
+      def read_rows
+        loaded = YAML.safe_load_file(LOCALE_PATH)
+        rows = loaded.is_a?(Hash) ? loaded.dig('en', 'fastererer', 'rules') : nil
+        return rows if rows.is_a?(Hash)
+
+        raise "Fastererer locale at #{LOCALE_PATH} is missing the 'en.fastererer.rules' section"
+      rescue Errno::ENOENT
+        raise "Fastererer locale file not found at #{LOCALE_PATH}"
+      rescue Psych::SyntaxError => e
+        raise "Fastererer locale at #{LOCALE_PATH} is not valid YAML: #{e.message}"
+      end
+
+      def validate_row!(key, row)
+        raise "Fastererer rule #{key} is malformed: #{row.inspect}" unless row.is_a?(Hash)
+        unless key.is_a?(String) && key.match?(KEY_SHAPE)
+          raise "Fastererer rule #{key.inspect} is not a snake_case key"
+        end
+
+        validate_url!(key, row['url'])
+        validate_description!(key, row['description'])
+      end
+
+      def validate_url!(key, url)
+        unless url.is_a?(String) && url.start_with?('https://')
+          raise "Fastererer rule #{key} has a non-https url: #{url.inspect}"
+        end
+
+        return if url.match?(/\A[[:print:]]+\z/)
+
+        raise "Fastererer rule #{key} has a non-printable url: #{url.inspect}"
+      end
+
+      def validate_description!(key, text)
+        return if text.is_a?(String) && text.match?(/\A[[:print:][:space:]]+\z/)
+
+        raise "Fastererer rule #{key} has a non-printable description: #{text.inspect}"
+      end
+
+      # Test-only hook: clears the memoized catalog so the YAML can be re-read.
+      def reset!
+        @all = nil
+      end
+    end
+  end
+end

data/lib/fastererer/rule_name.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Fastererer
+  # Derives a rubocop-style "Performance/PascalCase" display name from a snake_case rule key.
+  module RuleName
+    DEPARTMENT = 'Performance'
+
+    def self.from(offense_name)
+      "#{DEPARTMENT}/#{pascal_case(offense_name)}"
+    end
+
+    def self.pascal_case(name)
+      name.to_s.split('_').filter_map { |part| part.capitalize unless part.empty? }.join
+    end
+    private_class_method :pascal_case
+  end
+end

data/lib/fastererer/scanners/for_loop_scanner.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'fastererer/offense'
+require 'fastererer/scanners/offensive'
+
+module Fastererer
+  class ForLoopScanner
+    include Fastererer::Offensive
+
+    attr_reader :element
+
+    def initialize(element)
+      @element = element
+      check_offense
+    end
+
+    private
+
+    def check_offense
+      add_offense(:for_loop_vs_each) # for is always slower than each, so no guard
+    end
+  end
+end

data/lib/fastererer/scanners/method_call_scanner.rb

@@ -20,6 +20,7 @@ module Fastererer
       flatten: :check_flatten_offense,
       fetch: :check_fetch_offense,
       merge!: :check_merge_bang_offense,
+      update: :check_update_offense,
       last: :check_last_offense,
       include?: :check_range_include_offense
     }.freeze
@@ -33,7 +34,7 @@ module Fastererer
     end
 
     def method_call
-      @method_call ||= MethodCall.new(element)
+      @method_call ||= MethodCall.build(element)
     end
 
     private
@@ -74,9 +75,7 @@ module Fastererer
     end
 
     def check_first_offense
-      return unless method_call.receiver.is_a?(MethodCall)
-
-      case method_call.receiver.name
+      case method_call.receiver&.call_name
       when :shuffle
         add_offense(:shuffle_first_vs_sample)
       when :select
@@ -88,9 +87,7 @@ module Fastererer
     end
 
     def check_each_offense
-      return unless method_call.receiver.is_a?(MethodCall)
-
-      case method_call.receiver.name
+      case method_call.receiver&.call_name
       when :reverse
         add_offense(:reverse_each_vs_reverse_each)
       when :keys
@@ -99,8 +96,7 @@ module Fastererer
     end
 
     def check_flatten_offense
-      return unless method_call.receiver.is_a?(MethodCall)
-      return unless method_call.receiver.name == :map && method_call.arguments.one?
+      return unless method_call.receiver&.call_name == :map && method_call.arguments.one?
 
       add_offense(:map_flatten_vs_flat_map) if method_call.arguments.first.value == 1
     end
@@ -115,25 +111,25 @@ module Fastererer
       return unless method_call.arguments.one?
 
       first_argument = method_call.arguments.first
-      return unless first_argument.type == :hash
-      # each key and value is an item by itself.
-      return unless first_argument.element.drop(1).count == 2
+      return unless first_argument.type == :hash && first_argument.element.elements.one?
 
       add_offense(:hash_merge_bang_vs_hash_brackets)
     end
 
+    # Hash#update is a merge! alias but heavily overloaded, so require a provably-Hash receiver
+    def check_update_offense
+      check_merge_bang_offense if method_call.receiver&.hash?
+    end
+
     def check_last_offense
-      return unless method_call.receiver.is_a?(MethodCall)
-      return unless method_call.receiver.name == :select
+      return unless method_call.receiver&.call_name == :select
       return if method_call.arguments.any?
 
       add_offense(:select_last_vs_reverse_detect)
     end
 
     def check_range_include_offense
-      return unless method_call.receiver.is_a?(Primitive) && method_call.receiver.range?
-
-      add_offense(:include_vs_cover_on_range)
+      add_offense(:include_vs_cover_on_range) if method_call.receiver&.range?
     end
   end
 end

data/lib/fastererer/scanners/method_definition_scanner.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'prism'
 require 'fastererer/method_definition'
 require 'fastererer/method_call'
 require 'fastererer/offense'
@@ -27,33 +28,15 @@ module Fastererer
     end
 
     def scan_block_call_offense
-      traverse_tree(method_definition.body) do |element|
-        next unless element.sexp_type == :call
-
-        method_call = MethodCall.new(element)
-
-        if method_call.receiver.is_a?(Fastererer::VariableReference) &&
-           method_call.receiver.name == method_definition.block_argument_name &&
-           method_call.method_name == :call
-
-          add_offense(:proc_call_vs_yield) && return
-        end
-      end
+      visitor = ProcCallVisitor.new(method_definition.block_argument_name)
+      method_definition.body.each { |node| node.accept(visitor) }
+      add_offense(:proc_call_vs_yield) if visitor.proc_call_found?
     end
 
     def method_definition
       @method_definition ||= MethodDefinition.new(element)
     end
 
-    def traverse_tree(sexp_tree, &block)
-      sexp_tree.each do |element|
-        next unless element.is_a?(Array)
-
-        yield element
-        traverse_tree(element, &block)
-      end
-    end
-
     def scan_getter_and_setter_offense
       method_definition.setter? ? scan_setter_offense : scan_getter_offense
     end
@@ -69,12 +52,12 @@ module Fastererer
     end
 
     def trivial_setter?(first_argument)
-      body_first = method_definition.body.first
-      expected_ivar = "@#{method_definition.name.to_s.delete_suffix('=')}"
+      body_node = method_definition.body.first
+      return false unless body_node.is_a?(Prism::InstanceVariableWriteNode)
+      return false unless body_node.value.is_a?(Prism::LocalVariableReadNode)
 
-      body_first.sexp_type == :iasgn &&
-        body_first[1].to_s == expected_ivar &&
-        body_first[2][1] == first_argument.name
+      expected_ivar = :"@#{method_definition.name.to_s.delete_suffix('=')}"
+      body_node.name == expected_ivar && body_node.value.name == first_argument.name
     end
 
     def scan_getter_offense
@@ -85,10 +68,55 @@ module Fastererer
     end
 
     def trivial_getter?
-      body_first = method_definition.body.first
+      body_node = method_definition.body.first
+      expected_ivar = :"@#{method_definition.name}"
 
-      body_first.sexp_type == :ivar &&
-        body_first[1].to_s == "@#{method_definition.name}"
+      body_node.is_a?(Prism::InstanceVariableReadNode) && body_node.name == expected_ivar
     end
   end
+
+  # Finds `block_name.call` in a method body, without descending into nested def/class/module scopes
+  # where the block parameter is no longer in scope
+  class ProcCallVisitor < Prism::Visitor
+    def initialize(block_name)
+      super()
+      @block_name = block_name
+      @proc_call_found = false
+    end
+
+    def proc_call_found?
+      @proc_call_found
+    end
+
+    def visit_call_node(node)
+      @proc_call_found = true if proc_call?(node)
+      super
+    end
+
+    # No super on purpose: these open a new scope where the block param is unbound, so we stop
+    # descending rather than attribute their inner `name.call`s to the enclosing method.
+    def visit_def_node(_node)
+    end
+
+    def visit_class_node(_node)
+    end
+
+    def visit_module_node(_node)
+    end
+
+    def visit_singleton_class_node(_node)
+    end
+
+    private
+
+    def proc_call?(node)
+      return false if @block_name.nil? # an anonymous block param (&) is never invoked by name
+
+      node.receiver.is_a?(Prism::LocalVariableReadNode) &&
+        node.receiver.name == @block_name &&
+        node.name == :call
+    end
+  end
+
+  private_constant :ProcCallVisitor
 end

data/lib/fastererer/scanners/offensive.rb

@@ -14,12 +14,8 @@ module Fastererer
 
     private
 
-    def add_offense(offense_name, element_line_number = element.line)
-      self.offense = Fastererer::Offense.new(offense_name, element_line_number)
-    end
-
-    def check_offense
-      raise NotImplementedError
+    def add_offense(offense_name)
+      self.offense = Fastererer::Offense.new(offense_name, element.location.start_line)
     end
   end
 end

data/lib/fastererer/scanners/rescue_call_scanner.rb

@@ -18,7 +18,7 @@ module Fastererer
     private
 
     def check_offense
-      return unless rescue_call.rescue_classes.include? :NoMethodError
+      return unless rescue_call.rescue_classes.include?(:NoMethodError)
 
       add_offense(:rescue_vs_respond_to)
     end

data/lib/fastererer/scanners/symbol_to_proc_check.rb

@@ -1,35 +1,48 @@
 # frozen_string_literal: true
 
+require 'prism'
 require 'fastererer/method_call'
 
 module Fastererer
-  # Includer must respond to #method_call (returning a MethodCall) and #add_offense(symbol).
+  # Includer must respond to #method_call (returning a MethodCall) and #add_offense(symbol)
+  # (the latter via the Offensive mixin).
   module SymbolToProcCheck
     private
 
     def check_symbol_to_proc
       return unless symbol_to_proc_candidate?
 
-      body_call = MethodCall.new(method_call.block_body)
+      body_call = MethodCall.build(method_call.block_body.first)
       return unless symbol_to_proc_body?(body_call)
 
       add_offense(:block_vs_symbol_to_proc)
     end
 
     def symbol_to_proc_candidate?
-      method_call.block_argument_names.one? &&
-        !method_call.block_body.nil? &&
-        method_call.block_body.sexp_type == :call &&
+      single_block_argument_name &&
+        single_call_body? &&
         method_call.arguments.none? &&
         !method_call.lambda_literal?
     end
 
+    # A destructured param has no name, so |(a, b), c| must not read as a single-name block
+    def single_block_argument_name
+      names = method_call.block_argument_names
+      names.first if names.size == 1
+    end
+
+    # A safe-nav body (foo&.bar) is excluded: arr.map(&:bar) raises on a nil element, so the rewrite
+    # would not preserve behavior
+    def single_call_body?
+      body = method_call.block_body
+      body&.size == 1 && body.first.is_a?(Prism::CallNode) && !body.first.safe_navigation?
+    end
+
+    # A primitive receiver's name is nil, which never matches the named param the gate requires
     def symbol_to_proc_body?(body_call)
       body_call.arguments.none? &&
         !body_call.block? &&
-        !body_call.receiver.nil? &&
-        !body_call.receiver.is_a?(Fastererer::Primitive) &&
-        body_call.receiver.name == method_call.block_argument_names.first
+        body_call.receiver&.name == single_block_argument_name
     end
   end
 end

data/lib/fastererer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fastererer
-  VERSION = '0.12.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastererer
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Menefee
@@ -11,19 +11,19 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby_parser
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.22.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.22.0
+        version: 1.3.0
 description: Use Fastererer to check various places in your code that could be faster.
   A fork of fasterer (https://github.com/DamirSvrtan/fasterer) with Ruby 4.0 support
   and native Prism parsing.
@@ -35,28 +35,36 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".fastererer.yml"
-- ".ruby-version"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- SECURITY.md
+- config/locales/en.yml
 - exe/fastererer
 - lib/fastererer.rb
 - lib/fastererer/analyzer.rb
 - lib/fastererer/cli.rb
 - lib/fastererer/config.rb
+- lib/fastererer/explanation.rb
 - lib/fastererer/file_traverser.rb
+- lib/fastererer/finding.rb
+- lib/fastererer/formatters.rb
+- lib/fastererer/formatters/base.rb
+- lib/fastererer/formatters/json_formatter.rb
+- lib/fastererer/formatters/rdjsonl_formatter.rb
+- lib/fastererer/formatters/text_formatter.rb
+- lib/fastererer/formatters/text_statistics.rb
 - lib/fastererer/method_call.rb
 - lib/fastererer/method_definition.rb
 - lib/fastererer/offense.rb
 - lib/fastererer/offense_collector.rb
 - lib/fastererer/painter.rb
 - lib/fastererer/parser.rb
+- lib/fastererer/receiver.rb
+- lib/fastererer/report.rb
 - lib/fastererer/rescue_call.rb
+- lib/fastererer/rule_catalog.rb
+- lib/fastererer/rule_name.rb
+- lib/fastererer/scanners/for_loop_scanner.rb
 - lib/fastererer/scanners/method_call_scanner.rb
 - lib/fastererer/scanners/method_definition_scanner.rb
 - lib/fastererer/scanners/offensive.rb
@@ -86,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Run Ruby more than fast. Fastererer
 test_files: []

data/.fastererer.yml

@@ -1,27 +0,0 @@
-speedups:
-  rescue_vs_respond_to: true
-  module_eval: true
-  shuffle_first_vs_sample: true
-  for_loop_vs_each: true
-  each_with_index_vs_while: false
-  map_flatten_vs_flat_map: true
-  reverse_each_vs_reverse_each: true
-  select_first_vs_detect: true
-  select_last_vs_reverse_detect: true
-  sort_vs_sort_by: true
-  fetch_with_argument_vs_block: true
-  keys_each_vs_each_key: true
-  hash_merge_bang_vs_hash_brackets: true
-  block_vs_symbol_to_proc: true
-  proc_call_vs_yield: true
-  gsub_vs_tr: true
-  getter_vs_attr_reader: true
-  setter_vs_attr_writer: true
-
-exclude_paths:
-  - 'spec/support/analyzer/*.rb'
-  - 'spec/support/binary_call/*.rb'
-  - 'spec/support/method_call/*.rb'
-  - 'spec/support/method_definition/*.rb'
-  - 'spec/support/rescue_call/*.rb'
-  - 'vendor/**/*.rb'

data/.ruby-version

@@ -1 +0,0 @@
-4.0.4

data/CODE_OF_CONDUCT.md

@@ -1,18 +0,0 @@
-# Code of Conduct
-
-Fastererer follows [The Ruby Community Conduct Guideline][ruby-conduct] in all "collaborative
-space", which is defined as community communications channels (such as mailing lists, submitted
-patches, commit comments, etc.):
-
-* Participants will be tolerant of opposing views.
-* Participants must ensure that their language and actions are free of personal attacks and
-  disparaging personal remarks.
-* When interpreting the words and actions of others, participants should always assume good
-  intentions.
-* Behaviour which can be reasonably considered harassment will not be tolerated.
-
-If you have any concerns about behaviour within this project, please contact us at
-[matt.menefee@extractablemedia.com][email].
-
-[email]: mailto:matt.menefee@extractablemedia.com
-[ruby-conduct]: https://www.ruby-lang.org/en/conduct

data/CONTRIBUTING.md

@@ -1,63 +0,0 @@
-# Contributing to fastererer
-
-Thanks for your interest in improving `fastererer`. This document explains how to report issues
-and submit code.
-
-## Reporting Issues
-
-Before opening a new issue:
-
-1. Check the [existing issues][issues] to avoid duplicates.
-2. Confirm the bug reproduces on the latest release.
-
-When opening an issue, include:
-
-- The output of `fastererer --version`
-- Your Ruby version (`ruby --version`)
-- A minimal reproduction — the smallest Ruby snippet that triggers the behavior
-- The expected behavior and the actual behavior
-
-## Pull Requests
-
-1. Fork the repository and create a topic branch off `main`.
-2. Run `bin/setup` to install dependencies (or `bundle install` directly).
-3. Add tests that cover the change. Bug fixes should include a regression spec.
-4. Run the test suite with `bin/rspec` and make sure it passes.
-5. Update [CHANGELOG.md][changelog] under an unreleased heading describing the change.
-6. Submit the PR with a clear description of what changed and why.
-
-For non-trivial changes, consider opening an issue first to discuss the approach.
-
-## Local Development
-
-After cloning:
-
-```bash
-bin/setup            # installs dependencies
-bin/console          # opens an IRB session with the gem loaded
-bin/rake             # runs the test suite and rubocop (the default task)
-bin/rspec            # runs just the test suite
-bin/rubocop          # runs just the linter
-```
-
-To try the executable against a Ruby file:
-
-```bash
-bundle exec exe/fastererer path/to/file.rb
-```
-
-## Code Style
-
-- Follow the [Ruby Style Guide][ruby-style-guide].
-- Run `bin/rubocop` before submitting — CI runs the default rake task on every PR.
-- New Ruby files should start with `# frozen_string_literal: true`.
-- Tests use RSpec — see existing specs in `spec/` for examples and conventions.
-
-## Code of Conduct
-
-By participating in this project, you agree to abide by its [Code of Conduct][code-of-conduct].
-
-[changelog]: CHANGELOG.md
-[code-of-conduct]: CODE_OF_CONDUCT.md
-[issues]: https://github.com/ExtractableMedia/fastererer/issues
-[ruby-style-guide]: https://rubystyle.guide

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-desc 'Run all RSpec tests'
-RSpec::Core::RakeTask.new(:spec)
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/SECURITY.md

@@ -1,20 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Only the latest released version of `fastererer` receives security updates. Older versions are not
-supported.
-
-## Reporting a Vulnerability
-
-Please report security vulnerabilities **privately** rather than opening a public GitHub issue.
-
-The preferred channel is **GitHub Security Advisories**: [Report a vulnerability][advisory].
-
-If GitHub is unavailable, email [matt.menefee@extractablemedia.com][email].
-
-We will acknowledge receipt within a few business days and work with you on a coordinated disclosure
-timeline. Credit will be given in the release notes unless you prefer to remain anonymous.
-
-[advisory]: https://github.com/ExtractableMedia/fastererer/security/advisories/new
-[email]: mailto:matt.menefee@extractablemedia.com