inch 0.5.0.rc5 → 0.5.0.rc6

data/lib/inch/language/nodejs/code_object/member_object.rb

@@ -0,0 +1,11 @@
+module Inch
+  module Language
+    module Nodejs
+      module CodeObject
+        # Proxy class for types
+        class MemberObject < Base
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/code_object/module_object.rb

@@ -0,0 +1,23 @@
+module Inch
+  module Language
+    module Nodejs
+      module CodeObject
+        # Proxy class for modules
+        class ModuleObject < Base
+          MANY_CHILDREN_THRESHOLD = 20
+          def has_many_children?
+            children.size > MANY_CHILDREN_THRESHOLD
+          end
+
+          def has_methods?
+            children.any?(&:method?)
+          end
+
+          def pure_namespace?
+            children.all?(&:namespace?)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        # Base class for all Nodejs related evaluations
+        #
+        # @abstract
+        class Base < Inch::Evaluation::Proxy
+          protected
+
+          def relevant_base_roles
+            {
+              Role::Object::InRoot => nil,
+              Role::Object::Public => nil,
+              Role::Object::TaggedAsNodoc => nil,
+              Role::Object::WithDoc => score_for(:docstring),
+              Role::Object::WithoutDoc => score_for(:docstring),
+              Role::Object::WithCodeExample => score_for(:code_example_single),
+              Role::Object::WithMultipleCodeExamples =>
+                score_for(:code_example_multi),
+              Role::Object::WithoutCodeExample =>
+                score_for(:code_example_single)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/evaluation/function_object.rb

@@ -0,0 +1,31 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        # Proxy class for functions
+        class FunctionObject < Base
+          protected
+
+          def relevant_roles
+            relevant_base_roles.merge(relevant_function_roles)
+          end
+
+          def relevant_function_roles
+            {
+              Role::Function::Getter => nil,
+              Role::Function::Setter => nil,
+              Role::Function::Overridden =>
+                if object.overridden?
+                  object.overridden_method.score
+                else
+                  nil
+                end,
+              Role::Function::WithBangName => nil,
+              Role::Function::WithQuestioningName => nil
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/evaluation/member_object.rb

@@ -0,0 +1,11 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        # Proxy class for types
+        class MemberObject < Base
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/evaluation/module_object.rb

@@ -0,0 +1,27 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        # Proxy class for modules
+        class ModuleObject < Base
+          protected
+
+          def relevant_roles
+            relevant_base_roles.merge(relevant_namespace_roles)
+          end
+
+          # @see Evaluation::Ruby::Base
+          def relevant_namespace_roles
+            {
+              Role::Module::WithoutChildren => nil,
+              Role::Module::WithChildren => nil,
+              Role::Module::WithManyChildren => nil,
+              Role::Module::WithoutMethods => nil,
+              Role::Module::Pure => nil
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/import.rb

@@ -5,4 +5,20 @@ module Inch
   end
 end
 
-require "inch/language/nodejs/provider/jsdoc"
+require 'inch/language/nodejs/provider/jsdoc'
+
+require 'inch/language/nodejs/code_object/base'
+require 'inch/language/nodejs/code_object/module_object'
+require 'inch/language/nodejs/code_object/function_object'
+require 'inch/language/nodejs/code_object/member_object'
+
+require 'inch/language/nodejs/evaluation/base'
+require 'inch/language/nodejs/evaluation/module_object'
+require 'inch/language/nodejs/evaluation/function_object'
+require 'inch/language/nodejs/evaluation/member_object'
+
+require 'inch/language/nodejs/roles/base'
+require 'inch/language/nodejs/roles/object'
+require 'inch/language/nodejs/roles/module'
+require 'inch/language/nodejs/roles/function'
+require 'inch/language/nodejs/roles/member'

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

@@ -16,4 +16,4 @@ module Inch
   end
 end
 
-require "inch/language/nodejs/provider/jsdoc/parser"
+require 'inch/language/nodejs/provider/jsdoc/parser'

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

@@ -0,0 +1,13 @@
+
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          class Docstring < Ruby::Provider::YARD::Docstring
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,8 @@
+require 'inch/language/nodejs/provider/jsdoc/object/base'
+require 'inch/language/nodejs/provider/jsdoc/object/function_object'
+require 'inch/language/nodejs/provider/jsdoc/object/module_object'
+require 'inch/language/nodejs/provider/jsdoc/object/member_object'
+
 module Inch
   module Language
     module Nodejs
@@ -17,7 +22,7 @@ module Inch
               # @return [Provider::JSDoc::Object]
               def for(jsdoc_object)
                 @cache ||= {}
-                if proxy_object = @cache[cache_key(jsdoc_object)]
+                if (proxy_object = @cache[cache_key(jsdoc_object)])
                   proxy_object
                 else
                   @cache[cache_key(jsdoc_object)] =
@@ -27,15 +32,15 @@ module Inch
 
               private
 
-              # Returns a Proxy class for the given +jsdoc_object+
+              # Returns a Proxy class for the given +json_object+
               #
-              # @param jsdoc_object [Hash]
+              # @param json_object [Hash]
               # @return [Class]
-              def class_for(jsdoc_object)
-                class_name = jsdoc_object.class.to_s.split("::").last
-                const_get(class_name)
+              def class_for(json_object)
+                class_name = json_object['kind'].capitalize + 'Object'
+                JSDoc::Object.const_get(class_name)
               rescue NameError
-                Base
+                JSDoc::Object::Base
               end
 
               # Returns a cache key for the given +jsdoc_object+
@@ -44,7 +49,10 @@ module Inch
               # @return [String]
               def cache_key(jsdoc_object)
                 return if jsdoc_object['meta'].nil?
-                "#{jsdoc_object['meta']['path']}/#{jsdoc_object['meta']['path']}:#{jsdoc_object['meta']['lineno']}"
+                "#{jsdoc_object['longname']}/" \
+                  "#{jsdoc_object['meta']['path']}/" \
+                  "#{jsdoc_object['meta']['filename']}:" \
+                  "#{jsdoc_object['meta']['lineno']}"
               end
             end
           end

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

@@ -1,3 +1,6 @@
+require 'inch/language/nodejs/provider/jsdoc/docstring'
+require 'inch/utils/code_location'
+
 module Inch
   module Language
     module Nodejs
@@ -6,181 +9,215 @@ module Inch
           module Object
             # @abstract
             class Base
+              # @return [String] the codebase's directory
+              attr_accessor :base_dir
+
               # @param hash [Hash] hash returned via JSON interface
               def initialize(hash)
                 @hash = hash
               end
 
               def name
-                raise NotImplementedError
+                @hash['name']
               end
 
               def fullname
-                raise NotImplementedError
-              end
-
+                #fail NotImplementedError
+                base = "#{@hash['longname']}"
+                if meta?
+                  base << " @ #{meta['path']}/" \
+                          "#{meta['filename']}:" \
+                          "#{meta['lineno']}"
+                end
+                base
+              end
+
+              # Returns all files declaring the object in the form of an Array
+              # of Arrays containing the location of their declaration.
+              #
+              # @return [Array<CodeLocation>]
               def files
-                raise NotImplementedError
+                return [] unless meta?
+                filename = meta['path'] + '/' + meta['filename']
+                [
+                  Inch::Utils::CodeLocation.new('', filename, meta['lineno'])
+                ]
               end
 
               def filename
-                raise NotImplementedError
+                files.first.filename unless files.empty?
               end
 
+              attr_writer :children_fullnames
               def children_fullnames
-                raise NotImplementedError
+                @children_fullnames ||= []
               end
 
               def parent_fullname
-                raise NotImplementedError
+                if depth == 1
+                  nil
+                else
+                  fullname.split('.')[0...-1].join('.')
+                end
               end
 
               def api_tag?
-                raise NotImplementedError
+                nil
               end
 
               def aliased_object_fullname
-                raise NotImplementedError
+                nil
               end
 
               def aliases_fullnames
-                raise NotImplementedError
+                nil
               end
 
               def attributes
-                raise NotImplementedError
+                []
               end
 
               def bang_name?
-                raise NotImplementedError
+                false
               end
 
               def constant?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def constructor?
-                raise NotImplementedError
+                false
               end
 
               def depth
-                raise NotImplementedError
+                fullname.split('.').size
               end
 
+              # @return [Docstring]
               def docstring
-                raise NotImplementedError
+                @docstring ||= Docstring.new(@hash['comment'])
               end
 
               def getter?
-                raise NotImplementedError
+                name =~ /^get_/ # raise NotImplementedError
               end
 
               def has_children?
-                raise NotImplementedError
+                !children_fullnames.empty?
               end
 
               def has_code_example?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def has_doc?
-                raise NotImplementedError
+                !undocumented?
               end
 
               def has_multiple_code_examples?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def has_unconsidered_tags?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def method?
-                raise NotImplementedError
+                false
               end
 
               def nodoc?
-                raise NotImplementedError
+                @hash['comment'] == false
               end
 
               def namespace?
-                raise NotImplementedError
+                false
               end
 
               def original_docstring
-                raise NotImplementedError
+                @hash['comment']
               end
 
               def overridden?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def overridden_method_fullname
-                raise NotImplementedError
+                nil # raise NotImplementedError
               end
 
               def parameters
-                raise NotImplementedError
+                [] # raise NotImplementedError
               end
 
               def private?
-                raise NotImplementedError
+                false
               end
 
               def tagged_as_internal_api?
-                raise NotImplementedError
+                false
               end
 
               def tagged_as_private?
-                raise NotImplementedError
+                nodoc?
               end
 
               def protected?
-                raise NotImplementedError
+                false
               end
 
               def public?
-                raise NotImplementedError
+                true
               end
 
               def questioning_name?
-                raise NotImplementedError
+                fullname =~ /\?$/
               end
 
               def return_described?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def return_mentioned?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def return_typed?
-                raise NotImplementedError
+                false # raise NotImplementedError
               end
 
               def in_root?
-                raise NotImplementedError
+                depth == 1
               end
 
               def setter?
-                raise NotImplementedError
+                name =~ /^set_/ # raise NotImplementedError
               end
 
               def source
-                raise NotImplementedError
+                nil
               end
 
               def unconsidered_tag_count
-                raise NotImplementedError
+                0
               end
 
               def undocumented?
-                raise NotImplementedError
+                @hash['comment'].to_s.empty?
               end
 
               def visibility
-                raise NotImplementedError
+                :public
+              end
+
+              protected
+
+              def meta?
+                !meta.nil?
+              end
+
+              def meta
+                @hash['meta']
               end
             end
           end