yardcheck 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b594df9271ab2ef4f110b5fdaf97a44fc3e633a8
-  data.tar.gz: be08bcfad68850ed0adca3b1dba4e38562de2840
+  metadata.gz: fe668ef28d9117e65a7ef3507e3d43c5f19c817d
+  data.tar.gz: 3b03b4b15147cd4db2b7594b02e43f04f5d9f1e3
 SHA512:
-  metadata.gz: 5406813ffe5bda64d642a76cf9e6aab7c54fa0953e7bd693d5b98044048702cee8860c1af011fb48eb671a353d95b06e229b2996259180ac07e8ffb1cda68377
-  data.tar.gz: afc03fd46651422fbef24949eb940b175b4c6d62fb532c790b893482be060449d032c2202d02663c5f47f9dc2682069205da7cc5e403badaf66257ed78645bba
+  metadata.gz: 15f0d9b8d5bf900d1b8f090738bdb44f0a5d53d60636afe9b0a9e17ca1612902f4d3a96eaaa71e6a6ece59b46be94a3c0ccebf8c298e9551cfc92e0aa2880bee
+  data.tar.gz: 0411aa5a17f544b2f5ae3389ee8b84739c3cad5faeeb574b9794bc41ad321992a7465dd54deb0455485610145de0b69143ecc8fa9033cd5d7ab6c989afe72f1c

data/.buildkite/pipeline.yml

@@ -1,10 +1,10 @@
 steps:
-  - command: "build/run 2.3.3 'rspec'"
+  - command: "build/run 2.4.1 'rspec'"
     label: ":rspec: RSpec"
     agents:
       - queue=elastic
 
   - name: ':rubocop: Rubocop'
-    command: build/run 2.3.3 rubocop
+    command: build/run 2.4.1 rubocop
     agents:
       - queue=elastic

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.4.1

data/lib/yardcheck/method_call.rb

@@ -7,7 +7,7 @@ module Yardcheck
       :selector,
       :namespace,
       :params,
-      :example_location
+      :example_metadata
     )
 
     def self.process(params:, **attributes)
@@ -19,6 +19,14 @@ module Yardcheck
       new(params: params, **attributes)
     end
 
+    def example_location
+      example_metadata.fetch(:location)
+    end
+
+    def example_id
+      example_metadata.fetch(:id)
+    end
+
     def method_identifier
       [namespace, selector, scope]
     end

data/lib/yardcheck/method_tracer.rb

@@ -108,7 +108,10 @@ module Yardcheck
         scope:            event.defined_class.__send__(:singleton_class?) ? :class : :instance,
         selector:         event.method_id,
         namespace:        event.defined_class,
-        example_location: RSpec.current_example.location
+        example_metadata: {
+          location: RSpec.current_example.location,
+          id:       RSpec.current_example.id
+        }
       }
     end
 

data/lib/yardcheck/observation.rb

@@ -20,6 +20,10 @@ module Yardcheck
       event.example_location
     end
 
+    def test_id
+      event.example_id
+    end
+
     def method_shorthand
       documentation.shorthand
     end

data/lib/yardcheck/proxy.rb

@@ -11,7 +11,7 @@ module Yardcheck
     undef_method :!
 
     def method_missing(method_name, *args, &block)
-      if target_respond_to?(method_name)
+      if respond_to_missing?(method_name, true)
         @target.__send__(method_name, *args, &block)
       else
         ::Object
@@ -21,13 +21,20 @@ module Yardcheck
       end
     end
 
-    private
-
-    def target_respond_to?(method_name)
+    def respond_to_missing?(method_name, include_all = false)
       ::Object
         .instance_method(:respond_to?)
         .bind(@target)
-        .call(method_name, true)
+        .call(method_name, include_all)
+    end
+
+    private
+
+    def object_dispatch(receiver, method_name, *params)
+      ::Object
+        .instance_method(method_name)
+        .bind(receiver)
+        .call(*params)
     end
   end # Proxy
 end # Yardcheck

data/lib/yardcheck/version.rb

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

data/lib/yardcheck/violation.rb

@@ -5,9 +5,14 @@ module Yardcheck
     extend Color
     include Color
 
-    def initialize(observation, test_locations = [observation.test_location])
+    def initialize(
+      observation,
+      test_locations = [observation.test_location],
+      test_ids = [observation.test_id]
+    )
       @observation    = observation
       @test_locations = test_locations.sort.uniq
+      @test_ids       = test_ids.sort.uniq
     end
 
     def offense
@@ -16,23 +21,26 @@ module Yardcheck
 
       location_hint = indent(grey("source: #{observation.source_location}"))
       test_lines    = test_locations.map { |l| "  - #{l}" }.join("\n")
+
       tests_block   = "tests:\n#{test_lines}"
       test_hint     = indent(grey(tests_block))
 
-      "#{explanation}\n\n#{location_hint}\n#{test_hint}\n#{source}\n"
+      rerun_block   = indent(grey("rerun with:\n  #{rerun_command}"))
+
+      "#{explanation}\n\n#{location_hint}\n#{test_hint}\n#{rerun_block}\n#{source}\n"
     end
 
     def combine(other)
       fail 'Cannot combine' unless combine_with?(other)
 
-      with_tests(other.test_locations)
+      with_tests(other)
     end
 
     def combination_identifier
       combine_requirements.map(&method(:__send__))
     end
 
-    attr_reader :test_locations
+    attr_reader :test_locations, :test_ids
 
     private
 
@@ -43,7 +51,11 @@ module Yardcheck
     end
 
     def with_tests(other_test_locations)
-      self.class.new(observation, test_locations + other_test_locations)
+      self.class.new(observation, test_locations + other_test_locations, test_ids + other.test_ids)
+    end
+
+    def rerun_command
+      "rspec #{test_ids.map { |id| "'#{id}'" }.join(' ')}"
     end
 
     def indent(string)
@@ -70,7 +82,11 @@ module Yardcheck
         "#{yellow('%<signature>s')} but observed " \
         "#{red('%<observed_type>s')}"
 
-      def initialize(observation, test_locations = [observation.test_location])
+      def initialize(
+        observation,
+        test_locations = [observation.test_location],
+        test_ids = [observation.test_id]
+      )
         super
       end
 
@@ -103,10 +119,15 @@ module Yardcheck
     class Param < self
       include Equalizer.new(:name, :observation)
 
-      def initialize(name, observation, test_locations = [observation.test_location])
+      def initialize(
+        name,
+        observation,
+        test_locations = [observation.test_location],
+        test_ids = [observation.test_id]
+      )
         @name = name
 
-        super(observation, test_locations)
+        super(observation, test_locations, test_ids)
       end
 
       FORMAT =
@@ -136,11 +157,12 @@ module Yardcheck
         %i[name shorthand signature observed_type]
       end
 
-      def with_tests(other_test_locations)
+      def with_tests(other)
         self.class.new(
           name,
           observation,
-          test_locations + other_test_locations
+          test_locations + other.test_locations,
+          test_ids + other.test_ids
         )
       end
 

data/spec/integration/yardcheck_spec.rb

@@ -42,8 +42,10 @@ RSpec.describe 'test app integration' do
 
   it 'reports expectations' do
     aggregate_failures do
-      expect_report('Expected TestApp::Namespace#add to return String but observed Fixnum')
-      expect_report('Expected #<Class:TestApp::Namespace>#add to return String but observed Fixnum')
+      expect_report('Expected TestApp::Namespace#add to return String but observed Integer')
+      expect_report(
+        'Expected #<Class:TestApp::Namespace>#add to return String but observed Integer'
+      )
       expect_report(
         'Expected TestApp::Namespace#documents_relative ' \
         'to return TestApp::Namespace::Child but observed String'

data/spec/unit/yardcheck/method_tracer_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe Yardcheck::MethodTracer do
         namespace:        Foo.singleton_class,
         params:           { baz: 'Hello' },
         return_value:     'HELLO',
-        example_location: RSpec.current_example.location
+        example_metadata: { location: RSpec.current_example.location, id: RSpec.current_example.id }
       ),
       Yardcheck::MethodCall::Return.process(
         scope:            :instance,
@@ -50,7 +50,7 @@ RSpec.describe Yardcheck::MethodTracer do
         namespace:        Foo,
         params:           { baz: 'Hello' },
         return_value:     'HELLO',
-        example_location: RSpec.current_example.location
+        example_metadata: { location: RSpec.current_example.location, id: RSpec.current_example.id }
       )
     ])
   end

data/spec/unit/yardcheck/runner_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Yardcheck::Runner do
         namespace:        TestApp::Namespace,
         params:           { left: 'foo', right: 3 },
         return_value:     5,
-        example_location: 'test_app_spec.rb:1'
+        example_metadata: { location: 'test_app_spec.rb:1', id: 'test_app_spec.rb[1:1]' }
       ),
       Yardcheck::MethodCall::Return.process(
         scope:            :class,
@@ -33,18 +33,20 @@ RSpec.describe Yardcheck::Runner do
         namespace:        TestApp::Namespace.singleton_class,
         params:           { left: 2, right: 3 },
         return_value:     5,
-        example_location: 'test_app_spec.rb:2'
+        example_metadata: { location: 'test_app_spec.rb:2', id: 'test_app_spec.rb[1:2]' }
       )
     ]
   end
 
   let(:output) do
     <<~MSG
-      Expected #<Class:TestApp::Namespace>#add to return String but observed Fixnum
+      Expected #<Class:TestApp::Namespace>#add to return String but observed Integer
 
           source: ./test_app/lib/test_app.rb:15
           tests:
             - test_app_spec.rb:2
+          rerun with:
+            rspec 'test_app_spec.rb[1:2]'
 
           # Singleton method with correct param definition and incorrect return
           #
@@ -61,6 +63,8 @@ RSpec.describe Yardcheck::Runner do
           source: ./test_app/lib/test_app.rb:25
           tests:
             - test_app_spec.rb:1
+          rerun with:
+            rspec 'test_app_spec.rb[1:1]'
 
           # Instance method with correct param definition and incorrect return
           #
@@ -72,11 +76,13 @@ RSpec.describe Yardcheck::Runner do
             left + right
           end
 
-      Expected TestApp::Namespace#add to return String but observed Fixnum
+      Expected TestApp::Namespace#add to return String but observed Integer
 
           source: ./test_app/lib/test_app.rb:25
           tests:
             - test_app_spec.rb:1
+          rerun with:
+            rspec 'test_app_spec.rb[1:1]'
 
           # Instance method with correct param definition and incorrect return
           #
@@ -118,7 +124,7 @@ RSpec.describe Yardcheck::Runner do
           namespace:        TestApp::Namespace,
           params:           { left: 'foo', right: 3 },
           return_value:     'valid return type',
-          example_location: 'test_app_spec.rb:1'
+          example_metadata: { location: 'test_app_spec.rb:1', id: 'test_app_spec.rb[1:1]' }
         ),
         Yardcheck::MethodCall::Return.process(
           scope:            :instance,
@@ -126,7 +132,7 @@ RSpec.describe Yardcheck::Runner do
           namespace:        TestApp::Namespace,
           params:           { left: 'foo', right: 3 },
           return_value:     'valid return type',
-          example_location: 'test_app_spec.rb:2'
+          example_metadata: { location: 'test_app_spec.rb:2', id: 'test_app_spec.rb[1:2]' }
         ),
         Yardcheck::MethodCall::Return.process(
           scope:            :instance,
@@ -134,7 +140,7 @@ RSpec.describe Yardcheck::Runner do
           namespace:        TestApp::Namespace,
           params:           { left: 1, right: 'now this one is wrong' },
           return_value:     'valid return type',
-          example_location: 'test_app_spec.rb:3'
+          example_metadata: { location: 'test_app_spec.rb:3', id: 'test_app_spec.rb[1:3]' }
         )
       ]
     end
@@ -147,6 +153,8 @@ RSpec.describe Yardcheck::Runner do
             tests:
               - test_app_spec.rb:1
               - test_app_spec.rb:2
+            rerun with:
+              rspec 'test_app_spec.rb[1:1]' 'test_app_spec.rb[1:2]'
 
             # Instance method with correct param definition and incorrect return
             #
@@ -163,6 +171,8 @@ RSpec.describe Yardcheck::Runner do
             source: ./test_app/lib/test_app.rb:25
             tests:
               - test_app_spec.rb:3
+            rerun with:
+              rspec 'test_app_spec.rb[1:3]'
 
             # Instance method with correct param definition and incorrect return
             #

data/test_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    yardcheck (0.0.1)
+    yardcheck (0.0.3)
       anima (~> 0.3)
       coderay (~> 1.1)
       concord (~> 0.1)
@@ -26,7 +26,7 @@ GEM
     concord (0.1.5)
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     equalizer (0.0.11)
     ice_nine (0.11.2)
     memoizable (0.4.2)
@@ -41,19 +41,19 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     slop (3.6.0)
     thread_safe (0.3.6)
     yard (0.9.8)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yardcheck
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Validate YARD docs by running specs