inch 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a532903e5f4b680ac857bbd0cd00961894cac338
-  data.tar.gz: 8441b59d19f5306e4c0d419807bd43a74ad15941
+  metadata.gz: 97a2e0db4145398867af07819d6657c6473c7cf2
+  data.tar.gz: 288d4945533cde5327a6479d0c4225d8cdff562b
 SHA512:
-  metadata.gz: a5095f06f18343aa1b4d5247068c18cccbe9f39d59bdc878d5c328c6553238c7a1a55a78fd4d4cc6f72e2119d0fc8ee355d93e7e23990210be6475d46f1aaaae
-  data.tar.gz: 68c2ed5d448f1433bf0deaa81c82f6cbcd61c959c784968d32b560db3c4a0aa2d415cd55de00dbf6a015d2421ce54b65d7e9cf21b068605e8f722999af3581be
+  metadata.gz: 0958cf52771d502deeaa704a0c976dc8f3adb758f114fec1a9cb5bd08be81d1a5ced6c7a42f5ce609003d727a79acda12e879fe798cf3cbab97956dab33e7cca
+  data.tar.gz: aa5badaa8ea8c48db207dfe9830a42c59086471f9bd314478753de0c54659eba7b485fd7a1358a8af4a187e51b13826629d30834e0779e5fd39ad2bacedeb24f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.6.4
+
+- Ruby: Skip analysis for method parameters named '_'
+- Ruby: Fix bug regarding method object evaluation
+
 ## 0.6.3
 
 - Elixir: Recognize callbacks and macros

data/lib/inch/language/ruby/provider/yard/object/base.rb

@@ -258,7 +258,7 @@ module Inch
               protected
 
               def multi_code_examples?(text)
-                text.scan(/\b(#{Regexp.escape(name)})[^_0-9\!\?]/m).size > 1
+                text.to_s.scan(/\b(#{Regexp.escape(name)})[^_0-9\!\?]/m).size > 1
               end
 
               # @return [Boolean]

data/lib/inch/language/ruby/provider/yard/object/method_object.rb

@@ -159,7 +159,7 @@ module Inch
               def return_described_via_tag?
                 return_tags.any? do |t|
                   return_tag_describes_unusable_value?(t) ||
-                    !t.text.empty? && !YARD.implicit_tag?(t, self)
+                    !t.text.to_s.empty? && !YARD.implicit_tag?(t, self)
                 end
               end
 

data/lib/inch/language/ruby/provider/yard/object/method_parameter_object.rb

@@ -21,7 +21,8 @@ module Inch
                 @in_signature = in_signature
               end
 
-              BAD_NAME_EXCEPTIONS = %w(id)
+              IGNORE_NAME = "_"
+              BAD_NAME_EXCEPTIONS = [IGNORE_NAME, "id"]
               BAD_NAME_THRESHOLD = 3
 
               # @return [Boolean] +true+ if the name of the parameter is
@@ -38,13 +39,13 @@ module Inch
 
               # @return [Boolean] +true+ if an additional description given?
               def described?
-                described_by_tag? || described_by_docstring?
+                described_by_tag? || described_by_docstring? || ignore?
               end
 
               # @return [Boolean] +true+ if the parameter is mentioned in the
               #   docs
               def mentioned?
-                !!@tag || mentioned_by_docstring?
+                !!@tag || mentioned_by_docstring? || ignore?
               end
 
               # @return [Boolean] +true+ if the parameter is a splat argument
@@ -54,7 +55,7 @@ module Inch
 
               # @return [Boolean] +true+ if the type of the parameter is defined
               def typed?
-                @tag && @tag.types && !@tag.types.empty?
+                (@tag && @tag.types && !@tag.types.empty?) || ignore?
               end
 
               # @return [Boolean] +true+ if the parameter is mentioned in the
@@ -78,6 +79,10 @@ module Inch
                 end
               end
 
+              def ignore?
+                name == IGNORE_NAME
+              end
+
               def mentioned_by_docstring?
                 if @method.docstring.mentions_parameter?(name)
                   true

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
 end

data/test/fixtures/ruby/simple/lib/foo.rb

@@ -13,6 +13,12 @@ module Foo
     def method_with_missing_param_doc(param1, param2, param3)
     end
 
+    # Provides an example of a missing described parameter.
+    #
+    # @return [void]
+    def method_with_missing_ignore_param_doc(_)
+    end
+
     # Provides an example of a wrongly described parameter.
     #
     # @param param1 [String]

data/test/unit/language/ruby/code_object/method_object_test.rb

@@ -20,6 +20,12 @@ describe ::Inch::Language::Ruby::CodeObject::MethodObject do
       refute m.undocumented?
     end
 
+    it 'does not complain about _ parameter' do
+      m = @objects.find('Foo::Bar#method_with_missing_ignore_param_doc')
+      assert_equal 100, m.score
+      refute m.undocumented?
+    end
+
     it 'should not count a call to `raise`' do
       m = @objects.find('InchTest#raising_method')
       assert_equal 0, m.score

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler