inch 0.5.0.rc2 → 0.5.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cbc0d4c804e51d845b747f3e98dbb627e4cc03d
-  data.tar.gz: 19b9076a8005cafc3e80c8f73fb906710c9277e9
+  metadata.gz: ad7ddc303f887e07ca647f76f002aafed4dc120e
+  data.tar.gz: 7c0c21ee7be201462be99951d70c7544e9a4bc52
 SHA512:
-  metadata.gz: 74beefa52167ddb75d108ecc78c0cf3401cae9534796778fcfa12564a1f47dc86e87a5951a241134df1d8a00dd32b6be49667e55f341be8613a7028a8b221a31
-  data.tar.gz: 71546c69d7edf6e0ed626c448bba5ab263d98d7e5358f3cdd8ccafa40d1acdfc9da136e46f8d06443a74cc7d018650f3012df5b1b9a5f917960ef3f294f7d8ac
+  metadata.gz: 582a2edf65d9d3d3bd8c95ffee5c55d94a07718a2cc94bcc9c594ffe2b106ed616755d15710ef575cdd312963e54cdd92893955d0c178eeb90a7c35940003f3c
+  data.tar.gz: b97da1277e2c3b2644ca49250288ff9031a4fee69463b11cbae485739d6aededf536f02e7892ed365d87067ffccc2c99a63eb97baf97d838a85429333a7b4924

data/config/defaults.rb

@@ -64,6 +64,13 @@ Inch::Config.run do
       unconsidered_tag    0.2
     end
 
+    schema(:ClassVariableObject) do
+      docstring           1.0
+
+      # optional:
+      unconsidered_tag    0.2
+    end
+
     schema(:ClassObject) do
       docstring           1.0
 

data/lib/inch/code_object/provider/yard/docstring.rb

@@ -42,11 +42,12 @@ module Inch
           end
 
           def mentions_return?
-            last_line =~ /^Returns\ /
+            last_line =~ /^#{tomdoc_modifiers}Returns\ /
           end
 
           def describes_return?
-            last_line =~ /^Returns\ (\w+\s){2,}/
+            last_line =~ /^#{tomdoc_modifiers}Returns\ (\w+\s){2,}/i ||
+              last_line =~ /^#{tomdoc_modifiers}Returns\ (nil|nothing)\.*/i
           end
 
           def to_s
@@ -121,6 +122,10 @@ module Inch
               end
             end
           end
+
+          def tomdoc_modifiers
+            /((Public|Private|Internal)\:\ )*/
+          end
         end
       end
     end

data/lib/inch/code_object/provider/yard/object.rb

@@ -53,6 +53,7 @@ end
 require 'inch/code_object/provider/yard/object/base'
 require 'inch/code_object/provider/yard/object/namespace_object'
 require 'inch/code_object/provider/yard/object/class_object'
+require 'inch/code_object/provider/yard/object/class_variable_object'
 require 'inch/code_object/provider/yard/object/constant_object'
 require 'inch/code_object/provider/yard/object/method_object'
 require 'inch/code_object/provider/yard/object/method_parameter_object'

data/lib/inch/code_object/provider/yard/object/class_variable_object.rb

@@ -0,0 +1,12 @@
+module Inch
+  module CodeObject
+    module Provider
+      module YARD
+        module Object
+          class ClassVariableObject < Base
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/code_object/proxy.rb

@@ -32,6 +32,7 @@ end
 require 'inch/code_object/proxy/base'
 require 'inch/code_object/proxy/namespace_object'
 require 'inch/code_object/proxy/class_object'
+require 'inch/code_object/proxy/class_variable_object'
 require 'inch/code_object/proxy/constant_object'
 require 'inch/code_object/proxy/method_object'
 require 'inch/code_object/proxy/method_parameter_object'

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

@@ -0,0 +1,8 @@
+module Inch
+  module CodeObject
+    module Proxy
+      class ClassVariableObject < Base
+      end
+    end
+  end
+end

data/lib/inch/evaluation.rb

@@ -30,5 +30,6 @@ require 'inch/evaluation/role/method'
 require 'inch/evaluation/role/method_parameter'
 require 'inch/evaluation/role/namespace'
 require 'inch/evaluation/role/constant'
+require 'inch/evaluation/role/class_variable'
 
 require 'inch/evaluation/proxy'

data/lib/inch/evaluation/proxy.rb

@@ -20,6 +20,7 @@ end
 require 'inch/evaluation/proxy/base'
 require 'inch/evaluation/proxy/namespace_object'
 require 'inch/evaluation/proxy/class_object'
+require 'inch/evaluation/proxy/class_variable_object'
 require 'inch/evaluation/proxy/constant_object'
 require 'inch/evaluation/proxy/method_object'
 require 'inch/evaluation/proxy/module_object'

data/lib/inch/evaluation/proxy/class_variable_object.rb

@@ -0,0 +1,19 @@
+module Inch
+  module Evaluation
+    module Proxy
+      class ClassVariableObject < Base
+        protected
+
+        def relevant_roles
+          {
+            Role::ClassVariable::WithDoc => score_for(:docstring),
+            Role::ClassVariable::WithoutDoc => score_for(:docstring),
+            Role::ClassVariable::TaggedAsNodoc => nil,
+            Role::ClassVariable::Public => nil,
+            Role::ClassVariable::Private => nil,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Inch
+  module Evaluation
+    module Role
+      # Roles assigned to class variables
+      module ClassVariable
+        class WithDoc < Object::WithDoc
+          applicable_if :has_doc?
+        end
+        class WithoutDoc < Object::WithoutDoc
+          applicable_unless :has_doc?
+        end
+
+        class TaggedAsNodoc < Object::TaggedAsNodoc
+          applicable_if :nodoc?
+        end
+        class InRoot < Object::InRoot
+          applicable_if :in_root?
+        end
+
+        class Public < Object::Public
+          applicable_if :public?
+
+          def priority
+            -1
+          end
+        end
+        class Private < Object::Private
+          applicable_if :private?
+
+          def priority
+            -3
+          end
+        end
+
+        class WithCodeExample < Object::WithCodeExample
+          applicable_if do |o|
+            o.has_code_example? && !o.has_multiple_code_examples?
+          end
+        end
+
+        class WithMultipleCodeExamples < Object::WithMultipleCodeExamples
+          applicable_if :has_multiple_code_examples?
+        end
+
+        class WithoutCodeExample < Object::WithoutCodeExample
+          applicable_unless :has_code_example?
+
+          def suggestion
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.5.0.rc2"
+  VERSION = "0.5.0.rc3"
 end

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

@@ -1,4 +1,7 @@
 module Foo
+  # Determines :class_variable
+  @@class_variable = {Ace: 11, Jack: 10, Queen: 10, King: 10}
+
   # The problem here is that the @param tag is not given the name of the
   # parameter it documents.
   #

data/test/unit/code_object/provider/yard/docstring_test.rb

@@ -79,6 +79,48 @@ DOC
     assert docstring.describes_return?
   end
 
+  it "should understand 'Returns nil.'" do
+text = <<-DOC
+[...]
+Returns nil.
+DOC
+    docstring = described_class.new(text)
+    assert docstring.describes_return?
+  end
+
+  it "should understand 'Returns nil.' without fullstop and in lowercase" do
+text = <<-DOC
+[...]
+returns nil
+DOC
+    docstring = described_class.new(text)
+    assert docstring.describes_return?
+  end
+
+  it "should understand 'Returns nothing.'" do
+text = <<-DOC
+[...]
+Returns nothing.
+DOC
+    docstring = described_class.new(text)
+    assert docstring.describes_return?
+  end
+
+  it "should understand 'Returns nothing.' without fullstop and in lowercase" do
+text = <<-DOC
+[...]
+returns nothing
+DOC
+    docstring = described_class.new(text)
+    assert docstring.describes_return?
+  end
+
+  it "should understand 'Returns ...' with a visibility modifier in front of it" do
+    text = "Public: Returns the Integer color."
+    docstring = described_class.new(text)
+    assert docstring.mentions_return?
+    assert docstring.describes_return?
+  end
 
   #
   # PARAMETER MENTIONS
@@ -96,7 +138,7 @@ DOC
   end
 
 
-  it "should work 2" do
+  it "should work 2 if correct" do
 text = <<-DOC
 Just because format is mentioned here, does not mean
 the first parameter is meant.

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

@@ -6,47 +6,55 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     @objects = @codebase.objects
   end
 
-  def test_transitive_tags_dont_matter
-    m = @objects.find("InchTest::Deprecated::ClassMethods")
-    assert_equal 0, m.score
-    assert m.undocumented?
-  end
+  describe "Scores" do
+    #
+    it "should not count tags that are transitive" do
+      m = @objects.find("InchTest::Deprecated::ClassMethods")
+      assert_equal 0, m.score
+      assert m.undocumented?
+    end
 
-  def test_raising_method_with_comment
-    m = @objects.find("InchTest#raising_method_with_comment")
-    assert m.score > 0
-    refute m.undocumented?
-  end
+    it "counts a @raise tag" do
+      m = @objects.find("InchTest#raising_method_with_comment")
+      assert m.score > 0
+      refute m.undocumented?
+    end
 
-  def test_raising_method
-    m = @objects.find("InchTest#raising_method")
-    assert_equal 0, m.score
-    assert m.undocumented?
-  end
+    it "should not count a call to `raise`" do
+      m = @objects.find("InchTest#raising_method")
+      assert_equal 0, m.score
+      assert m.undocumented?
+    end
 
-  def test_yielding_method
-    m = @objects.find("InchTest#yielding_method")
-    assert_equal 0, m.score
-    assert m.undocumented?
+    it "should not count a call to `yield`" do
+      m = @objects.find("InchTest#yielding_method")
+      assert_equal 0, m.score
+      assert m.undocumented?
+    end
   end
 
-  def test_tagged_as_private
-    %w( InchTest#method_with_private_tag
-        InchTest#private_method_with_tomdoc).each do |fullname|
-      m = @objects.find(fullname)
-      assert m.tagged_as_private?
+  describe "Taggings" do
+    #
+    it "should recognize forms of @private-tags" do
+      %w( InchTest#method_with_private_tag
+          InchTest#private_method_with_tomdoc).each do |fullname|
+        m = @objects.find(fullname)
+        assert m.tagged_as_private?
+      end
     end
-  end
 
-  def test_tagged_as_internal_api
-    %w( InchTest#private_api_with_yard
-        InchTest#internal_api_with_tomdoc).each do |fullname|
-      m = @objects.find(fullname)
-      assert m.tagged_as_internal_api?
+    it "should recognize forms of internal-tags" do
+      # @api private in YARD
+      # Internal: in TomDoc
+      %w( InchTest#private_api_with_yard
+          InchTest#internal_api_with_tomdoc).each do |fullname|
+        m = @objects.find(fullname)
+        assert m.tagged_as_internal_api?
+      end
     end
   end
 
-  def test_method_without_doc
+  it "should recognize undocumented methods without parameters" do
     m = @objects.find("Foo::Bar#method_without_doc")
     refute m.has_doc?
     refute m.has_parameters?
@@ -56,7 +64,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert_equal 0, m.score
   end
 
-  def test_method_with_missing_param_doc
+  it "should recognize missing parameter documentation" do
     m = @objects.find("Foo::Bar#method_with_missing_param_doc")
     assert m.has_doc?
     assert m.has_parameters?
@@ -67,327 +75,354 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     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 = @objects.find("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
+    # not mentioned
     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 = @objects.find("Foo::Bar#method_with_full_doc")
-    assert m.has_doc?
-    assert m.has_parameters?
-    assert m.return_mentioned?
+  describe "Documentation Styles" do
+    #
+    it "should handle YARD when no additional docstring is given" do
+      m = @objects.find("Foo::Bar#method_without_docstring")
+      refute 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?
+      assert m.score
     end
 
-    assert_equal 100, m.score
-  end
+    it "should handle YARD when only @return is given" do
+      m = @objects.find("Foo::Bar#method_without_params_or_docstring")
+      refute m.has_doc?
+      refute m.has_parameters?
+      assert m.return_mentioned?
 
-  def test_method_without_params_or_return_type
-    m = @objects.find("Foo::Bar#method_without_params_or_return_type")
-    assert m.has_doc?
-    refute m.has_parameters?
-    refute m.return_mentioned?
+      assert m.score
+    end
 
-    assert m.score
-  end
+    it "should handle RDoc" do
+      m = @objects.find("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?
 
-  def test_method_without_docstring
-    m = @objects.find("Foo::Bar#method_without_docstring")
-    refute m.has_doc?
-    assert m.has_parameters?
-    assert m.return_mentioned?
+      assert m.score
+    end
 
-    assert m.score
-  end
+    it "should handle other RDoc styles" do
+      m = @objects.find("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_without_params_or_docstring
-    m = @objects.find("Foo::Bar#method_without_params_or_docstring")
-    refute m.has_doc?
-    refute m.has_parameters?
-    assert m.return_mentioned?
+    it "should handle unstructured doc styles" do
+      m = @objects.find("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
+      assert m.score
+    end
 
-  def test_method_with_rdoc_doc
-    m = @objects.find("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?
+    it "should handle unstructured doc styles with an undocumented param" do
+      m = @objects.find("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
+      assert m.score
+    end
 
-  def test_method_with_other_rdoc_doc
-    m = @objects.find("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?
+    it "should handle methods (without parameters) that have only a docstring (text comment)" do
+      m = @objects.find("Foo::Bar#method_without_params_or_return_type")
+      assert m.has_doc?
+      refute m.has_parameters?
+      refute m.return_mentioned?
 
-    assert m.score
+      assert m.score
+    end
   end
 
-  def test_method_with_unstructured_doc
-    m = @objects.find("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?
+  describe "Getter/Setter Handling" do
 
-    assert m.score
-  end
+    it "should recognize a getter method" do
+      m = @objects.find("InchTest#getter")
+      assert m.getter?, "should be a getter"
+      refute m.setter?
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-  def test_method_with_unstructured_doc_missing_params
-    m = @objects.find("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?
+    it "should recognize a setter method" do
+      m = @objects.find("InchTest#attr_setter=")
+      refute m.getter?
+      assert m.setter?, "should be a setter"
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-    assert m.score
-  end
+    it "should recognize a manually defined setter method" do
+      m = @objects.find("InchTest#manual_setter=")
+      refute m.getter?
+      assert m.setter?, "should be a setter"
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-  def test_question_mark_method
-    m = @objects.find("InchTest#question_mark_method?")
-    refute m.has_doc?
-    refute m.has_parameters?
+    it "should recognize a getter in a manually defined getter/setter pair" do
+      m = @objects.find("InchTest#manual_getset")
+      assert m.getter?, "should be a getter"
+      refute m.setter?
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-    assert_equal 0, m.score
-  end
+    it "should recognize a setter in a manually defined getter/setter pair" do
+      m = @objects.find("InchTest#manual_getset=")
+      refute m.getter?
+      assert m.setter?, "should be a setter"
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-  def test_question_mark_method_with_description
-    m = @objects.find("InchTest#question_mark_method_with_description?")
-    refute m.has_doc?
-    refute m.has_parameters?
+    it "should recognize a getter in a getter/setter pair defined via attr_accessor" do
+      m = @objects.find("InchTest#attr_getset")
+      assert m.getter?, "should be a getter"
+      refute m.setter?
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-    assert m.score > 0
-    assert m.score >= 50 # TODO: don't use magic numbers
-  end
+    it "should recognize a setter in a getter/setter pair defined via attr_accessor" do
+      m = @objects.find("InchTest#attr_getset=")
+      refute m.getter?
+      assert m.setter?, "should be a setter"
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-  def test_method_with_description_and_parameters
-    m = @objects.find("InchTest#method_with_description_and_parameters?")
-    refute m.has_doc?
-    assert m.has_parameters?
+    it "should recognize a getter in a getter/setter pair defined via Struct" do
+      m = @objects.find("InchTest::StructGetSet#struct_getset")
+      assert m.getter?, "should be a getter"
+      refute m.setter?
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-    assert m.score > 0
-  end
+    it "should recognize a setter in a getter/setter pair defined via Struct" do
+      m = @objects.find("InchTest::StructGetSet#struct_getset=")
+      refute m.getter?
+      assert m.setter?, "should be a setter"
+      refute m.has_doc?
+      assert_equal 0, m.score
+    end
 
-  def test_depth
-    m = @objects.find("#root_method")
-    assert_equal 1, m.depth
-    m = @objects.find("InchTest#getter")
-    assert_equal 2, m.depth
-    m = @objects.find("Foo::Bar#method_without_doc")
-    assert_equal 3, m.depth
-  end
+    it "should recognize docs on a getter in a getter/setter pair defined via attr_accessor" do
+      m = @objects.find("Attributes#username")
+      refute_equal 0, m.score
+      refute m.undocumented?
+    end
 
-  def test_getter
-    m = @objects.find("InchTest#getter")
-    assert m.getter?, "should be a getter"
-    refute m.setter?
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+    it "should recognize docs on a setter in a getter/setter pair defined via attr_accessor" do
+      m = @objects.find("Attributes#username=")
+      refute_equal 0, m.score
+      refute m.undocumented?
+    end
 
-  def test_setter
-    m = @objects.find("InchTest#attr_setter=")
-    refute m.getter?
-    assert m.setter?, "should be a setter"
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+    it "should recognize splat parameter notation" do
+      # it should assign the same score whether the parameter is
+      # described with or without the splat (*) operator
+      m1 = @objects.find("Foo#method_with_splat_parameter")
+      m2 = @objects.find("Foo#method_with_splat_parameter2")
+      assert_equal 1, m1.parameters.size
+      assert_equal 1, m2.parameters.size
+      assert_equal m1.score, m2.score
+    end
 
-  def test_setter2
-    m = @objects.find("InchTest#manual_setter=")
-    refute m.getter?
-    assert m.setter?, "should be a setter"
-    refute m.has_doc?
-    assert_equal 0, m.score
+    it "should recognize alias methods and aliased methods" do
+      m1 = @objects.find("InchTest#_aliased_method")
+      m2 = @objects.find("InchTest#_alias_method")
+      assert_equal m1.score, m2.score
+    end
   end
 
-  def test_manual_getset
-    m = @objects.find("InchTest#manual_getset")
-    assert m.getter?, "should be a getter"
-    refute m.setter?
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+  describe "YARDs @!attribute directive on a class" do
+    #
+    it "should work as a reader" do
+      m = @objects.find("Attributes#email")
+      refute_equal 0, m.score
+      refute m.undocumented?
+    end
 
-  def test_manual_getset2
-    m = @objects.find("InchTest#manual_getset=")
-    refute m.getter?
-    assert m.setter?, "should be a setter"
-    refute m.has_doc?
-    assert_equal 0, m.score
+    it "should work as a writer" do
+      m = @objects.find("Attributes#email=")
+      refute_equal 0, m.score
+      #refute m.undocumented?
+      # NOTE: this is undocumented since there is no original_docstring
+    end
   end
 
-  def test_attr_getset
-    m = @objects.find("InchTest#attr_getset")
-    assert m.getter?, "should be a getter"
-    refute m.setter?
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+  describe "YARDs @overload tag on methods" do
+    #
+    it "should work with basic overloading" do
+      list = []
+      list << @objects.find("Overloading#rgb")
+      list << @objects.find("Overloading#rgba")
+      list << @objects.find("Overloading#change_color")
+      list << @objects.find("Overloading#mix")
+      list << @objects.find("Overloading#hooks")
+      list << @objects.find("Overloading#identifiers")
+      list << @objects.find("Overloading#params_only_in_overloads")
+      list.each do |m|
+        assert_equal 100, m.score, "#{m.fullname} did not get 100"
+      end
+    end
 
-  def test_attr_getset2
-    m = @objects.find("InchTest#attr_getset=")
-    refute m.getter?
-    assert m.setter?, "should be a setter"
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+    it "should work with a malformed @param tag in an overload tag" do
+      m = @objects.find("Overloading#missing_param_names")
+      refute m.has_doc? # it may be mentioned in the docs, but it's malformed.
+    end
 
-  def test_struct_getset
-    m = @objects.find("InchTest::StructGetSet#struct_getset")
-    assert m.getter?, "should be a getter"
-    refute m.setter?
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+    it "should work with several overload tags on the same method" do
+      m = @objects.find("Overloading#many_overloads")
+      assert_equal 1, count_roles(m, Inch::Evaluation::Role::Method::WithoutReturnDescription)
+      assert_equal 1, count_roles(m, Inch::Evaluation::Role::Method::WithoutReturnType)
+      assert_equal 1, count_roles(m, Inch::Evaluation::Role::MethodParameter::WithoutMention, 'block')
+    end
 
-  def test_struct_getset2
-    m = @objects.find("InchTest::StructGetSet#struct_getset=")
-    refute m.getter?
-    assert m.setter?, "should be a setter"
-    refute m.has_doc?
-    assert_equal 0, m.score
-  end
+    it "should work if @param tags are only present in the @overload tags, but not on the actual method" do
+      m = @objects.find("Overloading#params_only_in_overloads")
+      unexpected_roles = [
+        Inch::Evaluation::Role::Object::WithoutCodeExample,
+        Inch::Evaluation::Role::MethodParameter::WithoutMention,
+        Inch::Evaluation::Role::MethodParameter::WithoutType,
+      ]
+      assert_roles m, [], unexpected_roles
+    end
 
-  def test_splat_parameter_notation
-    # it should assign the same score whether the parameter is
-    # described with or without the splat (*) operator
-    m1 = @objects.find("Foo#method_with_splat_parameter")
-    m2 = @objects.find("Foo#method_with_splat_parameter2")
-    assert_equal 1, m1.parameters.size
-    assert_equal 1, m2.parameters.size
-    assert_equal m1.score, m2.score
+    it "should work with one param missing in the overload tag" do
+      m = @objects.find("Overloading#one_param_missing_in_overload")
+      unexpected_roles = [
+        Inch::Evaluation::Role::Object::WithoutCodeExample,
+      ]
+      expected_roles = [
+        Inch::Evaluation::Role::MethodParameter::WithoutMention,
+        Inch::Evaluation::Role::MethodParameter::WithoutType,
+      ]
+      assert_roles m, expected_roles, unexpected_roles
+    end
   end
 
-  def test_alias_method
-    m1 = @objects.find("InchTest#_aliased_method")
-    m2 = @objects.find("InchTest#_alias_method")
-    assert_equal m1.score, m2.score
-  end
+  describe "MISC" do
+    #
+    it "should recognize named parameters in Ruby 2.1" do
+      m = @objects.find("Foo#method_with_named_parameter")
+      unexpected_roles = [
+        Inch::Evaluation::Role::MethodParameter::WithoutMention,
+        Inch::Evaluation::Role::MethodParameter::WithoutType,
+      ]
+      assert_roles m, [], unexpected_roles
+    end
 
-  def test_overloading1
-    list = []
-    list << @objects.find("Overloading#rgb")
-    list << @objects.find("Overloading#rgba")
-    list << @objects.find("Overloading#change_color")
-    list << @objects.find("Overloading#mix")
-    list << @objects.find("Overloading#hooks")
-    list << @objects.find("Overloading#identifiers")
-    list << @objects.find("Overloading#params_only_in_overloads")
-    list.each do |m|
-      assert_equal 100, m.score, "#{m.fullname} did not get 100"
+    it "should recognize wrong parameter documentation" do
+      m = @objects.find("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
-  end
 
-  def test_overloading_with_bad_doc
-    m = @objects.find("Overloading#missing_param_names")
-    refute m.has_doc? # it may be mentioned in the docs, but it's malformed.
-  end
+    it "should recognize fully-documented methods with parameters" do
+      m = @objects.find("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_attribute_directive_on_reader
-    m = @objects.find("Attributes#email")
-    refute_equal 0, m.score
-    refute m.undocumented?
-  end
+    it "should recognize question mark methods" do
+      m = @objects.find("InchTest#question_mark_method?")
+      refute m.has_doc?
+      refute m.has_parameters?
 
-  def test_attribute_directive_on_writer
-    m = @objects.find("Attributes#email=")
-    refute_equal 0, m.score
-    refute m.undocumented?
-  end
+      # assert it is zero, because YARD auto-assigns tags to these
+      assert_equal 0, m.score
+    end
 
-  def test_attr_accessor_on_reader
-    m = @objects.find("Attributes#username")
-    refute_equal 0, m.score
-    refute m.undocumented?
-  end
+    it "should recognize question mark methods with description" do
+      m = @objects.find("InchTest#question_mark_method_with_description?")
+      refute m.has_doc?
+      refute m.has_parameters?
 
-  def test_attr_accessor_on_writer
-    m = @objects.find("Attributes#username=")
-    refute_equal 0, m.score
-    refute m.undocumented?
-  end
+      assert m.score > 0
+      assert m.score >= 50 # TODO: don't use magic numbers
+    end
 
-  def test_overloading_with_many_overloads
-    m = @objects.find("Overloading#many_overloads")
-    assert_equal 1, count_roles(m, Inch::Evaluation::Role::Method::WithoutReturnDescription)
-    assert_equal 1, count_roles(m, Inch::Evaluation::Role::Method::WithoutReturnType)
-    assert_equal 1, count_roles(m, Inch::Evaluation::Role::MethodParameter::WithoutMention, 'block')
-  end
+    it "should recognize question mark methods with description and parameters" do
+      m = @objects.find("InchTest#method_with_description_and_parameters?")
+      refute m.has_doc?
+      assert m.has_parameters?
 
-  def test_overloading_with_bad_doc
-    m = @objects.find("Overloading#params_only_in_overloads")
-    unexpected_roles = [
-      Inch::Evaluation::Role::Object::WithoutCodeExample,
-      Inch::Evaluation::Role::MethodParameter::WithoutMention,
-      Inch::Evaluation::Role::MethodParameter::WithoutType,
-    ]
-    assert_roles m, [], unexpected_roles
-  end
+      assert m.score > 0
+    end
 
-  def test_overloading_with_half_bad_doc
-    m = @objects.find("Overloading#one_param_missing_in_overload")
-    unexpected_roles = [
-      Inch::Evaluation::Role::Object::WithoutCodeExample,
-    ]
-    expected_roles = [
-      Inch::Evaluation::Role::MethodParameter::WithoutMention,
-      Inch::Evaluation::Role::MethodParameter::WithoutType,
-    ]
-    assert_roles m, expected_roles, unexpected_roles
-  end
+    it "should recognize the depth of methods" do
+      m = @objects.find("#root_method")
+      assert_equal 1, m.depth
+      m = @objects.find("InchTest#getter")
+      assert_equal 2, m.depth
+      m = @objects.find("Foo::Bar#method_without_doc")
+      assert_equal 3, m.depth
+    end
 
-  def test_documenting_named_parameters
-    m = @objects.find("Foo#method_with_named_parameter")
-    unexpected_roles = [
-      Inch::Evaluation::Role::MethodParameter::WithoutMention,
-      Inch::Evaluation::Role::MethodParameter::WithoutType,
-    ]
-    assert_roles m, [], unexpected_roles
+    it "should recognize docs on class variables" do
+      m = @objects.find("Foo::@@class_variable")
+      assert m.has_doc?
+      refute m.undocumented?
+      assert_equal 100, m.score
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc2
+  version: 0.5.0.rc3
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,6 +189,7 @@ files:
 - lib/inch/code_object/provider/yard/object.rb
 - lib/inch/code_object/provider/yard/object/base.rb
 - lib/inch/code_object/provider/yard/object/class_object.rb
+- lib/inch/code_object/provider/yard/object/class_variable_object.rb
 - lib/inch/code_object/provider/yard/object/constant_object.rb
 - lib/inch/code_object/provider/yard/object/method_object.rb
 - lib/inch/code_object/provider/yard/object/method_parameter_object.rb
@@ -200,6 +201,7 @@ files:
 - lib/inch/code_object/proxy.rb
 - lib/inch/code_object/proxy/base.rb
 - lib/inch/code_object/proxy/class_object.rb
+- lib/inch/code_object/proxy/class_variable_object.rb
 - lib/inch/code_object/proxy/constant_object.rb
 - lib/inch/code_object/proxy/method_object.rb
 - lib/inch/code_object/proxy/method_parameter_object.rb
@@ -224,11 +226,13 @@ files:
 - lib/inch/evaluation/proxy.rb
 - lib/inch/evaluation/proxy/base.rb
 - lib/inch/evaluation/proxy/class_object.rb
+- lib/inch/evaluation/proxy/class_variable_object.rb
 - lib/inch/evaluation/proxy/constant_object.rb
 - lib/inch/evaluation/proxy/method_object.rb
 - lib/inch/evaluation/proxy/module_object.rb
 - lib/inch/evaluation/proxy/namespace_object.rb
 - lib/inch/evaluation/role/base.rb
+- lib/inch/evaluation/role/class_variable.rb
 - lib/inch/evaluation/role/constant.rb
 - lib/inch/evaluation/role/method.rb
 - lib/inch/evaluation/role/method_parameter.rb