reek 6.3.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1093258cb1b25a91e16e800eabcee4087d4ae8830d579decc6b11433b6fd9c4
-  data.tar.gz: ea2c3a5e1f51edd9bdfcb1fe973b4d08210491f34bcfb26278bc970cd61325bf
+  metadata.gz: 3cd53c902c108773156429c3aacbb8aaa12f7e0c8f22966f833e4ade893ad5ce
+  data.tar.gz: 765ece4c34e29251afb173e37616b3be740e8f8035394958d7df5d3d6b4f1473
 SHA512:
-  metadata.gz: 56e29753527fc67429285f7da3537411ac951567d41a59024895fefa4287523e67c8c78332bc46375b4b6b154bf68bb6b5d6665f10cadec4f86654e0f5ea0a00
-  data.tar.gz: e2b1f0f40d67f5ba966f527d9afdd1a18e6c6150ade2658a5316750f1d03ca5aef7580a82f59d59e617c581323dff8ef0b7d71ea070442a45cc924649edf32e7
+  metadata.gz: db05cf1c8d8186cd2c1a36e68afe5a628458332e275ef87b0681903f05dbaad1f0d6228aaaa6257cf706d3d07e3efbfaab0f2c9f1c37ebc9284312be942ff182
+  data.tar.gz: 4826674e1ac0dffa73f6856403b7254f52f3a066ba75cb4968e5a836d58995229fa3a31d66beece59afa80648506ef310fa15476a97e5283a84303ba710ffa53

data/.github/workflows/ruby.yml

@@ -11,6 +11,7 @@ name: CI
     branches: [master]
   schedule:
     - cron: '16 4 12 * *'
+  workflow_dispatch:
 
 env:
   CUCUMBER_PUBLISH_QUIET: true
@@ -22,7 +23,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "jruby-9.4", "3.3"]
+        ruby: ["3.1", "3.2", "jruby-9.4", "3.3", "3.4"]
 
     steps:
       - uses: actions/checkout@v4

data/.gitignore

@@ -11,7 +11,6 @@ coverage
 Gemfile.lock
 *.swp
 tags
-.pryrc
 .tags*
 .DS_Store
 .idea/

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_mode:
   merge:
     - Exclude
 
-require:
+plugins:
   - rubocop-rspec
   - rubocop-performance
 
@@ -12,7 +12,7 @@ AllCops:
   Exclude:
     - 'samples/**/*'
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
 
 # Tables are nice
 Layout/HashAlignment:
@@ -84,13 +84,6 @@ RSpec/ExampleLength:
 Style/AndOr:
   EnforcedStyle: conditionals
 
-# Require comment for files in lib and bin
-Style/FrozenStringLiteralComment:
-  Include:
-    - 'bin/*'
-    - 'lib/**/*'
-  EnforcedStyle: always
-
 # Allow multiline block chains
 Style/MultilineBlockChain:
   Enabled: false

data/.simplecov

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SimpleCov.start do
   track_files 'lib/**/*.rb'
   add_filter 'lib/reek/version.rb' # version.rb is loaded too early to test

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 
 # Change log
 
+## 6.5.0 (2025-03-24)
+
+### Features and bugfixes
+
+* Loosen up Gemfile dependencies by [mvz])
+
+## 6.4.0 (2025-01-12)
+
+### Features and bugfixes
+
+* Fix DataClump smell in Reek::AST::Node class ([#1799] by [le-santos])
+
 ## 6.3.0 (2024-01-28)
 
 ### Features and bugfixes

data/Gemfile

@@ -1,30 +1,22 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-ruby RUBY_VERSION
-
-group :development do
-  gem 'aruba',                 '~> 2.1'
-  gem 'bigdecimal',            '>= 2.0.0', '< 4.0'
-  gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              '~> 9.0'
-  gem 'kramdown',              '~> 2.1'
-  gem 'kramdown-parser-gfm',   '~> 1.0'
-  gem 'rake',                  '~> 13.0'
-  gem 'rspec',                 '~> 3.0'
-  gem 'rspec-benchmark',       '~> 0.6.0'
-  gem 'rubocop',               '~> 1.60.2'
-  gem 'rubocop-performance',   '~> 1.20.0'
-  gem 'rubocop-rspec',         '~> 2.26.0'
-  gem 'simplecov',             '>= 0.18.0', '< 0.23.0'
-  gem 'yard',                  '~> 0.9.5'
-
-  platforms :mri do
-    gem 'redcarpet', '~> 3.4'
-  end
-end
+gem 'aruba',                 '~> 2.1'
+gem 'codeclimate-engine-rb', '~> 0.4.0'
+gem 'cucumber',              '~> 9.0'
+gem 'kramdown',              '~> 2.1'
+gem 'kramdown-parser-gfm',   '~> 1.0'
+gem 'rake',                  '~> 13.0'
+gem 'rspec',                 '~> 3.0'
+gem 'rspec-benchmark',       '~> 0.6.0'
+gem 'rubocop',               '~> 1.72.2'
+gem 'rubocop-performance',   '~> 1.24.0'
+gem 'rubocop-rspec',         '~> 3.5.0'
+gem 'simplecov',             '~> 0.22.0'
+gem 'yard',                  '~> 0.9.5'
 
-group :debugging do
-  gem 'pry', '~> 0.14.0'
-end
+# Needed for YARD to properly parse GFM code blocks in the documentation
+gem 'redcarpet', '~> 3.4', platform: :mri

data/README.md

@@ -94,7 +94,7 @@ demo.rb -- 2 warnings:
 
 ## Supported Ruby versions
 
-Reek is officially supported for CRuby 2.6 through 3.1 and for JRuby 9.3.
+Reek is officially supported for CRuby 3.0 through 3.3 and for JRuby 9.4.
 Other Ruby implementations (like Rubinius) are not officially supported but
 should work as well.
 
@@ -514,18 +514,15 @@ Another useful Rake task is the `console` task. This will throw you right into a
 ```
 bundle exec rake console
 
-[3] pry(main)> require_relative 'lib/reek/examiner'
-=> true
-[4] pry(main)> Reek::Examiner
+irb(main):001> Reek::Examiner
 => Reek::Examiner
 ```
 
-You can also use Pry while running the tests by adding the following at the
+You can also use IRB while running the tests by adding the following at the
 point where you want to start debugging:
 
 ```ruby
-require 'pry'
-binding.pry
+binding.irb
 ```
 
 Have a look at our [Developer API](docs/API.md) for more inspiration.
@@ -556,13 +553,14 @@ e.g., `codeclimate analyze -e duplication`
 
 ## Output formats
 
-Reek supports 5 output formats:
+Reek supports 6 output formats:
 
 * plain text (default)
-* HTML (`--format html`)
-* YAML (`--format yaml`, see also [YAML Reports](docs/YAML-Reports.md))
-* JSON (`--format json`)
-* XML  (`--format xml`)
+* HTML   (`--format html`)
+* YAML   (`--format yaml`, see also [YAML Reports](docs/YAML-Reports.md))
+* JSON   (`--format json`)
+* XML    (`--format xml`)
+* GitHub (`--format github`)
 
 ## Working with Rails
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/clean'
 

data/docs/yard_plugin.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'yard'
+
+# Template helper to modify processing of links in HTML generated from our
+# markdown files.
+module LocalLinkHelper
+  # Rewrites links to (assumed local) markdown files so they're processed as
+  # {file: } directives.
+  def resolve_links(text)
+    text = text.gsub(%r{<a href="([^"]*.md)">([^<]*)</a>}, '{file:\1 \2}')
+    super
+  end
+end
+
+YARD::Templates::Template.extra_includes << LocalLinkHelper
+YARD::Tags::Library.define_tag('Guaranteed public API', :public)
+YARD::Tags::Library.define_tag('Code quality configuration', :quality)
+YARD::Templates::Engine.register_template_path File.join(File.dirname(__FILE__), 'templates')

data/lib/reek/ast/node.rb

@@ -9,6 +9,11 @@ module Reek
     # methods to ease the transition from Sexp to AST::Node.
     #
     class Node < ::Parser::AST::Node
+      # Struct representing the rules for the search performed by each_node method.
+      NodeLookupRule = Struct.new(:target_types, :ignoring)
+
+      private_constant :NodeLookupRule
+
       def initialize(type, children = [], options = {})
         @comments = options.fetch(:comments, [])
         super
@@ -62,7 +67,8 @@ module Reek
       def each_node(target_types, ignoring = [], &blk)
         return enum_for(:each_node, target_types, ignoring) unless blk
 
-        look_for(Array(target_types), ignoring, &blk)
+        lookup_rule = NodeLookupRule.new(Array(target_types), ignoring)
+        look_for(lookup_rule, &blk)
       end
 
       def contains_nested_node?(target_type)
@@ -108,23 +114,23 @@ module Reek
       protected
 
       # See ".each_node" for documentation.
-      def look_for(target_types, ignoring, &blk)
-        if target_types.include? type
+      def look_for(lookup_rule, &blk)
+        if lookup_rule.target_types.include?(type)
           yield self
-          return if ignoring.include?(type)
+          return if lookup_rule.ignoring.include?(type)
         end
         each_sexp do |elem|
-          elem.look_for_recurse(target_types, ignoring, &blk)
+          elem.look_for_recurse(lookup_rule, &blk)
         end
       end
 
       # See ".each_node" for documentation.
-      def look_for_recurse(target_types, ignoring, &blk)
-        yield self if target_types.include? type
-        return if ignoring.include? type
+      def look_for_recurse(lookup_rule, &blk)
+        yield self if lookup_rule.target_types.include?(type)
+        return if lookup_rule.ignoring.include?(type)
 
         each_sexp do |elem|
-          elem.look_for_recurse(target_types, ignoring, &blk)
+          elem.look_for_recurse(lookup_rule, &blk)
         end
       end
 

data/lib/reek/cli/options.rb

@@ -131,9 +131,9 @@ module Reek
       def set_alternative_formatter_options
         parser.separator "\nReport format:"
         parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml, :github],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json', '  xml') do |opt|
+          '  html', '  text (default)', '  yaml', '  json', '  xml', '  github') do |opt|
           self.report_format = opt
         end
       end

data/lib/reek/context/code_context.rb

@@ -38,9 +38,9 @@ module Reek
       # @param type [Symbol] the type of the nodes we are looking for, e.g. :defs.
       # @yield block that is executed for every node.
       #
-      def local_nodes(type, ignored = [], &blk)
+      def local_nodes(type, ignored = [], &)
         ignored |= [:class, :module]
-        exp.each_node(type, ignored, &blk)
+        exp.each_node(type, ignored, &)
       end
 
       # Iterate over `self` and child contexts.

data/lib/reek/report/github_report.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Displays smells as GitHub Workflow commands.
+    #
+    # @public
+    #
+    class GithubReport < BaseReport
+      def show(out = $stdout)
+        out.print(workflow_commands.join)
+      end
+
+      private
+
+      def workflow_commands
+        smells.map do |smell|
+          WorkflowCommand.new(smell)
+        end
+      end
+
+      # Represents a smell as a GitHub Workflow command.
+      class WorkflowCommand
+        def initialize(smell)
+          @smell = smell
+        end
+
+        def to_s
+          format(
+            "::warning file=%<file>s,line=%<line>d::%<message>s\n",
+            file: file,
+            line: line,
+            message: message)
+        end
+
+        private
+
+        def file
+          @smell.source
+        end
+
+        def line
+          @smell.lines.first
+        end
+
+        def message
+          @smell.base_message.gsub('%', '%25').gsub("\r", '%0D').gsub("\n", '%0A')
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/text_report.rb

@@ -20,7 +20,7 @@ module Reek
       # @public
       def add_examiner(examiner)
         print progress_formatter.progress examiner
-        super(examiner)
+        super
       end
 
       # @public

data/lib/reek/report.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'report/github_report'
 require_relative 'report/html_report'
 require_relative 'report/json_report'
 require_relative 'report/text_report'
@@ -16,11 +17,12 @@ module Reek
   # Reek reporting functionality.
   module Report
     REPORT_CLASSES = {
-      yaml: YAMLReport,
-      json: JSONReport,
-      html: HTMLReport,
-      xml:  XMLReport,
-      text: TextReport
+      yaml:   YAMLReport,
+      json:   JSONReport,
+      html:   HTMLReport,
+      xml:    XMLReport,
+      text:   TextReport,
+      github: GithubReport
     }.freeze
 
     LOCATION_FORMATTERS = {

data/lib/reek/smell_detectors/data_clump.rb

@@ -84,7 +84,7 @@ module Reek
       end
 
       def candidate_clumps
-        candidate_methods.each_cons(max_copies + 1).map do |methods|
+        candidate_methods.combination(max_copies + 1).map do |methods|
           common_argument_names_for(methods)
         end.select do |clump|
           clump.length >= min_clump_size

data/lib/reek/smell_detectors/uncommunicative_module_name.rb

@@ -31,7 +31,7 @@ module Reek
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
       def self.default_config
-        super().merge(
+        super.merge(
           REJECT_KEY => DEFAULT_REJECT_PATTERNS,
           ACCEPT_KEY => DEFAULT_ACCEPT_PATTERNS)
       end

data/lib/reek/source/source_code.rb

@@ -75,11 +75,17 @@ module Reek
 
       def code
         @code ||=
-          case source
-          when File, Pathname then source.read
-          when IO             then source.readlines.join
-          when String         then source
-          end.force_encoding(Encoding::UTF_8)
+          begin
+            str =
+              case source
+              when File, Pathname then source.read
+              when IO             then source.readlines.join
+              when String         then source
+              end
+
+            str = str.dup if str.frozen?
+            str.force_encoding(Encoding::UTF_8)
+          end
       end
 
       attr_reader :parser, :source

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '6.3.0'
+    STRING = '6.5.0'
   end
 end

data/reek.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/reek/version'
 
 Gem::Specification.new do |spec|
@@ -17,10 +19,11 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples|docs|tasks)/}) }
   end
+  spec.files << Dir['docs/yard_plugin.rb']
 
   spec.executables = spec.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   spec.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   spec.metadata = {
     'homepage_uri'          => 'https://github.com/troessner/reek',
@@ -31,8 +34,9 @@ Gem::Specification.new do |spec|
     'rubygems_mfa_required' => 'true'
   }
 
-  spec.add_runtime_dependency 'dry-schema', '~> 1.13.0'
-  spec.add_runtime_dependency 'parser',  '~> 3.3.0'
-  spec.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
-  spec.add_runtime_dependency 'rexml',   '~> 3.1'
+  spec.add_dependency 'dry-schema', '~> 1.13'
+  spec.add_dependency 'logger',  '~> 1.6'
+  spec.add_dependency 'parser',  '~> 3.3.0'
+  spec.add_dependency 'rainbow', '>= 2.0', '< 4.0'
+  spec.add_dependency 'rexml',   '~> 3.1'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.5.0
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
 - Piotr Szotkowski
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema
@@ -19,14 +19,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ files:
 - Rakefile
 - bin/code_climate_reek
 - bin/reek
+- docs/yard_plugin.rb
 - engine.json
 - lib/reek.rb
 - lib/reek/ast/ast_node_class_map.rb
@@ -186,6 +201,7 @@ files:
 - lib/reek/report.rb
 - lib/reek/report/base_report.rb
 - lib/reek/report/documentation_link_warning_formatter.rb
+- lib/reek/report/github_report.rb
 - lib/reek/report/heading_formatter.rb
 - lib/reek/report/html_report.rb
 - lib/reek/report/html_report/html_report.html.erb
@@ -258,7 +274,7 @@ metadata:
   changelog_uri: https://github.com/troessner/reek/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/reek
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.md
@@ -270,15 +286,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []