inch 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba3a203a48459da4bf88d52ff9855712483543f7
-  data.tar.gz: 31403afde0e69710d5d6ab5c6f997f3940eee18f
+  metadata.gz: f20cc532c358b6ed1b38c07a3aee0fb70463c854
+  data.tar.gz: 02ca81c0f84df27a474e41ecef356742e6336d17
 SHA512:
-  metadata.gz: 5efa4c765863b66ddb2775f4b14027645bb3dfb6fb06701a4dec796506ef3e59924222810fa58c7ea321515dc274110cb5011828d152b7ce6ec6f5cfa53303be
-  data.tar.gz: 6b81968eeba91c2403550c649f877cc6d9f703afef025eb15e21162ba0e49e13375d5dc4d7c9f2486f63749c44099b7ed1605a841b0e7b27cf6388cc00af428d
+  metadata.gz: e86adb1bf23ee8ce3d70435756af852cf00afb95e6caf53828e7b20043dab221e79d08513587dc15ad18d135529fa9cd24df579ddfc752beea66797a0d6dc9f6
+  data.tar.gz: c244532af0d1fad89f9448037a4cd2663263b36914a2467123e6e1c7a22bb5de00b4c5612797797f591ed9605a3fc17741d9b4381e38999a4879dc93e6e7f0e2

data/lib/inch/language/ruby/provider/yard/docstring.rb

@@ -28,6 +28,8 @@ module Inch
               @code_examples ||= parse_code_examples
             end
 
+            # Returns +true+ if the docstring describes the parameter with the
+            # given +name+.
             def describes_parameter?(name)
               return false if name.nil?
               describe_parameter_regexps(name).any? do |pattern|
@@ -149,7 +151,7 @@ module Inch
               same_line_regexps =
                 mention_parameter_patterns(name).map do |pattern|
                   r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
-                  /^#{r}\s?\S+/
+                  /^\s*[-\*]?\s*#{r}\s?\S+/
                 end
               same_line_regexps + describe_parameter_extra_regexps(name)
             end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/test/unit/language/ruby/provider/yard/docstring_test.rb

@@ -3,6 +3,31 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../../../test_helper')
 describe ::Inch::Language::Ruby::Provider::YARD::Docstring do
   let(:described_class) { ::Inch::Language::Ruby::Provider::YARD::Docstring }
 
+  it 'should notice things in phoenix style docs' do
+    text = <<-DOC
+Unsubscribes the pid from the topic.
+
+  * `param1` - The registered server name or pid
+  * `p2` - The subscriber pid
+  * `prm3` - The string topic, ie "users:123"
+
+## Examples
+
+    iex> unsubscribe(:param1, self, "foo")
+    :ok
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.mentions_parameter?(:p2)
+    assert docstring.mentions_parameter?(:prm3)
+    assert docstring.describes_parameter?(:param1)
+    assert docstring.describes_parameter?(:p2)
+    assert docstring.describes_parameter?(:prm3)
+    assert docstring.contains_code_example?
+    refute docstring.mentions_return?
+    refute docstring.describes_return?
+  end
+
   #
   # loose TomDoc compatibility
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -403,7 +403,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby