inch 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59bee612ede489407c91b02db9f32296bddcac2f
-  data.tar.gz: 855ca0e1f24b9c3014479238454d0a5e4378021b
+  metadata.gz: ef6e8adf9c15caf207085b29dfd1645055779b1d
+  data.tar.gz: 742b78011452c52a063b5bdfb753704b8cff4a13
 SHA512:
-  metadata.gz: 97c6be81a2121af032aa58da92a87df06e1d4e0d9d242d0d8358a38d3499ebe99fa2eb7aa999ca75feb35149eba4a971287bcb04ea74e4729287e225b2b7b4b5
-  data.tar.gz: 9f18030b6109d9aa63ec09e2393d61d8f492df236ca24fb2445cdacde4e8c4ea2a69062de618a7e75794ca6aed38af1e565a1e85cd019cd8c640c50e06b6b941
+  metadata.gz: 06175a21a0890883b2385cb667d2b6e3520508c42bd0e7567e3463be0bca921497d595f87c5ab7cfd64f5eee41edc18c38c4dc98047048715624f32a7711fee1
+  data.tar.gz: f8b9a873aa09601d5346aded469c0e11612ad1553e3c646a5d4bc8fe0b19484160517df21f7dbe8e18be44c124df405a385bc5f7e43d89fa0841ae37df6f6846

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
   - ruby-head
   - jruby-head
   - jruby-19mode

data/CHANGELOG.md

@@ -1,15 +1,25 @@
 # Changelog
 
 
+## 0.4.6
+
+- Do not count @yield tag if it is auto-assigned via YARD
+
+
+## 0.4.5
+
+- Fixes a warning regarding re-initialized constants related to require_relative (thanks @jfelchner)
+
+
 ## 0.4.4
 
-- Fixes some bugs introduced in 0.4.3 concerning documentation that is 
+- Fixes some bugs introduced in 0.4.3 concerning documentation that is
   auto-generated by YARD and should not be recognized by Inch
 
 
 ## 0.4.3
 
-- Fixed a bug where the 'show' command did not properly recognize overloaded
+- Fixes a bug where the 'show' command did not properly recognize overloaded
   method signatures
 
 

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

@@ -18,6 +18,7 @@ module Inch
 
             # Tags considered by wrapper methods like {#has_code_example?}
             CONSIDERED_YARD_TAGS = %w(api example param private return since)
+            AUTO_GENERATED_TAG_NAMES = %w(raise yield)
 
             # convenient shortcuts to (YARD) code object
             def_delegators :object, :type, :namespace, :source, :source_type, :group, :dynamic, :visibility
@@ -266,7 +267,7 @@ module Inch
             #   YARD tags that are not already covered by other wrapper methods
             def unconsidered_tags
               @unconsidered_tags ||= tags.reject do |tag|
-                (tag.tag_name == "raise" && tag.text.empty?) ||
+                auto_generated_tag?(tag) ||
                   CONSIDERED_YARD_TAGS.include?(tag.tag_name)
                 end
             end
@@ -289,6 +290,10 @@ module Inch
               tag(:private) || (parent && parent.private_tag)
             end
 
+            def auto_generated_tag?(tag)
+              tag.text.to_s.empty? &&
+                AUTO_GENERATED_TAG_NAMES.include?(tag.tag_name)
+            end
           end
         end
       end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

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

@@ -28,6 +28,10 @@ module InchTest
   def block_method(&block)
   end
 
+  def yielding_method
+    yield true if block_given?
+  end
+
   def question_mark_method?
     if true
       bang_method!

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

@@ -24,6 +24,12 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert m.undocumented?
   end
 
+  def test_yielding_method
+    m = @objects.find("InchTest#yielding_method")
+    assert_equal 0, m.score
+    assert m.undocumented?
+  end
+
   def test_tagged_as_private
     %w( InchTest#method_with_private_tag
         InchTest#private_method_with_tomdoc).each do |fullname|

metadata

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