inch 0.0.1 → 0.1.0

data/test/inch/code_object/proxy_test.rb

@@ -0,0 +1,188 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CodeObject::Proxy::Base do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @source_parser ||= Inch::SourceParser.run(["lib/**/*.rb"])
+  end
+
+  def test_method_without_doc
+    m = @source_parser.find_object("Foo::Bar#method_without_doc")
+    refute m.has_doc?
+    refute m.has_parameters?
+    refute m.return_mentioned?
+    assert m.undocumented?
+
+    assert_equal 0, m.score
+  end
+
+  def test_method_with_missing_param_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_missing_param_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert_equal 3, m.parameters.size
+    p = m.parameter(:param1)
+    assert p.mentioned?
+    p = m.parameter(:param2)
+    assert p.mentioned?
+    p = m.parameter(:param3)
+    refute p.mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_wrong_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_wrong_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert_equal 4, m.parameters.size
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute p.wrongly_mentioned?
+    p = m.parameter(:param2)
+    refute p.mentioned?
+    refute p.wrongly_mentioned? # not mentioned in docs at all
+    p = m.parameter(:param3)
+    refute p.mentioned?
+    refute p.wrongly_mentioned? # not mentioned in docs at all
+    p = m.parameter(:param4)
+    assert p.mentioned?
+    assert p.wrongly_mentioned? # mentioned in docs, but not present
+
+    assert m.score
+  end
+
+  def test_method_with_full_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_full_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert_equal 2, m.parameters.size
+    m.parameters.each do |param|
+      assert param.mentioned?
+      assert param.typed?
+      assert param.described?
+      refute param.wrongly_mentioned?
+    end
+
+    assert_equal 100, m.score
+  end
+
+  def test_method_without_params_or_return_type
+    m = @source_parser.find_object("Foo::Bar#method_without_params_or_return_type")
+    assert m.has_doc?
+    refute m.has_parameters?
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_without_docstring
+    m = @source_parser.find_object("Foo::Bar#method_without_docstring")
+    refute m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_without_params_or_docstring
+    m = @source_parser.find_object("Foo::Bar#method_without_params_or_docstring")
+    refute m.has_doc?
+    refute m.has_parameters?
+    assert m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_rdoc_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_rdoc_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_other_rdoc_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_other_rdoc_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    p = m.parameter(:param2)
+    assert p.mentioned?         # mentioned in docs, correctly
+    p = m.parameter(:param3)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_unstructured_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_unstructured_doc_missing_params
+    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc_missing_params")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:format)
+    refute p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+end
+
+describe ::Inch::CodeObject::Proxy::Base do
+  before do
+    Dir.chdir fixture_path(:code_examples)
+    @source_parser = Inch::SourceParser.run(["lib/**/*.rb"])
+  end
+
+  def test_method_with_code_example
+    m = @source_parser.find_object("Foo::Bar#method_with_code_example")
+    assert m.has_code_example?
+  end
+
+  def test_method_with_code_example2
+    m = @source_parser.find_object("Foo::Bar#method_with_code_example2")
+    assert m.has_code_example?
+  end
+
+  def test_method_with_code_examples
+    m = @source_parser.find_object("Foo::Bar#method_with_one_example")
+    assert m.has_code_example?
+    refute m.has_multiple_code_examples?
+  end
+
+  def test_method_with_code_examples
+    m = @source_parser.find_object("Foo::Bar#method_with_examples")
+    assert m.has_multiple_code_examples?
+  end
+
+  def test_method_with_code_examples
+    m = @source_parser.find_object("Foo::Bar#method_with_tagged_example")
+    assert m.has_multiple_code_examples?
+  end
+
+  def test_method_with_code_examples
+    m = @source_parser.find_object("Foo::Bar#method_with_2tagged_examples")
+    assert m.has_multiple_code_examples?
+  end
+end

data/test/inch/source_parser_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe ::Inch::SourceParser do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @source_parser = Inch::SourceParser.run(["lib/**/*.rb"])
+  end
+
+  it "should parse all objects" do
+    refute_nil @source_parser.find_object("Foo")
+    refute_nil @source_parser.find_object("Foo::Bar")
+    refute_nil @source_parser.find_object("Foo::Bar#method_without_doc")
+    refute_nil @source_parser.find_object("Foo::Bar#method_with_missing_param_doc")
+    refute_nil @source_parser.find_object("Foo::Bar#method_with_wrong_doc")
+    refute_nil @source_parser.find_object("Foo::Bar#method_with_full_doc")
+  end
+
+  it "should return the correct depth for each object" do
+    assert_equal 1, @source_parser.find_object("Foo").depth
+    assert_equal 2, @source_parser.find_object("Foo::Bar").depth
+    assert_equal 3, @source_parser.find_object("Foo::Bar#method_without_doc").depth
+  end
+end

data/test/integration/stats_options_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+#
+# These format tests also broke things in the regular testsuite.
+# See ./list_options_test.rb
+#
+# Therefore, here are some integration tests:
+#
+describe ::Inch::CLI::Command::List do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = "bundle exec inch stats"
+  end
+
+  def assert_parsed_output(parsed)
+    assert parsed.size > 0
+    assert parsed["ranges"]
+    assert parsed["scores"]
+    assert parsed["priorities"]
+  end
+
+  it "should run with --no-private switch" do
+    out = %x|#{@command} --format json|
+    refute out.empty?, "there should be some output"
+    assert_parsed_output JSON[out]
+  end
+
+  it "should run with --no-protected switch" do
+    out = %x|#{@command} --format yaml|
+    refute out.empty?, "there should be some output"
+    assert_parsed_output YAML.load(out)
+  end
+
+end

data/test/integration/visibility_options_test.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+#
+# Tests with the YARD specific --no-public, --no-protected and --private
+# switches can't be run in one test instance. The flags seem to add up after
+# being called. In combination with a random test order this resulted in ever
+# different failure outputs.
+#
+# Therefore, here are some integration tests:
+#
+describe ::Inch::CLI::Command::List do
+  before do
+    Dir.chdir fixture_path(:visibility)
+    @command = "bundle exec inch list"
+  end
+
+  it "should run without visibility switches" do
+    out = %x|#{@command} --all|
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo#public_method\b/, out
+    assert_match /\bFoo#protected_method\b/, out
+    refute_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has @private tag
+  end
+
+  it "should run with --no-protected switch" do
+    out = %x|#{@command} --all --no-protected|
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo#public_method\b/, out
+    refute_match /\bFoo#protected_method\b/, out
+    refute_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has @private tag
+  end
+
+  it "should run with --no-public switch" do
+    out = %x|#{@command} --all --no-public|
+    refute out.empty?, "there should be some output"
+    refute_match /\bFoo#public_method\b/, out
+    assert_match /\bFoo#protected_method\b/, out
+    refute_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has @private tag
+  end
+
+  it "should run with --no-public --no-protected switch" do
+    out = %x|#{@command} --all --no-public --no-protected|
+    assert out.empty?, "there should be no output"
+    refute_match /\bFoo#public_method\b/, out
+    refute_match /\bFoo#protected_method\b/, out
+    refute_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has a @private tag, but is really :public
+  end
+
+  it "should run with --no-public --no-protected --private switch" do
+    out = %x|#{@command} --all --no-public --no-protected --private|
+    refute out.empty?, "there should be some output"
+    refute_match /\bFoo#public_method\b/, out
+    refute_match /\bFoo#protected_method\b/, out
+    assert_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has a @private tag, but is really :public
+  end
+
+  it "should run with --no-public switch" do
+    out = %x|#{@command} --all --no-public|
+    refute out.empty?, "there should be some output"
+    refute_match /\bFoo#public_method\b/, out
+    assert_match /\bFoo#protected_method\b/, out
+    refute_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has a @private tag, but is really :public
+  end
+
+  it "should run with --no-protected switch" do
+    out = %x|#{@command} --all --no-protected|
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo#public_method\b/, out
+    refute_match /\bFoo#protected_method\b/, out
+    refute_match /\bFoo#private_method\b/, out # has @private tag
+    refute_match /\bFoo#method_with_private_tag\b/, out # has a @private tag, but is really :public
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'bundler'
+Bundler.require
+require 'inch'
+
+def fixture_path(name)
+  File.join(File.dirname(__FILE__), "fixtures", name.to_s)
+end
+
+def in_fixture_path(name, &block)
+  old_dir = Dir.pwd
+  Dir.chdir fixture_path(name)
+  yield
+  Dir.chdir old_dir
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,10 +38,67 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Wrapper for YARD
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  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'
+- !ruby/object:Gem::Dependency
+  name: sparkr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Documentation measurement tool for Ruby, based on YARD.
 email:
 - rf@bamaru.de
-executables: []
+executables:
+- inch
 extensions: []
 extra_rdoc_files: []
 files:
@@ -52,9 +109,102 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODOS.md
+- bin/inch
 - inch.gemspec
 - lib/inch.rb
+- lib/inch/cli.rb
+- lib/inch/cli/arguments.rb
+- lib/inch/cli/command.rb
+- lib/inch/cli/command/base.rb
+- lib/inch/cli/command/base_list.rb
+- lib/inch/cli/command/base_object.rb
+- lib/inch/cli/command/console.rb
+- lib/inch/cli/command/inspect.rb
+- lib/inch/cli/command/list.rb
+- lib/inch/cli/command/options/base.rb
+- lib/inch/cli/command/options/base_list.rb
+- lib/inch/cli/command/options/base_object.rb
+- lib/inch/cli/command/options/console.rb
+- lib/inch/cli/command/options/inspect.rb
+- lib/inch/cli/command/options/list.rb
+- lib/inch/cli/command/options/show.rb
+- lib/inch/cli/command/options/stats.rb
+- lib/inch/cli/command/options/suggest.rb
+- lib/inch/cli/command/output/base.rb
+- lib/inch/cli/command/output/console.rb
+- lib/inch/cli/command/output/inspect.rb
+- lib/inch/cli/command/output/list.rb
+- lib/inch/cli/command/output/show.rb
+- lib/inch/cli/command/output/stats.rb
+- lib/inch/cli/command/output/suggest.rb
+- lib/inch/cli/command/show.rb
+- lib/inch/cli/command/stats.rb
+- lib/inch/cli/command/suggest.rb
+- lib/inch/cli/command_parser.rb
+- lib/inch/cli/sparkline_helper.rb
+- lib/inch/cli/trace_helper.rb
+- lib/inch/cli/yardopts_helper.rb
+- lib/inch/code_object.rb
+- lib/inch/code_object/docstring.rb
+- lib/inch/code_object/nodoc_helper.rb
+- lib/inch/code_object/proxy.rb
+- lib/inch/code_object/proxy/base.rb
+- lib/inch/code_object/proxy/class_object.rb
+- lib/inch/code_object/proxy/constant_object.rb
+- lib/inch/code_object/proxy/method_object.rb
+- lib/inch/code_object/proxy/method_parameter_object.rb
+- lib/inch/code_object/proxy/module_object.rb
+- lib/inch/code_object/proxy/namespace_object.rb
+- lib/inch/core_ext.rb
+- lib/inch/core_ext/string.rb
+- lib/inch/core_ext/yard.rb
+- lib/inch/evaluation.rb
+- lib/inch/evaluation/base.rb
+- lib/inch/evaluation/class_object.rb
+- lib/inch/evaluation/constant_object.rb
+- lib/inch/evaluation/file.rb
+- lib/inch/evaluation/method_object.rb
+- lib/inch/evaluation/module_object.rb
+- lib/inch/evaluation/namespace_object.rb
+- lib/inch/evaluation/role/base.rb
+- lib/inch/evaluation/role/constant.rb
+- lib/inch/evaluation/role/method.rb
+- lib/inch/evaluation/role/method_parameter.rb
+- lib/inch/evaluation/role/missing.rb
+- lib/inch/evaluation/role/namespace.rb
+- lib/inch/evaluation/role/object.rb
+- lib/inch/evaluation/score_range.rb
+- lib/inch/rake.rb
+- lib/inch/rake/suggest.rb
+- lib/inch/source_parser.rb
 - lib/inch/version.rb
+- test/fixtures/code_examples/lib/foo.rb
+- test/fixtures/readme/lib/foo.rb
+- test/fixtures/simple/README
+- test/fixtures/simple/lib/broken.rb
+- test/fixtures/simple/lib/foo.rb
+- test/fixtures/simple/lib/role_methods.rb
+- test/fixtures/simple/lib/role_namespaces.rb
+- test/fixtures/visibility/lib/foo.rb
+- test/fixtures/yardopts/.yardopts
+- test/fixtures/yardopts/foo/bar.rb
+- test/inch/cli/arguments_test.rb
+- test/inch/cli/command/console_test.rb
+- test/inch/cli/command/inspect_test.rb
+- test/inch/cli/command/list_test.rb
+- test/inch/cli/command/show_test.rb
+- test/inch/cli/command/stats_test.rb
+- test/inch/cli/command/suggest_test.rb
+- test/inch/cli/command_parser_test.rb
+- test/inch/cli/yardopts_helper_test.rb
+- test/inch/code_object/docstring_test.rb
+- test/inch/code_object/nodoc_helper_test.rb
+- test/inch/code_object/proxy_test.rb
+- test/inch/source_parser_test.rb
+- test/integration/stats_options_test.rb
+- test/integration/visibility_options_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -75,8 +225,35 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Wrapper for YARD
-test_files: []
+summary: Documentation measurement tool for Ruby
+test_files:
+- test/fixtures/code_examples/lib/foo.rb
+- test/fixtures/readme/lib/foo.rb
+- test/fixtures/simple/README
+- test/fixtures/simple/lib/broken.rb
+- test/fixtures/simple/lib/foo.rb
+- test/fixtures/simple/lib/role_methods.rb
+- test/fixtures/simple/lib/role_namespaces.rb
+- test/fixtures/visibility/lib/foo.rb
+- test/fixtures/yardopts/.yardopts
+- test/fixtures/yardopts/foo/bar.rb
+- test/inch/cli/arguments_test.rb
+- test/inch/cli/command/console_test.rb
+- test/inch/cli/command/inspect_test.rb
+- test/inch/cli/command/list_test.rb
+- test/inch/cli/command/show_test.rb
+- test/inch/cli/command/stats_test.rb
+- test/inch/cli/command/suggest_test.rb
+- test/inch/cli/command_parser_test.rb
+- test/inch/cli/yardopts_helper_test.rb
+- test/inch/code_object/docstring_test.rb
+- test/inch/code_object/nodoc_helper_test.rb
+- test/inch/code_object/proxy_test.rb
+- test/inch/source_parser_test.rb
+- test/integration/stats_options_test.rb
+- test/integration/visibility_options_test.rb
+- test/test_helper.rb
+has_rdoc: