yardcheck 0.0.1

data/test_app/spec/test_app_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+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
+
+  it 'does math with singleton method' do
+    expect(TestApp::Namespace.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)
+  end
+
+  it 'documents returning the parent but returns child' do
+    expect(TestApp::Namespace.new.returns_generic).to be_an_instance_of(TestApp::Namespace::Child)
+  end
+
+  it 'documents returning a relative namespace incorrectly' do
+    expect(TestApp::Namespace.new.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)
+  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)
+  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)
+  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)
+  end
+
+  it 'improperly documents the param with an invalid const' do
+    expect(TestApp::Namespace.new.ignoring_invalid_types('hi')).to be(nil)
+  end
+
+  it 'returns a literal symbol' do
+    expect(TestApp::Namespace.new.returns_literal_symbol).to be(:foo)
+  end
+end

data/yardcheck.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require File.expand_path('../lib/yardcheck/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name        = 'yardcheck'
+  spec.version     = Yardcheck::VERSION
+  spec.authors     = %w[John Backus]
+  spec.email       = %w[johncbackus@gmail.com]
+
+  spec.summary     = 'Validate YARD docs by running specs'
+  spec.description = 'Verify that your YARD @param and @return types are correct'
+  spec.homepage    = 'https://github.com/backus/yardcheck'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.require_paths = %w[lib]
+  spec.executables   = %w[yardcheck]
+
+  spec.add_dependency 'yard',     '~> 0.9'
+  spec.add_dependency 'concord',  '~> 0.1'
+  spec.add_dependency 'anima',    '~> 0.3'
+  spec.add_dependency 'rspec',    '~> 3.4'
+  spec.add_dependency 'coderay',  '~> 1.1'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: yardcheck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John
+- Backus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Verify that your YARD @param and @return types are correct
+email:
+- johncbackus@gmail.com
+executables:
+- yardcheck
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- README.md
+- bin/yardcheck
+- lib/yardcheck.rb
+- lib/yardcheck/color.rb
+- lib/yardcheck/const.rb
+- lib/yardcheck/documentation.rb
+- lib/yardcheck/documentation/method_object.rb
+- lib/yardcheck/method_call.rb
+- lib/yardcheck/method_tracer.rb
+- lib/yardcheck/observation.rb
+- lib/yardcheck/proxy.rb
+- lib/yardcheck/runner.rb
+- lib/yardcheck/source_lines.rb
+- lib/yardcheck/spec_observer.rb
+- lib/yardcheck/test_runner.rb
+- lib/yardcheck/test_value.rb
+- lib/yardcheck/typedef.rb
+- lib/yardcheck/typedef/parser.rb
+- lib/yardcheck/version.rb
+- lib/yardcheck/violation.rb
+- lib/yardcheck/warning.rb
+- spec/integration/yardcheck_spec.rb
+- spec/spec_helper.rb
+- spec/unit/yardcheck/const_spec.rb
+- spec/unit/yardcheck/documentation_spec.rb
+- spec/unit/yardcheck/method_tracer_spec.rb
+- spec/unit/yardcheck/runner_spec.rb
+- spec/unit/yardcheck/test_value_spec.rb
+- spec/unit/yardcheck/typedef/parser_spec.rb
+- spec/unit/yardcheck/typedef_spec.rb
+- test_app/.rspec
+- test_app/Gemfile
+- test_app/Gemfile.lock
+- test_app/lib/test_app.rb
+- test_app/spec/test_app_spec.rb
+- yardcheck.gemspec
+homepage: https://github.com/backus/yardcheck
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Validate YARD docs by running specs
+test_files: []