inch 0.5.0.rc1 → 0.5.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b627b3f3280cb1d20ff03e3a90decafe62cae3e
-  data.tar.gz: 5489c5a9d46a46e20d924aef08063bd4a2663998
+  metadata.gz: 2cbc0d4c804e51d845b747f3e98dbb627e4cc03d
+  data.tar.gz: 19b9076a8005cafc3e80c8f73fb906710c9277e9
 SHA512:
-  metadata.gz: 748f0227ada481c78e398ba26e9c30397293acdefa22244c4b2482accaac8893f0eb10076ce4eb1c2484c91cc8253acd7619b5071e2e9c8189eb1b8676905603
-  data.tar.gz: 4e82d4927c776c8c825187821af1d6e4d5abfdbd56d7c5c4f73dbe093d50d85b901d24fc8934bae81dc1c6fd22b7ceac8bc39aa0c52569bc7cb9c32be3a2bfa8
+  metadata.gz: 74beefa52167ddb75d108ecc78c0cf3401cae9534796778fcfa12564a1f47dc86e87a5951a241134df1d8a00dd32b6be49667e55f341be8613a7028a8b221a31
+  data.tar.gz: 71546c69d7edf6e0ed626c448bba5ab263d98d7e5358f3cdd8ccafa40d1acdfc9da136e46f8d06443a74cc7d018650f3012df5b1b9a5f917960ef3f294f7d8ac

data/README.md

@@ -1,4 +1,4 @@
-# Inch [![Build Status](https://travis-ci.org/rrrene/inch.png)](https://travis-ci.org/rrrene/inch) [![Code Climate](https://codeclimate.com/github/rrrene/inch.png)](https://codeclimate.com/github/rrrene/inch) [![Inline docs](http://inch-pages.github.io/github/rrrene/inch.png)](http://inch-pages.github.io/github/rrrene/inch)
+# Inch [![Build Status](https://travis-ci.org/rrrene/inch.png)](https://travis-ci.org/rrrene/inch) [![Code Climate](https://codeclimate.com/github/rrrene/inch.png)](https://codeclimate.com/github/rrrene/inch) [![Inline docs](http://inch-ci.org/github/rrrene/inch.png)](http://inch-ci.org/github/rrrene/inch)
 
 `inch` gives you hints where to improve your docs. One Inch at a time.
 

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

@@ -102,24 +102,49 @@ module Inch
 
             private
 
-            # Returns +true+ if the docstring was generated by YARD
+            # Returns @return tags that are assigned to the getter
+            # corresponding to this setter.
+            #
+            # @return [Array<::YARD::Tag>]
+            def attributed_return_tags
+              if setter? && object.tags(:return).empty?
+                method = corresponding_getter
+                if method
+                  return method.object.tags(:return)
+                end
+              end
+              []
+            end
+
+            # @return [MethodObject,nil]
+            def corresponding_getter
+              clean_name = name.to_s.gsub(/(\=)$/, '')
+              parent.child(clean_name.to_sym)
+            end
+
+            # Returns +true+ if the docstring was generated by YARD.
             def implicit_docstring?
               YARD.implicit_docstring?(docstring, self)
             end
 
+            # @return [Array<::YARD::Tag>]
             def overload_tags
               object.tags(:overload)
             end
 
-            def return_tags
-              object.tags(:return) + overloaded_return_tags
-            end
-
+            # @return [Array<::YARD::Tag>]
             def overloaded_return_tags
               overload_tags.map do |overload_tag|
                 overload_tag.tag(:return)
               end.compact
             end
+
+            # @return [Array<::YARD::Tag>]
+            def return_tags
+              object.tags(:return) +
+                overloaded_return_tags +
+                  attributed_return_tags
+            end
           end
         end
       end

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

@@ -8,7 +8,7 @@ module Inch
             attr_reader :method, :docstring
 
             # @param method [Provider::YARD::Object::MethodObject]
-            # @param method [::YARD::Tags::Tag,nil] if nil, the method's normal signature is used
+            # @param yard_tag [::YARD::Tags::Tag,nil] if nil, the method's normal signature is used
             def initialize(method, yard_tag = nil)
               @method = method
               @yard_tag = yard_tag

data/lib/inch/version.rb

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

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

@@ -34,9 +34,42 @@ module Foo
   # @return   HasH
   def method_with_wrong_return_tag
   end
+
+  # Redirect to the given URL
+  # @param url [String] the destination URL
+  # @param status [Fixnum] the http code
+  def method_with_named_parameter(url, status: 302)
+  end
+end
+
+# Representation of attributes of a user in the database
+#
+# @!attribute email
+#   @return [String] E-mail address (from Devise)
+class Attributes
+  # @return [String] Username (from Devise)
+  attr_accessor :username
 end
 
 module Overloading
+  # @overload many_overloads(&block)
+  # @overload many_overloads(scope, &block)
+  #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to `:example`)
+  # @overload many_overloads(scope, conditions, &block)
+  #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to `:example`)
+  #   @param conditions [Hash]
+  #     constrains this hook to examples matching these conditions e.g.
+  #     `many_overloads(:example, :ui => true) { ... }` will only run with examples or
+  #     groups declared with `:ui => true`.
+  # @overload many_overloads(conditions, &block)
+  #   @param conditions [Hash]
+  #     constrains this hook to examples matching these conditions e.g.
+  #     `many_overloads(:example, :ui => true) { ... }` will only run with examples or
+  #     groups declared with `:ui => true`.
+  def many_overloads(*args, &block)
+    hooks.register :append, :before, *args, &block
+  end
+
   # Creates a {Sass::Script::Value::Color Color} object from red, green, and
   # blue values.
   #

data/test/test_helper.rb

@@ -18,6 +18,16 @@ 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/code_object/proxy/method_object_test.rb

@@ -329,6 +329,37 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     refute m.has_doc? # it may be mentioned in the docs, but it's malformed.
   end
 
+  def test_attribute_directive_on_reader
+    m = @objects.find("Attributes#email")
+    refute_equal 0, m.score
+    refute m.undocumented?
+  end
+
+  def test_attribute_directive_on_writer
+    m = @objects.find("Attributes#email=")
+    refute_equal 0, m.score
+    refute m.undocumented?
+  end
+
+  def test_attr_accessor_on_reader
+    m = @objects.find("Attributes#username")
+    refute_equal 0, m.score
+    refute m.undocumented?
+  end
+
+  def test_attr_accessor_on_writer
+    m = @objects.find("Attributes#username=")
+    refute_equal 0, m.score
+    refute m.undocumented?
+  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
+
   def test_overloading_with_bad_doc
     m = @objects.find("Overloading#params_only_in_overloads")
     unexpected_roles = [
@@ -350,4 +381,13 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     ]
     assert_roles m, expected_roles, unexpected_roles
   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
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc1
+  version: 0.5.0.rc2
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler