inch 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7567dd076efa1061ed2fe78515e1cae97bacd0c
-  data.tar.gz: d56dc92a462fab56c73d1693f091aec50b29ca62
+  metadata.gz: 252dd36f4749f380d6f1a5c6c78ebf39cbb6a02b
+  data.tar.gz: 189e4afb63928cfda6dceab1f855b8633a5490d7
 SHA512:
-  metadata.gz: fac873dedadc24c9d3430d2c60b921bd1b3ab16a7797ab37aca149b56897b28e53bcd021b7569fb56c1a29b3f31c12a0c72150b8092e49a40e4a1383738442d6
-  data.tar.gz: d3648df680260a3c7c9d450f372db7ff5eeb2477d3f9feef31f6b3380d08a6291cb295a263fe291cd91fbbbc11491fc2878f35896ae8c3e931dfb364349fa826
+  metadata.gz: 41efced3e37aac30b9a83ce7c278f0ea2e35d952f087242e24c11a59c2ad8ec8d4dd4a565023d8350c462afc46d21258478ce475c83bcf5cc4fe6126583fde3d
+  data.tar.gz: 4f5b2baba065d521af008bffeaa1f911e0d54024865fa31c5167bf9a677aa42863a20231c7e52c9dbab55f51710babfd6951f3b16aabc57480555c740a2cb9ed

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/README.md

@@ -3,9 +3,8 @@
 Inch is a documentation measurement tool for Ruby, based on
 [YARD](http://yardoc.org/).
 
-It does not measure documentation *coverage*, but grades and
-prioritizes code objects to give you hints where to improve your docs.
-One Inch at a time.
+It does not measure *coverage*, but grades your documentation to give you
+hints where to improve your docs. One Inch at a time.
 
 
 ## Installation
@@ -140,25 +139,19 @@ Suggests places where a codebase suffers a lack of documentation.
 
     # Properly documented, could be improved:
 
-    ┃  B  ↑  Inch::CLI::Command::BaseObject#prepare_objects
     ┃  B  ↑  Inch::CLI::Command::BaseList#prepare_list
-    ┃  B  ↑  Inch::CLI::Command::Suggest#run
-    ┃  B  ↑  Inch::CLI::Command::List#run
     ┃  B  ↑  Inch::CodeObject::Proxy::MethodParameterObject#initialize
     ┃  B  ↗  Inch::CLI::Command::Stats#run
     ┃  B  ↗  Inch::CLI::CommandParser#run
-    ┃  B  ↗  Inch::CLI::CommandParser.run
 
     # Not properly documented:
 
     ┃  C  ↑  Inch::CodeObject::NodocHelper#implicit_nodoc_comment?
-    ┃  C  ↑  Inch::CLI::Command::Output::Console#initialize
     ┃  C  ↑  Inch::CLI::Command::Output::Suggest#initialize
     ┃  C  ↑  Inch::Rake::Suggest#initialize
 
     # Undocumented:
 
-    ┃  U  ↑  Inch::Evaluation::NamespaceObject#evaluate
     ┃  U  ↑  Inch::Evaluation::ConstantObject#evaluate
     ┃  U  ↑  Inch::Evaluation::MethodObject#evaluate
     ┃  U  ↑  Inch::SourceParser#find_object
@@ -167,8 +160,6 @@ Suggests places where a codebase suffers a lack of documentation.
 
     ┃ lib/inch/code_object/proxy/base.rb
     ┃ lib/inch/code_object/proxy/method_object.rb
-    ┃ lib/inch/evaluation/role/constant.rb
-    ┃ lib/inch/evaluation/role/method_parameter.rb
     ┃ lib/inch/evaluation/role/object.rb
 
     Grade distribution (undocumented, C, B, A):  █  ▃ ▁ ▄
@@ -244,41 +235,24 @@ Lists all objects in your codebase with their grades.
     # Seems really good
 
     ┃  A  ↑  Inch::CLI::Command::Output::Console#object
-    ┃  A  ↗  Inch
     ┃  A  ↗  Inch::CodeObject::Proxy::Base#depth
-    ┃  A  ↗  Inch::CodeObject::Proxy::Base#height
     ┃  A  ↗  Inch::CLI::Command::Base#description
     ┃  A  ↗  Inch::CodeObject::NodocHelper#nodoc?
-    ┃  A  ↗  Inch::CLI::YardoptsHelper#parse_yardopts_options
-    ┃  A  ↗  Inch::Evaluation::NamespaceObject
-    ┃  A  ↗  Inch::SourceParser
-    ┃  A  ↗  Inch::Evaluation::ScoreRange#range=
     ┃ ...  (omitting 75 objects)
 
     # Proper documentation present
 
     ┃  B  ↑  Inch::CLI::Command::Suggest#run
-    ┃  B  ↑  Inch::CLI::Command::List#run
     ┃  B  ↑  Inch::CodeObject::Proxy::MethodParameterObject#initialize
     ┃  B  ↗  Inch::CLI::Command::Stats#run
     ┃  B  ↗  Inch::CLI::CommandParser#run
-    ┃  B  ↗  Inch::CLI::CommandParser.run
-    ┃  B  ↗  Inch::CLI::Command::Base.run
-    ┃  B  ↗  Inch::Evaluation::Base#object=
-    ┃  B  ↗  Inch::CodeObject::Proxy::Base#object=
 
     # Needs work
 
-    ┃  C  ↑  Inch::CLI::Command::Output::Stats#initialize
-    ┃  C  ↑  Inch::CLI::Command::Output::Suggest#initialize
     ┃  C  ↑  Inch::CodeObject::NodocHelper#implicit_nodoc_comment?
     ┃  C  ↑  Inch::CLI::Command::Output::Console#initialize
-    ┃  C  ↑  Inch::Evaluation::NamespaceObject#evaluate
     ┃  C  ↑  Inch::Evaluation::ConstantObject#evaluate
     ┃  C  ↑  Inch::SourceParser#find_object
-    ┃  C  ↑  Inch::Evaluation::MethodObject#evaluate
-    ┃  C  ↗  Inch::CLI::Command::Show#run
-    ┃  C  ↗  Inch::CodeObject::Proxy::Base
     ┃ ...  (omitting 248 objects)
 
     This output omitted 323 objects. Use `--all` to display all objects.

data/TODOS.md

@@ -7,6 +7,4 @@
   visibility options
 * Add support for multiple signatures for methods
   (realized via the @overload tag in YARD)
-* YARD assigns an implicit @return tag to methods ending in a question
-  mark -- maybe this is a problem since those methods appear as `C` in
-  the output, even if they don't have any other documentation
+* Make `inch lib/optparse.rb` work (without explicit `suggest`)

data/bin/inch

@@ -5,6 +5,12 @@ begin
   Bundler.require
 rescue Bundler::GemfileNotFound
 ensure
+  path = __FILE__
+  while File.symlink?(path)
+    path = File.expand_path(File.readlink(path), File.dirname(path))
+  end
+  $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+
   require 'inch'
 end
 

data/lib/inch/code_object/docstring.rb

@@ -33,6 +33,10 @@ module Inch
         @text.lines.last =~ /^Returns\ /
       end
 
+      def describes_return?
+        @text.lines.last =~ /^Returns\ (\w+\s){2,}/
+      end
+
       def parse_code_examples
         code_examples = []
         example = nil
@@ -76,10 +80,11 @@ module Inch
       end
 
       def describe_parameter_regexps(name)
-        mention_parameter_patterns(name).map do |pattern|
+        same_line_regexps = mention_parameter_patterns(name).map do |pattern|
           r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
           /^#{r}\s?\S+/
-        end + describe_parameter_extra_regexps(name)
+        end
+        same_line_regexps + describe_parameter_extra_regexps(name)
       end
 
       def mention_parameter_regexps(name)

data/lib/inch/code_object/proxy/method_object.rb

@@ -58,6 +58,14 @@ module Inch
           !!return_tag || docstring.mentions_return?
         end
 
+        def return_described?
+          (return_tag && !return_tag.text.empty?) || docstring.describes_return?
+        end
+
+        def questioning_name?
+          name =~ /\?$/
+        end
+
         private
 
         def all_parameter_names

data/lib/inch/evaluation/method_object.rb

@@ -22,6 +22,9 @@ module Inch
         if object.bang_name?
           add_role Role::Method::WithBangName.new(object)
         end
+        if object.questioning_name?
+          add_role Role::Method::WithQuestioningName.new(object)
+        end
         if object.has_alias?
           add_role Role::Method::HasAlias.new(object)
         end
@@ -117,7 +120,15 @@ module Inch
 
       def eval_return_type
         if object.return_mentioned?
-          add_role Role::Method::WithReturnType.new(object, RETURN_SCORE)
+          if object.questioning_name? && !object.return_described?
+            # annotating a question mark method with the return type boolean
+            # does not give any points
+            # also, this could to be one of those cases where YARD
+            # automatically assigns a @return tag to methods ending in a
+            # question mark
+          else
+            add_role Role::Method::WithReturnType.new(object, RETURN_SCORE)
+          end
         else
           add_role Role::Method::WithoutReturnType.new(object, RETURN_SCORE)
         end

data/lib/inch/evaluation/role/method.rb

@@ -22,6 +22,11 @@ module Inch
             +3
           end
         end
+        class WithQuestioningName < Base
+          def priority
+            -4
+          end
+        end
         class HasAlias < Base
           # +priority
           def priority
@@ -33,7 +38,7 @@ module Inch
         end
         class WithoutReturnType < Missing
           def suggestion
-            "Describe the return type of '#{object.name}'"
+            "Describe what '#{object.name}' returns"
           end
         end
 

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

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

@@ -17,6 +17,10 @@ module InchTest
     end
   end
 
+  # @return [Boolean] something funny
+  def question_mark_method_with_description?
+  end
+
   def many_parameters_method(a,b,c,d,e,f)
   end
 

data/test/inch/code_object/docstring_test.rb

@@ -29,6 +29,7 @@ DOC
     assert docstring.describes_parameter?(:param3)
     refute docstring.contains_code_example?
     assert docstring.mentions_return?
+    assert docstring.describes_return?
   end
 
   it "should notice things in tomdoc style docs 2" do
@@ -51,6 +52,7 @@ DOC
     refute docstring.mentions_parameter?(:Look)
     assert docstring.contains_code_example?
     assert docstring.mentions_return?
+    assert docstring.describes_return?
   end
 
   it "should notice things in tomdoc style docs 3" do
@@ -73,6 +75,7 @@ DOC
     refute docstring.mentions_parameter?(:Look)
     assert docstring.contains_code_example?
     assert docstring.mentions_return?
+    assert docstring.describes_return?
   end
 
 

data/test/inch/code_object/proxy/method_object_test.rb

@@ -0,0 +1,166 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CodeObject::Proxy::MethodObject do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @source_parser ||= Inch::SourceParser.run(["lib/**/*.rb"])
+  end
+
+  def test_method_without_doc
+    m = @source_parser.find_object("Foo::Bar#method_without_doc")
+    refute m.has_doc?
+    refute m.has_parameters?
+    refute m.return_mentioned?
+    assert m.undocumented?
+
+    assert_equal 0, m.score
+  end
+
+  def test_method_with_missing_param_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_missing_param_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert_equal 3, m.parameters.size
+    p = m.parameter(:param1)
+    assert p.mentioned?
+    p = m.parameter(:param2)
+    assert p.mentioned?
+    p = m.parameter(:param3)
+    refute p.mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_wrong_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_wrong_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert_equal 4, m.parameters.size
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute p.wrongly_mentioned?
+    p = m.parameter(:param2)
+    refute p.mentioned?
+    refute p.wrongly_mentioned? # not mentioned in docs at all
+    p = m.parameter(:param3)
+    refute p.mentioned?
+    refute p.wrongly_mentioned? # not mentioned in docs at all
+    p = m.parameter(:param4)
+    assert p.mentioned?
+    assert p.wrongly_mentioned? # mentioned in docs, but not present
+
+    assert m.score
+  end
+
+  def test_method_with_full_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_full_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert_equal 2, m.parameters.size
+    m.parameters.each do |param|
+      assert param.mentioned?
+      assert param.typed?
+      assert param.described?
+      refute param.wrongly_mentioned?
+    end
+
+    assert_equal 100, m.score
+  end
+
+  def test_method_without_params_or_return_type
+    m = @source_parser.find_object("Foo::Bar#method_without_params_or_return_type")
+    assert m.has_doc?
+    refute m.has_parameters?
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_without_docstring
+    m = @source_parser.find_object("Foo::Bar#method_without_docstring")
+    refute m.has_doc?
+    assert m.has_parameters?
+    assert m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_without_params_or_docstring
+    m = @source_parser.find_object("Foo::Bar#method_without_params_or_docstring")
+    refute m.has_doc?
+    refute m.has_parameters?
+    assert m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_rdoc_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_rdoc_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_other_rdoc_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_other_rdoc_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    p = m.parameter(:param2)
+    assert p.mentioned?         # mentioned in docs, correctly
+    p = m.parameter(:param3)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_unstructured_doc
+    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:param1)
+    assert p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_method_with_unstructured_doc_missing_params
+    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc_missing_params")
+    assert m.has_doc?
+    assert m.has_parameters?
+    p = m.parameter(:format)
+    refute p.mentioned?         # mentioned in docs, correctly
+    refute m.return_mentioned?
+
+    assert m.score
+  end
+
+  def test_question_mark_method
+    m = @source_parser.find_object("InchTest#question_mark_method?")
+    refute m.has_doc?
+    refute m.has_parameters?
+
+    assert_equal 0, m.score
+  end
+
+  def test_question_mark_method_with_description
+    m = @source_parser.find_object("InchTest#question_mark_method_with_description?")
+    refute m.has_doc?
+    refute m.has_parameters?
+
+    assert m.score > 0
+  end
+end

data/test/inch/code_object/proxy_test.rb

@@ -1,154 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
-describe ::Inch::CodeObject::Proxy::Base do
-  before do
-    Dir.chdir fixture_path(:simple)
-    @source_parser ||= Inch::SourceParser.run(["lib/**/*.rb"])
-  end
-
-  def test_method_without_doc
-    m = @source_parser.find_object("Foo::Bar#method_without_doc")
-    refute m.has_doc?
-    refute m.has_parameters?
-    refute m.return_mentioned?
-    assert m.undocumented?
-
-    assert_equal 0, m.score
-  end
-
-  def test_method_with_missing_param_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_missing_param_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    assert m.return_mentioned?
-
-    assert_equal 3, m.parameters.size
-    p = m.parameter(:param1)
-    assert p.mentioned?
-    p = m.parameter(:param2)
-    assert p.mentioned?
-    p = m.parameter(:param3)
-    refute p.mentioned?
-
-    assert m.score
-  end
-
-  def test_method_with_wrong_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_wrong_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    assert m.return_mentioned?
-
-    assert_equal 4, m.parameters.size
-    p = m.parameter(:param1)
-    assert p.mentioned?         # mentioned in docs, correctly
-    refute p.wrongly_mentioned?
-    p = m.parameter(:param2)
-    refute p.mentioned?
-    refute p.wrongly_mentioned? # not mentioned in docs at all
-    p = m.parameter(:param3)
-    refute p.mentioned?
-    refute p.wrongly_mentioned? # not mentioned in docs at all
-    p = m.parameter(:param4)
-    assert p.mentioned?
-    assert p.wrongly_mentioned? # mentioned in docs, but not present
-
-    assert m.score
-  end
-
-  def test_method_with_full_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_full_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    assert m.return_mentioned?
-
-    assert_equal 2, m.parameters.size
-    m.parameters.each do |param|
-      assert param.mentioned?
-      assert param.typed?
-      assert param.described?
-      refute param.wrongly_mentioned?
-    end
-
-    assert_equal 100, m.score
-  end
-
-  def test_method_without_params_or_return_type
-    m = @source_parser.find_object("Foo::Bar#method_without_params_or_return_type")
-    assert m.has_doc?
-    refute m.has_parameters?
-    refute m.return_mentioned?
-
-    assert m.score
-  end
-
-  def test_method_without_docstring
-    m = @source_parser.find_object("Foo::Bar#method_without_docstring")
-    refute m.has_doc?
-    assert m.has_parameters?
-    assert m.return_mentioned?
-
-    assert m.score
-  end
-
-  def test_method_without_params_or_docstring
-    m = @source_parser.find_object("Foo::Bar#method_without_params_or_docstring")
-    refute m.has_doc?
-    refute m.has_parameters?
-    assert m.return_mentioned?
-
-    assert m.score
-  end
-
-  def test_method_with_rdoc_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_rdoc_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    p = m.parameter(:param1)
-    assert p.mentioned?         # mentioned in docs, correctly
-    refute m.return_mentioned?
-
-    assert m.score
-  end
-
-  def test_method_with_other_rdoc_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_other_rdoc_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    p = m.parameter(:param1)
-    assert p.mentioned?         # mentioned in docs, correctly
-    p = m.parameter(:param2)
-    assert p.mentioned?         # mentioned in docs, correctly
-    p = m.parameter(:param3)
-    assert p.mentioned?         # mentioned in docs, correctly
-    refute m.return_mentioned?
-
-    assert m.score
-  end
-
-  def test_method_with_unstructured_doc
-    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    p = m.parameter(:param1)
-    assert p.mentioned?         # mentioned in docs, correctly
-    refute m.return_mentioned?
-
-    assert m.score
-  end
-
-  def test_method_with_unstructured_doc_missing_params
-    m = @source_parser.find_object("Foo::Bar#method_with_unstructured_doc_missing_params")
-    assert m.has_doc?
-    assert m.has_parameters?
-    p = m.parameter(:format)
-    refute p.mentioned?         # mentioned in docs, correctly
-    refute m.return_mentioned?
-
-    assert m.score
-  end
-end
-
 describe ::Inch::CodeObject::Proxy::Base do
   before do
     Dir.chdir fixture_path(:code_examples)

data/test/test_helper.rb

@@ -1,5 +1,11 @@
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/test/'
+
+  add_group 'CLI', 'lib/inch/cli'
+  add_group 'Code Objects', 'lib/inch/code_object'
+  add_group 'Evaluation', 'lib/inch/evaluation'
+end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - .gitignore
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -200,6 +201,7 @@ files:
 - test/inch/cli/yardopts_helper_test.rb
 - test/inch/code_object/docstring_test.rb
 - test/inch/code_object/nodoc_helper_test.rb
+- test/inch/code_object/proxy/method_object_test.rb
 - test/inch/code_object/proxy_test.rb
 - test/inch/source_parser_test.rb
 - test/integration/stats_options_test.rb
@@ -251,6 +253,7 @@ test_files:
 - test/inch/cli/yardopts_helper_test.rb
 - test/inch/code_object/docstring_test.rb
 - test/inch/code_object/nodoc_helper_test.rb
+- test/inch/code_object/proxy/method_object_test.rb
 - test/inch/code_object/proxy_test.rb
 - test/inch/source_parser_test.rb
 - test/integration/stats_options_test.rb