inch 0.0.1 → 0.1.0

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

@@ -0,0 +1,78 @@
+def root_method
+end
+
+module InchTest
+  def bang_method!
+  end
+
+  def splat_method(*args)
+  end
+
+  def block_method(&block)
+  end
+
+  def question_mark_method?
+    if true
+      bang_method!
+    end
+  end
+
+  def many_parameters_method(a,b,c,d,e,f)
+  end
+
+  def alias_method
+  end
+  alias :am :alias_method
+
+  def many_lines_method
+    if true
+      if true
+        if true
+          if true
+            bang_method!
+          end
+        end
+      end
+    end
+    if true
+      if true
+        if true
+          if true
+            bang_method!
+          end
+        end
+      end
+    end
+    if true
+      if true
+        if true
+          if true
+            bang_method!
+          end
+        end
+      end
+    end
+  end
+
+  # @deprecated
+  # @see InchTest
+  def unconsidered_tags_method
+  end
+  public :public_method
+
+  def public_method
+  end
+
+
+  def protected_method
+  end
+  protected :protected_method
+
+  def private_method
+  end
+  private :private_method
+
+  # @private
+  def method_with_private_tag
+  end
+end

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

@@ -0,0 +1,68 @@
+
+# @deprecated
+# @see PureNamespace
+PUBLIC_ROOT_CONSTANT = :foo
+
+class String
+  def foobar
+    self + 'foobar!'
+  end
+end
+
+module InchTest
+  # You would want to use it like this:
+  #
+  #  CodeExample.new
+  #
+  class CodeExample
+  end
+
+  # You would want to use it like this:
+  #
+  #  CodeExample.new
+  #
+  #  CodeExample.new # => something
+  #
+  class MultipleCodeExamples
+  end
+
+  module PureNamespace
+  end
+
+  # @deprecated
+  # @see PureNamespace
+  module ManyChildren
+    class Base0; end
+    class Base1; end
+    class Base2; end
+    class Base3; end
+    class Base4; end
+    class Base5; end
+    class Base6; end
+    class Base7; end
+    class Base8; end
+    class Base9; end
+    class Base10; end
+    class Base11; end
+    class Base12; end
+    class Base13; end
+    class Base14; end
+    class Base15; end
+    class Base16; end
+    class Base17; end
+    class Base18; end
+    class Base19; end
+    class Base20; end
+    class Base21; end
+  end
+
+  module ManyAttributes
+    attr_accessor :base0
+    attr_accessor :base1
+    attr_accessor :base2
+    attr_accessor :base3
+    attr_accessor :base4
+    attr_accessor :base5
+    attr_accessor :base6
+  end
+end

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

@@ -0,0 +1,18 @@
+class Foo
+  def public_method
+  end
+  public :public_method
+
+
+  def protected_method
+  end
+  protected :protected_method
+
+  def private_method
+  end
+  private :private_method
+
+  # @private
+  def method_with_private_tag
+  end
+end

data/test/fixtures/yardopts/.yardopts

@@ -0,0 +1 @@
+foo/**/*.rb

data/test/fixtures/yardopts/foo/bar.rb

@@ -0,0 +1,6 @@
+class Foo
+  class Bar
+    def initialize
+    end
+  end
+end

data/test/inch/cli/arguments_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CLI::Arguments do
+  before do
+    Dir.chdir fixture_path(:simple)
+    assert File.file?("README")
+  end
+
+  it "should run with files" do
+    args = [
+      "lib/**/*.rb", "app/**/*.rb", "README"
+    ]
+    arguments = ::Inch::CLI::Arguments.new(args)
+    assert_equal ["lib/**/*.rb", "app/**/*.rb", "README"], arguments.files
+    assert_equal [], arguments.object_names
+    assert_equal [], arguments.switches
+  end
+
+  it "should run with directories as well" do
+    args = [
+      "lib", "app/**/*.rb", "README"
+    ]
+    arguments = ::Inch::CLI::Arguments.new(args)
+    assert_equal ["lib", "app/**/*.rb", "README"], arguments.files
+    assert_equal [], arguments.object_names
+    assert_equal [], arguments.switches
+  end
+
+  it "should run with files and object_name" do
+    args = [
+      "{app,lib}.rb", "README", "Foo"
+    ]
+    arguments = ::Inch::CLI::Arguments.new(args)
+    assert_equal ["{app,lib}.rb", "README"], arguments.files
+    assert_equal ["Foo"], arguments.object_names
+    assert_equal [], arguments.switches
+  end
+
+  it "should run with object_names" do
+    args = [
+      "Foo::Bar"
+    ]
+    arguments = ::Inch::CLI::Arguments.new(args)
+    assert_equal [], arguments.files, "files"
+    assert_equal ["Foo::Bar"], arguments.object_names
+    assert_equal [], arguments.switches
+  end
+
+  it "should run with option switches" do
+    args = [
+      "--no-color", "--all"
+    ]
+    arguments = ::Inch::CLI::Arguments.new(args)
+    assert_equal [], arguments.files
+    assert_equal [], arguments.object_names
+    assert_equal ["--no-color", "--all"], arguments.switches
+  end
+
+  it "should run with all of them" do
+    args = [
+      "lib/**/*.rb", "app/**/*.rb", "README",
+      "Foo", "Foo::Bar", "--no-color", "--all"
+    ]
+    arguments = ::Inch::CLI::Arguments.new(args)
+    assert_equal ["lib/**/*.rb", "app/**/*.rb", "README"], arguments.files
+    assert_equal ["Foo", "Foo::Bar"], arguments.object_names
+    assert_equal ["--no-color", "--all"], arguments.switches
+  end
+
+end

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

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+class Inch::CLI::Command::Output::Console
+  def run_pry
+    nil # instead of binding.pry
+  end
+end
+
+describe ::Inch::CLI::Command::Console do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Console
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--help") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+console/, out
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should run without args" do
+    out, err = capture_io do
+      @prompt = @command.new.run()
+    end
+    assert @prompt.respond_to?(:all)
+    assert @prompt.respond_to?(:ff)
+    assert @prompt.respond_to?(:f)
+    assert @prompt.respond_to?(:o)
+    assert @prompt.o.nil?
+    assert @prompt.objects.empty?
+  end
+
+  it "should run with a definitive object name" do
+    out, err = capture_io do
+      @prompt = @command.new.run("Foo::Bar#method_with_full_doc")
+    end
+    assert @prompt.respond_to?(:all)
+    assert @prompt.respond_to?(:ff)
+    assert @prompt.respond_to?(:f)
+    assert @prompt.respond_to?(:o)
+    refute @prompt.o.nil?
+    assert_equal 1, @prompt.objects.size
+  end
+
+  it "should run with a partial name" do
+    out, err = capture_io do
+      @prompt = @command.new.run("Foo::Bar#")
+    end
+    assert @prompt.respond_to?(:all)
+    assert @prompt.respond_to?(:ff)
+    assert @prompt.respond_to?(:f)
+    assert @prompt.respond_to?(:o)
+    refute @prompt.o.nil?
+    assert @prompt.objects.size > 1
+  end
+end

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

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CLI::Command::Inspect do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Inspect
+  end
+
+  it "should warn and exit when run without args" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run() }
+    end
+    assert out.empty?, "there should be no output"
+    refute err.empty?, "there should be some error message"
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--help") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+inspect/, out
+    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::Bar#method_with_full_doc", "--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    refute_match(/\b Foo::Bar#method_without_doc\b/, out)
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output all children info when run with a partial name" do
+    out, err = capture_io do
+      @command.run("Foo::Bar#", "--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo::Bar#method_without_doc\b/, out
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output colored information" 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
+      @command.run("Foo::Bar#", "--no-color")
+    end
+    assert_equal out.uncolor, out, "should not be colored"
+  end
+end

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

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CLI::Command::List do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::List
+  end
+
+  it "should run without args" do
+    out, err = capture_io do
+      @command.run()
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_match /\bFoo\b/, out
+    assert_match /\bFoo::Bar\b/, out
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    assert_match /\bFoo::Bar#method_with_code_example\b/, out
+  end
+
+  it "should run with --numbers switch" do
+    out, err = capture_io do
+      @command.run("--numbers")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_match /\bFoo\b/, out
+    assert_match /\bFoo::Bar\b/, out
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    assert_match /\bFoo::Bar#method_with_code_example\b/, out
+  end
+
+  it "should run with filelist in args" do
+    out, err = capture_io do
+      @command.run("lib/**/*.rb", "app/**/*.rb")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_match /\bFoo\b/, out
+    assert_match /\bFoo::Bar\b/, out
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    assert_match /\bFoo::Bar#method_with_code_example\b/, out
+  end
+
+  it "should run with non-existing filelist in args" do
+    out, err = capture_io do
+      @command.run("app/**/*.rb")
+    end
+    assert out.empty?, "there should be no output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--help") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+list/, out
+    assert err.empty?, "there should be no errors"
+  end
+end

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

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CLI::Command::Show do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Show
+  end
+
+  it "should warn and exit when run without args" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run() }
+    end
+    assert out.empty?, "there should be no output"
+    refute err.empty?, "there should be some error message"
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--help") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+show/, out
+    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::Bar#method_with_full_doc", "--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    refute_match(/\b Foo::Bar#method_without_doc\b/, out)
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output all children info when run with a partial name" do
+    out, err = capture_io do
+      @command.run("Foo::Bar#", "--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo::Bar#method_without_doc\b/, out
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output colored information" 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
+      @command.run("Foo::Bar#", "--no-color")
+    end
+    assert_equal out.uncolor, out, "should not be colored"
+  end
+end