rspectre 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0605c2e9efccc4a2b34893deb51bc2799504b56458b3ce954057b434cb5fd93
-  data.tar.gz: b67d394f99ab11d29eae2327604ae70cde200268bd8f892138c44c95f45fedd4
+  metadata.gz: 87d88a2681d80d0f13e8cad1a0b5147c92d0ced19dede1657a74261cd4f9a8ae
+  data.tar.gz: 865b52f9b37fd3fa54b154dedb4196a4ce5bfcf20a0e8b8493e6bcd3611e8690
 SHA512:
-  metadata.gz: e0b080c91cd39d1b2649b55b3c92cbd68a2c43fae4b28829936b005da721d9a756541a5dbf6901f73960e4ac8507a1d4c5f197bc760d52dcd1e451c96a7fe8f7
-  data.tar.gz: 485ed75293bcb98bdd40d7e5b6ac18d8bd2c015f9a110937ec92d05ea21526ad4d192553a38374edd3e889599cef7c4ff991432548a725cd38fda4994b7f9e21
+  metadata.gz: cebc09f233bd5f6f2fd76c6f0741866472badae3a6a8f9c6012cfac379af4f2c4585827e0f73b0cd0e3b39848c0376dead07fad7bbd209666f10d8cc3242ed55
+  data.tar.gz: '09049b6500de8e538fa07a7e110e4671392e209b4345d1da8253c15901ce9af450cc54cfc330f19bcff1c5d05dd129df62ebcdc34c850d4daa92fa94e15056db'

data/bin/rspectre

@@ -20,8 +20,8 @@ OptionParser.new do |opts|
   opts.on(
     '--auto-correct',
     'Enables auto-correct.',
-    'When auto-correct is enabled, rspectre will modify your source files in place and delete any'\
-    ' unused test setup.'
+    'When auto-correct is enabled, rspectre will modify your source files in place and delete ' \
+    'any unused test setup.'
   ) do |value|
     options[:'auto-correct'] = value
   end
@@ -29,4 +29,4 @@ end.parse(ARGV)
 
 rspec, auto_correct = options.fetch_values(:rspec, :'auto-correct')
 
-RSpectre::Runner.new(rspec, auto_correct).lint
+RSpectre::Runner.new(rspec_arguments: rspec, auto_correct: auto_correct).lint

data/lib/rspectre/auto_corrector.rb

@@ -2,19 +2,20 @@
 
 module RSpectre
   class AutoCorrector < Parser::TreeRewriter
-    include Concord.new(:filename, :nodes, :buffer)
+    include KeywordStruct.new(:filename, :nodes, :buffer)
 
     def initialize(filename, nodes)
       buffer = Parser::Source::Buffer.new("(#{filename})")
       buffer.source = File.read(filename)
 
-      super(filename, nodes, buffer)
+      super(filename: filename, nodes: nodes, buffer: buffer)
     end
 
     def correct
-      File.open(filename, 'w') do |file|
-        file.write(rewrite(buffer, Parser::CurrentRuby.new.parse(buffer)))
-      end
+      File.write(
+        filename,
+        rewrite(buffer, Parser::CurrentRuby.new.parse(buffer))
+      )
     end
 
     def on_block(node)

data/lib/rspectre/keyword_struct.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RSpectre
+  # Heavily influenced by dkubb/equalizer, mbj/concord, and mbj/anima
+  class KeywordStruct < Module
+    def initialize(*names) # rubocop:disable Lint/MissingSuper
+      raise 'Specify at least one keyword name!' if names.empty?
+
+      names.each do |name|
+        next if /\A\w+\z/.match?(name)
+
+        raise "Invalid keyword name #{name.inspect}!"
+      end
+
+      @module =
+        Module.new do
+          attr_reader(*names)
+
+          define_method(:eql?) do |other|
+            other.instance_of?(self.class) && names.all? do |name|
+              __send__(name).eql?(other.__send__(name))
+            end
+          end
+          alias_method :==, :eql?
+
+          define_method(:hash) do
+            [self.class, *names.map { |name| __send__(name) }].hash
+          end
+
+          define_method(:inspect) do
+            class_name = self.class.name || self.class.inspect
+            attributes = names.map { |name| "#{name}=#{__send__(name).inspect}" }.join(' ')
+            "#<#{class_name} #{attributes}>"
+          end
+        end.tap do |generated_module|
+          generated_module.class_eval(<<~RUBY, __FILE__, __LINE__ + 1) # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def initialize(#{names.map { |name| "#{name}:" }.join(', ')})
+              #{names.map { |name| "@#{name} = #{name}" }.join("\n  ")}
+            end
+          RUBY
+        end
+    end
+
+    def included(descendant)
+      descendant.include(@module)
+    end
+  end
+end

data/lib/rspectre/linter/unused_shared_setup.rb

@@ -10,21 +10,21 @@ module RSpectre
         original_method = receiver.method(method)
 
         # Overwrite the class method using define_singleton_method
-        receiver.__send__(:define_singleton_method, method) do |name, *args, &block|
+        receiver.__send__(:define_singleton_method, method) do |name, *args, **kwargs, &block|
           # When we can locate the source of the node, tag it
           if (node = UnusedSharedSetup.register(method, caller_locations))
-            # And call the orignal
-            original_method.(name, *args) do |*shared_args|
+            # And call the original
+            original_method.(name, *args, **kwargs) do |*shared_args, **shared_kwargs|
               # But record that it was used in a `before`
               before { UnusedSharedSetup.record(node) }
 
               # And then perform the original block in a `class_exec` like the original block was
               # supposed to be
-              class_exec(*shared_args, &block)
+              class_exec(*shared_args, **shared_kwargs, &block)
             end
           else
             # If we couldn't locate the source, just delegate to the original method.
-            original_method.(name, *args, &block)
+            original_method.(name, *args, **kwargs, &block)
           end
         end
       end
@@ -46,39 +46,39 @@ module RSpectre
       # terms of the old method. I think we can probably do some kind of module inclusion to reduce
       # this duplication (which is effectively what happens here anyway, i think), but this works
       # for now.
-      def example_group.shared_examples(name, *args, &block)
+      def example_group.shared_examples(name, *args, **kwargs, &block)
         if (node = UnusedSharedSetup.register(:shared_examples, caller_locations))
-          super(name, *args) do |*shared_args|
+          super(name, *args, **kwargs) do |*shared_args, **shared_kwargs|
             before { UnusedSharedSetup.record(node) }
 
-            class_exec(*shared_args, &block)
+            class_exec(*shared_args, **shared_kwargs, &block)
           end
         else
-          super(name, *args, &block)
+          super(name, *args, **kwargs, &block)
         end
       end
 
-      def example_group.shared_examples_for(name, *args, &block)
+      def example_group.shared_examples_for(name, *args, **kwargs, &block)
         if (node = UnusedSharedSetup.register(:shared_examples_for, caller_locations))
-          super(name, *args) do |*shared_args|
+          super(name, *args, **kwargs) do |*shared_args, **shared_kwargs|
             before { UnusedSharedSetup.record(node) }
 
-            class_exec(*shared_args, &block)
+            class_exec(*shared_args, **shared_kwargs, &block)
           end
         else
-          super(name, *args, &block)
+          super(name, *args, **kwargs, &block)
         end
       end
 
-      def example_group.shared_context(name, *args, &block)
+      def example_group.shared_context(name, *args, **kwargs, &block)
         if (node = UnusedSharedSetup.register(:shared_context, caller_locations))
-          super(name, *args) do |*shared_args|
+          super(name, *args, **kwargs) do |*shared_args, **shared_kwargs|
             before { UnusedSharedSetup.record(node) }
 
-            class_exec(*shared_args, &block)
+            class_exec(*shared_args, **shared_kwargs, &block)
           end
         else
-          super(name, *args, &block)
+          super(name, *args, **kwargs, &block)
         end
       end
     end

data/lib/rspectre/linter.rb

@@ -19,12 +19,12 @@ module RSpectre
       raw_node = node_map(file).find_method(selector, line)
 
       if raw_node
-        node = RSpectre::Node.new(file, line, raw_node)
+        node = RSpectre::Node.new(file: file, line: line, node: raw_node)
         TRACKER.register(self::TAG, node)
         if block_given?
           yield node
         else
-          return node
+          node
         end
       end
     end
@@ -40,10 +40,10 @@ module RSpectre
     def self.prepend_behavior(scope, method_name)
       original_method = scope.instance_method(method_name)
 
-      scope.__send__(:define_method, method_name) do |*args, &block|
+      scope.__send__(:define_method, method_name) do |*args, **kwargs, &block|
         yield
 
-        original_method.bind(self).(*args, &block)
+        original_method.bind_call(self, *args, **kwargs, &block)
       end
     end
 

data/lib/rspectre/node.rb

@@ -2,7 +2,7 @@
 
 module RSpectre
   class Node
-    include Concord::Public.new(:file, :line, :node)
+    include KeywordStruct.new(:file, :line, :node)
 
     def start_column
       location.column + 1
@@ -27,7 +27,11 @@ module RSpectre
     end
 
     def location
-      node.children.first.location
+      if node.type.equal?(:block)
+        node.children.first.location
+      else
+        node.location
+      end
     end
   end
 end

data/lib/rspectre/offense.rb

@@ -2,13 +2,13 @@
 
 module RSpectre
   class Offense
-    include Anima.new(:file, :line, :source_line, :start_column, :end_column, :type)
+    include KeywordStruct.new(:file, :line, :source_line, :start_column, :end_column, :type)
 
     DESCRIPTIONS = {
       'UnusedLet'         => 'Unused `let` definition.',
       'UnusedSubject'     => 'Unused `subject` definition.',
-      'UnusedSharedSetup' => 'Unused `shared_examples`, `shared_examples_for`, or'\
-                             ' `shared_context` definition.'
+      'UnusedSharedSetup' => 'Unused `shared_examples`, `shared_examples_for`, or ' \
+                             '`shared_context` definition.'
     }.freeze
 
     def self.parse(type, node)
@@ -23,19 +23,17 @@ module RSpectre
     end
 
     def warn
-      puts to_s
+      puts self
     end
 
-    # rubocop:disable Layout/IndentHeredoc
     def to_s
       <<~DOC
 
-          #{source_id}: #{offense_type}: #{description}
-              #{source_line}
-              #{highlight}
+        #{source_id}: #{offense_type}: #{description}
+            #{source_line}
+            #{highlight}
       DOC
     end
-    # rubocop:enable Layout/IndentHeredoc
 
     def description
       DESCRIPTIONS.fetch(type)

data/lib/rspectre/runner.rb

@@ -2,11 +2,11 @@
 
 module RSpectre
   class Runner
-    include Concord.new(:rspec_arguments, :auto_correct)
+    include KeywordStruct.new(:rspec_arguments, :auto_correct)
 
     EXIT_SUCCESS = 0
 
-    def initialize(*)
+    def initialize(**)
       super
       @rspec_output = StringIO.new
     end
@@ -39,7 +39,7 @@ module RSpectre
 
       abort(
         Color.red(
-          'Running the specs failed. Either your tests do not pass '\
+          'Running the specs failed. Either your tests do not pass ' \
           'normally or this is a bug in RSpectre.'
         ) + <<~TEXT
 

data/lib/rspectre/source_map/parser.rb

@@ -3,7 +3,7 @@
 module RSpectre
   class SourceMap
     class Parser
-      include Concord.new(:file)
+      include KeywordStruct.new(:file)
 
       def populate(map)
         walk(parsed_source) { |node| map.add(node) }

data/lib/rspectre/source_map.rb

@@ -2,15 +2,15 @@
 
 module RSpectre
   class SourceMap
-    include Concord.new(:map)
+    include KeywordStruct.new(:map)
 
     def initialize
-      super(Hash.new { [] })
+      super(map: Hash.new { [] })
     end
     private_class_method :new
 
     def self.parse(file)
-      self::Parser.new(file).populate(new)
+      self::Parser.new(file: file).populate(new)
     end
 
     def add(node)
@@ -20,20 +20,47 @@ module RSpectre
     end
 
     def find_method(target_selector, line)
-      block_nodes(line).select do |node|
-        send, = *node
-        _receiver, selector = *send
+      candidates = find_methods(target_selector, line)
 
-        selector.equal?(target_selector)
-      end.first
+      if candidates.one?
+        candidates.first
+      else
+        warn Color.yellow("Unable to resolve `#{target_selector}` on line #{line}.")
+      end
     end
 
     private
 
+    def find_methods(target_selector, line)
+      block_candidates =
+        block_nodes(line).select do |node|
+          send, = *node
+          matching_send?(send, target_selector)
+        end
+
+      if block_candidates.any?
+        block_candidates
+      else
+        send_nodes(line).select do |node|
+          matching_send?(node, target_selector)
+        end
+      end
+    end
+
+    def matching_send?(node, method_name)
+      _receiver, selector = *node
+
+      selector.equal?(method_name)
+    end
+
     def block_nodes(line)
       map.fetch(line, []).select { |node| node.type.equal?(:block) }
     end
 
+    def send_nodes(line)
+      map.fetch(line, []).select { |node| node.type.equal?(:send) }
+    end
+
     class Null < self
       public_class_method :new
 

data/lib/rspectre/tracker.rb

@@ -2,10 +2,10 @@
 
 module RSpectre
   class Tracker
-    include Concord.new(:registry, :tracker)
+    include KeywordStruct.new(:registry, :tracker)
 
     def initialize
-      super(Hash.new { Set.new }, Hash.new { Set.new })
+      super(registry: Hash.new { Set.new }, tracker: Hash.new { Set.new })
     end
 
     def register(type, node)

data/lib/rspectre/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSpectre
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/lib/rspectre.rb

@@ -6,11 +6,11 @@ require 'pathname'
 require 'set'
 require 'stringio'
 
-require 'anima'
-require 'concord'
 require 'parser/current'
 require 'rspec'
 
+require 'rspectre/keyword_struct'
+
 require 'rspectre/auto_corrector'
 require 'rspectre/color'
 require 'rspectre/node'

metadata

@@ -1,113 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rspectre
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Gollahon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2023-05-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: anima
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: concord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 3.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 3.2.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 1.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 1.51.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 2.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 2.22.0
 description:
 email:
 executables:
@@ -119,6 +91,7 @@ files:
 - lib/rspectre.rb
 - lib/rspectre/auto_corrector.rb
 - lib/rspectre/color.rb
+- lib/rspectre/keyword_struct.rb
 - lib/rspectre/linter.rb
 - lib/rspectre/linter/unused_let.rb
 - lib/rspectre/linter/unused_shared_setup.rb
@@ -134,7 +107,8 @@ files:
 homepage: http://github.com/dgollahon/rspectre
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -143,14 +117,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A tool for linting RSpec test suites.