inch 0.2.3 → 0.3.0.rc1

data/test/inch/code_object/proxy_test.rb

@@ -2,48 +2,48 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::CodeObject::Proxy::Base do
   before do
-    Dir.chdir fixture_path(:code_examples)
-    @source_parser = Inch::SourceParser.run(["lib/**/*.rb"])
+    dir = fixture_path(:code_examples)
+    @codebase = Inch::Codebase.parse(dir, ["lib/**/*.rb"])
   end
 
   def test_inspect_gives_original_name
-    m = @source_parser.find_object("Foo::Bar#method_with_code_example")
+    m = @codebase.objects.find("Foo::Bar#method_with_code_example")
     assert_match /Foo::Bar#method_with_code_example/, m.inspect
   end
 
   def test_grade_is_not_nil
-    m = @source_parser.find_object("Foo::Bar#method_with_code_example")
+    m = @codebase.objects.find("Foo::Bar#method_with_code_example")
     assert m.grade
   end
 
   def test_method_with_code_example
-    m = @source_parser.find_object("Foo::Bar#method_with_code_example")
+    m = @codebase.objects.find("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")
+    m = @codebase.objects.find("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")
+    m = @codebase.objects.find("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")
+    m = @codebase.objects.find("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")
+    m = @codebase.objects.find("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")
+    m = @codebase.objects.find("Foo::Bar#method_with_2tagged_examples")
     assert m.has_multiple_code_examples?
   end
 end

data/test/inch/codebase/objects_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::Codebase::Objects do
+  before do
+    dir = fixture_path(:simple)
+    paths = ["lib/**/*.rb"]
+    @codebase = Inch::Codebase::Proxy.new dir, paths
+    @objects = @codebase.objects
+  end
+
+  it "should parse all objects" do
+    refute @objects.empty?
+  end
+
+  it "should find some objects" do
+    refute_nil @objects.find("Foo")
+    refute_nil @objects.find("Foo::Bar")
+    refute_nil @objects.find("Foo::Bar#method_without_doc")
+  end
+
+  it "should support iteration" do
+    sum = 0
+    @objects.each do |o|
+      sum += 1
+    end
+    assert_equal @objects.size, sum
+  end
+end

data/test/inch/codebase/proxy_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::Codebase::Proxy do
+  it "should parse all objects" do
+    dir = fixture_path(:simple)
+    paths = ["lib/**/*.rb"]
+    @codebase = Inch::Codebase::Proxy.new dir, paths
+    refute_nil @codebase.objects
+  end
+
+  it "should parse all objects" do
+    dir = fixture_path(:simple)
+    paths = ["app/**/*.rb"]
+    @codebase = Inch::Codebase::Proxy.new dir, paths
+    assert @codebase.objects.empty?
+  end
+end

data/test/inch/evaluation/role/base_test.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+class MockPrivateRole < ::Inch::Evaluation::Role::Base
+  applicable_if :private?
+end
+
+class MockNotPrivateRole < ::Inch::Evaluation::Role::Base
+  applicable_unless :private?
+end
+
+class MockPublicRole < ::Inch::Evaluation::Role::Base
+  applicable_if { |o| o.public? }
+end
+
+class MockIndifferentRole < ::Inch::Evaluation::Role::Base
+  def self.applicable?(object)
+    true
+  end
+end
+
+class MockPrivateObject
+  def private?
+    true
+  end
+
+  def public?
+    false
+  end
+end
+
+class MockPublicObject
+  def private?
+    false
+  end
+
+  def public?
+    true
+  end
+end
+
+describe ::Inch::Evaluation::Role::Base do
+  describe ".applicable" do
+    let(:private_object) { MockPrivateObject.new }
+    let(:public_object) { MockPublicObject.new }
+
+    describe ".applicable_if" do
+      it "should work with a symbol" do
+        assert MockPrivateRole.applicable?(private_object)
+        assert !MockPrivateRole.applicable?(public_object)
+      end
+
+      it "should work with a block" do
+        assert MockPublicRole.applicable?(public_object)
+        assert MockNotPrivateRole.applicable?(public_object)
+        assert !MockPublicRole.applicable?(private_object)
+      end
+    end
+
+    describe ".applicable_unless" do
+      it "should work with a block" do
+        assert MockNotPrivateRole.applicable?(public_object)
+        assert !MockNotPrivateRole.applicable?(private_object)
+      end
+    end
+
+    it "should work by implementing a class method" do
+      assert MockIndifferentRole.applicable?(private_object)
+      assert MockIndifferentRole.applicable?(public_object)
+    end
+  end
+end

data/test/inch/{cli → utils}/weighted_list_test.rb

@@ -1,12 +1,12 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
-describe ::Inch::CLI::WeightedList do
+describe ::Inch::Utils::WeightedList do
   before do
     @counts = [4, 8, 8]
   end
 
   def assert_weighted_list(list, counts, expected)
-    weighted_list = ::Inch::CLI::WeightedList.new(list, counts)
+    weighted_list = ::Inch::Utils::WeightedList.new(list, counts)
     # assert_equal expected.map(&:size).inject(:+), weighted_list.to_a.map(&:size).inject(:+)
     assert_equal expected, weighted_list.to_a, "should be #{expected.map(&:size)}, was #{weighted_list.to_a.map(&:size)}"
   end

data/test/shared/base_list.rb

@@ -0,0 +1,73 @@
+module Shared
+  module BaseList
+    extend Minitest::Spec::DSL
+
+    it "should give error when run with --unknown-switch" do
+      out, err = capture_io do
+        assert_raises(SystemExit) { @command.run("lib/foo.rb", "--unknown-switch") }
+      end
+    end
+
+    it "should run with --depth switch" do
+      out, err = capture_io do
+        @command.run("lib/foo.rb", "--depth=2")
+      end
+      refute out.empty?, "there should be some output"
+      assert err.empty?, "there should be no errors"
+      assert_match /\bFoo\b/, out
+      assert_match /\bFoo::Bar\b/, out
+      refute_match /\bFoo::Bar#method_with_full_doc\b/, out
+      refute_match /\bFoo::Bar#method_with_code_example\b/, out
+    end
+
+    it "should run with --only-namespaces switch" do
+      out, err = capture_io do
+        @command.run("lib/foo.rb", "--only-namespaces")
+      end
+      refute out.empty?, "there should be some output"
+      assert err.empty?, "there should be no errors"
+      assert_match /\bFoo\s/, out
+      assert_match /\bFoo::Bar\s/, out
+      refute_match /\bFoo::Bar\./, out
+      refute_match /\bFoo::Bar#/, out
+    end
+
+    it "should run with --no-namespaces switch" do
+      out, err = capture_io do
+        @command.run("lib/foo.rb", "--no-namespaces")
+      end
+      refute out.empty?, "there should be some output"
+      assert err.empty?, "there should be no errors"
+      refute_match /\bFoo\s/, out
+      refute_match /\bFoo::Bar\s/, out
+      assert_match /\bFoo::Bar#/, out
+    end
+
+
+    it "should run with --only-undocumented switch" do
+      skip
+      out, err = capture_io do
+        @command.run("lib/foo.rb", "--all", "--only-undocumented")
+      end
+      refute out.empty?, "there should be some output"
+      assert err.empty?, "there should be no errors"
+      refute_match /\bFoo\s/, out
+      refute_match /\bFoo::Bar#method_with_full_doc\b/, out
+      assert_match /\bFoo::Bar\s/, out
+      assert_match /\bFoo::Bar#method_without_doc\b/, out
+    end
+
+    it "should run with --no-undocumented switch" do
+      skip
+      out, err = capture_io do
+        @command.run("lib/foo.rb", "--all", "--no-undocumented")
+      end
+      refute out.empty?, "there should be some output"
+      assert err.empty?, "there should be no errors"
+      assert_match /\bFoo\s/, out
+      assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+      refute_match /\bFoo::Bar\s/, out
+      refute_match /\bFoo::Bar#method_without_doc\b/, out
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,15 +1,7 @@
 require 'simplecov'
-SimpleCov.start do
-  add_filter '/test/'
-
-  add_group 'CLI', 'lib/inch/cli'
-  add_group 'Code Objects', 'lib/inch/code_object'
-  add_group 'Evaluation', 'lib/inch/evaluation'
-end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'minitest/spec'
 require 'minitest/autorun'
 require 'bundler'
 Bundler.require
@@ -18,90 +10,3 @@ 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
-
-
-module BaseListTests
-  def self.included(other)
-    other.instance_eval do
-      # these tests are added when BaseListTests is included inside a
-      # `describe` block
-
-      it "should give error when run with --unknown-switch" do
-        out, err = capture_io do
-          assert_raises(SystemExit) { @command.run("lib/foo.rb", "--unknown-switch") }
-        end
-      end
-
-      it "should run with --depth switch" do
-        out, err = capture_io do
-          @command.run("lib/foo.rb", "--depth=2")
-        end
-        refute out.empty?, "there should be some output"
-        assert err.empty?, "there should be no errors"
-        assert_match /\bFoo\b/, out
-        assert_match /\bFoo::Bar\b/, out
-        refute_match /\bFoo::Bar#method_with_full_doc\b/, out
-        refute_match /\bFoo::Bar#method_with_code_example\b/, out
-      end
-
-      it "should run with --only-namespaces switch" do
-        out, err = capture_io do
-          @command.run("lib/foo.rb", "--only-namespaces")
-        end
-        refute out.empty?, "there should be some output"
-        assert err.empty?, "there should be no errors"
-        assert_match /\bFoo\s/, out
-        assert_match /\bFoo::Bar\s/, out
-        refute_match /\bFoo::Bar\./, out
-        refute_match /\bFoo::Bar#/, out
-      end
-
-      it "should run with --no-namespaces switch" do
-        out, err = capture_io do
-          @command.run("lib/foo.rb", "--no-namespaces")
-        end
-        refute out.empty?, "there should be some output"
-        assert err.empty?, "there should be no errors"
-        refute_match /\bFoo\s/, out
-        refute_match /\bFoo::Bar\s/, out
-        assert_match /\bFoo::Bar#/, out
-      end
-
-
-      it "should run with --only-undocumented switch" do
-        skip
-        out, err = capture_io do
-          @command.run("lib/foo.rb", "--all", "--only-undocumented")
-        end
-        refute out.empty?, "there should be some output"
-        assert err.empty?, "there should be no errors"
-        refute_match /\bFoo\s/, out
-        refute_match /\bFoo::Bar#method_with_full_doc\b/, out
-        assert_match /\bFoo::Bar\s/, out
-        assert_match /\bFoo::Bar#method_without_doc\b/, out
-      end
-
-      it "should run with --no-undocumented switch" do
-        skip
-        out, err = capture_io do
-          @command.run("lib/foo.rb", "--all", "--no-undocumented")
-        end
-        refute out.empty?, "there should be some output"
-        assert err.empty?, "there should be no errors"
-        assert_match /\bFoo\s/, out
-        assert_match /\bFoo::Bar#method_with_full_doc\b/, out
-        refute_match /\bFoo::Bar\s/, out
-        refute_match /\bFoo::Bar#method_without_doc\b/, out
-      end
-
-
-    end
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: sparkr
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ files:
 - .gitignore
 - .ruby-gemset
 - .ruby-version
+- .simplecov
 - .travis.yml
 - Gemfile
 - LICENSE
@@ -115,6 +130,15 @@ files:
 - config/defaults.rb
 - inch.gemspec
 - lib/inch.rb
+- lib/inch/api.rb
+- lib/inch/api/filter.rb
+- lib/inch/api/get.rb
+- lib/inch/api/list.rb
+- lib/inch/api/options/base.rb
+- lib/inch/api/options/filter.rb
+- lib/inch/api/options/suggest.rb
+- lib/inch/api/stats.rb
+- lib/inch/api/suggest.rb
 - lib/inch/cli.rb
 - lib/inch/cli/arguments.rb
 - lib/inch/cli/command.rb
@@ -140,11 +164,22 @@ files:
 - lib/inch/cli/command_parser.rb
 - lib/inch/cli/sparkline_helper.rb
 - lib/inch/cli/trace_helper.rb
-- lib/inch/cli/weighted_list.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/converter.rb
+- lib/inch/code_object/provider.rb
+- lib/inch/code_object/provider/yard.rb
+- lib/inch/code_object/provider/yard/docstring.rb
+- lib/inch/code_object/provider/yard/nodoc_helper.rb
+- lib/inch/code_object/provider/yard/object.rb
+- lib/inch/code_object/provider/yard/object/base.rb
+- lib/inch/code_object/provider/yard/object/class_object.rb
+- lib/inch/code_object/provider/yard/object/constant_object.rb
+- lib/inch/code_object/provider/yard/object/method_object.rb
+- lib/inch/code_object/provider/yard/object/method_parameter_object.rb
+- lib/inch/code_object/provider/yard/object/module_object.rb
+- lib/inch/code_object/provider/yard/object/namespace_object.rb
+- lib/inch/code_object/provider/yard/parser.rb
 - lib/inch/code_object/proxy.rb
 - lib/inch/code_object/proxy/base.rb
 - lib/inch/code_object/proxy/class_object.rb
@@ -153,22 +188,27 @@ files:
 - 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/codebase.rb
+- lib/inch/codebase/objects.rb
+- lib/inch/codebase/objects_filter.rb
+- lib/inch/codebase/proxy.rb
 - lib/inch/config.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/grade.rb
 - lib/inch/evaluation/grade_list.rb
-- lib/inch/evaluation/method_object.rb
-- lib/inch/evaluation/module_object.rb
-- lib/inch/evaluation/namespace_object.rb
 - lib/inch/evaluation/object_schema.rb
-- lib/inch/evaluation/read_write_methods.rb
+- lib/inch/evaluation/priority_range.rb
+- lib/inch/evaluation/proxy.rb
+- lib/inch/evaluation/proxy/base.rb
+- lib/inch/evaluation/proxy/class_object.rb
+- lib/inch/evaluation/proxy/constant_object.rb
+- lib/inch/evaluation/proxy/method_object.rb
+- lib/inch/evaluation/proxy/module_object.rb
+- lib/inch/evaluation/proxy/namespace_object.rb
 - lib/inch/evaluation/role/base.rb
 - lib/inch/evaluation/role/constant.rb
 - lib/inch/evaluation/role/method.rb
@@ -178,7 +218,8 @@ files:
 - lib/inch/evaluation/role/object.rb
 - lib/inch/rake.rb
 - lib/inch/rake/suggest.rb
-- lib/inch/source_parser.rb
+- lib/inch/utils/read_write_methods.rb
+- lib/inch/utils/weighted_list.rb
 - lib/inch/version.rb
 - test/fixtures/code_examples/lib/foo.rb
 - test/fixtures/readme/lib/foo.rb
@@ -191,6 +232,12 @@ files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
+- test/inch/api/filter_test.rb
+- test/inch/api/get_test.rb
+- test/inch/api/list_test.rb
+- test/inch/api/options/base_test.rb
+- test/inch/api/stats_test.rb
+- test/inch/api/suggest_test.rb
 - test/inch/cli/arguments_test.rb
 - test/inch/cli/command/base_test.rb
 - test/inch/cli/command/list_test.rb
@@ -202,15 +249,21 @@ files:
 - test/inch/cli/command/suggest_test.rb
 - test/inch/cli/command_parser_test.rb
 - test/inch/cli/trace_helper_test.rb
-- test/inch/cli/weighted_list_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/converter_test.rb
+- test/inch/code_object/provider/yard/docstring_test.rb
+- test/inch/code_object/provider/yard/nodoc_helper_test.rb
+- test/inch/code_object/provider/yard_test.rb
+- test/inch/code_object/provider_test.rb
 - test/inch/code_object/proxy/method_object_test.rb
 - test/inch/code_object/proxy_test.rb
-- test/inch/source_parser_test.rb
+- test/inch/codebase/objects_test.rb
+- test/inch/codebase/proxy_test.rb
+- test/inch/evaluation/role/base_test.rb
+- test/inch/utils/weighted_list_test.rb
 - test/integration/stats_options_test.rb
 - test/integration/visibility_options_test.rb
+- test/shared/base_list.rb
 - test/test_helper.rb
 homepage: http://trivelop.de/inch/
 licenses:
@@ -227,12 +280,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby
@@ -248,6 +301,12 @@ test_files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
+- test/inch/api/filter_test.rb
+- test/inch/api/get_test.rb
+- test/inch/api/list_test.rb
+- test/inch/api/options/base_test.rb
+- test/inch/api/stats_test.rb
+- test/inch/api/suggest_test.rb
 - test/inch/cli/arguments_test.rb
 - test/inch/cli/command/base_test.rb
 - test/inch/cli/command/list_test.rb
@@ -259,14 +318,20 @@ test_files:
 - test/inch/cli/command/suggest_test.rb
 - test/inch/cli/command_parser_test.rb
 - test/inch/cli/trace_helper_test.rb
-- test/inch/cli/weighted_list_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/converter_test.rb
+- test/inch/code_object/provider/yard/docstring_test.rb
+- test/inch/code_object/provider/yard/nodoc_helper_test.rb
+- test/inch/code_object/provider/yard_test.rb
+- test/inch/code_object/provider_test.rb
 - test/inch/code_object/proxy/method_object_test.rb
 - test/inch/code_object/proxy_test.rb
-- test/inch/source_parser_test.rb
+- test/inch/codebase/objects_test.rb
+- test/inch/codebase/proxy_test.rb
+- test/inch/evaluation/role/base_test.rb
+- test/inch/utils/weighted_list_test.rb
 - test/integration/stats_options_test.rb
 - test/integration/visibility_options_test.rb
+- test/shared/base_list.rb
 - test/test_helper.rb
 has_rdoc: