inch 0.4.10 → 0.5.0.rc1

data/test/unit/api/get_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Get do
   before do

data/test/unit/api/list_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::List do
   before do

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

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

data/test/unit/api/stats_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Stats do
   before do

data/test/unit/api/suggest_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Suggest do
   before do
@@ -13,10 +13,10 @@ describe ::Inch::API::Suggest do
   end
 
   it "should work with option: object_count" do
-    @options = { object_count: 10 }
+    @options = {:object_count => 10}
     @context = ::Inch::API::Suggest.new @codebase, @options
 
-    @options2 = { object_count: 20 }
+    @options2 = {:object_count => 20}
     @context2 = ::Inch::API::Suggest.new @codebase, @options2
 
     assert_equal 10, @context.objects.size

data/test/unit/cli/arguments_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::CLI::Arguments do
   before do

data/test/unit/cli/command/base_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 describe ::Inch::CLI::Command::Console do
   before do

data/test/unit/cli/command/options/base_list_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
 describe ::Inch::CLI::Command::Options::BaseList do
   it "should run parse without errors" do
@@ -10,7 +10,7 @@ describe ::Inch::CLI::Command::Options::BaseList do
     assert @options.undocumented.nil?
     assert @options.depth.nil?
   end
-
+  
   it "should run parse twice without affecting the second run" do
     @options = ::Inch::CLI::Command::Options::BaseList.new
     @options.parse(["--no-public", "--no-protected", "--private"])

data/test/unit/cli/command/options/base_object_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
 describe ::Inch::CLI::Command::Options::BaseObject do
   it "should run parse without errors" do

data/test/unit/cli/command/options/base_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
 describe ::Inch::CLI::Command::Options::Base do
   it "should run parse without errors" do

data/test/unit/cli/command_parser_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::CLI::CommandParser do
   before do
@@ -8,7 +8,7 @@ describe ::Inch::CLI::CommandParser do
 
   it "should run without args" do
     out, err = capture_io do
-      @command = @command_parser.run
+      @command = @command_parser.run()
     end
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"

data/test/unit/cli/trace_helper_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 class Tracer
   include ::Inch::CLI::TraceHelper

data/test/unit/cli/yardopts_helper_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::CLI::YardoptsHelper do
   before do
@@ -9,7 +9,7 @@ describe ::Inch::CLI::YardoptsHelper do
 
   it "should run without args" do
     out, err = capture_io do
-      @command.run
+      @command.run()
     end
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
@@ -56,8 +56,7 @@ describe ::Inch::CLI::YardoptsHelper do
     end
     refute out.empty?, "there should be some output"
     assert_match /\bUsage\b.+list/, out
-    # assert_match /\b\-\-\[no\-\]yardopts\b/, out,
-    #              "--[no-]yardopts should be mentioned"
+    #assert_match /\b\-\-\[no\-\]yardopts\b/, out, "--[no-]yardopts should be mentioned"
     assert err.empty?, "there should be no errors"
   end
 end

data/test/unit/code_object/converter_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::CodeObject::Converter do
   class MockObject

data/test/unit/code_object/provider/yard/docstring_test.rb

@@ -1,4 +1,4 @@
-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 }
@@ -7,8 +7,9 @@ describe ::Inch::CodeObject::Provider::YARD::Docstring do
   # 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
@@ -18,7 +19,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)
@@ -33,7 +34,7 @@ Returns Language or nil.
   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
@@ -44,7 +45,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)
@@ -55,33 +56,8 @@ Returns the Lexer or nil if none was found.
     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
@@ -92,7 +68,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)
@@ -103,80 +79,42 @@ Returns the Lexer or nil if none was found.
     assert docstring.describes_return?
   end
 
-  it "should understand 'Returns nil.'" do
-    text = <<-DOC
-[...]
-Returns nil.
-    DOC
-    docstring = described_class.new(text)
-    assert docstring.describes_return?
-  end
-
-  it "should understand 'Returns nil.' without fullstop and in lowercase" do
-    text = <<-DOC
-[...]
-returns nil
-    DOC
-    docstring = described_class.new(text)
-    assert docstring.describes_return?
-  end
-
-  it "should understand 'Returns nothing.'" do
-    text = <<-DOC
-[...]
-Returns nothing.
-    DOC
-    docstring = described_class.new(text)
-    assert docstring.describes_return?
-  end
-
-  it "should understand 'Returns nothing.' without fullstop and in lowercase" do
-    text = <<-DOC
-[...]
-returns nothing
-    DOC
-    docstring = described_class.new(text)
-    assert docstring.describes_return?
-  end
-
-  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?
-    assert docstring.describes_return?
-  end
 
   #
   # 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
+
+  it "should work 2" do
+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:
@@ -185,13 +123,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
@@ -200,7 +138,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)
@@ -211,37 +149,21 @@ Params:
     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
@@ -252,7 +174,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
@@ -261,7 +183,7 @@ A string in the specified format.
   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
@@ -277,7 +199,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/provider/yard/nodoc_helper_test.rb

@@ -1,4 +1,4 @@
-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
   before do
@@ -17,9 +17,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.find { |o| o.fullname == query }
+      m = @objects.detect { |o| o.fullname == query }
       assert m.nodoc?, "nodoc? should return true for #{query}"
     end
   end
@@ -30,10 +30,9 @@ 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.find { |o| o.fullname == query }
+      m = @objects.detect { |o| o.fullname == query }
       refute m.nodoc?, "nodoc? should return false for #{query}"
     end
   end