inch 0.0.1 → 0.1.0

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

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CLI::Command::Stats do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Stats
+  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"
+  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"
+  end
+
+  it "should run even with non-existing filelist in args" do
+    out, err = capture_io do
+      @command.run("app/**/*.rb")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output info when run with --format=json" do
+    out, err = capture_io do
+      @command.run("--format=json")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors: #{err.yellow}"
+  end
+
+  it "should output info when run with --format=yaml" do
+    out, err = capture_io do
+      @command.run("--format=yaml")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors: #{err.yellow}"
+  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.+stats/, out
+    assert err.empty?, "there should be no errors"
+  end
+end

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

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CLI::Command::Suggest do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Suggest
+  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::Bar#method_with_wrong_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 --pedantic switch" do
+    out, err = capture_io do
+      @command.run("--pedantic")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+  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::Bar#method_with_wrong_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
+      @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"
+  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.+suggest/, out
+    assert err.empty?, "there should be no errors"
+  end
+end

data/test/inch/cli/command_parser_test.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CLI::CommandParser do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::CommandParser
+  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"
+  end
+
+  it "should run Command::Suggest with filelist in args" do
+    out, err = capture_io do
+      @command.run("suggest", "lib/**/*.rb", "app/**/*.rb")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      @command.run("--help")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+inch/, out
+    assert err.empty?, "there should be no errors"
+  end
+end

data/test/inch/cli/yardopts_helper_test.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CLI::YardoptsHelper do
+  before do
+    Dir.chdir fixture_path(:yardopts)
+    assert File.file?(".yardopts")
+    @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#initialize\b/, out
+  end
+
+  it "should run with --no-yardopts" do
+    out, err = capture_io do
+      @instance = @command.run("app/**/*.rb", "--no-yardopts")
+    end
+    assert out.empty?, "there should be no output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should run with a given path and .yardopts" do
+    out, err = capture_io do
+      # lib/something*.rb doesnot exist in the fixture, it is just given as
+      # a command-line path to check if it appears in the parsed filelist
+      @instance = @command.run("lib/something*.rb")
+    end
+    refute out.empty?, "there should be no output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should parse options with --no-yardopts" do
+    @options = ::Inch::CLI::Command::Options::List.new
+    @options.parse(["app/**/*.rb", "--no-yardopts"])
+    assert_equal ["app/**/*.rb"], @options.paths
+  end
+
+  it "should parse options with a given path and .yardopts" do
+    # lib/something*.rb doesnot exist in the fixture, it is just given as
+    # a command-line path to check if it appears in the parsed filelist
+    @options = ::Inch::CLI::Command::Options::List.new
+    @options.parse(["lib/something*.rb"])
+    assert_equal ["foo/**/*.rb", "lib/something*.rb"], @options.paths
+  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_match /\b\-\-\[no\-\]yardopts\b/, out, "--[no-]yardopts should be mentioned"
+    assert err.empty?, "there should be no errors"
+  end
+end
+
+describe ::Inch::CLI::YardoptsHelper do
+  before do
+    Dir.chdir fixture_path(:simple)
+    refute File.file?(".yardopts")
+    refute File.file?(".document")
+    @command = ::Inch::CLI::Command::List
+  end
+
+  it "should not interfere with paths in arguments" do
+    @options = ::Inch::CLI::Command::Options::List.new
+    @options.parse(["lib/**/foo*.rb"])
+    assert_equal ["lib/**/foo*.rb"], @options.paths
+  end
+
+  it "should not intefer with --all at the end" do
+    @options = ::Inch::CLI::Command::Options::List.new
+    @options.parse(["lib/**/foo*.rb", "--all"])
+    assert_equal ["lib/**/foo*.rb"], @options.paths
+  end
+
+end

data/test/inch/code_object/docstring_test.rb

@@ -0,0 +1,204 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CodeObject::Docstring do
+
+
+  #
+  # loose TomDoc compatibility
+  #
+
+
+  it "should notice things in tomdoc style docs" do
+text = <<-DOC
+Public: Detects the Language of the blob.
+
+param1 - String filename
+param2 - String blob data. A block also maybe passed in for lazy
+       loading. This behavior is deprecated and you should always
+       pass in a String.
+param3 - Optional String mode (defaults to nil)
+
+Returns Language or nil.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.mentions_parameter?(:param2)
+    assert docstring.mentions_parameter?(:param3)
+    assert docstring.describes_parameter?(:param1)
+    assert docstring.describes_parameter?(:param2)
+    assert docstring.describes_parameter?(:param3)
+    refute docstring.contains_code_example?
+    assert docstring.mentions_return?
+  end
+
+  it "should notice things in tomdoc style docs 2" do
+text = <<-DOC
+Public: Look up Language by one of its aliases.
+
+param1 - A String alias of the Language
+
+Examples
+
+  Language.find_by_alias('cpp')
+  # => #<Language name="C++">
+
+Returns the Lexer or nil if none was found.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.describes_parameter?(:param1)
+    refute docstring.mentions_parameter?(:alias)
+    refute docstring.mentions_parameter?(:Look)
+    assert docstring.contains_code_example?
+    assert docstring.mentions_return?
+  end
+
+  it "should notice things in tomdoc style docs 3" do
+text = <<-DOC
+Public: Look up Language by one of its aliases.
+
+param1 - A String alias of the Language
+
+Examples
+
+  Language.find_by_alias('cpp')
+  # => #<Language name="C++">
+
+Returns the Lexer or nil if none was found.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.describes_parameter?(:param1)
+    refute docstring.mentions_parameter?(:alias)
+    refute docstring.mentions_parameter?(:Look)
+    assert docstring.contains_code_example?
+    assert docstring.mentions_return?
+  end
+
+
+  #
+  # PARAMETER MENTIONS
+  #
+
+
+  it "should work 2" do
+text = <<-DOC
+Just because format_html is mentioned here, does not mean
+the first parameter is mentioned.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    refute docstring.mentions_parameter?(:format)
+    refute docstring.contains_code_example?
+  end
+
+
+  it "should work 2" do
+text = <<-DOC
+Just because format is mentioned here, does not mean
+the first parameter is meant.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    refute docstring.mentions_parameter?(:format)
+    refute docstring.contains_code_example?
+  end
+
+
+
+  #
+  # CODE EXAMPLES
+  #
+
+
+  it "should work 3" do
+text = <<-DOC
+An example of a method using RDoc rather than YARD.
+
+== Parameters:
+param1::
+  A Symbol declaring some markup language like `:md` or `:html`.
+
+== Returns:
+A string in the specified format.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    refute docstring.contains_code_example?
+  end
+
+  it "should work with code example" do
+text = <<-DOC
+Another example.
+
+  method_with_code_example() # => some value
+
+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
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    assert docstring.contains_code_example?
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.mentions_parameter?(:param2)
+    assert docstring.mentions_parameter?(:param3)
+    assert docstring.describes_parameter?(:param1)
+    assert docstring.describes_parameter?(:param2)
+    assert docstring.describes_parameter?(:param3)
+  end
+
+  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.
+
+  method_with_code_example() # => some value
+  method_with_missing_param_doc(param1, param2, param3)
+DOC
+    docstring = ::Inch::CodeObject::Docstring.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
+An example of a method using RDoc rather than YARD.
+
+  method_with_code_example() # => some value
+
+== Parameters:
+param1::
+  A Symbol declaring some markup language like `:md` or `:html`.
+
+== Returns:
+A string in the specified format.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    assert docstring.contains_code_example?
+    assert_equal 1, docstring.code_examples.size
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.describes_parameter?(:param1)
+  end
+
+  it "should work with multiple code examples" do
+text = <<-DOC
+An example of a method using RDoc rather than YARD.
+
+  method_with_code_example() # => some value
+
+Another example of a method:
+
+  Article.__elasticsearch__.create_index! 1, force: true
+  Article.__elasticsearch__.create_index! 2, force: true
+
+== Parameters:
+param1::
+  A Symbol declaring some markup language like `:md` or `:html`.
+
+== Returns:
+A string in the specified format.
+DOC
+    docstring = ::Inch::CodeObject::Docstring.new(text)
+    assert docstring.contains_code_example?
+    assert_equal 2, docstring.code_examples.size
+    assert docstring.code_examples.last.index("create_index! 2")
+  end
+end

data/test/inch/code_object/nodoc_helper_test.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CodeObject::NodocHelper do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @source_parser = Inch::SourceParser.run(["lib/**/*.rb"])
+  end
+
+  it "should return true for explicitly 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",
+    ].each do |query|
+      m = @source_parser.find_object(query)
+      assert m.nodoc?, "nodoc? should return true for #{query}"
+    end
+  end
+
+  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",
+    ].each do |query|
+      m = @source_parser.find_object(query)
+      refute m.nodoc?, "nodoc? should return false for #{query}"
+    end
+  end
+
+end