inch 0.1.4 → 0.2.0

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

@@ -1,9 +1,13 @@
 module Inch
   module Evaluation
     module Role
+      # Roles assigned to all objects
       module Object
+        # Role assigned to objects with a describing comment (docstring)
         class WithDoc < Base
         end
+
+        # Role assigned to objects without a docstring
         class WithoutDoc < Missing
           def suggestion
             "Add a comment describing the #{object_type}"
@@ -18,37 +22,68 @@ module Inch
             -1
           end
         end
+
+        # Role assigned to objects explicitly or implicitly tagged not to be
+        # documented.
+        #
+        # @see CodeObject::NodocHelper
         class TaggedAsNodoc < Base
           def priority
             -7
           end
         end
+
+        # Role assigned to objects explicitly or implicitly tagged to be part
+        # of an API. If the API is 'private' TaggedAsPrivateAPI is assigned
+        # instead.
+        class TaggedAsAPI < Base
+        end
+
+        # Role assigned to objects explicitly or implicitly tagged to be part
+        # of a private API.
+        class TaggedAsPrivateAPI < Base
+          def priority
+            -5
+          end
+        end
+
+        # Role assigned to objects declared in the top-level namespace
         class InRoot < Base
           def priority
             +3
           end
         end
 
+        # Role assigned to public objects
         class Public < Base
           def priority
             +2
           end
         end
+
+        # Role assigned to protected objects
         class Protected < Base
           def priority
             +1
           end
         end
+
+        # Role assigned to private objects
         class Private < Base
           def priority
             -2
           end
         end
 
+        # Role assigned to objects with a single code example
         class WithCodeExample < Base
         end
+
+        # Role assigned to objects with multiple code examples
         class WithMultipleCodeExamples < Base
         end
+
+        # Role assigned to objects without a code example
         class WithoutCodeExample < Missing
           def suggestion
             "Add a code example (optional)"

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

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

@@ -177,43 +177,6 @@ module Foo
     def method_with_missing_param_doc(param1, param2, param3)
     end
   end
-
-  class Qux # :nodoc:
-    def method_with_implicit_nodoc
-    end
-
-    DOCCED_VALUE = 42 # :doc:
-
-    class Quux
-      def method_without_nodoc
-      end
-
-      PUBLIC_VALUE = :foo
-      PRIVATE_VALUE = :bar # :nodoc:
-
-      # @private
-      def method_with_private_tag
-      end
-
-      def method_with_explicit_nodoc # :nodoc:
-      end
-    end
-  end
-
-  class HiddenClass #:nodoc: all
-    def some_value
-    end
-
-    class EvenMoreHiddenClass
-      def method_with_implicit_nodoc
-      end
-
-      class SuddenlyVisibleClass # :doc:
-        def method_with_implicit_doc
-        end
-      end
-    end
-  end
 end
 
 def top

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

@@ -0,0 +1,45 @@
+module Foo
+  class Qux # :nodoc:
+    def method_with_implicit_nodoc
+    end
+
+    DOCCED_VALUE = 42 # :doc:
+
+    class Quux
+      def method_without_nodoc
+      end
+
+      PUBLIC_VALUE = :foo
+      PRIVATE_VALUE = :bar # :nodoc:
+
+      # @private
+      def method_with_private_tag
+      end
+
+      def method_with_explicit_nodoc # :nodoc:
+      end
+    end
+  end
+
+  class HiddenClass #:nodoc: all
+    def some_value
+    end
+
+    class EvenMoreHiddenClass
+      def method_with_implicit_nodoc
+      end
+
+      class SuddenlyVisibleClass # :doc:
+        def method_with_implicit_doc
+        end
+      end
+    end
+  end
+
+  # @private
+  class HiddenClassViaTag
+    # @api private
+    def some_value
+    end
+  end
+end

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

@@ -21,6 +21,10 @@ module InchTest
   def question_mark_method_with_description?
   end
 
+  # @return [Boolean] something funny
+  def method_with_description_and_parameters?(user)
+  end
+
   def many_parameters_method(a,b,c,d,e,f)
   end
 

data/test/inch/code_object/nodoc_helper_test.rb

@@ -6,7 +6,7 @@ describe ::Inch::CodeObject::NodocHelper do
     @source_parser = Inch::SourceParser.run(["lib/**/*.rb"])
   end
 
-  it "should return true for explicitly tagged objects" do
+  it "should return true for explicitly or implicitly tagged objects" do
     [
       "Foo::Qux",
       "Foo::Qux#method_with_implicit_nodoc",
@@ -16,6 +16,8 @@ describe ::Inch::CodeObject::NodocHelper do
       "Foo::HiddenClass",
       "Foo::HiddenClass::EvenMoreHiddenClass",
       "Foo::HiddenClass::EvenMoreHiddenClass#method_with_implicit_nodoc",
+      "Foo::HiddenClassViaTag",
+      "Foo::HiddenClassViaTag#some_value",
     ].each do |query|
       m = @source_parser.find_object(query)
       assert m.nodoc?, "nodoc? should return true for #{query}"

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

@@ -161,6 +161,15 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     refute m.has_doc?
     refute m.has_parameters?
 
+    assert m.score > 0
+    assert m.score >= 50 # TODO: don't use magic numbers
+  end
+
+  def test_method_with_description_and_parameters
+    m = @source_parser.find_object("InchTest#method_with_description_and_parameters?")
+    refute m.has_doc?
+    assert m.has_parameters?
+
     assert m.score > 0
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,27 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
-  name: term-ansicolor
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -70,18 +56,18 @@ dependencies:
   name: sparkr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -94,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 description: Documentation measurement tool for Ruby, based on YARD.
 email:
 - rf@bamaru.de
@@ -120,21 +120,15 @@ files:
 - lib/inch/cli/command/base.rb
 - lib/inch/cli/command/base_list.rb
 - lib/inch/cli/command/base_object.rb
-- lib/inch/cli/command/console.rb
-- lib/inch/cli/command/inspect.rb
 - lib/inch/cli/command/list.rb
 - lib/inch/cli/command/options/base.rb
 - lib/inch/cli/command/options/base_list.rb
 - lib/inch/cli/command/options/base_object.rb
-- lib/inch/cli/command/options/console.rb
-- lib/inch/cli/command/options/inspect.rb
 - lib/inch/cli/command/options/list.rb
 - lib/inch/cli/command/options/show.rb
 - lib/inch/cli/command/options/stats.rb
 - lib/inch/cli/command/options/suggest.rb
 - lib/inch/cli/command/output/base.rb
-- lib/inch/cli/command/output/console.rb
-- lib/inch/cli/command/output/inspect.rb
 - lib/inch/cli/command/output/list.rb
 - lib/inch/cli/command/output/show.rb
 - lib/inch/cli/command/output/stats.rb
@@ -157,6 +151,7 @@ files:
 - lib/inch/code_object/proxy/method_parameter_object.rb
 - lib/inch/code_object/proxy/module_object.rb
 - lib/inch/code_object/proxy/namespace_object.rb
+- lib/inch/config.rb
 - lib/inch/core_ext.rb
 - lib/inch/core_ext/string.rb
 - lib/inch/core_ext/yard.rb
@@ -164,6 +159,7 @@ files:
 - lib/inch/evaluation/base.rb
 - lib/inch/evaluation/class_object.rb
 - lib/inch/evaluation/constant_object.rb
+- lib/inch/evaluation/criteria.rb
 - lib/inch/evaluation/file.rb
 - lib/inch/evaluation/method_object.rb
 - lib/inch/evaluation/module_object.rb
@@ -185,6 +181,7 @@ files:
 - test/fixtures/simple/README
 - test/fixtures/simple/lib/broken.rb
 - test/fixtures/simple/lib/foo.rb
+- test/fixtures/simple/lib/nodoc.rb
 - test/fixtures/simple/lib/role_methods.rb
 - test/fixtures/simple/lib/role_namespaces.rb
 - test/fixtures/visibility/lib/foo.rb
@@ -192,8 +189,6 @@ files:
 - test/fixtures/yardopts/foo/bar.rb
 - test/inch/cli/arguments_test.rb
 - test/inch/cli/command/base_test.rb
-- test/inch/cli/command/console_test.rb
-- test/inch/cli/command/inspect_test.rb
 - test/inch/cli/command/list_test.rb
 - test/inch/cli/command/options/base_list_test.rb
 - test/inch/cli/command/options/base_object_test.rb
@@ -232,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby
@@ -242,6 +237,7 @@ test_files:
 - test/fixtures/simple/README
 - test/fixtures/simple/lib/broken.rb
 - test/fixtures/simple/lib/foo.rb
+- test/fixtures/simple/lib/nodoc.rb
 - test/fixtures/simple/lib/role_methods.rb
 - test/fixtures/simple/lib/role_namespaces.rb
 - test/fixtures/visibility/lib/foo.rb
@@ -249,8 +245,6 @@ test_files:
 - test/fixtures/yardopts/foo/bar.rb
 - test/inch/cli/arguments_test.rb
 - test/inch/cli/command/base_test.rb
-- test/inch/cli/command/console_test.rb
-- test/inch/cli/command/inspect_test.rb
 - test/inch/cli/command/list_test.rb
 - test/inch/cli/command/options/base_list_test.rb
 - test/inch/cli/command/options/base_object_test.rb

data/lib/inch/cli/command/console.rb

@@ -1,22 +0,0 @@
-require 'pry'
-
-module Inch
-  module CLI
-    module Command
-      class Console < BaseObject
-        def description
-          'Shows a console'
-        end
-
-        def usage
-          'Usage: inch console [paths] [OBJECT_NAME] [options]'
-        end
-
-        def run(*args)
-          prepare_objects(*args)
-          Output::Console.new(@options, @object, @objects, source_parser)
-        end
-      end
-    end
-  end
-end

data/lib/inch/cli/command/inspect.rb

@@ -1,20 +0,0 @@
-module Inch
-  module CLI
-    module Command
-      class Inspect < BaseObject
-        def description
-          'Inspects an object'
-        end
-
-        def usage
-          'Usage: inch inspect [paths] OBJECT_NAME [[OBJECT_NAME2] ...] [options]'
-        end
-
-        def run(*args)
-          prepare_objects(*args)
-          Output::Inspect.new(@options, objects)
-        end
-      end
-    end
-  end
-end

data/lib/inch/cli/command/options/console.rb

@@ -1,26 +0,0 @@
-module Inch
-  module CLI
-    module Command
-      module Options
-        class Console < BaseObject
-          def descriptions
-            [
-              "",
-              "Provides a PRY based REPL to inspect objects.",
-              "",
-              "Example: " + "$ inch console lib/**/*.rb Foo::Bar#initialize".cyan,
-              "",
-              "Shortcut commands on the prompt are:",
-              "",
-              "all".ljust(5) + " returns all code objects",
-              "f".ljust(5) + " finds an object by its path",
-              "ff".ljust(5) + " finds all objects given a partial path",
-              "o".ljust(5) + " returns the code object for OBJECT_NAME (if present)",
-            ]
-          end
-
-        end
-      end
-    end
-  end
-end