yardcheck 0.0.1 → 0.0.2

data/spec/unit/yardcheck/const_spec.rb

@@ -8,10 +8,17 @@ RSpec.describe Yardcheck::Const do
       module Bar
         module Baz
         end # Baz
+
+        class Hash
+        end # Hash
       end # Bar
     end # Foo
   end
 
+  it 'resolves Object' do
+    expect(described_class.resolve('')).to eql(described_class.new(Object))
+  end
+
   it 'resolves top level constant' do
     expect(described_class.resolve('Foo')).to eql(described_class.new(Foo))
   end
@@ -45,4 +52,11 @@ RSpec.describe Yardcheck::Const do
       described_class::Invalid.new(Foo::Bar, 'What')
     )
   end
+
+  it 'special cases Hash' do
+    aggregate_failures do
+      expect(described_class.resolve('Hash', Foo::Bar)).to eql(described_class.new(Hash))
+      expect(described_class.resolve('Bar::Hash', Foo)).to eql(described_class.new(Foo::Bar::Hash))
+    end
+  end
 end

data/spec/unit/yardcheck/documentation_spec.rb

@@ -59,8 +59,10 @@ RSpec.describe Yardcheck::Documentation do
   end
 
   it 'handles documented returns without types' do
-    expect(method_object('TestApp::Namespace#return_tag_without_type').return_type)
-      .to eql(typedef)
+    aggregate_failures do
+      expect(method_object('TestApp::Namespace#tags_without_types').return_type).to be(nil)
+      expect(method_object('TestApp::Namespace#tags_without_types').params).to eql({})
+    end
   end
 
   it 'handles returns with a literal nil' do
@@ -145,4 +147,17 @@ RSpec.describe Yardcheck::Documentation do
   it 'return type of undocumented' do
     expect(undocumented.return_type).to be(nil)
   end
+
+  it 'identifies predicate methods' do
+    aggregate_failures do
+      expect(namespace_add).not_to be_predicate_method
+      expect(method_object('TestApp::Namespace#truthy_predicate?')).to be_predicate_method
+    end
+  end
+
+  it 'exposes documented raise' do
+    expect(method_object('TestApp::Namespace#always_raise').raise_type).to eql(
+      typedef(literal(const(TestApp::Namespace::AppError)))
+    )
+  end
 end

data/spec/unit/yardcheck/method_tracer_spec.rb

@@ -36,23 +36,21 @@ RSpec.describe Yardcheck::MethodTracer do
     end
 
     expect(tracer.events).to eq([
-      Yardcheck::MethodCall.process(
+      Yardcheck::MethodCall::Return.process(
         scope:            :class,
         selector:         :singleton_method_example,
         namespace:        Foo.singleton_class,
         params:           { baz: 'Hello' },
         return_value:     'HELLO',
-        example_location: RSpec.current_example.location,
-        error_raised:     false
+        example_location: RSpec.current_example.location
       ),
-      Yardcheck::MethodCall.process(
+      Yardcheck::MethodCall::Return.process(
         scope:            :instance,
         selector:         :instance_method_example,
         namespace:        Foo,
         params:           { baz: 'Hello' },
         return_value:     'HELLO',
-        example_location: RSpec.current_example.location,
-        error_raised:     false
+        example_location: RSpec.current_example.location
       )
     ])
   end

data/spec/unit/yardcheck/processed_source_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.describe Yardcheck::ProcessedSource do
+  context 'when method has a rescue with an embedded explicit return' do
+    let(:source) { described_class.new(<<-RUBY) }
+      def foo
+        bar
+      rescue SomeError
+        return 2
+      end
+    RUBY
+
+    it 'marks it as tracepoint bug candidate' do
+      expect(source).to be_tracepoint_bug_candidate
+    end
+  end
+
+  context 'when the method does not have a rescue or return' do
+    let(:source) { described_class.new(<<-RUBY) }
+      def foo
+        bar
+      end
+    RUBY
+
+    it 'is not a bug candidate' do
+      expect(source).not_to be_tracepoint_bug_candidate
+    end
+  end
+
+  context 'when the resbody contains an implicit return' do
+    let(:source) { described_class.new(<<-RUBY) }
+      def foo
+        bar
+      rescue
+        baz
+      end
+    RUBY
+
+    it 'is not a bug candidate' do
+      expect(source).not_to be_tracepoint_bug_candidate
+    end
+  end
+end

data/spec/unit/yardcheck/runner_spec.rb

@@ -19,23 +19,21 @@ RSpec.describe Yardcheck::Runner do
 
   let(:observed_events) do
     [
-      Yardcheck::MethodCall.process(
+      Yardcheck::MethodCall::Return.process(
         scope:            :instance,
         selector:         :add,
         namespace:        TestApp::Namespace,
         params:           { left: 'foo', right: 3 },
         return_value:     5,
-        example_location: 'test_app_spec.rb:1',
-        error_raised:     false
+        example_location: 'test_app_spec.rb:1'
       ),
-      Yardcheck::MethodCall.process(
+      Yardcheck::MethodCall::Return.process(
         scope:            :class,
         selector:         :add,
         namespace:        TestApp::Namespace.singleton_class,
         params:           { left: 2, right: 3 },
         return_value:     5,
-        example_location: 'test_app_spec.rb:2',
-        error_raised:     false
+        example_location: 'test_app_spec.rb:2'
       )
     ]
   end
@@ -44,7 +42,7 @@ RSpec.describe Yardcheck::Runner do
     <<~MSG
       Expected #<Class:TestApp::Namespace>#add to return String but observed Fixnum
 
-          source: ./test_app/lib/test_app.rb:9
+          source: ./test_app/lib/test_app.rb:15
           tests:
             - test_app_spec.rb:2
 
@@ -60,7 +58,7 @@ RSpec.describe Yardcheck::Runner do
 
       Expected TestApp::Namespace#add to receive Integer for left but observed String
 
-          source: ./test_app/lib/test_app.rb:19
+          source: ./test_app/lib/test_app.rb:25
           tests:
             - test_app_spec.rb:1
 
@@ -76,7 +74,7 @@ RSpec.describe Yardcheck::Runner do
 
       Expected TestApp::Namespace#add to return String but observed Fixnum
 
-          source: ./test_app/lib/test_app.rb:19
+          source: ./test_app/lib/test_app.rb:25
           tests:
             - test_app_spec.rb:1
 
@@ -97,6 +95,10 @@ RSpec.describe Yardcheck::Runner do
     string.gsub(/\e\[(?:1\;)?\d+m/, '')
   end
 
+  before do
+    allow(Kernel).to receive(:exit).with(1)
+  end
+
   shared_examples 'violation output' do
     it 'compares the spec observations against the documentation' do
       runner.check
@@ -110,32 +112,29 @@ RSpec.describe Yardcheck::Runner do
   context 'when multiple tests find the same violation' do
     let(:observed_events) do
       [
-        Yardcheck::MethodCall.process(
+        Yardcheck::MethodCall::Return.process(
           scope:            :instance,
           selector:         :add,
           namespace:        TestApp::Namespace,
           params:           { left: 'foo', right: 3 },
           return_value:     'valid return type',
-          example_location: 'test_app_spec.rb:1',
-          error_raised:     false
+          example_location: 'test_app_spec.rb:1'
         ),
-        Yardcheck::MethodCall.process(
+        Yardcheck::MethodCall::Return.process(
           scope:            :instance,
           selector:         :add,
           namespace:        TestApp::Namespace,
           params:           { left: 'foo', right: 3 },
           return_value:     'valid return type',
-          example_location: 'test_app_spec.rb:2',
-          error_raised:     false
+          example_location: 'test_app_spec.rb:2'
         ),
-        Yardcheck::MethodCall.process(
+        Yardcheck::MethodCall::Return.process(
           scope:            :instance,
           selector:         :add,
           namespace:        TestApp::Namespace,
           params:           { left: 1, right: 'now this one is wrong' },
           return_value:     'valid return type',
-          example_location: 'test_app_spec.rb:3',
-          error_raised:     false
+          example_location: 'test_app_spec.rb:3'
         )
       ]
     end
@@ -144,7 +143,7 @@ RSpec.describe Yardcheck::Runner do
       <<~MSG
         Expected TestApp::Namespace#add to receive Integer for left but observed String
 
-            source: ./test_app/lib/test_app.rb:19
+            source: ./test_app/lib/test_app.rb:25
             tests:
               - test_app_spec.rb:1
               - test_app_spec.rb:2
@@ -161,7 +160,7 @@ RSpec.describe Yardcheck::Runner do
 
         Expected TestApp::Namespace#add to receive Integer for right but observed String
 
-            source: ./test_app/lib/test_app.rb:19
+            source: ./test_app/lib/test_app.rb:25
             tests:
               - test_app_spec.rb:3
 

data/test_app/Gemfile

@@ -5,3 +5,4 @@ source 'https://rubygems.org'
 gem 'yardcheck', path: '..'
 gem 'pry'
 gem 'pry-byebug'
+gem 'yard'

data/test_app/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: ..
   specs:
-    yardcheck (0.0.0)
-      anima
+    yardcheck (0.0.1)
+      anima (~> 0.3)
       coderay (~> 1.1)
-      concord
-      rspec
+      concord (~> 0.1)
+      parser
+      rspec (~> 3.4)
       yard (~> 0.9)
 
 GEM
@@ -19,6 +20,7 @@ GEM
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2)
       equalizer (~> 0.0.11)
+    ast (2.3.0)
     byebug (9.0.6)
     coderay (1.1.1)
     concord (0.1.5)
@@ -30,6 +32,8 @@ GEM
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
     method_source (0.8.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -60,6 +64,7 @@ PLATFORMS
 DEPENDENCIES
   pry
   pry-byebug
+  yard
   yardcheck!
 
 BUNDLED WITH

data/test_app/lib/test_app/ambiguous_raise.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TestApp
+  module AmbiguousRaise
+    SomeError = Class.new(StandardError)
+
+    # @return [Integer]
+    def self.method1
+      method2
+    end
+
+    # @return [Integer]
+    def self.method2
+      method3
+    rescue SomeError
+      2
+    end
+
+    # @return [Integer]
+    def self.method3
+      method4
+
+      3
+    end
+
+    # @return [Integer]
+    def self.method4
+      raise SomeError
+
+      4
+    end
+  end
+end

data/test_app/lib/test_app/block_return.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TestApp
+  module BlockReturn
+    SomeError = Class.new(StandardError)
+
+    # @return [Integer]
+    def self.entrypoint
+      method_that_executes_normal_block do
+        1
+      end
+
+      method_that_passes_block_with_return_keyword_along do
+        return 1
+      end
+
+      'foo'
+    end
+
+    # @return [Integer]
+    def self.method_that_passes_block_with_return_keyword_along(&block)
+      method_that_yield_block_with_return_keyword(&block)
+
+      2
+    end
+
+    # @return [Integer]
+    def self.method_that_yield_block_with_return_keyword
+      yield
+
+      3
+    end
+
+    def self.method_that_executes_normal_block
+      yield
+
+      4
+    end
+  end
+end

data/test_app/lib/test_app/tracepoint_bug.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TestApp
+  class TracepointBug
+    SomeError = Class.new(StandardError)
+
+    # @return [Integer]
+    def method1
+      method2
+    rescue SomeError => error
+      foo # resolve ambiguous raise state
+      return 1
+    end
+
+    def foo
+      1
+    end
+
+    def method2
+      raise SomeError
+    end
+  end
+end

data/test_app/lib/test_app.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require 'test_app/ambiguous_raise'
+require 'test_app/block_return'
+require 'test_app/tracepoint_bug'
+
 module TestApp
   class Namespace
     # Singleton method with correct param definition and incorrect return
@@ -47,8 +53,9 @@ module TestApp
       'str'
     end
 
+    # @param foo but not type definition in brackets
     # @return no type specified here
-    def return_tag_without_type
+    def tags_without_types(foo)
     end
 
     # @param [String]
@@ -98,6 +105,7 @@ module TestApp
 
     AppError = Class.new(StandardError)
 
+    # @raise [AppError]
     # @return [Fixnum]
     def always_raise
       raise AppError
@@ -105,11 +113,34 @@ module TestApp
       1
     end
 
+    # @raise [AppError]
+    def invalid_raise_documentation
+      raise KeyError
+    end
+
     # @return [:foo]
     def returns_literal_symbol
       :foo
     end
 
+    # This should be ignored since truthy and falsey values are all values
+    #
+    # @return [Boolean]
+    def truthy_predicate?
+      1
+    end
+
+    # @return [Array<Hash>]
+    def special_cases_top_level_constants
+      [{}]
+    end
+
+    class Hash
+    end
+
+    class Array
+    end
+
     class Parent
     end
 

data/test_app/spec/test_app/ambiguous_raise_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative './../../lib/test_app'
+
+RSpec.describe TestApp::AmbiguousRaise do
+  it 'calls a method which raises an error' do
+    expect(described_class.method1).to be(2)
+  end
+end

data/test_app/spec/test_app/block_return_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative './../../lib/test_app'
+
+RSpec.describe TestApp::BlockReturn do
+  it 'calls a method which eventually yields and then executes a return' do
+    expect(described_class.entrypoint).to be(1)
+  end
+end

data/test_app/spec/test_app/tracepoint_bug_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe TestApp::TracepointBug do
+  it 'returns 1' do
+    expect(described_class.new.method1).to be(1)
+  end
+end

data/test_app/spec/test_app_spec.rb

@@ -3,47 +3,65 @@
 require_relative './../lib/test_app'
 
 RSpec.describe TestApp::Namespace do
-  it 'does math with instance method' do
-    expect(TestApp::Namespace.new.add(2, 3)).to be(5)
-  end
+  let(:object) { described_class.new }
 
   it 'does math with singleton method' do
-    expect(TestApp::Namespace.add(2, 3)).to be(5)
+    expect(described_class.add(2, 3)).to be(5)
+  end
+
+  it 'does math with instance method' do
+    expect(object.add(2, 3)).to be(5)
   end
 
   it 'has an undocumented method and that is fine' do
-    expect(TestApp::Namespace.new.undocumented).to be(nil)
+    expect(object.undocumented).to be(nil)
   end
 
   it 'documents returning the parent but returns child' do
-    expect(TestApp::Namespace.new.returns_generic).to be_an_instance_of(TestApp::Namespace::Child)
+    expect(object.returns_generic).to be_an_instance_of(described_class::Child)
   end
 
   it 'documents returning a relative namespace incorrectly' do
-    expect(TestApp::Namespace.new.documents_relative).to be_a(String)
+    expect(object.documents_relative).to be_a(String)
   end
 
   it 'incorrectly documents a method as accepting Enumerable<String>' do
-    expect(TestApp::Namespace.new.enumerable_param('hi')).to be(nil)
+    expect(object.enumerable_param('hi')).to be(nil)
   end
 
   it 'properly tests a method with an instance double' do
-    expect(TestApp::Namespace.new.properly_tested_with_instance_double(instance_double(String))).to be(nil)
+    expect(object.properly_tested_with_instance_double(instance_double(String))).to be(nil)
   end
 
   it 'improperly tests a method with an instance double' do
-    expect(TestApp::Namespace.new.improperly_tested_with_instance_double(instance_double(Integer))).to be(nil)
+    expect(object.improperly_tested_with_instance_double(instance_double(Integer))).to be(nil)
   end
 
   it 'tests a method that raises an error instead of returning' do
-    expect { TestApp::Namespace.new.always_raise }.to raise_error(TestApp::Namespace::AppError)
+    expect { object.always_raise }.to raise_error(described_class::AppError)
   end
 
   it 'improperly documents the param with an invalid const' do
-    expect(TestApp::Namespace.new.ignoring_invalid_types('hi')).to be(nil)
+    expect(object.ignoring_invalid_types('hi')).to be(nil)
   end
 
   it 'returns a literal symbol' do
-    expect(TestApp::Namespace.new.returns_literal_symbol).to be(:foo)
+    expect(object.returns_literal_symbol).to be(:foo)
+  end
+
+  it 'returns a truthy value for predicate?' do
+    expect(object.truthy_predicate?).to be_truthy
+  end
+
+  specify do
+    expect(object.tags_without_types(1)).to be(nil)
+  end
+
+  it 'special cases Array and Hash' do
+    expect(object.special_cases_top_level_constants).to eq([{}])
+  end
+
+  it 'is documented as raising AppError but actually raises KeyError' do
+    expect { object.invalid_raise_documentation }.to raise_error(KeyError)
   end
 end

data/yardcheck.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'anima',    '~> 0.3'
   spec.add_dependency 'rspec',    '~> 3.4'
   spec.add_dependency 'coderay',  '~> 1.1'
+  spec.add_dependency 'parser'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yardcheck
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Verify that your YARD @param and @return types are correct
 email:
 - johncbackus@gmail.com
@@ -89,7 +103,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".buildkite/hooks/pre-command"
+- ".buildkite/pipeline.yml"
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -106,6 +123,7 @@ files:
 - lib/yardcheck/method_call.rb
 - lib/yardcheck/method_tracer.rb
 - lib/yardcheck/observation.rb
+- lib/yardcheck/processed_source.rb
 - lib/yardcheck/proxy.rb
 - lib/yardcheck/runner.rb
 - lib/yardcheck/source_lines.rb
@@ -122,6 +140,7 @@ files:
 - spec/unit/yardcheck/const_spec.rb
 - spec/unit/yardcheck/documentation_spec.rb
 - spec/unit/yardcheck/method_tracer_spec.rb
+- spec/unit/yardcheck/processed_source_spec.rb
 - spec/unit/yardcheck/runner_spec.rb
 - spec/unit/yardcheck/test_value_spec.rb
 - spec/unit/yardcheck/typedef/parser_spec.rb
@@ -130,6 +149,12 @@ files:
 - test_app/Gemfile
 - test_app/Gemfile.lock
 - test_app/lib/test_app.rb
+- test_app/lib/test_app/ambiguous_raise.rb
+- test_app/lib/test_app/block_return.rb
+- test_app/lib/test_app/tracepoint_bug.rb
+- test_app/spec/test_app/ambiguous_raise_spec.rb
+- test_app/spec/test_app/block_return_spec.rb
+- test_app/spec/test_app/tracepoint_bug_spec.rb
 - test_app/spec/test_app_spec.rb
 - yardcheck.gemspec
 homepage: https://github.com/backus/yardcheck