inch 0.2.3 → 0.3.0.rc1

data/lib/inch/{cli → utils}/weighted_list.rb

@@ -1,5 +1,5 @@
 module Inch
-  module CLI
+  module Utils
     class WeightedList
       # Trims down a list of object lists to given sizes.
       # If there are not enough objects in any particular tier,

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.2.3"
+  VERSION = "0.3.0.rc1"
 end

data/test/fixtures/simple/lib/broken.rb

@@ -7,6 +7,14 @@ module Foo
   def method_with_wrong_param_tag(e)
 
   end
+
+  # The problem here is that the @param tag does not describe the parameter
+  #
+  # @param [Encoding] e
+  # @return [String]
+  def method_with_empty_param_tag_text(e)
+
+  end
 end
 
 module YardError

data/test/inch/api/filter_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::API::Filter do
+  before do
+    @dir = fixture_path(:simple)
+    @codebase = ::Inch::Codebase.parse(@dir)
+  end
+
+  it "should work" do
+    @options = {}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    refute @context.objects.empty?
+    refute @context.grade_lists.empty?
+  end
+
+  it "should work with option: visibility == :public" do
+    @options = {:visibility => [:public]}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    assert @context.objects.all? { |o| o.public? }
+  end
+
+  it "should work with option: visibility == :protected" do
+    @options = {:visibility => [:protected]}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    assert @context.objects.all? { |o| o.protected? }
+  end
+
+  it "should work with option: visibility == :private" do
+    @options = {:visibility => [:private]}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    assert @context.objects.all? { |o| o.private? || o.private_tag? }
+  end
+
+  it "should work with option: namespaces == :only" do
+    @options = {:namespaces => :only}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    assert @context.objects.all? { |o| o.namespace? }
+  end
+
+  it "should work with option: undocumented == :only" do
+    @options = {:undocumented => :only}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    assert @context.objects.all? { |o| o.undocumented? }
+  end
+
+  it "should work with option: depth == 2" do
+    @options = {:depth => 2}
+    @context = ::Inch::API::Filter.new @codebase, @options
+    refute @context.objects.any? { |o| o.depth > 2 }
+  end
+end

data/test/inch/api/get_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::API::Get do
+  before do
+    @dir = fixture_path(:simple)
+    @codebase = ::Inch::Codebase.parse(@dir)
+  end
+
+  it "should work" do
+    @object_names = ["Foo", "Foo::Bar"]
+    @context = ::Inch::API::Get.new @codebase, @object_names
+    assert_equal 2, @context.objects.size
+    refute @context.object.nil?
+    refute @context.grade_lists.empty?
+  end
+
+  it "should work with wildcard" do
+    @object_names = ["Foo", "Foo::Bar#"]
+    @context = ::Inch::API::Get.new @codebase, @object_names
+    assert @context.objects.size > 2
+  end
+end

data/test/inch/api/list_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::API::List do
+  before do
+    @dir = fixture_path(:simple)
+    @codebase = ::Inch::Codebase.parse(@dir)
+  end
+
+  it "should work" do
+    @options = {}
+    @context = ::Inch::API::List.new @codebase, @options
+    refute @context.objects.empty?
+    refute @context.grade_lists.empty?
+  end
+end

data/test/inch/api/options/base_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::API::Options::Base do
+  class APIOptionsTest < ::Inch::API::Options::Base
+    attribute :foo, :bar
+    attribute :baz
+    attribute :qux
+  end
+
+  it "should work with a Hash or Struct" do
+    @options_hash = {:foo => "foo", :baz => 42}
+    @options_struct = OpenStruct.new(@options_hash)
+
+    @options1 = APIOptionsTest.new @options_hash
+    @options2 = APIOptionsTest.new @options_struct
+
+    assert_equal "foo", @options1.foo
+    assert_equal "foo", @options2.foo
+    assert_equal 42, @options1.baz
+    assert_equal 42, @options2.baz
+  end
+
+  it "should return default values" do
+    @options_hash = {:baz => 42}
+    @options = APIOptionsTest.new @options_hash
+
+    assert_equal :bar, @options.foo
+    assert_equal 42, @options.baz
+  end
+end

data/test/inch/api/stats_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::API::Stats do
+  before do
+    @dir = fixture_path(:simple)
+    @codebase = ::Inch::Codebase.parse(@dir)
+  end
+
+  it "should work" do
+    @options = {}
+    @context = ::Inch::API::Stats.new @codebase, @options
+    refute @context.objects.empty?
+    refute @context.grade_lists.empty?
+  end
+end

data/test/inch/api/suggest_test.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::API::Suggest do
+  before do
+    @dir = fixture_path(:simple)
+    @codebase = ::Inch::Codebase.parse(@dir)
+  end
+
+  it "should work" do
+    @options = {}
+    @context = ::Inch::API::Suggest.new @codebase, @options
+    refute @context.objects.empty?
+    refute @context.grade_lists.empty?
+  end
+
+  it "should work with option: object_count" do
+    @options = {:object_count => 10}
+    @context = ::Inch::API::Suggest.new @codebase, @options
+
+    @options2 = {:object_count => 20}
+    @context2 = ::Inch::API::Suggest.new @codebase, @options2
+
+    assert_equal 10, @context.objects.size
+    assert_equal 20, @context2.objects.size
+  end
+end

data/test/inch/cli/command/list_test.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../../shared/base_list')
 
 describe ::Inch::CLI::Command::List do
   before do
@@ -6,7 +7,7 @@ describe ::Inch::CLI::Command::List do
     @command = ::Inch::CLI::Command::List
   end
 
-  include BaseListTests
+  include Shared::BaseList
 
   it "should run without args" do
     out, err = capture_io do

data/test/inch/code_object/converter_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CodeObject::Converter do
+  class MockObject
+    def docstring
+      "Foo::Bar"
+    end
+
+    def parameters
+      []
+    end
+
+    def public?
+      false
+    end
+
+    def private?
+      true
+    end
+  end
+
+  let(:object) { MockObject.new }
+  it "should parse all objects" do
+    attributes = ::Inch::CodeObject::Converter.to_hash(object)
+    assert_equal object.docstring, attributes[:docstring]
+    assert_equal object.public?, attributes[:public?]
+    assert_equal object.private?, attributes[:private?]
+  end
+end

data/test/inch/code_object/{docstring_test.rb → provider/yard/docstring_test.rb}

@@ -1,7 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
-
-describe ::Inch::CodeObject::Docstring do
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
+describe ::Inch::CodeObject::Provider::YARD::Docstring do
+  let(:described_class) { ::Inch::CodeObject::Provider::YARD::Docstring }
 
   #
   # loose TomDoc compatibility
@@ -20,7 +20,7 @@ param3 - Optional String mode (defaults to nil)
 
 Returns Language or nil.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.mentions_parameter?(:param1)
     assert docstring.mentions_parameter?(:param2)
     assert docstring.mentions_parameter?(:param3)
@@ -45,7 +45,7 @@ Examples
 
 Returns the Lexer or nil if none was found.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.mentions_parameter?(:param1)
     assert docstring.describes_parameter?(:param1)
     refute docstring.mentions_parameter?(:alias)
@@ -68,7 +68,7 @@ Examples
 
 Returns the Lexer or nil if none was found.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.mentions_parameter?(:param1)
     assert docstring.describes_parameter?(:param1)
     refute docstring.mentions_parameter?(:alias)
@@ -89,7 +89,7 @@ text = <<-DOC
 Just because format_html is mentioned here, does not mean
 the first parameter is mentioned.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     refute docstring.mentions_parameter?(:format)
     refute docstring.contains_code_example?
   end
@@ -100,7 +100,7 @@ text = <<-DOC
 Just because format is mentioned here, does not mean
 the first parameter is meant.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     refute docstring.mentions_parameter?(:format)
     refute docstring.contains_code_example?
   end
@@ -123,7 +123,7 @@ param1::
 == Returns:
 A string in the specified format.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     refute docstring.contains_code_example?
   end
 
@@ -138,7 +138,7 @@ Params:
 +param2+:: +Proc+ object that takes a pipe object as first and only param (may be nil)
 +param3+:: +Proc+ object that takes a pipe object as first and only param (may be nil)
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert docstring.mentions_parameter?(:param1)
     assert docstring.mentions_parameter?(:param2)
@@ -156,7 +156,7 @@ the first parameter is mentioned.
   method_with_code_example() # => some value
   method_with_missing_param_doc(param1, param2, param3)
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert_equal 1, docstring.code_examples.size
   end
@@ -174,7 +174,7 @@ param1::
 == Returns:
 A string in the specified format.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert_equal 1, docstring.code_examples.size
     assert docstring.mentions_parameter?(:param1)
@@ -199,7 +199,7 @@ param1::
 == Returns:
 A string in the specified format.
 DOC
-    docstring = ::Inch::CodeObject::Docstring.new(text)
+    docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert_equal 2, docstring.code_examples.size
     assert docstring.code_examples.last.index("create_index! 2")

data/test/inch/code_object/{nodoc_helper_test.rb → provider/yard/nodoc_helper_test.rb}

@@ -1,9 +1,9 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
-describe ::Inch::CodeObject::NodocHelper do
+describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
   before do
-    Dir.chdir fixture_path(:simple)
-    @source_parser = Inch::SourceParser.run(["lib/**/*.rb"])
+    @provider = ::Inch::CodeObject::Provider::YARD.parse(fixture_path(:simple), ["lib/**/*.rb"], [])
+    @objects = @provider.objects
   end
 
   it "should return true for explicitly or implicitly tagged objects" do
@@ -19,7 +19,7 @@ describe ::Inch::CodeObject::NodocHelper do
       "Foo::HiddenClassViaTag",
       "Foo::HiddenClassViaTag#some_value",
     ].each do |query|
-      m = @source_parser.find_object(query)
+      m = @objects.detect { |o| o.fullname == query }
       assert m.nodoc?, "nodoc? should return true for #{query}"
     end
   end
@@ -32,7 +32,7 @@ describe ::Inch::CodeObject::NodocHelper do
       "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass",
       "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass#method_with_implicit_doc",
     ].each do |query|
-      m = @source_parser.find_object(query)
+      m = @objects.detect { |o| o.fullname == query }
       refute m.nodoc?, "nodoc? should return false for #{query}"
     end
   end

data/test/inch/code_object/provider/yard_test.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CodeObject::Provider::YARD do
+  let(:described_class) { ::Inch::CodeObject::Provider::YARD }
+
+  it "should parse" do
+    provider = described_class.parse(fixture_path(:simple), ["lib/**/*.rb"], [])
+    assert !provider.objects.empty?
+  end
+
+end

data/test/inch/code_object/provider_test.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CodeObject::Provider do
+  it "should parse all objects" do
+    Dir.chdir File.dirname(__FILE__)
+    @provider = ::Inch::CodeObject::Provider.parse(fixture_path(:simple), ["lib/**/*.rb"], [])
+    refute @provider.objects.empty?
+  end
+end

data/test/inch/code_object/proxy/method_object_test.rb

@@ -3,11 +3,11 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 describe ::Inch::CodeObject::Proxy::MethodObject do
   before do
     Dir.chdir fixture_path(:simple)
-    @source_parser ||= Inch::SourceParser.run(["lib/**/*.rb"])
+    @codebase = Inch::Codebase.parse(fixture_path(:simple), ["lib/**/*.rb"])
   end
 
   def test_method_without_doc
-    m = @source_parser.find_object("Foo::Bar#method_without_doc")
+    m = @codebase.objects.find("Foo::Bar#method_without_doc")
     refute m.has_doc?
     refute m.has_parameters?
     refute m.return_mentioned?
@@ -17,7 +17,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_missing_param_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_missing_param_doc")
+    m = @codebase.objects.find("Foo::Bar#method_with_missing_param_doc")
     assert m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -34,7 +34,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_wrong_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_wrong_doc")
+    m = @codebase.objects.find("Foo::Bar#method_with_wrong_doc")
     assert m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -57,7 +57,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_full_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_full_doc")
+    m = @codebase.objects.find("Foo::Bar#method_with_full_doc")
     assert m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -74,7 +74,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_without_params_or_return_type
-    m = @source_parser.find_object("Foo::Bar#method_without_params_or_return_type")
+    m = @codebase.objects.find("Foo::Bar#method_without_params_or_return_type")
     assert m.has_doc?
     refute m.has_parameters?
     refute m.return_mentioned?
@@ -83,7 +83,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_without_docstring
-    m = @source_parser.find_object("Foo::Bar#method_without_docstring")
+    m = @codebase.objects.find("Foo::Bar#method_without_docstring")
     refute m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -92,7 +92,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_without_params_or_docstring
-    m = @source_parser.find_object("Foo::Bar#method_without_params_or_docstring")
+    m = @codebase.objects.find("Foo::Bar#method_without_params_or_docstring")
     refute m.has_doc?
     refute m.has_parameters?
     assert m.return_mentioned?
@@ -101,7 +101,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_rdoc_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_rdoc_doc")
+    m = @codebase.objects.find("Foo::Bar#method_with_rdoc_doc")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:param1)
@@ -112,7 +112,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_other_rdoc_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_other_rdoc_doc")
+    m = @codebase.objects.find("Foo::Bar#method_with_other_rdoc_doc")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:param1)
@@ -127,7 +127,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_unstructured_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc")
+    m = @codebase.objects.find("Foo::Bar#method_with_unstructured_doc")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:param1)
@@ -138,7 +138,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_unstructured_doc_missing_params
-    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc_missing_params")
+    m = @codebase.objects.find("Foo::Bar#method_with_unstructured_doc_missing_params")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:format)
@@ -149,7 +149,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_question_mark_method
-    m = @source_parser.find_object("InchTest#question_mark_method?")
+    m = @codebase.objects.find("InchTest#question_mark_method?")
     refute m.has_doc?
     refute m.has_parameters?
 
@@ -157,7 +157,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_question_mark_method_with_description
-    m = @source_parser.find_object("InchTest#question_mark_method_with_description?")
+    m = @codebase.objects.find("InchTest#question_mark_method_with_description?")
     refute m.has_doc?
     refute m.has_parameters?
 
@@ -166,7 +166,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_description_and_parameters
-    m = @source_parser.find_object("InchTest#method_with_description_and_parameters?")
+    m = @codebase.objects.find("InchTest#method_with_description_and_parameters?")
     refute m.has_doc?
     assert m.has_parameters?
 
@@ -174,43 +174,43 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_getter
-    m = @source_parser.find_object("InchTest#getter")
+    m = @codebase.objects.find("InchTest#getter")
     assert m.getter?, "should be a getter"
     refute m.setter?
   end
 
   def test_setter
-    m = @source_parser.find_object("InchTest#attr_setter=")
+    m = @codebase.objects.find("InchTest#attr_setter=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_setter2
-    m = @source_parser.find_object("InchTest#manual_setter=")
+    m = @codebase.objects.find("InchTest#manual_setter=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_manual_getset
-    m = @source_parser.find_object("InchTest#manual_getset")
+    m = @codebase.objects.find("InchTest#manual_getset")
     assert m.getter?, "should be a getter"
     refute m.setter?
   end
 
   def test_manual_getset2
-    m = @source_parser.find_object("InchTest#manual_getset=")
+    m = @codebase.objects.find("InchTest#manual_getset=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_attr_getset
-    m = @source_parser.find_object("InchTest#attr_getset")
+    m = @codebase.objects.find("InchTest#attr_getset")
     assert m.getter?, "should be a getter"
     refute m.setter?
   end
 
   def test_attr_getset2
-    m = @source_parser.find_object("InchTest#attr_getset=")
+    m = @codebase.objects.find("InchTest#attr_getset=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end