inch 0.5.0.rc5 → 0.5.0.rc6

data/lib/inch/language/elixir/provider/reader/object.rb

@@ -1,7 +1,7 @@
-require "inch/language/elixir/provider/reader/object/base"
-require "inch/language/elixir/provider/reader/object/function_object"
-require "inch/language/elixir/provider/reader/object/module_object"
-require "inch/language/elixir/provider/reader/object/type_object"
+require 'inch/language/elixir/provider/reader/object/base'
+require 'inch/language/elixir/provider/reader/object/function_object'
+require 'inch/language/elixir/provider/reader/object/module_object'
+require 'inch/language/elixir/provider/reader/object/type_object'
 
 module Inch
   module Language
@@ -22,7 +22,7 @@ module Inch
               # @return [Provider::JSDoc::Object]
               def for(json_object)
                 @cache ||= {}
-                if proxy_object = @cache[cache_key(json_object)]
+                if (proxy_object = @cache[cache_key(json_object)])
                   proxy_object
                 else
                   @cache[cache_key(json_object)] =

data/lib/inch/language/elixir/provider/reader/object/base.rb

@@ -1,3 +1,5 @@
+require 'inch/language/elixir/provider/reader/docstring'
+
 module Inch
   module Language
     module Elixir
@@ -16,7 +18,7 @@ module Inch
               end
 
               def fullname
-                raise NotImplementedError
+                fail NotImplementedError
               end
 
               def files
@@ -27,12 +29,17 @@ module Inch
                 nil
               end
 
+              attr_writer :children_fullnames
               def children_fullnames
-                [] # raise NotImplementedError
+                @children_fullnames ||= []
               end
 
               def parent_fullname
-                false # raise NotImplementedError
+                if depth == 1
+                  nil
+                else
+                  fullname.split('.')[0...-1].join('.')
+                end
               end
 
               def api_tag?
@@ -67,8 +74,9 @@ module Inch
                 fullname.split('.').size
               end
 
+              # @return [Docstring]
               def docstring
-                @hash['doc'] # raise NotImplementedError
+                @docstring ||= Docstring.new(@hash['doc'])
               end
 
               def getter?
@@ -76,7 +84,7 @@ module Inch
               end
 
               def has_children?
-                false # raise NotImplementedError
+                !children_fullnames.empty?
               end
 
               def has_code_example?

data/lib/inch/language/elixir/provider/reader/object/function_object.rb

@@ -11,7 +11,7 @@ module Inch
               end
 
               def fullname
-                @hash['module_id'] + "." + @hash['id']
+                @hash['module_id'] + '.' + @hash['id']
               end
 
               def method?

data/lib/inch/language/elixir/provider/reader/parser.rb

@@ -1,5 +1,5 @@
-require "json"
-require "inch/language/elixir/provider/reader/object"
+require 'json'
+require 'inch/language/elixir/provider/reader/object'
 
 module Inch
   module Language
@@ -13,7 +13,8 @@ module Inch
             # Helper method to parse an instance with the given +args+
             #
             # @see #parse
-            # @return [CodeObject::Provider::Reader::Parser] the instance that ran
+            # @return [CodeObject::Provider::Reader::Parser] the instance that
+            #   ran
             def self.parse(*args)
               parser = new
               parser.parse(*args)
@@ -32,16 +33,29 @@ module Inch
 
             # @return [Array<YARD::Object::Base>]
             def objects
-              @objects ||= parsed_objects.map do |o|
-                Reader::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
-              end.compact
+              @objects ||= begin
+                list = parsed_objects.map do |o|
+                  Reader::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
+                end.compact
+                children_map = {}
+                list.each do |object|
+                  if object.parent_fullname
+                    children_map[object.parent_fullname] ||= []
+                    children_map[object.parent_fullname] << object.fullname
+                  end
+                end
+                list.each do |object|
+                  object.children_fullnames = children_map[object.fullname]
+                end
+                list
+              end
             end
 
             private
 
             def parse_objects(paths, excluded, read_dump_file = nil)
               if read_dump_file.nil?
-                raise "Elixir analysis only works with --read-from-dump."
+                fail 'Elixir analysis only works with --read-from-dump.'
               else
                 output = File.read(read_dump_file)
               end

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

@@ -7,7 +7,7 @@ module Inch
           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
+              object.class.to_s.split('::').last.gsub(/Object$/, '').downcase
             end
           end
 
@@ -19,8 +19,8 @@ module Inch
             end
 
             # @return [Fixnum]
-            #  a score that can be achieved by adding the missing thing mentioned
-            #  by the role
+            #  a score that can be achieved by adding the missing thing
+            #  mentioned by the role
             def potential_score
               @value.to_i
             end

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

@@ -17,7 +17,8 @@ module Inch
               priority      +2
             end
 
-            # Role assigned to methods where the return value is typed in the docs
+            # Role assigned to methods where the return value is typed in the
+            # docs
             class WithReturnType < Base
               applicable_if :return_typed?
             end

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

@@ -65,7 +65,7 @@ module Inch
               applicable_unless :has_code_example?
 
               def suggestion
-                "Add a code example (optional)"
+                'Add a code example (optional)'
               end
             end
           end

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

@@ -0,0 +1,199 @@
+require 'forwardable'
+
+module Inch
+  module Language
+    module Nodejs
+      # This is the base class for code object proxies.
+      # Code object proxies are via an attributes Hash and provide all methods
+      # necessary for the evaluation of its documentation.
+      #
+      # @abstract
+      module CodeObject
+        class Base < Inch::CodeObject::Proxy
+          def language
+            :nodejs
+          end
+
+          # @return [Boolean] if the current object is an alias for something
+          #   else
+          def alias?
+            !aliased_object.nil?
+          end
+
+          # @return [CodeObject::Proxy] the object the current object is an
+          #   alias of
+          def aliased_object
+            object_lookup.find(self[:aliased_object_fullname])
+          end
+
+          # @return [Boolean] +true+ if the object has an @api tag
+          def api_tag?
+            self[:api_tag?]
+          end
+
+          # @return [Array] the children of the current object
+          def children
+            @children ||= self[:children_fullnames].map do |fullname|
+              object_lookup.find(fullname)
+            end
+          end
+
+          # @return [Boolean] +true+ if the object represents a constant
+          def constant?
+            self[:constant?]
+          end
+
+          def core?
+            self[:core?]
+          end
+
+          # The depth of the following is 4:
+          #
+          #   Foo::Bar::Baz#initialize
+          #    ^    ^    ^      ^
+          #    1 << 2 << 3  <<  4
+          #
+          # +depth+ answers the question "how many layers of code objects are
+          # above this one?"
+          #
+          # @note top-level counts, that's why Foo has depth 1!
+          #
+          # @return [Fixnum] the depth of the object in terms of namespace
+          def depth
+            self[:depth]
+          end
+
+          # @return [Docstring]
+          def docstring
+            self[:docstring]
+          end
+
+          def files
+            self[:files]
+          end
+
+          # Returns the name of the file where the object is declared first
+          # @return [String] a filename
+          def filename
+            # just checking the first file (which is the file where an object
+            # is first declared)
+            files.first
+          end
+
+          # @return [String] the name of an object, e.g.
+          #   "Docstring"
+          def name
+            self[:name]
+          end
+
+          # @return [String] the fully qualified name of an object, e.g.
+          #   "Inch::CodeObject::Provider::YARD::Docstring"
+          def fullname
+            self[:fullname]
+          end
+
+          def has_alias?
+            !self[:aliases_fullnames].empty?
+          end
+
+          def has_children?
+            self[:has_children?]
+          end
+
+          def has_code_example?
+            self[:has_code_example?]
+          end
+
+          def has_doc?
+            self[:has_doc?]
+          end
+
+          def has_multiple_code_examples?
+            self[:has_multiple_code_examples?]
+          end
+
+          def has_unconsidered_tags?
+            self[:has_unconsidered_tags?]
+          end
+
+          def in_root?
+            self[:in_root?]
+          end
+
+          # @return [Boolean] +true+ if the object represents a method
+          def method?
+            self[:method?]
+          end
+
+          # @return [Boolean] +true+ if the object represents a namespace
+          def namespace?
+            self[:namespace?]
+          end
+
+          def original_docstring
+            self[:original_docstring]
+          end
+
+          # @return [Boolean] +true+ if the object was tagged not to be
+          #   documented
+          def nodoc?
+            self[:nodoc?]
+          end
+
+          # @return [CodeObject::Proxy,nil] the parent of the current object
+          #   or +nil+
+          def parent
+            object_lookup.find(self[:parent_fullname])
+          end
+
+          def private?
+            self[:private?]
+          end
+
+          # @return [Boolean]
+          #   +true+ if the object or its parent is tagged as @private
+          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
+
+          def protected?
+            self[:protected?]
+          end
+
+          def public?
+            self[:public?]
+          end
+
+          def source
+            self[:source]
+          end
+
+          def type
+            self.class.to_s.gsub(/Object$/, '')
+          end
+
+          # @return [Boolean] +true+ if the object has no documentation at all
+          def undocumented?
+            self[:undocumented?]
+          end
+
+          # @return [Fixnum] the amount of tags not considered for this object
+          def unconsidered_tag_count
+            self[:unconsidered_tag_count]
+          end
+
+          def visibility
+            self[:visibility]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Inch
+  module Language
+    module Nodejs
+      module CodeObject
+        # Proxy class for functions
+        class FunctionObject < Base
+          def bang_name?
+            self[:bang_name?]
+          end
+
+          def getter?
+            self[:getter?]
+          end
+
+          def has_parameters?
+            !parameters.empty?
+          end
+
+          MANY_PARAMETERS_THRESHOLD = 3
+          def has_many_parameters?
+            parameters.size > MANY_PARAMETERS_THRESHOLD
+          end
+
+          def has_many_lines?
+            false
+          end
+
+          def parameter(name)
+            parameters.find { |p| p.name == name.to_s }
+          end
+
+          def parameters
+            @parameters ||= self[:parameters].map do |param_attr|
+              MethodParameterObject.new(param_attr)
+            end
+          end
+
+          def overridden?
+            self[:overridden?]
+          end
+
+          def overridden_method
+            @overridden_method ||=
+              object_lookup.find(self[:overridden_method_fullname])
+          end
+
+          def return_mentioned?
+            self[:return_mentioned?]
+          end
+
+          def return_described?
+            self[:return_described?]
+          end
+
+          def return_typed?
+            self[:return_typed?]
+          end
+
+          def setter?
+            self[:setter?]
+          end
+
+          def source
+            self[:source?]
+          end
+
+          def questioning_name?
+            self[:questioning_name?]
+          end
+        end
+      end
+    end
+  end
+end