inch 0.5.0.rc5 → 0.5.0.rc6

data/test/unit/language/ruby/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::Language::Ruby::Provider::YARD::Docstring do
   let(:described_class) { ::Inch::Language::Ruby::Provider::YARD::Docstring }
@@ -7,7 +7,7 @@ describe ::Inch::Language::Ruby::Provider::YARD::Docstring do
   # loose TomDoc compatibility
   #
 
-  it "should notice things in tomdoc style docs" do
+  it 'should notice things in tomdoc style docs' do
     text = <<-DOC
 Internal: Detects the Language of the blob.
 
@@ -32,7 +32,7 @@ Returns Language or nil.
     assert docstring.describes_return?
   end
 
-  it "should notice things in tomdoc style docs 2" do
+  it 'should notice things in tomdoc style docs 2' do
     text = <<-DOC
 Public: Look up Language by one of its aliases.
 
@@ -55,7 +55,7 @@ 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
+  it 'should notice multi-line returns in tomdoc style docs' do
     text = <<-DOC
 Public: Look up Language by one of its aliases.
 
@@ -67,7 +67,7 @@ Returns the Lexer or nil
     assert docstring.describes_return?
   end
 
-  it "should notice multi-line returns in tomdoc style docs 2" do
+  it 'should notice multi-line returns in tomdoc style docs 2' do
     text = <<-DOC
 Public: Look up Language by one of its aliases.
 
@@ -80,7 +80,7 @@ Returns the Lexer or nil
     assert docstring.describes_return?
   end
 
-  it "should notice things in tomdoc style docs 3" do
+  it 'should notice things in tomdoc style docs 3' do
     text = <<-DOC
 Public: Look up Language by one of its aliases.
 
@@ -140,8 +140,8 @@ returns nothing
   end
 
   it "should understand 'Returns ...' with a visibility modifier in front of" \
-     " it" do
-    text = "Public: Returns the Integer color."
+     ' it' do
+    text = 'Public: Returns the Integer color.'
     docstring = described_class.new(text)
     assert docstring.mentions_return?
     assert docstring.describes_return?
@@ -151,7 +151,7 @@ returns nothing
   # PARAMETER MENTIONS
   #
 
-  it "should work 2" do
+  it 'should work 2' do
     text = <<-DOC
 Just because format_html is mentioned here, does not mean
 the first parameter is mentioned.
@@ -161,7 +161,7 @@ the first parameter is mentioned.
     refute docstring.contains_code_example?
   end
 
-  it "should work 2 if correct" do
+  it 'should work 2 if correct' do
     text = <<-DOC
 Just because format is mentioned here, does not mean
 the first parameter is meant.
@@ -175,7 +175,7 @@ the first parameter is meant.
   # CODE EXAMPLES
   #
 
-  it "should work 3" do
+  it 'should work 3' do
     text = <<-DOC
 An example of a method using RDoc rather than YARD.
 
@@ -190,7 +190,8 @@ A string in the specified format.
     refute docstring.contains_code_example?
   end
 
-  it "should work with code example" do
+  it 'should work with code example' do
+    # rubocop:disable Metrics/LineLength
     text = <<-DOC
 Another example.
 
@@ -201,6 +202,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
+    # rubocop:enable Metrics/LineLength
     docstring = described_class.new(text)
     assert docstring.contains_code_example?
     assert docstring.mentions_parameter?(:param1)
@@ -211,23 +213,25 @@ Params:
     assert docstring.describes_parameter?(:param3)
   end
 
-  it "should recognize several parameter notations" do
+  it 'should recognize several parameter notations' do
+    # rubocop:disable Metrics/LineLength
     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
+    # rubocop:enable Metrics/LineLength
     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"
+    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
+  it 'should work with code example 2' do
     text = <<-DOC
 Just because format_html is mentioned here, does not mean
 the first parameter is mentioned.
@@ -240,7 +244,7 @@ the first parameter is mentioned.
     assert_equal 1, docstring.code_examples.size
   end
 
-  it "should work with code example 3" do
+  it 'should work with code example 3' do
     text = <<-DOC
 An example of a method using RDoc rather than YARD.
 
@@ -260,7 +264,7 @@ A string in the specified format.
     assert docstring.describes_parameter?(:param1)
   end
 
-  it "should work with multiple code examples" do
+  it 'should work with multiple code examples' do
     text = <<-DOC
 An example of a method using RDoc rather than YARD.
 
@@ -281,6 +285,6 @@ A string in the specified format.
     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")
+    assert docstring.code_examples.last.index('create_index! 2')
   end
 end

data/test/unit/language/ruby/provider/yard/nodoc_helper_test.rb

@@ -1,38 +1,39 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../test_helper')
 
 describe ::Inch::Language::Ruby::Provider::YARD::NodocHelper do
   before do
     @config = Inch::Config.codebase
-    @provider = ::Inch::Language::Ruby::Provider::YARD.parse(fixture_path(:ruby, :simple), @config)
+    @provider = ::Inch::Language::Ruby::Provider::YARD.parse(
+      fixture_path(:ruby, :simple), @config)
     @objects = @provider.objects
   end
 
-  it "should return true for explicitly or implicitly tagged objects" do
+  it 'should return true for explicitly or implicitly tagged objects' do
     [
-      "Foo::Qux",
-      "Foo::Qux#method_with_implicit_nodoc",
-      "Foo::Qux::Quux#method_with_private_tag",
-      "Foo::Qux::Quux#method_with_explicit_nodoc",
-      "Foo::Qux::Quux::PRIVATE_VALUE",
-      "Foo::HiddenClass",
-      "Foo::HiddenClass::EvenMoreHiddenClass",
-      "Foo::HiddenClass::EvenMoreHiddenClass#method_with_implicit_nodoc",
-      "Foo::HiddenClassViaTag",
-      "Foo::HiddenClassViaTag#some_value"
+      'Foo::Qux',
+      'Foo::Qux#method_with_implicit_nodoc',
+      'Foo::Qux::Quux#method_with_private_tag',
+      'Foo::Qux::Quux#method_with_explicit_nodoc',
+      'Foo::Qux::Quux::PRIVATE_VALUE',
+      'Foo::HiddenClass',
+      'Foo::HiddenClass::EvenMoreHiddenClass',
+      'Foo::HiddenClass::EvenMoreHiddenClass#method_with_implicit_nodoc',
+      'Foo::HiddenClassViaTag',
+      'Foo::HiddenClassViaTag#some_value'
     ].each do |query|
       m = @objects.find { |o| o.fullname == query }
       assert m.nodoc?, "nodoc? should return true for #{query}"
     end
   end
 
-  it "should return false for other objects" do
+  it 'should return false for other objects' do
     [
-      "Foo::Qux::Quux#method_without_nodoc",
-      "Foo::Qux::Quux::PUBLIC_VALUE",
-      "Foo::Qux::DOCCED_VALUE",
-      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass",
-      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass" \
-        "#method_with_implicit_doc"
+      'Foo::Qux::Quux#method_without_nodoc',
+      'Foo::Qux::Quux::PUBLIC_VALUE',
+      'Foo::Qux::DOCCED_VALUE',
+      'Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass',
+      'Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass' \
+        '#method_with_implicit_doc'
     ].each do |query|
       m = @objects.find { |o| o.fullname == query }
       refute m.nodoc?, "nodoc? should return false for #{query}"

data/test/unit/language/ruby/provider/yard/object/method_object_test.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) +
+                         '/../../../../../../test_helper')
 
 describe ::Inch::Language::Ruby::Provider::YARD::Parser do
   before do
@@ -8,18 +9,19 @@ describe ::Inch::Language::Ruby::Provider::YARD::Parser do
     @objects = @parser.objects
   end
 
-  it "should work for Overloading#params_also_in_overloads" do
+  it 'should work for Overloading#params_also_in_overloads' do
     m = @objects.find do |o|
-      o.fullname == "Overloading#params_also_in_overloads"
+      o.fullname == 'Overloading#params_also_in_overloads'
     end
 
     assert m.has_code_example?
 
     assert_equal 3, m.signatures.size
-    assert_equal 2, m.parameters.size # at this moment, this counts all parameters in all overloaded signatures
+    # at this moment, this counts all parameters in all overloaded signatures
+    assert_equal 2, m.parameters.size
 
     signature = m.signatures[0]
-    assert_equal "params_also_in_overloads(user_options = {})",
+    assert_equal 'params_also_in_overloads(user_options = {})',
                  signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:user_options).nil?
@@ -27,62 +29,63 @@ describe ::Inch::Language::Ruby::Provider::YARD::Parser do
     assert signature.has_doc?
 
     signature = m.signatures[1]
-    assert_equal "params_also_in_overloads()", signature.signature
+    assert_equal 'params_also_in_overloads()', signature.signature
     assert signature.parameters.empty?,
            "Should have been empty: #{signature.parameters.inspect}"
     assert signature.has_code_example?
     refute signature.has_doc?
 
     signature = m.signatures[2]
-    assert_equal "params_also_in_overloads(transaction_id)", signature.signature
+    assert_equal 'params_also_in_overloads(transaction_id)', signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:transaction_id).nil?
     assert signature.has_code_example?
     refute signature.has_doc?
   end
 
-  it "should work for Overloading#params_only_in_overloads" do
+  it 'should work for Overloading#params_only_in_overloads' do
     m = @objects.find do |o|
-      o.fullname == "Overloading#params_only_in_overloads"
+      o.fullname == 'Overloading#params_only_in_overloads'
     end
 
     assert m.has_code_example?
 
     assert_equal 3, m.signatures.size
-    assert_equal 2, m.parameters.size # at this moment, this counts all parameters in all overloaded signatures
+    # at this moment, this counts all parameters in all overloaded signatures
+    assert_equal 2, m.parameters.size
 
     signature = m.signatures[0]
-    assert_equal "params_only_in_overloads()", signature.signature
+    assert_equal 'params_only_in_overloads()', signature.signature
     assert signature.parameters.empty?,
            "Should have been empty: #{signature.parameters.inspect}"
     assert signature.has_code_example?
     refute signature.has_doc?
 
     signature = m.signatures[1]
-    assert_equal "params_only_in_overloads(transaction_id)", signature.signature
+    assert_equal 'params_only_in_overloads(transaction_id)', signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:transaction_id).nil?
     assert signature.has_code_example?
     refute signature.has_doc?
 
     signature = m.signatures[2]
-    assert_equal "params_only_in_overloads(user_options)", signature.signature
+    assert_equal 'params_only_in_overloads(user_options)', signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:user_options).nil?
     assert signature.has_code_example?
     # assert signature.has_doc?
   end
 
-  it "should work" do
+  it 'should work' do
     m = @objects.find do |o|
-      o.fullname == "Foo::Bar#method_with_unstructured_doc"
+      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.find { |o| o.fullname == "Foo#method_with_splat_parameter" }
+  it 'should work 2' do
+    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

@@ -1,16 +1,16 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../../test_helper")
+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
+  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"
+  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 }

data/test/unit/utils/buffered_ui_test.rb

@@ -1,48 +1,48 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+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
+  it 'should trace' do
     out, err = capture_io do
       @instance = described_class.new
-      @instance.trace("Test")
+      @instance.trace('Test')
     end
-    assert out.empty?, "there should be output"
-    assert err.empty?, "there should be no errors"
+    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
+  it 'should trace header' do
     out, err = capture_io do
       @instance = described_class.new
-      @instance.header("Test", :red)
+      @instance.header('Test', :red)
     end
-    assert out.empty?, "there should be output"
-    assert err.empty?, "there should be no errors"
+    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"
+  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")
+      @instance.debug('Test')
     end
-    ENV["DEBUG"] = nil
-    assert out.empty?, "there should be output"
-    assert err.empty?, "there should be no errors"
+    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"]
+  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")
+      @instance.debug('Test')
     end
-    assert out.empty?, "there should be no output"
-    assert err.empty?, "there should be no errors"
+    assert out.empty?, 'there should be no output'
+    assert err.empty?, 'there should be no errors'
     assert @instance.buffer.empty?
   end
 end

data/test/unit/utils/ui_test.rb

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