inch 0.5.0.rc3 → 0.5.0.rc4

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

@@ -0,0 +1,32 @@
+module Inch
+  module Language
+    module Elixir
+      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/elixir/roles/function.rb

@@ -0,0 +1,112 @@
+module Inch
+  module Language
+    module Elixir
+      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/elixir/roles/module.rb

@@ -0,0 +1,64 @@
+module Inch
+  module Language
+    module Elixir
+      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/elixir/roles/object.rb

@@ -0,0 +1,76 @@
+module Inch
+  module Language
+    module Elixir
+      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/elixir/roles/type.rb

@@ -0,0 +1,13 @@
+module Inch
+  module Language
+    module Elixir
+      module Evaluation
+        module Role
+          # Roles assigned to types
+          module Type
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Inch
+  module Language
+    module Nodejs
+    end
+  end
+end
+
+require "inch/language/nodejs/provider/jsdoc"

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

@@ -0,0 +1,19 @@
+require 'json'
+
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        # Parses the source tree (using JSDoc)
+        module JSDoc
+          # @see Provider.parse
+          def self.parse(dir, config)
+            Parser.parse(dir, config)
+          end
+        end
+      end
+    end
+  end
+end
+
+require "inch/language/nodejs/provider/jsdoc/parser"

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

@@ -0,0 +1,55 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          # CodeObject::Provider::JSDoc::Object object represent code objects.
+          #
+          module Object
+            class << self
+              def clear_cache
+                @cache = {}
+              end
+
+              # Returns a Proxy object for the given +jsdoc_object+
+              #
+              # @param jsdoc_object [Hash]
+              # @return [Provider::JSDoc::Object]
+              def for(jsdoc_object)
+                @cache ||= {}
+                if proxy_object = @cache[cache_key(jsdoc_object)]
+                  proxy_object
+                else
+                  @cache[cache_key(jsdoc_object)] =
+                    class_for(jsdoc_object).new(jsdoc_object)
+                end
+              end
+
+              private
+
+              # Returns a Proxy class for the given +jsdoc_object+
+              #
+              # @param jsdoc_object [Hash]
+              # @return [Class]
+              def class_for(jsdoc_object)
+                class_name = jsdoc_object.class.to_s.split("::").last
+                const_get(class_name)
+              rescue NameError
+                Base
+              end
+
+              # Returns a cache key for the given +jsdoc_object+
+              #
+              # @param jsdoc_object [Hash]
+              # @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']}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          module Object
+            # @abstract
+            class Base
+              # @param hash [Hash] hash returned via JSON interface
+              def initialize(hash)
+                @hash = hash
+              end
+
+              def name
+                raise NotImplementedError
+              end
+
+              def fullname
+                raise NotImplementedError
+              end
+
+              def files
+                raise NotImplementedError
+              end
+
+              def filename
+                raise NotImplementedError
+              end
+
+              def children_fullnames
+                raise NotImplementedError
+              end
+
+              def parent_fullname
+                raise NotImplementedError
+              end
+
+              def api_tag?
+                raise NotImplementedError
+              end
+
+              def aliased_object_fullname
+                raise NotImplementedError
+              end
+
+              def aliases_fullnames
+                raise NotImplementedError
+              end
+
+              def attributes
+                raise NotImplementedError
+              end
+
+              def bang_name?
+                raise NotImplementedError
+              end
+
+              def constant?
+                raise NotImplementedError
+              end
+
+              def constructor?
+                raise NotImplementedError
+              end
+
+              def depth
+                raise NotImplementedError
+              end
+
+              def docstring
+                raise NotImplementedError
+              end
+
+              def getter?
+                raise NotImplementedError
+              end
+
+              def has_children?
+                raise NotImplementedError
+              end
+
+              def has_code_example?
+                raise NotImplementedError
+              end
+
+              def has_doc?
+                raise NotImplementedError
+              end
+
+              def has_multiple_code_examples?
+                raise NotImplementedError
+              end
+
+              def has_unconsidered_tags?
+                raise NotImplementedError
+              end
+
+              def method?
+                raise NotImplementedError
+              end
+
+              def nodoc?
+                raise NotImplementedError
+              end
+
+              def namespace?
+                raise NotImplementedError
+              end
+
+              def original_docstring
+                raise NotImplementedError
+              end
+
+              def overridden?
+                raise NotImplementedError
+              end
+
+              def overridden_method_fullname
+                raise NotImplementedError
+              end
+
+              def parameters
+                raise NotImplementedError
+              end
+
+              def private?
+                raise NotImplementedError
+              end
+
+              def tagged_as_internal_api?
+                raise NotImplementedError
+              end
+
+              def tagged_as_private?
+                raise NotImplementedError
+              end
+
+              def protected?
+                raise NotImplementedError
+              end
+
+              def public?
+                raise NotImplementedError
+              end
+
+              def questioning_name?
+                raise NotImplementedError
+              end
+
+              def return_described?
+                raise NotImplementedError
+              end
+
+              def return_mentioned?
+                raise NotImplementedError
+              end
+
+              def return_typed?
+                raise NotImplementedError
+              end
+
+              def in_root?
+                raise NotImplementedError
+              end
+
+              def setter?
+                raise NotImplementedError
+              end
+
+              def source
+                raise NotImplementedError
+              end
+
+              def unconsidered_tag_count
+                raise NotImplementedError
+              end
+
+              def undocumented?
+                raise NotImplementedError
+              end
+
+              def visibility
+                raise NotImplementedError
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end