inch 0.6.0.rc5 → 0.6.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0fbf4de3c8dff60c578af2acaddbd061645c03
-  data.tar.gz: 16c82a3ace60404b68e622ab5e25e9750692ef6b
+  metadata.gz: c8e5fc3d5ed658a3353dd12bb0ddd920cabf969e
+  data.tar.gz: a5c679dcdd4ce2196d779f3fa536ee63e9a7784e
 SHA512:
-  metadata.gz: 4f90b4d92ab6c91c07b7957ba2d4336ba6eaa26abb42487d18fddb9b8a937326c7e548a63050f8c9af88a80aaba83c3f11d442e9ecb256ef1719d1265620fbe4
-  data.tar.gz: aeb3b4b108f805749237ceece228644828f5bda071b6cd4e490decb82ba66835df22cd86e122c3df1e7c8e59e4d466dfc53d91533bd611d0e2f93aabea98043a
+  metadata.gz: 1c05926dd14887882de1cc8bc6f99b1b4f8365fbc8915849b921ec9f99fb47a8b2d9b3b89217876e8eb3ecebc0eb9ad63cba96f1e184daa5ef91ac5691470d07
+  data.tar.gz: e836bc2a885bf658b7bf2b09e2b2f259326ce398f85490a547b77a8e38acee7467cd1f804593c1592ea721341fa5a7844c71bae9158f749bb44c679cf2fabcca

data/.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 language: ruby
 rvm:
   - 1.9.3

data/lib/inch/language/elixir/provider/reader/parser.rb

@@ -25,6 +25,7 @@ module Inch
             # @param config [Inch::Config::Codebase] configuration for codebase
             # @return [void]
             def parse(dir, config)
+              raise "Directory does not exist: #{dir}" if !File.exist?(dir)
               Dir.chdir(dir) do
                 parse_objects(config.included_files, config.excluded_files,
                               config.read_dump_file)

data/lib/inch/language/javascript/provider/jsdoc/parser.rb

@@ -28,6 +28,7 @@ module Inch
             # @param config [Inch::Config::Codebase] configuration for codebase
             # @return [void]
             def parse(dir, config)
+              raise "Directory does not exist: #{dir}" if !File.exist?(dir)
               Dir.chdir(dir) do
                 parse_objects(config.included_files, config.excluded_files,
                               config.read_dump_file)

data/lib/inch/language/ruby/code_object/base.rb

@@ -108,6 +108,12 @@ module Inch
             self[:has_doc?]
           end
 
+          # @return [Boolean] +true+ if the docstring mentions a given
+          #   +member_name+.
+          def has_doc_for?(member_name)
+            docstring.mentions_member?(member_name)
+          end
+
           def has_multiple_code_examples?
             self[:has_multiple_code_examples?]
           end

data/lib/inch/language/ruby/code_object/method_object.rb

@@ -16,6 +16,10 @@ module Inch
             self[:getter?]
           end
 
+          def has_doc?
+            super || mentioned_in_parent_docstring?
+          end
+
           def has_parameters?
             !parameters.empty?
           end
@@ -75,9 +79,20 @@ module Inch
             self[:source?]
           end
 
+          def undocumented?
+            super && !mentioned_in_parent_docstring?
+          end
+
           def questioning_name?
             self[:questioning_name?]
           end
+
+          private
+
+          def mentioned_in_parent_docstring?
+            parent && parent.has_doc_for?(name)
+          end
+
         end
       end
     end

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

@@ -35,6 +35,14 @@ module Inch
               end
             end
 
+            # Returns +true+ if the docstring mentions a member with the given
+            # +name+.
+            def mentions_member?(name)
+              mentions_parameter?(name)
+            end
+
+            # Returns +true+ if the docstring mentions a parameter with the
+            # given +name+.
             def mentions_parameter?(name)
               return false if name.nil?
               mention_parameter_regexps(name).any? do |pattern|
@@ -111,7 +119,7 @@ module Inch
                 /\+#{expr}\+\:\:/,        # +param1+::
                 /<tt>#{expr}<\/tt>/,      # <tt>param1</tt>
                 /<tt>#{expr}<\/tt>\:\:/,  # <tt>param1</tt>::
-                /^#{expr}\ +\-\ /         # param1 -
+                /^\s*#{expr}\ +\-\ /         # param1 -
               ]
             end
 

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

@@ -206,9 +206,13 @@ module Inch
                 []
               end
 
-              # @return [Array,nil] the parent of the current object or +nil+
+              # @return [CodeObject::Base,nil] the parent of the current object or +nil+
               attr_reader :parent
 
+              def parent_fullname
+                parent && parent.fullname
+              end
+
               def __parent
                 YARD::Object.for(object.parent) if object.parent
               end

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

@@ -52,6 +52,12 @@ module Inch
                 parameters.find { |p| p.name == name.to_s }
               end
 
+              # Returns the original docstring unless it was generated by YARD.
+              # @return [String]
+              def original_docstring
+                implicit_docstring? ? "" : super
+              end
+
               def overridden?
                 !!object.overridden_method
               end

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

@@ -21,6 +21,7 @@ module Inch
             # @param config [Inch::Config::Codebase] configuration for codebase
             # @return [void]
             def parse(dir, config)
+              raise "Directory does not exist: #{dir}" if !File.exist?(dir)
               Dir.chdir(dir) do
                 parse_yard_objects(config.included_files,
                                    config.excluded_files,

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.6.0.rc5'
+  VERSION = '0.6.0.rc6'
 end

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

@@ -44,6 +44,28 @@ module Foo
   #     @option params [Hash<Symbol, String>] :headers The default headers to supply in a request. Only used if params[:headers] is not supplied to Connection#request
   def method_with_indented_param_tag(params = {})
   end
+
+  ##
+  # Checks wether the given Foo allows this Actor to perform the given action.
+  #
+  # @param action [Symbol] a valid action for this Foo (see {DSL::Foo})
+  # @param resource [Foo] an authorized Foo
+  #
+  # @see Foo
+  #
+  def can?(action, resource)
+    resource.allows?(action, self)
+  end
+
+  ##
+  # Opposite of {#can?}.
+  #
+  # @param (see #can?)
+  # @return (see #can?)
+  #
+  def cannot?(*args)
+    !can?(*args)
+  end
 end
 
 module Overloading

data/test/fixtures/ruby/structs/lib/structs_member.rb

@@ -0,0 +1,72 @@
+# One entry of a cross-reference section or stream.
+#
+# An entry has the attributes +type+, +oid+, +gen+, +pos+ and +objstm+ and can be created like
+# this:
+#
+#   Entry.new(type, oid, gen, pos, objstm)   -> entry
+#
+# The +type+ attribute can be:
+#
+# :free:: Denotes a free entry.
+#
+# :in_use:: A used entry that resides in the body of the PDF file. The +pos+ attribute defines
+#           the position in the file at which the object can be found.
+#
+# :compressed:: A used entry that resides in an object stream. The +objstm+ attribute contains
+#               the reference to the object stream in which the object can be found and the
+#               +pos+ attribute contains the index into the object stream.
+#
+#               Objects in an object stream always have a generation number of 0!
+#
+# See: PDF1.7 s7.5.4, s7.5.8
+StructWithRDoc = Struct.new(:type, :oid, :gen, :pos, :objstm, :member_without_doc)
+
+# One entry of a cross-reference section or stream.
+#
+# An entry has the attributes +type+, +oid+, +gen+, +pos+ and +objstm+ and can be created like
+# this:
+#
+#   Entry.new(type, oid, gen, pos, objstm)   -> entry
+#
+# The +type+ attribute can be:
+#
+# :free:: Denotes a free entry.
+#
+# :in_use:: A used entry that resides in the body of the PDF file. The +pos+ attribute defines
+#           the position in the file at which the object can be found.
+#
+# :compressed:: A used entry that resides in an object stream. The +objstm+ attribute contains
+#               the reference to the object stream in which the object can be found and the
+#               +pos+ attribute contains the index into the object stream.
+#
+#               Objects in an object stream always have a generation number of 0!
+#
+# See: PDF1.7 s7.5.4, s7.5.8
+class StructWithRDocAsInheritedClass < Struct.new(:type, :oid, :gen, :pos, :objstm, :member_without_doc)
+end
+
+# Representation of attributes of a user in the database
+#
+# @!attribute email
+#   @return [String] E-mail address (from Devise)
+# @!attribute username
+#   @return [String] Username (from Devise)
+StructWithYardDirectivesOutside = Struct.new(:email, :username, :member_without_doc)
+
+# Representation of attributes of a user in the database
+#
+class StructWithYardDirectivesAsInheritedClass < Struct.new(:email, :username, :member_without_doc)
+  # @!attribute email
+  #   @return [String] E-mail address (from Devise)
+  # @!attribute username
+  #   @return [String] Username (from Devise)
+end
+
+# Representation of attributes of a user in the database
+#
+# @!attribute email
+#   @return [String] E-mail address (from Devise)
+# @!attribute username
+#   @return [String] Username (from Devise)
+class StructWithYardDirectivesOutsideAsInheritedClass < Struct.new(:email, :username, :member_without_doc)
+end

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

@@ -501,4 +501,19 @@ describe ::Inch::Language::Ruby::CodeObject::MethodObject do
       assert_equal 100, m.score
     end
   end
+
+  describe 'YARDs reference tag on methods' do
+    #
+    it 'should recognize referenced docs' do
+      m1 = @objects.find('Foo#can?')
+      assert m1.has_doc?
+      refute m1.undocumented?
+      assert_equal 100, m1.score
+
+      m2 = @objects.find('Foo#cannot?')
+      assert m2.has_doc?
+      refute m2.undocumented?
+      assert_equal 100, m2.score
+    end
+  end
 end

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

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
+
+describe ::Inch::Language::Ruby::CodeObject::ClassObject do
+  before do
+    @codebase = test_codebase(:ruby, :structs)
+    @objects = @codebase.objects
+  end
+
+  describe 'Structs with RDoc comment mentioning members' do
+    #
+    it 'should recognize that the members are documented in the class docstring' do
+      %w(StructWithRDoc StructWithRDocAsInheritedClass).each do |class_name|
+        %w(type oid gen pos objstm).each do |member_name|
+          m = @objects.find("#{class_name}##{member_name}")
+          refute_equal 0, m.score, "#{class_name}##{member_name} should have score > 0"
+          refute m.undocumented?, "#{class_name}##{member_name} should not be undocumented"
+        end
+        m = @objects.find("#{class_name}#member_without_doc")
+        assert_equal 0, m.score, "#{class_name}#member_without_doc should have score == 0"
+        assert m.undocumented?, "#{class_name}#member_without_doc should be undocumented"
+      end
+    end
+  end
+
+  describe 'Structs with YARD directives' do
+    #
+    it 'should recognize that the members are documented via directives' do
+      %w(email username).each do |member_name|
+        m = @objects.find("StructWithYardDirectivesAsInheritedClass##{member_name}")
+        refute_equal 0, m.score, "StructWithYardDirectivesAsInheritedClass##{member_name} should have score > 0"
+        refute m.undocumented?, "StructWithYardDirectivesAsInheritedClass##{member_name} should not be undocumented"
+      end
+      m = @objects.find("StructWithYardDirectivesAsInheritedClass#member_without_doc")
+      assert_equal 0, m.score, "StructWithYardDirectivesAsInheritedClass#member_without_doc should have score == 0"
+      assert m.undocumented?, "StructWithYardDirectivesAsInheritedClass#member_without_doc should be undocumented"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.6.0.rc5
+  version: 0.6.0.rc6
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -331,6 +331,7 @@ files:
 - test/fixtures/ruby/simple/lib/nodoc.rb
 - test/fixtures/ruby/simple/lib/role_methods.rb
 - test/fixtures/ruby/simple/lib/role_namespaces.rb
+- test/fixtures/ruby/structs/lib/structs_member.rb
 - test/fixtures/ruby/visibility/lib/foo.rb
 - test/fixtures/ruby/yardopts/.yardopts
 - test/fixtures/ruby/yardopts/foo/bar.rb
@@ -374,6 +375,7 @@ files:
 - test/unit/language/javascript/provider/jsdoc/docstring_test.rb
 - test/unit/language/ruby/code_object/alias_test.rb
 - test/unit/language/ruby/code_object/method_object_test.rb
+- test/unit/language/ruby/code_object/structs_member_test.rb
 - test/unit/language/ruby/provider/yard/docstring_test.rb
 - test/unit/language/ruby/provider/yard/nodoc_helper_test.rb
 - test/unit/language/ruby/provider/yard/object/method_object_test.rb
@@ -427,6 +429,7 @@ test_files:
 - test/fixtures/ruby/simple/lib/nodoc.rb
 - test/fixtures/ruby/simple/lib/role_methods.rb
 - test/fixtures/ruby/simple/lib/role_namespaces.rb
+- test/fixtures/ruby/structs/lib/structs_member.rb
 - test/fixtures/ruby/visibility/lib/foo.rb
 - test/fixtures/ruby/yardopts/.yardopts
 - test/fixtures/ruby/yardopts/foo/bar.rb
@@ -470,6 +473,7 @@ test_files:
 - test/unit/language/javascript/provider/jsdoc/docstring_test.rb
 - test/unit/language/ruby/code_object/alias_test.rb
 - test/unit/language/ruby/code_object/method_object_test.rb
+- test/unit/language/ruby/code_object/structs_member_test.rb
 - test/unit/language/ruby/provider/yard/docstring_test.rb
 - test/unit/language/ruby/provider/yard/nodoc_helper_test.rb
 - test/unit/language/ruby/provider/yard/object/method_object_test.rb