inch 0.3.1.rc4 → 0.3.1.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0e0ac12145f490c8344decf540c18bfde47cd80
-  data.tar.gz: 9bcb872f479818b9feac08c5d2db80303aee6ef5
+  metadata.gz: a7b99573da9408ffa0e56ee31e420c296a42b3ea
+  data.tar.gz: 93ab1ce0fe32d5ab28f52dc92a6fa17261b32bee
 SHA512:
-  metadata.gz: 65f3ce04102ade8753d5b1b7d0db2620f7a8087df58949fd9efe21c41ac54c27c82a4031885d913acbc9cd48353333ef36b1147d848f462a033cbb22162fcae1
-  data.tar.gz: acfdb32fe9cfb3a2301feef2110eedbf39ccfe6e4f78eb8e07dc2dffba2dd8f4e43601630c96b463b493a1c3a1453c2240c0072fb18b25bdedf27c2b133a9bfe
+  metadata.gz: a66b5b26a2bbbb2840413cb20082f14df0e158fde60c72655c5627b252f4ae08daa26148df44f8239ecd9ca5ceb1bacbb0e8ad2d3c79810471834e66f14b9f15
+  data.tar.gz: 293663583786f286140ce3df1f0910e8660413156113231d12f8588724f8b72bbaf3cf07ed6c05de20a4d13562b57ee8794eae986136a9a524472270e60fbbad

data/lib/inch/code_object/converter.rb

@@ -37,7 +37,7 @@ module Inch
         parameters
         private?
         tagged_as_internal_api?
-        private_tag?
+        tagged_as_private?
         protected?
         public?
         questioning_name?

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

@@ -11,6 +11,10 @@ module Inch
             first_line =~ /^Internal\:\ .+/
           end
 
+          def describes_private_object?
+            first_line =~ /^Private\:\ .+/
+          end
+
           def empty?
             @text.strip.empty?
           end

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

@@ -10,7 +10,7 @@ module Inch
           # @note Doesnot recognize ":startdoc:" and ":stopdoc:"
           #
           def nodoc?
-            private_tag? || nodoc_comment?
+            tagged_as_private? || nodoc_comment?
           end
 
           NO_DOC_REGEX = /#\s*\:nodoc\:/

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

@@ -186,20 +186,14 @@ module Inch
               visibility == :private
             end
 
-            # @return [Boolean]
-            #   +true+ if the object or its parent is tagged as @private
-            def private_tag?
-              !private_tag.nil?
-            end
-
-            def private_tag
-              @__private_tag
-            end
-
             def tagged_as_internal_api?
               private_api_tag? || docstring.describes_internal_api?
             end
 
+            def tagged_as_private?
+              private_tag? || docstring.describes_private_object?
+            end
+
             def protected?
               visibility == :protected
             end
@@ -235,6 +229,16 @@ module Inch
               object.docstring.all
             end
 
+            # @return [Boolean]
+            #   +true+ if the object or its parent is tagged as @private
+            def private_tag?
+              !private_tag.nil?
+            end
+
+            def private_tag
+              @__private_tag
+            end
+
             def private_api_tag?
               api_tag && api_tag.text == 'private'
             end

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

@@ -163,10 +163,13 @@ module Inch
 
         # @return [Boolean]
         #   +true+ if the object or its parent is tagged as @private
-        def private_tag?
-          self[:private_tag?]
+        def tagged_as_private?
+          self[:tagged_as_private?]
         end
 
+        # @return [Boolean]
+        #   +true+ if the object or its parent is tagged as part of an
+        #   internal api
         def tagged_as_internal_api?
           self[:tagged_as_internal_api?]
         end

data/lib/inch/codebase/objects_filter.rb

@@ -52,7 +52,7 @@ module Inch
         end
         if !options.visibility.include?(:private)
           @list = @list.reject do |o|
-            o.private_tag?
+            o.tagged_as_private?
           end
         end
       end

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

@@ -104,6 +104,7 @@ module Inch
             Role::Object::Tagged => score_for_unconsidered_tags,
             Role::Object::TaggedAsAPI => nil,
             Role::Object::TaggedAsInternalAPI => nil,
+            Role::Object::TaggedAsPrivate => nil,
           }
         end
 

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

@@ -57,6 +57,18 @@ module Inch
           end
         end
 
+        # Role assigned to objects explicitly or implicitly tagged to be
+        # private.
+        #
+        # @see CodeObject::NodocHelper
+        class TaggedAsPrivate < Base
+          applicable_if :tagged_as_private?
+
+          def priority
+            -5
+          end
+        end
+
         # Role assigned to objects declared in the top-level namespace
         class InRoot < Base
           applicable_if :in_root?

data/lib/inch/version.rb

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

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

@@ -100,10 +100,14 @@ module InchTest
   end
 
   # @api private
-  def internal_api_with_yard
+  def private_api_with_yard
   end
 
   # Internal: Normalize the filename.
   def internal_api_with_tomdoc
   end
+
+  # Private: Normalize the filename.
+  def private_method_with_tomdoc
+  end
 end

data/test/inch/api/filter_test.rb

@@ -28,7 +28,7 @@ describe ::Inch::API::Filter do
   it "should work with option: visibility == :private" do
     @options = {:visibility => [:private]}
     @context = ::Inch::API::Filter.new @codebase, @options
-    assert @context.objects.all? { |o| o.private? || o.private_tag? }
+    assert @context.objects.all? { |o| o.private? || o.tagged_as_private? }
   end
 
   it "should work with option: namespaces == :only" do

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

@@ -12,8 +12,16 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert m.undocumented?
   end
 
+  def test_tagged_as_private
+    %w( InchTest#method_with_private_tag
+        InchTest#private_method_with_tomdoc).each do |fullname|
+      m = @codebase.objects.find(fullname)
+      assert m.tagged_as_private?
+    end
+  end
+
   def test_tagged_as_internal_api
-    %w( InchTest#internal_api_with_yard
+    %w( InchTest#private_api_with_yard
         InchTest#internal_api_with_tomdoc).each do |fullname|
       m = @codebase.objects.find(fullname)
       assert m.tagged_as_internal_api?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.1.rc4
+  version: 0.3.1.rc5
 platform: ruby
 authors:
 - René Föhring