inch 0.4.10 → 0.5.0.rc1

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

@@ -41,12 +41,8 @@ module Foo
     def method_without_docstring(p1, p2 = nil)
     end
 
-    # @return [String]
-    def method_without_params_or_docstring
-    end
-
     # @return [void]
-    def method_without_usable_return_value
+    def method_without_params_or_docstring
     end
 
     # Provides an example of a method without parameters
@@ -76,23 +72,6 @@ module Foo
     def method_with_other_rdoc_doc(param1, param2, param3)
     end
 
-    # Injects text right after the class definition. Since it depends on
-    # insert_into_file, it's reversible.
-    #
-    # ==== Parameters
-    # param1<String>:: path of the file to be changed
-    # param2<String|Class>:: the class to be manipulated
-    #
-    # ==== Examples
-    #
-    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController, "  filter_parameter :password\n"
-    #
-    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController do
-    #     "  filter_parameter :password\n"
-    #   end
-    def method_with_yet_another_rdoc_doc(param1, param2)
-    end
-
     # An example of a method that takes a parameter (+param1+)
     # and does nothing. But the previous sentence mentions said
     # parameter.

data/test/integration/api/compare/codebases.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::Compare::Codebases do
   let(:described_class) { ::Inch::API::Compare::Codebases }

data/test/integration/cli/command/console_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 Inch::CLI::Command::Output::Console
   def run_pry
@@ -22,8 +22,8 @@ describe ::Inch::CLI::Command::Console do
   end
 
   it "should run without args" do
-    _out, _err = capture_io do
-      @prompt = @command.new.run
+    out, err = capture_io do
+      @prompt = @command.new.run()
     end
     assert @prompt.respond_to?(:all)
     assert @prompt.respond_to?(:ff)
@@ -34,7 +34,7 @@ describe ::Inch::CLI::Command::Console do
   end
 
   it "should run with a definitive object name" do
-    _out, _err = capture_io do
+    out, err = capture_io do
       @prompt = @command.new.run("Foo::Bar#method_with_full_doc")
     end
     assert !@prompt.all.empty?
@@ -46,7 +46,7 @@ describe ::Inch::CLI::Command::Console do
   end
 
   it "should run with a partial name" do
-    _out, _err = capture_io do
+    out, err = capture_io do
       @prompt = @command.new.run("Foo::Bar#")
     end
     assert @prompt.respond_to?(:all)

data/test/integration/cli/command/inspect_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::Inspect do
   before do
@@ -8,7 +8,7 @@ describe ::Inch::CLI::Command::Inspect do
 
   it "should warn and exit when run without args" do
     out, err = capture_io do
-      assert_raises(SystemExit) { @command.run }
+      assert_raises(SystemExit) { @command.run() }
     end
     assert out.empty?, "there should be no output"
     refute err.empty?, "there should be some error message"
@@ -33,6 +33,7 @@ describe ::Inch::CLI::Command::Inspect do
     assert err.empty?, "there should be no errors"
   end
 
+
   it "should output some info when run with a definitive object name" do
     out, err = capture_io do
       @command.run("Foo::Qux")
@@ -52,14 +53,14 @@ describe ::Inch::CLI::Command::Inspect do
   end
 
   it "should output colored information" do
-    out, _err = capture_io do
+    out, err = capture_io do
       @command.run("Foo::Bar#")
     end
     refute_equal out.uncolor, out, "should be colored"
   end
 
   it "should output uncolored information when asked" do
-    out, _err = capture_io do
+    out, err = capture_io do
       @command.run("Foo::Bar#", "--no-color")
     end
     assert_equal out.uncolor, out, "should not be colored"

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

@@ -1,5 +1,5 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
-require File.expand_path(File.dirname(__FILE__) + "/../../../shared/base_list")
+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
@@ -11,7 +11,7 @@ describe ::Inch::CLI::Command::List 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"
@@ -62,3 +62,4 @@ describe ::Inch::CLI::Command::List do
     assert err.empty?, "there should be no errors"
   end
 end
+

data/test/integration/cli/command/show_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::Show do
   before do
@@ -8,7 +8,7 @@ describe ::Inch::CLI::Command::Show do
 
   it "should warn and exit when run without args" do
     out, err = capture_io do
-      assert_raises(SystemExit) { @command.run }
+      assert_raises(SystemExit) { @command.run() }
     end
     assert out.empty?, "there should be no output"
     refute err.empty?, "there should be some error message"
@@ -44,14 +44,14 @@ describe ::Inch::CLI::Command::Show do
   end
 
   it "should output colored information" do
-    out, _err = capture_io do
+    out, err = capture_io do
       @command.run("Foo::Bar#")
     end
     refute_equal out.uncolor, out, "should be colored"
   end
 
   it "should output uncolored information when asked" do
-    out, _err = capture_io do
+    out, err = capture_io do
       @command.run("Foo::Bar#", "--no-color")
     end
     assert_equal out.uncolor, out, "should not be colored"

data/test/integration/cli/command/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::CLI::Command::Stats do
   before do
@@ -8,7 +8,7 @@ describe ::Inch::CLI::Command::Stats 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"

data/test/integration/cli/command/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::CLI::Command::Suggest do
   before do
@@ -8,12 +8,12 @@ describe ::Inch::CLI::Command::Suggest 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"
     assert_match /\bFoo::Bar#method_with_wrong_doc\b/, out
-    assert_match /\bFoo::Bar#method_with_rdoc_doc\b/, out
+    assert_match /\bFoo::Bar#method_without_docstring\b/, out
     assert_match /\bFoo::Bar#method_with_unstructured_doc\b/, out
   end
 
@@ -32,18 +32,18 @@ describe ::Inch::CLI::Command::Suggest do
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
     assert_match /\bFoo::Bar#method_with_wrong_doc\b/, out
-    assert_match /\bFoo::Bar#method_with_rdoc_doc\b/, out
+    assert_match /\bFoo::Bar#method_without_docstring\b/, out
     assert_match /\bFoo::Bar#method_with_unstructured_doc\b/, out
   end
 
   it "should run with non-existing filelist in args" do
-    _out, _err = capture_io do
+    out, err = capture_io do
       @command.run("app/**/*.rb")
     end
     # TODO: not sure what should actually happen here:
     #   no output or error message?
-    # 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
 
   it "should run with --objects switch" do
@@ -53,12 +53,12 @@ describe ::Inch::CLI::Command::Suggest do
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
     assert_match /\bFoo::Bar#method_with_wrong_doc\b/, out
-    assert_match /\bFoo::Bar#method_with_rdoc_doc\b/, out
+    assert_match /\bFoo::Bar#method_without_docstring\b/, out
     assert_match /\bFoo::Bar#method_with_unstructured_doc\b/, out
   end
 
   it "should give error when run with --unknown-switch" do
-    _out, _err = capture_io do
+    out, err = capture_io do
       assert_raises(SystemExit) { @command.run("--unknown-switch") }
     end
   end
@@ -86,7 +86,7 @@ describe ::Inch::CLI::Command::Suggest do
   it "should run without args on really good fixture" do
     out, err = capture_io do
       Dir.chdir fixture_path(:really_good)
-      @command.run
+      @command.run()
     end
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"

data/test/integration/stats_options_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 #
 # These format tests also broke things in the regular testsuite.
@@ -20,13 +20,13 @@ describe ::Inch::CLI::Command::List do
   end
 
   it "should run with --no-private switch" do
-    out = `#{@command} --format json`
+    out = %x|#{@command} --format json|
     refute out.empty?, "there should be some output"
     assert_parsed_output JSON[out]
   end
 
   it "should run with --no-protected switch" do
-    out = `#{@command} --format yaml`
+    out = %x|#{@command} --format yaml|
     refute out.empty?, "there should be some output"
     assert_parsed_output YAML.load(out)
   end

data/test/integration/visibility_options_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 do
   before do
@@ -7,7 +7,7 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run without visibility switches" do
-    out, _err = capture_io do
+    out, err = capture_io do
       @command.run("--all")
     end
     refute out.empty?, "there should be some output"
@@ -18,7 +18,7 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run with --no-protected switch" do
-    out, _err = capture_io do
+    out, err = capture_io do
       @command.run("--all", "--no-protected")
     end
     refute out.empty?, "there should be some output"
@@ -29,8 +29,8 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run with --no-public switch" do
-    out, _err = capture_io do
-      @command.run(*%w(--all --no-public))
+    out, err = capture_io do
+      @command.run(*%w|--all --no-public|)
     end
     refute out.empty?, "there should be some output"
     refute_match /\bFoo#public_method\b/, out
@@ -40,8 +40,8 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run with --no-public --no-protected switch" do
-    out, _err = capture_io do
-      @command.run(*%w(--all --no-public --no-protected))
+    out, err = capture_io do
+      @command.run(*%w|--all --no-public --no-protected|)
     end
     assert out.empty?, "there should be no output"
     refute_match /\bFoo#public_method\b/, out
@@ -51,8 +51,8 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run with --no-public --no-protected --private switch" do
-    out, _err = capture_io do
-      @command.run(*%w(--all --no-public --no-protected --private))
+    out, err = capture_io do
+      @command.run(*%w|--all --no-public --no-protected --private|)
     end
     refute out.empty?, "there should be some output"
     refute_match /\bFoo#public_method\b/, out
@@ -62,8 +62,8 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run with --no-public switch" do
-    out, _err = capture_io do
-      @command.run(*%w(--all --no-public))
+    out, err = capture_io do
+      @command.run(*%w|--all --no-public|)
     end
     refute out.empty?, "there should be some output"
     refute_match /\bFoo#public_method\b/, out
@@ -73,8 +73,8 @@ describe ::Inch::CLI::Command do
   end
 
   it "should run with --no-protected switch" do
-    out, _err = capture_io do
-      @command.run(*%w(--all --no-protected))
+    out, err = capture_io do
+      @command.run(*%w|--all --no-protected|)
     end
     refute out.empty?, "there should be some output"
     assert_match /\bFoo#public_method\b/, out

data/test/shared/base_list.rb

@@ -3,10 +3,8 @@ module Shared
     extend Minitest::Spec::DSL
 
     it "should give error when run with --unknown-switch" do
-      _out, _err = capture_io do
-        assert_raises(SystemExit) do
-          @command.run("lib/foo.rb", "--unknown-switch")
-        end
+      out, err = capture_io do
+        assert_raises(SystemExit) { @command.run("lib/foo.rb", "--unknown-switch") }
       end
     end
 
@@ -45,6 +43,7 @@ module Shared
       assert_match /\bFoo::Bar#/, out
     end
 
+
     it "should run with --only-undocumented switch" do
       skip
       out, err = capture_io do

data/test/test_helper.rb

@@ -1,12 +1,12 @@
-require "simplecov"
+require 'simplecov'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require "minitest/autorun"
-require "bundler"
+require 'minitest/autorun'
+require 'bundler'
 Bundler.require
-require "inch"
-require "inch/cli"
+require 'inch'
+require 'inch/cli'
 
 def assert_roles(object, expected, unexpected)
   roles = object.roles.map(&:class)
@@ -18,16 +18,6 @@ def assert_roles(object, expected, unexpected)
   end
 end
 
-def count_roles(object, role_class, object_name = nil)
-  find_roles(object, role_class, object_name).size
-end
-
-def find_roles(object, role_class, object_name = nil)
-  object.roles.select do |r|
-    r.class == role_class && (object_name.nil? || r.object.name == object_name)
-  end
-end
-
 def fixture_path(name)
   File.join(File.dirname(__FILE__), "fixtures", name.to_s)
 end

data/test/unit/api/filter_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::Filter do
   before do
@@ -13,37 +13,37 @@ describe ::Inch::API::Filter do
   end
 
   it "should work with option: visibility == :public" do
-    @options = { visibility: [:public] }
+    @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] }
+    @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] }
+    @options = {:visibility => [:private]}
     @context = ::Inch::API::Filter.new @codebase, @options
     assert @context.objects.all? { |o| o.private? || o.tagged_as_private? }
   end
 
   it "should work with option: namespaces == :only" do
-    @options = { namespaces: :only }
+    @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 }
+    @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 }
+    @options = {:depth => 2}
     @context = ::Inch::API::Filter.new @codebase, @options
     refute @context.objects.any? { |o| o.depth > 2 }
   end