inch 0.5.0.rc5 → 0.5.0.rc6

data/lib/inch/language/nodejs/provider/jsdoc/object/function_object.rb

@@ -0,0 +1,18 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          module Object
+            # Proxy class for functions
+            class FunctionObject < Base
+              def method?
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/provider/jsdoc/object/member_object.rb

@@ -0,0 +1,15 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          module Object
+            # Proxy class for types
+            class MemberObject < Base
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/provider/jsdoc/object/module_object.rb

@@ -0,0 +1,22 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          module Object
+            # Proxy class for modules
+            class ModuleObject < Base
+              def fullname
+                @hash['id']
+              end
+
+              def namespace?
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
-require "json"
-require "inch/language/nodejs/provider/jsdoc/object"
+require 'json'
+require 'inch/language/nodejs/provider/jsdoc/object'
 
 module Inch
   module Language
@@ -8,12 +8,15 @@ module Inch
         module JSDoc
           # Parses the source tree (using JSDoc)
           class Parser
+            IGNORE_TYPES = %w(member package)
+
             attr_reader :parsed_objects
 
             # Helper method to parse an instance with the given +args+
             #
             # @see #parse
-            # @return [CodeObject::Provider::JSDoc::Parser] the instance that ran
+            # @return [CodeObject::Provider::JSDoc::Parser] the instance that
+            #   ran
             def self.parse(*args)
               parser = new
               parser.parse(*args)
@@ -32,24 +35,20 @@ module Inch
 
             # @return [Array<YARD::Object::Base>]
             def objects
-              pp @parsed_objects[10]
               @objects ||= parsed_objects.map do |o|
-                JSDoc::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
+                JSDoc::Object.for(o) unless IGNORE_TYPES.include?(o['kind'])
               end.compact
-              puts "#{@objects.size} objects found."
-              puts "Rest of implementation: coming soon -.-"
-              exit 1
             end
 
             private
 
             def parse_objects(paths, excluded, read_dump_file = nil)
               if read_dump_file.nil?
-                output = %x(jsdoc --explain #{paths.join(' ')})
+                fail 'NodeJS analysis only works with --read-from-dump.'
               else
                 output = File.read(read_dump_file)
               end
-              @parsed_objects = JSON[output]
+              @parsed_objects = JSON[output]['objects']
             end
           end
         end

data/lib/inch/language/nodejs/roles/base.rb

@@ -0,0 +1,32 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        module Role
+          # @abstract
+          class Base < Inch::Evaluation::Role
+            # Returns the type of the +object+ that is being evaluated.
+            def object_type
+              object.class.to_s.split('::').last.gsub(/Object$/, '').downcase
+            end
+          end
+
+          # Missing is the base class for things that can be improved in the doc
+          #
+          class Missing < Base
+            def score
+              nil
+            end
+
+            # @return [Fixnum]
+            #  a score that can be achieved by adding the missing thing
+            #  mentioned by the role
+            def potential_score
+              @value.to_i
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/roles/function.rb

@@ -0,0 +1,113 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        module Role
+          module Function
+            # Role assigned to methods without parameters
+            class WithoutParameters < Base
+              applicable_unless :has_parameters?
+            end
+
+            # Role assigned to methods with many parameters
+            #
+            # @see CodeObject::Ruby::MethodObject#has_many_parameters?
+            class WithManyParameters < Base
+              applicable_if :has_many_parameters?
+              priority      +2
+            end
+
+            # Role assigned to methods where the return value is typed in the
+            # docs
+            class WithReturnType < Base
+              applicable_if :return_typed?
+            end
+
+            # Role assigned to methods where the return value is not typed
+            class WithoutReturnType < Missing
+              applicable_unless :return_typed?
+
+              def suggestion
+                "Describe what '#{object.name}' returns"
+              end
+            end
+
+            # Role assigned to methods where the return value is decribed in the
+            # docs
+            class WithReturnDescription < Base
+              applicable_if :return_described?
+            end
+
+            # Role assigned to methods where the return value is not decribed
+            class WithoutReturnDescription < Missing
+              applicable_unless :return_described?
+
+              def suggestion
+                "Describe what '#{object.name}' returns"
+              end
+            end
+
+            # Role assigned to methods with many lines
+            #
+            # @see CodeObject::Ruby::MethodObject#has_many_lines?
+            class WithManyLines < Base
+              applicable_if :has_many_lines?
+              priority      +2
+            end
+
+            # Role assigned to methods whose name end in a '!'
+            class WithBangName < Base
+              applicable_if :bang_name?
+              priority      +3
+            end
+
+            # Role assigned to methods whose name end in a '?'
+            class WithQuestioningName < Base
+              applicable_if :questioning_name?
+              priority      -4
+            end
+
+            # Role assigned to methods which are aliased
+            class HasAlias < Base
+              applicable_if :has_alias?
+              priority      +2
+            end
+
+            # Role assigned to methods that are constructors
+            class Constructor < Base
+              applicable_if :constructor?
+            end
+
+            # Role assigned to methods that are getters
+            class Getter < Base
+              applicable_if :getter?
+            end
+
+            # Role assigned to methods that are setters
+            class Setter < Base
+              applicable_if :setter?
+            end
+
+            # Role assigned to methods that are overriding another method
+            class Overridden < Base
+              applicable_if :overridden?
+              # It seems more important to document the overridden method,
+              # than the overriding one
+              priority      -2
+
+              # This role doesnot assign a score.
+              def score
+                nil
+              end
+
+              # This role sets a min_score.
+              def min_score
+                @value.to_f
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/roles/member.rb

@@ -0,0 +1,13 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        module Role
+          # Roles assigned to members
+          module Member
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/roles/module.rb

@@ -0,0 +1,64 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        module Role
+          # Roles assigned to modules
+          module Module
+            # Role assigned to modules with children
+            #
+            # @see CodeObject::Ruby::NamespaceObject#has_children?
+            class WithChildren < Base
+              applicable_if :has_children?
+
+              # This role doesnot assign a score.
+              def score
+                0
+              end
+
+              # This role sets a max_score.
+              def max_score
+                # @value.to_f
+              end
+            end
+
+            # Role assigned to modules with many children
+            #
+            # @see CodeObject::Ruby::NamespaceObject#has_many_children?
+            class WithManyChildren < Base
+              applicable_if :has_many_children?
+
+              # +priority
+              def priority
+                +1
+              end
+            end
+
+            # Role assigned to modules without any children
+            class WithoutChildren < Base
+              applicable_unless :has_children?
+            end
+
+            # Role assigned to modules without any methods
+            class WithoutMethods < Base
+              applicable_unless :has_methods?
+
+              def priority
+                -2
+              end
+            end
+
+            # A 'pure' namespace has only modules as children
+            class Pure < Base
+              applicable_if :pure_namespace?
+
+              def priority
+                -2
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/roles/object.rb

@@ -0,0 +1,76 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        module Role
+          # Roles assigned to all objects
+          module Object
+            # Role assigned to objects with a describing comment (docstring)
+            class WithDoc < Base
+              applicable_if :has_doc?
+            end
+
+            # Role assigned to objects without a docstring
+            class WithoutDoc < Missing
+              applicable_unless :has_doc?
+
+              def suggestion
+                "Add a comment describing the #{object_type}"
+              end
+            end
+
+            # Tagged means tagged in an unconsidred way, i.e. YARD tags not
+            # considered by Inch. Since these tags are parsed from the docstring
+            # the object seems undocumented to Inch.
+            class Tagged < Base
+              applicable_if :has_unconsidered_tags?
+              priority      -1
+            end
+
+            # Role assigned to objects explicitly or implicitly tagged not to be
+            # documented.
+            #
+            # @see CodeObject::NodocHelper
+            class TaggedAsNodoc < Base
+              applicable_if :nodoc?
+              priority      -7
+            end
+
+            # Role assigned to objects declared in the top-level namespace
+            class InRoot < Base
+              applicable_if :in_root?
+              priority      +3
+            end
+
+            # Role assigned to public objects
+            class Public < Base
+              applicable_if :public?
+              priority      0
+            end
+
+            # Role assigned to objects with a single code example
+            class WithCodeExample < Base
+              applicable_if do |o|
+                o.has_code_example? && !o.has_multiple_code_examples?
+              end
+            end
+
+            # Role assigned to objects with multiple code examples
+            class WithMultipleCodeExamples < Base
+              applicable_if :has_multiple_code_examples?
+            end
+
+            # Role assigned to objects without a code example
+            class WithoutCodeExample < Missing
+              applicable_unless :has_code_example?
+
+              def suggestion
+                'Add a code example (optional)'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require "forwardable"
+require 'forwardable'
 
 module Inch
   module Language
@@ -14,7 +14,8 @@ module Inch
             :ruby
           end
 
-          # @return [Boolean] if the current object is an alias for something else
+          # @return [Boolean] if the current object is an alias for something
+          #   else
           def alias?
             !aliased_object.nil?
           end
@@ -133,7 +134,8 @@ module Inch
             self[:original_docstring]
           end
 
-          # @return [Boolean] +true+ if the object was tagged not to be documented
+          # @return [Boolean] +true+ if the object was tagged not to be
+          #   documented
           def nodoc?
             self[:nodoc?]
           end
@@ -174,7 +176,7 @@ module Inch
           end
 
           def type
-            self.class.to_s.gsub(/Object$/, "")
+            self.class.to_s.gsub(/Object$/, '')
           end
 
           # @return [Boolean] +true+ if the object has no documentation at all