inch 0.3.1.rc3 → 0.3.1.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7ebfc095c5dacd9a9b7e5c034e8ece4d04c62c0
-  data.tar.gz: 9fc736421aac730436c60b90ce2c8fe524e6a7af
+  metadata.gz: e0e0ac12145f490c8344decf540c18bfde47cd80
+  data.tar.gz: 9bcb872f479818b9feac08c5d2db80303aee6ef5
 SHA512:
-  metadata.gz: 4a9cebf6e1c4e435b68509c5e02b216ab99266d3e4bab7e7736eb5d3d5f216119426b0061e0280073c1b0c32aecf50f62925d6de4c75ea88ca551fa215880815
-  data.tar.gz: 316deebcb7ed8bb2fcd9ba8ea90454b407b55b2c8f99435a1b6d97f63f34e876c12ab54c3385e0fdc8b92a86adf165ba6016846f5d7e8282123f2543ad641b17
+  metadata.gz: 65f3ce04102ade8753d5b1b7d0db2620f7a8087df58949fd9efe21c41ac54c27c82a4031885d913acbc9cd48353333ef36b1147d848f462a033cbb22162fcae1
+  data.tar.gz: acfdb32fe9cfb3a2301feef2110eedbf39ccfe6e4f78eb8e07dc2dffba2dd8f4e43601630c96b463b493a1c3a1453c2240c0072fb18b25bdedf27c2b133a9bfe

data/lib/inch/cli/command/output/suggest.rb

@@ -103,9 +103,9 @@ module Inch
           end
 
           def priority_arrows_gte(min_priority)
-            Evaluation::PriorityRange.all.map do |range, str|
-              str if range.min >= min_priority
-            end.compact
+            Evaluation::PriorityRange.all.select do |priority_range|
+              priority_range.priorities.min >= min_priority
+            end
           end
 
           def grade_list(grade_symbol)

data/lib/inch/code_object/converter.rb

@@ -36,7 +36,7 @@ module Inch
         overridden_method_fullname
         parameters
         private?
-        private_api_tag?
+        tagged_as_internal_api?
         private_tag?
         protected?
         public?

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

@@ -7,6 +7,10 @@ module Inch
             @text = text.to_s
           end
 
+          def describes_internal_api?
+            first_line =~ /^Internal\:\ .+/
+          end
+
           def empty?
             @text.strip.empty?
           end
@@ -32,11 +36,21 @@ module Inch
           end
 
           def mentions_return?
-            @text.lines.to_a.last =~ /^Returns\ /
+            last_line =~ /^Returns\ /
           end
 
           def describes_return?
-            @text.lines.to_a.last =~ /^Returns\ (\w+\s){2,}/
+            last_line =~ /^Returns\ (\w+\s){2,}/
+          end
+
+          private
+
+          def first_line
+            @first_line ||= @text.lines.to_a.first
+          end
+
+          def last_line
+            @last_line ||= @text.lines.to_a.last
           end
 
           def parse_code_examples
@@ -57,8 +71,6 @@ module Inch
             code_examples.delete_if(&:empty?).map(&:join)
           end
 
-          private
-
           def mention_parameter_patterns(name)
             [
               "+#{name}+",

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

@@ -68,15 +68,9 @@ module Inch
             end
 
             # Returns all files declaring the object in the form of an Array of
-            # Arrays containing the filename and the line number of their
-            # declaration.
+            # Arrays containing the location of their declaration.
             #
-            # @example
-            #   files # => [["lib/inch.rb", 3],
-            #                ["lib/inch/cli.rb", 1],
-            #                 ["lib/inch/version.rb", 1],
-            #
-            # @return [Array<Array(String, Fixnum)>]
+            # @return [Array<CodeLocation>]
             def files
               object.files.map do |(filename, line_no)|
                 CodeLocation.new(base_dir, filename, line_no)
@@ -202,8 +196,8 @@ module Inch
               @__private_tag
             end
 
-            def private_api_tag?
-              api_tag && api_tag.text == 'private'
+            def tagged_as_internal_api?
+              private_api_tag? || docstring.describes_internal_api?
             end
 
             def protected?
@@ -220,7 +214,7 @@ module Inch
 
             # @return [Boolean] +true+ if the object has no documentation at all
             def undocumented?
-              docstring.empty? && tags.empty?
+              original_docstring.empty?
             end
 
             def unconsidered_tag_count
@@ -237,6 +231,14 @@ module Inch
               text.scan(/\b(#{Regexp.escape(name)})[^_0-9\!\?]/m).size > 1
             end
 
+            def original_docstring
+              object.docstring.all
+            end
+
+            def private_api_tag?
+              api_tag && api_tag.text == 'private'
+            end
+
             def tag(name)
               tags(name).first
             end

data/lib/inch/code_object/proxy/base.rb

@@ -167,8 +167,8 @@ module Inch
           self[:private_tag?]
         end
 
-        def private_api_tag?
-          self[:private_api_tag?]
+        def tagged_as_internal_api?
+          self[:tagged_as_internal_api?]
         end
 
         def protected?

data/lib/inch/evaluation/proxy/base.rb

@@ -103,7 +103,7 @@ module Inch
             Role::Object::WithoutCodeExample => score_for(:code_example_single),
             Role::Object::Tagged => score_for_unconsidered_tags,
             Role::Object::TaggedAsAPI => nil,
-            Role::Object::TaggedAsPrivateAPI => nil,
+            Role::Object::TaggedAsInternalAPI => nil,
           }
         end
 

data/lib/inch/evaluation/role/object.rb

@@ -41,7 +41,7 @@ module Inch
         end
 
         # Role assigned to objects explicitly or implicitly tagged to be part
-        # of an API. If the API is 'private' TaggedAsPrivateAPI is assigned
+        # of an API. If the API is 'private'/'internal' TaggedAsInternalAPI is assigned
         # instead.
         class TaggedAsAPI < Base
           applicable_if :api_tag?
@@ -49,8 +49,8 @@ module Inch
 
         # Role assigned to objects explicitly or implicitly tagged to be part
         # of a private API.
-        class TaggedAsPrivateAPI < Base
-          applicable_if :private_api_tag?
+        class TaggedAsInternalAPI < Base
+          applicable_if :tagged_as_internal_api?
 
           def priority
             -5

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.3.1.rc3"
+  VERSION = "0.3.1.rc4"
 end

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

@@ -98,4 +98,12 @@ module InchTest
   # @private
   def method_with_private_tag
   end
+
+  # @api private
+  def internal_api_with_yard
+  end
+
+  # Internal: Normalize the filename.
+  def internal_api_with_tomdoc
+  end
 end

data/test/inch/code_object/provider/yard/docstring_test.rb

@@ -10,7 +10,7 @@ describe ::Inch::CodeObject::Provider::YARD::Docstring do
 
   it "should notice things in tomdoc style docs" do
 text = <<-DOC
-Public: Detects the Language of the blob.
+Internal: Detects the Language of the blob.
 
 param1 - String filename
 param2 - String blob data. A block also maybe passed in for lazy
@@ -21,6 +21,7 @@ param3 - Optional String mode (defaults to nil)
 Returns Language or nil.
 DOC
     docstring = described_class.new(text)
+    assert docstring.describes_internal_api?
     assert docstring.mentions_parameter?(:param1)
     assert docstring.mentions_parameter?(:param2)
     assert docstring.mentions_parameter?(:param3)

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

@@ -12,6 +12,14 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert m.undocumented?
   end
 
+  def test_tagged_as_internal_api
+    %w( InchTest#internal_api_with_yard
+        InchTest#internal_api_with_tomdoc).each do |fullname|
+      m = @codebase.objects.find(fullname)
+      assert m.tagged_as_internal_api?
+    end
+  end
+
   def test_method_without_doc
     m = @codebase.objects.find("Foo::Bar#method_without_doc")
     refute m.has_doc?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.1.rc3
+  version: 0.3.1.rc4
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -290,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby