inch 0.5.0.rc3 → 0.5.0.rc4

data/test/unit/{code_object → language/ruby}/provider/yard/docstring_test.rb

@@ -1,15 +1,14 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../../../../test_helper")
 
-describe ::Inch::CodeObject::Provider::YARD::Docstring do
-  let(:described_class) { ::Inch::CodeObject::Provider::YARD::Docstring }
+describe ::Inch::Language::Ruby::Provider::YARD::Docstring do
+  let(:described_class) { ::Inch::Language::Ruby::Provider::YARD::Docstring }
 
   #
   # loose TomDoc compatibility
   #
 
-
   it "should notice things in tomdoc style docs" do
-text = <<-DOC
+    text = <<-DOC
 Internal: Detects the Language of the blob.
 
 param1 - String filename
@@ -19,7 +18,7 @@ param2 - String blob data. A block also maybe passed in for lazy
 param3 - Optional String mode (defaults to nil)
 
 Returns Language or nil.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.describes_internal_api?
     assert docstring.mentions_parameter?(:param1)
@@ -34,7 +33,7 @@ DOC
   end
 
   it "should notice things in tomdoc style docs 2" do
-text = <<-DOC
+    text = <<-DOC
 Public: Look up Language by one of its aliases.
 
 param1 - A String alias of the Language
@@ -45,7 +44,7 @@ Examples
   # => #<Language name="C++">
 
 Returns the Lexer or nil if none was found.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.mentions_parameter?(:param1)
     assert docstring.describes_parameter?(:param1)
@@ -56,8 +55,33 @@ DOC
     assert docstring.describes_return?
   end
 
+  it "should notice multi-line returns in tomdoc style docs" do
+    text = <<-DOC
+Public: Look up Language by one of its aliases.
+
+Returns the Lexer or nil
+  if none was found.
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_return?
+    assert docstring.describes_return?
+  end
+
+  it "should notice multi-line returns in tomdoc style docs 2" do
+    text = <<-DOC
+Public: Look up Language by one of its aliases.
+
+Returns the Lexer or nil
+  if none
+  was found.
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_return?
+    assert docstring.describes_return?
+  end
+
   it "should notice things in tomdoc style docs 3" do
-text = <<-DOC
+    text = <<-DOC
 Public: Look up Language by one of its aliases.
 
 param1 - A String alias of the Language
@@ -68,7 +92,7 @@ Examples
   # => #<Language name="C++">
 
 Returns the Lexer or nil if none was found.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.mentions_parameter?(:param1)
     assert docstring.describes_parameter?(:param1)
@@ -80,42 +104,43 @@ DOC
   end
 
   it "should understand 'Returns nil.'" do
-text = <<-DOC
+    text = <<-DOC
 [...]
 Returns nil.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.describes_return?
   end
 
   it "should understand 'Returns nil.' without fullstop and in lowercase" do
-text = <<-DOC
+    text = <<-DOC
 [...]
 returns nil
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.describes_return?
   end
 
   it "should understand 'Returns nothing.'" do
-text = <<-DOC
+    text = <<-DOC
 [...]
 Returns nothing.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.describes_return?
   end
 
   it "should understand 'Returns nothing.' without fullstop and in lowercase" do
-text = <<-DOC
+    text = <<-DOC
 [...]
 returns nothing
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.describes_return?
   end
 
-  it "should understand 'Returns ...' with a visibility modifier in front of it" do
+  it "should understand 'Returns ...' with a visibility modifier in front of" \
+     " it" do
     text = "Public: Returns the Integer color."
     docstring = described_class.new(text)
     assert docstring.mentions_return?
@@ -126,37 +151,32 @@ DOC
   # PARAMETER MENTIONS
   #
 
-
   it "should work 2" do
-text = <<-DOC
+    text = <<-DOC
 Just because format_html is mentioned here, does not mean
 the first parameter is mentioned.
-DOC
+    DOC
     docstring = described_class.new(text)
     refute docstring.mentions_parameter?(:format)
     refute docstring.contains_code_example?
   end
 
-
   it "should work 2 if correct" do
-text = <<-DOC
+    text = <<-DOC
 Just because format is mentioned here, does not mean
 the first parameter is meant.
-DOC
+    DOC
     docstring = described_class.new(text)
     refute docstring.mentions_parameter?(:format)
     refute docstring.contains_code_example?
   end
 
-
-
   #
   # CODE EXAMPLES
   #
 
-
   it "should work 3" do
-text = <<-DOC
+    text = <<-DOC
 An example of a method using RDoc rather than YARD.
 
 == Parameters:
@@ -165,13 +185,13 @@ param1::
 
 == Returns:
 A string in the specified format.
-DOC
+    DOC
     docstring = described_class.new(text)
     refute docstring.contains_code_example?
   end
 
   it "should work with code example" do
-text = <<-DOC
+    text = <<-DOC
 Another example.
 
   method_with_code_example() # => some value
@@ -180,7 +200,7 @@ Params:
 +param1+:: param1 line string to be executed by the system
 +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
+    DOC
     docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert docstring.mentions_parameter?(:param1)
@@ -191,21 +211,37 @@ DOC
     assert docstring.describes_parameter?(:param3)
   end
 
+  it "should recognize several parameter notations" do
+    text = <<-DOC
+Params:
++param1<String>+:: param1 line string to be executed by the system
++param2<String,nil>+:: +Proc+ object that takes a pipe object as first and only param (may be nil)
++param3<String|Class>+:: +Proc+ object that takes a pipe object as first and only param (may be nil)
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_parameter?(:param1), "should mention param1"
+    assert docstring.mentions_parameter?(:param2), "should mention param2"
+    assert docstring.mentions_parameter?(:param3), "should mention param3"
+    assert docstring.describes_parameter?(:param1), "should describe param1"
+    assert docstring.describes_parameter?(:param2), "should describe param2"
+    assert docstring.describes_parameter?(:param3), "should describe param3"
+  end
+
   it "should work with code example 2" do
-text = <<-DOC
+    text = <<-DOC
 Just because format_html is mentioned here, does not mean
 the first parameter is mentioned.
 
   method_with_code_example() # => some value
   method_with_missing_param_doc(param1, param2, param3)
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert_equal 1, docstring.code_examples.size
   end
 
   it "should work with code example 3" do
-text = <<-DOC
+    text = <<-DOC
 An example of a method using RDoc rather than YARD.
 
   method_with_code_example() # => some value
@@ -216,7 +252,7 @@ param1::
 
 == Returns:
 A string in the specified format.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert_equal 1, docstring.code_examples.size
@@ -225,7 +261,7 @@ DOC
   end
 
   it "should work with multiple code examples" do
-text = <<-DOC
+    text = <<-DOC
 An example of a method using RDoc rather than YARD.
 
   method_with_code_example() # => some value
@@ -241,7 +277,7 @@ param1::
 
 == Returns:
 A string in the specified format.
-DOC
+    DOC
     docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert_equal 2, docstring.code_examples.size

data/test/unit/{code_object → language/ruby}/provider/yard/nodoc_helper_test.rb

@@ -1,8 +1,9 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../../../../test_helper")
 
-describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
+describe ::Inch::Language::Ruby::Provider::YARD::NodocHelper do
   before do
-    @provider = ::Inch::CodeObject::Provider::YARD.parse(fixture_path(:simple))
+    @config = Inch::Config.codebase
+    @provider = ::Inch::Language::Ruby::Provider::YARD.parse(fixture_path(:ruby, :simple), @config)
     @objects = @provider.objects
   end
 
@@ -17,9 +18,9 @@ describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
       "Foo::HiddenClass::EvenMoreHiddenClass",
       "Foo::HiddenClass::EvenMoreHiddenClass#method_with_implicit_nodoc",
       "Foo::HiddenClassViaTag",
-      "Foo::HiddenClassViaTag#some_value",
+      "Foo::HiddenClassViaTag#some_value"
     ].each do |query|
-      m = @objects.detect { |o| o.fullname == query }
+      m = @objects.find { |o| o.fullname == query }
       assert m.nodoc?, "nodoc? should return true for #{query}"
     end
   end
@@ -30,9 +31,10 @@ describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
       "Foo::Qux::Quux::PUBLIC_VALUE",
       "Foo::Qux::DOCCED_VALUE",
       "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass",
-      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass#method_with_implicit_doc",
+      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass" \
+        "#method_with_implicit_doc"
     ].each do |query|
-      m = @objects.detect { |o| o.fullname == query }
+      m = @objects.find { |o| o.fullname == query }
       refute m.nodoc?, "nodoc? should return false for #{query}"
     end
   end

data/test/unit/{code_object → language/ruby}/provider/yard/object/method_object_test.rb

@@ -1,14 +1,17 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../../../../../test_helper")
 
-describe ::Inch::CodeObject::Provider::YARD::Parser do
+describe ::Inch::Language::Ruby::Provider::YARD::Parser do
   before do
     @config = Inch::Config.codebase
-    @parser = ::Inch::CodeObject::Provider::YARD::Parser.parse(fixture_path(:simple), @config)
+    @parser = ::Inch::Language::Ruby::Provider::YARD::Parser.parse(
+      fixture_path(:ruby, :simple), @config)
     @objects = @parser.objects
   end
 
   it "should work for Overloading#params_also_in_overloads" do
-    m = @objects.detect { |o| o.fullname == 'Overloading#params_also_in_overloads' }
+    m = @objects.find do |o|
+      o.fullname == "Overloading#params_also_in_overloads"
+    end
 
     assert m.has_code_example?
 
@@ -16,7 +19,8 @@ describe ::Inch::CodeObject::Provider::YARD::Parser do
     assert_equal 2, m.parameters.size # at this moment, this counts all parameters in all overloaded signatures
 
     signature = m.signatures[0]
-    assert_equal "params_also_in_overloads(user_options = {})", signature.signature
+    assert_equal "params_also_in_overloads(user_options = {})",
+                 signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:user_options).nil?
     assert signature.has_code_example?
@@ -24,7 +28,8 @@ describe ::Inch::CodeObject::Provider::YARD::Parser do
 
     signature = m.signatures[1]
     assert_equal "params_also_in_overloads()", signature.signature
-    assert signature.parameters.empty?, "Should have been empty: #{signature.parameters.inspect}"
+    assert signature.parameters.empty?,
+           "Should have been empty: #{signature.parameters.inspect}"
     assert signature.has_code_example?
     refute signature.has_doc?
 
@@ -37,7 +42,9 @@ describe ::Inch::CodeObject::Provider::YARD::Parser do
   end
 
   it "should work for Overloading#params_only_in_overloads" do
-    m = @objects.detect { |o| o.fullname == 'Overloading#params_only_in_overloads' }
+    m = @objects.find do |o|
+      o.fullname == "Overloading#params_only_in_overloads"
+    end
 
     assert m.has_code_example?
 
@@ -46,7 +53,8 @@ describe ::Inch::CodeObject::Provider::YARD::Parser do
 
     signature = m.signatures[0]
     assert_equal "params_only_in_overloads()", signature.signature
-    assert signature.parameters.empty?, "Should have been empty: #{signature.parameters.inspect}"
+    assert signature.parameters.empty?,
+           "Should have been empty: #{signature.parameters.inspect}"
     assert signature.has_code_example?
     refute signature.has_doc?
 
@@ -62,17 +70,19 @@ describe ::Inch::CodeObject::Provider::YARD::Parser do
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:user_options).nil?
     assert signature.has_code_example?
-    #assert signature.has_doc?
+    # assert signature.has_doc?
   end
 
   it "should work" do
-    m = @objects.detect { |o| o.fullname == 'Foo::Bar#method_with_unstructured_doc' }
+    m = @objects.find do |o|
+      o.fullname == "Foo::Bar#method_with_unstructured_doc"
+    end
     assert_equal 1, m.signatures.size
     assert_equal 1, m.parameters.size
   end
 
   it "should work 2" do
-    m = @objects.detect { |o| o.fullname == 'Foo#method_with_splat_parameter' }
+    m = @objects.find { |o| o.fullname == "Foo#method_with_splat_parameter" }
     assert_equal 1, m.signatures.size
     assert_equal 1, m.parameters.size
   end

data/test/unit/language/ruby/provider/yard_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../../test_helper")
+
+describe ::Inch::Language::Ruby::Provider::YARD do
+  let(:described_class) { ::Inch::Language::Ruby::Provider::YARD }
+  let(:config) { ::Inch::Config.codebase }
+
+  it "should parse" do
+    provider = described_class.parse(fixture_path(:ruby, :simple), config)
+    assert !provider.objects.empty?
+  end
+
+  it "should parse too different codebases" do
+    fullname = "Foo#b"
+
+    provider1 = described_class.parse(fixture_path(:ruby, :diff1), config)
+    object1 = provider1.objects.find { |o| o.fullname == fullname }
+
+    provider2 = described_class.parse(fixture_path(:ruby, :diff2), config)
+    object2 = provider2.objects.find { |o| o.fullname == fullname }
+
+    refute object1.nil?
+    refute object2.nil?
+    assert object1.object_id != object2.object_id
+  end
+end

data/test/unit/utils/buffered_ui_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require 'inch/utils/buffered_ui'
+
+describe ::Inch::Utils::BufferedUI do
+  let(:described_class) { ::Inch::Utils::BufferedUI }
+  it "should trace" do
+    out, err = capture_io do
+      @instance = described_class.new
+      @instance.trace("Test")
+    end
+    assert out.empty?, "there should be output"
+    assert err.empty?, "there should be no errors"
+    refute @instance.buffer.empty?
+  end
+
+  it "should trace header" do
+    out, err = capture_io do
+      @instance = described_class.new
+      @instance.header("Test", :red)
+    end
+    assert out.empty?, "there should be output"
+    assert err.empty?, "there should be no errors"
+    refute @instance.buffer.empty?
+  end
+
+  it "should trace debug if ENV variable is set" do
+    ENV["DEBUG"] = "1"
+    out, err = capture_io do
+      @instance = described_class.new
+      @instance.debug("Test")
+    end
+    ENV["DEBUG"] = nil
+    assert out.empty?, "there should be output"
+    assert err.empty?, "there should be no errors"
+    refute @instance.buffer.empty?
+  end
+
+  it "should not trace debug if ENV variable is set" do
+    refute ENV["DEBUG"]
+    out, err = capture_io do
+      @instance = described_class.new
+      @instance.debug("Test")
+    end
+    assert out.empty?, "there should be no output"
+    assert err.empty?, "there should be no errors"
+    assert @instance.buffer.empty?
+  end
+end