inch 0.4.2 → 0.4.3.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b2d25865d4af4a7a7d2d8ae09344ac7b828148e
-  data.tar.gz: dc387ecfacf69092c3344fc5c1b4bfe7229087b0
+  metadata.gz: 8df11f0c3f8e4f6ac9aea9b24fc63cd6ecc9d31f
+  data.tar.gz: b91f994c074b34d6d67f81ee36b17c6029c8961d
 SHA512:
-  metadata.gz: 248469d48cdaf7dd7ffc82614a3e043ecde92ce800f5d64c271f8f268d0f5b20a7e7ee3f34a05a2a611cae3e5be128af02adc013490546343abe7dd5a4412c74
-  data.tar.gz: af2f65be144c7edc0367f8bde04e1bc97cacbe0afcf0947c1fbe62cb8bb14b2236b412e884b3442df133729884168a4be0a7881a65f03376db97d5791d86a6e7
+  metadata.gz: e98e2c4bbcf6f32fd6fb9df7b03be207be2d92d103615493b9be1859d1f4fe14e90292d89c4d3cf4090f11d7f2e38c5d8b9cf4b7299cdb5ae6963e02320fbd14
+  data.tar.gz: 8cd1a2706a738a6cb5d4fe970d09aa519e058494c66cdf3d84e4def4b054d600ad49af9634a0f1965b9c42c452f3765b103a97f7b04effa3d7b78943b7f5f5ea

data/.travis.yml

@@ -3,3 +3,13 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - ruby-head
+  - jruby-head
+  - jruby-19mode
+  - rbx-2.2.3
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-2.2.3

data/lib/inch/cli.rb

@@ -7,13 +7,14 @@ module Inch
     class << self
       # Returns the columns of the terminal window
       # (defaults to 80)
+      # @param default [Fixnum] default value for columns
       # @return [Fixnum]
-      def get_term_columns
+      def get_term_columns(default = 80)
         str = `stty size`
         rows_cols = str.split(' ').map(&:to_i)
-        rows_cols[1]
+        rows_cols[1] || default
       rescue
-        80
+        default
       end
     end
     COLUMNS = get_term_columns

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

@@ -28,12 +28,14 @@ module Inch
           end
 
           def describes_parameter?(name)
+            return false if name.nil?
             describe_parameter_regexps(name).any? do |pattern|
               @text.index(pattern)
             end
           end
 
           def mentions_parameter?(name)
+            return false if name.nil?
             mention_parameter_regexps(name).any? do |pattern|
               @text.index(pattern)
             end

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

@@ -20,7 +20,7 @@ module Inch
             CONSIDERED_YARD_TAGS = %w(api example param private return since)
 
             # convenient shortcuts to (YARD) code object
-            def_delegators :object, :type, :namespace, :source, :source_type, :signature, :group, :dynamic, :visibility
+            def_delegators :object, :type, :namespace, :source, :source_type, :group, :dynamic, :visibility
 
             # @param object [YARD::CodeObjects::Base] the actual (YARD) code object
             def initialize(object)
@@ -227,7 +227,7 @@ module Inch
             end
 
             def inspect
-              "#<#{self.class.to_s}: #{path}>"
+              "#<#{self.class.to_s}: #{fullname}>"
             end
 
             protected

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

@@ -1,3 +1,5 @@
+require_relative 'method_signature'
+
 module Inch
   module CodeObject
     module Provider
@@ -28,7 +30,7 @@ module Inch
             end
 
             def has_doc?
-              super && !implicit_docstring? || overload_tags.any? { |t| !t.docstring.empty? }
+              super && !implicit_docstring? || signatures.any? { |t| t.has_doc? }
             end
 
             def method?
@@ -36,13 +38,7 @@ module Inch
             end
 
             def parameters
-              @parameters ||= all_parameter_names.map do |name|
-                signature_name = in_signature(name)
-                tag = parameter_tag(name) || parameter_tag(signature_name) ||
-                        param_tag_in_overload_tags(name) ||
-                        param_tag_in_overload_tags(signature_name)
-                MethodParameterObject.new(self, name, signature_name, tag)
-              end
+              @parameters ||= signatures.map(&:parameters).flatten
             end
 
             def parameter(name)
@@ -80,18 +76,19 @@ module Inch
               name =~ /\=$/ && parameters.size == 1
             end
 
+            def signatures
+              [self, *overload_tags].map do |tag_or_self|
+                MethodSignature.new(self, tag_or_self)
+              end
+            end
+
             def questioning_name?
               name =~ /\?$/
             end
 
             private
 
-            def all_parameter_names
-              names = signature_parameter_names
-              names.concat parameter_tags.map(&:name)
-              names.compact.map { |name| name.gsub(/[\*\&]/, '') }.uniq
-            end
-
+            # Returns +true+ if the docstring was generated by YARD
             def implicit_docstring?
               if getter?
                 docstring == "Returns the value of attribute #{name}"
@@ -103,58 +100,10 @@ module Inch
               end
             end
 
-            def in_signature(name)
-              possible_names = [name, "*#{name}", "&#{name}"]
-              (signature_parameter_names & possible_names).first
-            end
-
-            def normalize_parameter_name(name)
-              # remove leading and trailing brackets
-              # (sometimes used to indicate optional parameters in overload
-              # signatures)
-              name.gsub(/[\[\]]/, '')
-            end
-
             def overload_tags
               object.tags(:overload)
             end
 
-            # Returns all parameter names from all overload signatures.
-            # @todo analyse each signature on its own
-            def overloaded_parameter_names
-              overload_tags.map do |tag|
-                Array(tag.parameters).map do |parameter|
-                  normalize_parameter_name(parameter[0])
-                end
-              end.flatten
-            end
-
-            def param_tag_in_overload_tags(name)
-              overload_tags.map do |overload_tag|
-                find_param_tag(overload_tag, name)
-              end.first
-            end
-
-            def find_param_tag(overload_tag, name)
-              overload_tag.tags(:param).detect do |param_tag|
-                param_tag.name == name
-              end
-            end
-
-            def signature_parameter_names
-              object.parameters.map(&:first) + overloaded_parameter_names
-            end
-
-            def parameter_tag(param_name)
-              parameter_tags.detect do |tag|
-                tag.name == param_name
-              end
-            end
-
-            def parameter_tags
-              object.tags(:param)
-            end
-
             def return_tags
               object.tags(:return) + overloaded_return_tags
             end

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

@@ -0,0 +1,109 @@
+module Inch
+  module CodeObject
+    module Provider
+      module YARD
+        module Object
+          # Utility class to describe (overloaded) method signatures
+          class MethodSignature < Struct.new(:method, :tag_or_method)
+            def has_code_example?
+              !yard_object.tags(:example).empty?
+            end
+
+            def has_doc?
+              !docstring.empty?
+            end
+
+            def parameters
+              @parameters ||= all_parameter_names.map do |name|
+                signature_name = in_signature(name)
+                tag = parameter_tag(name) || parameter_tag(signature_name)
+                MethodParameterObject.new(method, name, signature_name, tag)
+              end
+            end
+
+            def parameter(name)
+              parameters.detect { |p| p.name == name.to_s }
+            end
+
+            # Returns the actual signature of the method.
+            # @return [String]
+            def signature
+              if tag?
+                tag_or_method.signature
+              else
+                yard_object.signature.gsub(/^(def\ )/, '')
+              end
+            end
+
+            #private
+
+            def all_parameter_names
+              all_names = all_signature_parameter_names + parameter_tags.map(&:name)
+              all_names.map do |name|
+                normalize_parameter_name(name) if name
+              end.compact.uniq
+            end
+
+            def all_signature_parameter_names
+              if tag?
+                tag_or_method.parameters.map(&:first)
+              else
+                yard_object.parameters.map(&:first)
+              end
+            end
+
+            def docstring
+              if tag?
+                tag_or_method.docstring
+              else
+                yard_object.docstring
+              end
+            end
+
+            # Returns how the given parameter is noted in the method's
+            # signature.
+            #
+            # @param name [String] parameter name
+            # @return [String]
+            def in_signature(name)
+              possible_names = [name, "*#{name}", "&#{name}"]
+              (all_signature_parameter_names & possible_names).first
+            end
+
+            # Removes block, splat symbols, dollar sign,
+            # leading and trailing brackets from a given +name+
+            # (sometimes used to indicate optional parameters in overload
+            # signatures).
+            # @param name [String] parameter name
+            # @return [String]
+            def normalize_parameter_name(name)
+              name.gsub(/[\&\*\$\[\]]/, '')
+            end
+
+            def parameter_tag(param_name)
+              parameter_tags.detect do |tag|
+                tag.name == param_name
+              end
+            end
+
+            def parameter_tags
+              if tag?
+                tag_or_method.tags(:param)
+              else
+                yard_object.tags(:param)
+              end
+            end
+
+            def tag?
+              tag_or_method.respond_to?(:signature)
+            end
+
+            def yard_object
+              tag_or_method.object
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Inch
           # Helper method to parse an instance with the given +args+
           #
           # @see #parse
-          # @return [CodeObject::Provider::YARD] the instance that ran
+          # @return [CodeObject::Provider::YARD::Parser] the instance that ran
           def self.parse(*args)
             parser = self.new
             parser.parse(*args)

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.2"
+  VERSION = "0.4.3.rc1"
 end

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

@@ -179,6 +179,28 @@ module Overloading
   #   @return [void]
   def missing_param_names(*identifiers)
   end
+
+  # Creates a Hello OpenFlow message.
+  #
+  # @overload params_only_in_overloads()
+  #   @example
+  #     Hello.new
+  #
+  # @overload params_only_in_overloads(transaction_id)
+  #   @example
+  #     Hello.new(123)
+  #   @param [Number] transaction_id
+  #     An unsigned 32-bit integer number associated with this
+  #     message. If not specified, an auto-generated value is set.
+  #
+  # @example
+  #   Hello.new(transaction_id: 123)
+  #   Hello.new(xid: 123)
+  # @param [Hash] user_options the options to create a message with.
+  # @option user_options [Number] :transaction_id
+  # @option user_options [Number] :xid an alias to transaction_id.
+  def params_only_in_overloads(user_options = {})
+  end
 end
 
 module YardError

data/test/unit/code_object/provider/yard/object/method_object_test.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../test_helper')
+
+describe ::Inch::CodeObject::Provider::YARD::Parser do
+  before do
+    @config = Inch::Config.codebase
+    @parser = ::Inch::CodeObject::Provider::YARD::Parser.parse(fixture_path(:simple), @config)
+    @objects = @parser.objects
+  end
+
+  it "should work for Overloading#params_only_in_overloads" do
+    m = @objects.detect { |o| o.fullname == 'Overloading#params_only_in_overloads' }
+
+    assert m.has_code_example?
+
+    refute m.signatures.empty?
+    assert_equal 3, m.signatures.size
+    assert_equal 2, m.parameters.size # at this moment, this counts all parameters in all overloaded signatures
+
+    signature = m.signatures[0]
+    assert_equal "params_only_in_overloads(user_options = {})", signature.signature
+    assert_equal 1, signature.parameters.size
+    refute signature.parameter(:user_options).nil?
+    assert signature.has_code_example?
+    assert signature.has_doc?
+
+    signature = m.signatures[1]
+    assert_equal "params_only_in_overloads()", signature.signature
+    assert signature.parameters.empty?, "Should have been empty: #{signature.parameters.inspect}"
+    assert signature.has_code_example?
+    refute signature.has_doc?
+
+    signature = m.signatures[2]
+    assert_equal "params_only_in_overloads(transaction_id)", signature.signature
+    assert_equal 1, signature.parameters.size
+    refute signature.parameter(:transaction_id).nil?
+    assert signature.has_code_example?
+    refute signature.has_doc?
+  end
+
+  it "should work" do
+    m = @objects.detect { |o| o.fullname == 'Foo::Bar#method_with_unstructured_doc' }
+    assert_equal 1, m.signatures.size
+    assert_equal 1, m.parameters.size
+  end
+
+  it "should work 2" do
+    m = @objects.detect { |o| o.fullname == 'Foo#method_with_splat_parameter' }
+    assert_equal 1, m.signatures.size
+    assert_equal 1, m.parameters.size
+  end
+
+end

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

@@ -259,8 +259,12 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   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
   end
 
@@ -278,6 +282,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     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
@@ -287,4 +292,17 @@ describe ::Inch::CodeObject::Proxy::MethodObject 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_overloading_with_bad_doc
+    m = @objects.find("Overloading#params_only_in_overloads")
+    roles = m.roles.map(&:class)
+    bad_roles = [
+      Inch::Evaluation::Role::Object::WithoutCodeExample,
+      Inch::Evaluation::Role::MethodParameter::WithoutMention,
+      Inch::Evaluation::Role::MethodParameter::WithoutType,
+    ]
+    bad_roles.each do |role|
+      refute roles.include?(role), "Should not assign #{role}"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,7 @@ files:
 - 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
+- lib/inch/code_object/provider/yard/object/method_signature.rb
 - lib/inch/code_object/provider/yard/object/module_object.rb
 - lib/inch/code_object/provider/yard/object/namespace_object.rb
 - lib/inch/code_object/provider/yard/object/root_object.rb
@@ -288,6 +289,7 @@ files:
 - test/unit/code_object/converter_test.rb
 - test/unit/code_object/provider/yard/docstring_test.rb
 - test/unit/code_object/provider/yard/nodoc_helper_test.rb
+- test/unit/code_object/provider/yard/object/method_object_test.rb
 - test/unit/code_object/provider/yard_test.rb
 - test/unit/code_object/provider_test.rb
 - test/unit/code_object/proxy/method_object_test.rb
@@ -313,9 +315,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -370,6 +372,7 @@ test_files:
 - test/unit/code_object/converter_test.rb
 - test/unit/code_object/provider/yard/docstring_test.rb
 - test/unit/code_object/provider/yard/nodoc_helper_test.rb
+- test/unit/code_object/provider/yard/object/method_object_test.rb
 - test/unit/code_object/provider/yard_test.rb
 - test/unit/code_object/provider_test.rb
 - test/unit/code_object/proxy/method_object_test.rb