inch 0.5.0.rc3 → 0.5.0.rc4

data/lib/inch/language/ruby/provider/yard/object/namespace_object.rb

@@ -0,0 +1,46 @@
+module Inch
+  module Language
+    module Ruby
+      module Provider
+        module YARD
+          module Object
+            # a namespace object can have methods and other namespace objects
+            # inside itself (e.g. classes and modules)
+            class NamespaceObject < Base
+              def attributes
+                object.class_attributes.values + object.instance_attributes.values
+              end
+
+              def children_fullnames
+                children.map(&:fullname)
+              end
+
+              def namespace?
+                true
+              end
+
+              def has_methods?
+                children.any?(&:method?)
+              end
+
+              def pure_namespace?
+                children.all?(&:namespace?)
+              end
+
+              # called by MethodObject#getter?
+              def child(name)
+                children.find { |child| child.name == name } if children
+              end
+
+              def children
+                object.children.map do |o|
+                  YARD::Object.for(o)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/ruby/provider/yard/object/root_object.rb

@@ -0,0 +1,14 @@
+module Inch
+  module Language
+    module Ruby
+      module Provider
+        module YARD
+          module Object
+            class RootObject < NamespaceObject
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/ruby/provider/yard/parser.rb

@@ -0,0 +1,71 @@
+module Inch
+  module Language
+    module Ruby
+      module Provider
+        module YARD
+          # Parses the source tree (using YARD)
+          class Parser
+            IGNORE_TYPES      = [:macro]
+
+            # Helper method to parse an instance with the given +args+
+            #
+            # @see #parse
+            # @return [CodeObject::Provider::YARD::Parser] the instance that ran
+            def self.parse(*args)
+              parser = new
+              parser.parse(*args)
+              parser
+            end
+
+            # @param dir [String] directory
+            # @param config [Inch::Config::Codebase] configuration for codebase
+            # @return [void]
+            def parse(dir, config)
+              Dir.chdir(dir) do
+                parse_yard_objects(config.included_files,
+                                    config.excluded_files,
+                                    config.read_dump_file)
+                inject_base_dir(dir)
+              end
+            end
+
+            # @return [Array<YARD::Object::Base>]
+            def objects
+              @objects ||= parsed_objects.map do |o|
+                YARD::Object.for(o) unless IGNORE_TYPES.include?(o.type)
+              end.compact
+            end
+
+            private
+
+            def parse_yard_objects(paths, excluded, read_dump_file = nil)
+              if read_dump_file.nil?
+                YARD::Object.clear_cache
+                ::YARD::Registry.clear
+                ::YARD.parse(paths, excluded)
+              else
+                puts "Ruby doesn't support the --read option."
+                exit 1
+              end
+            end
+
+            def inject_base_dir(dir)
+              objects.each do |object|
+                object.base_dir = dir
+
+                object.aliases_fullnames.each do |fullname|
+                  alias_object = objects.find { |o| o.fullname == fullname }
+                  alias_object.aliased_object_fullname = object.fullname
+                end
+              end
+            end
+
+            def parsed_objects
+              ::YARD::Registry.all
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Inch
+  module Language
+    module Ruby
+      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
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/ruby/roles/class_variable.rb

@@ -0,0 +1,53 @@
+module Inch
+  module Language
+    module Ruby
+      module Evaluation
+        module Role
+          # Roles assigned to class variables
+          module ClassVariable
+            class WithDoc < Object::WithDoc
+              applicable_if :has_doc?
+            end
+            class WithoutDoc < Object::WithoutDoc
+              applicable_unless :has_doc?
+            end
+
+            class TaggedAsNodoc < Object::TaggedAsNodoc
+              applicable_if :nodoc?
+            end
+            class InRoot < Object::InRoot
+              applicable_if :in_root?
+            end
+
+            class Public < Object::Public
+              applicable_if :public?
+              priority      -1
+            end
+            class Private < Object::Private
+              applicable_if :private?
+              priority      -3
+            end
+
+            class WithCodeExample < Object::WithCodeExample
+              applicable_if do |o|
+                o.has_code_example? && !o.has_multiple_code_examples?
+              end
+            end
+
+            class WithMultipleCodeExamples < Object::WithMultipleCodeExamples
+              applicable_if :has_multiple_code_examples?
+            end
+
+            class WithoutCodeExample < Object::WithoutCodeExample
+              applicable_unless :has_code_example?
+
+              def suggestion
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/ruby/roles/constant.rb

@@ -0,0 +1,53 @@
+module Inch
+  module Language
+    module Ruby
+      module Evaluation
+        module Role
+          # Roles assigned to constants
+          module Constant
+            class WithDoc < Object::WithDoc
+              applicable_if :has_doc?
+            end
+            class WithoutDoc < Object::WithoutDoc
+              applicable_unless :has_doc?
+            end
+
+            class TaggedAsNodoc < Object::TaggedAsNodoc
+              applicable_if :nodoc?
+            end
+            class InRoot < Object::InRoot
+              applicable_if :in_root?
+            end
+
+            class Public < Object::Public
+              applicable_if :public?
+              priority      -1
+            end
+            class Private < Object::Private
+              applicable_if :private?
+              priority      -3
+            end
+
+            class WithCodeExample < Object::WithCodeExample
+              applicable_if do |o|
+                o.has_code_example? && !o.has_multiple_code_examples?
+              end
+            end
+
+            class WithMultipleCodeExamples < Object::WithMultipleCodeExamples
+              applicable_if :has_multiple_code_examples?
+            end
+
+            class WithoutCodeExample < Object::WithoutCodeExample
+              applicable_unless :has_code_example?
+
+              def suggestion
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/ruby/roles/method.rb

@@ -0,0 +1,112 @@
+module Inch
+  module Language
+    module Ruby
+      module Evaluation
+        module Role
+          module Method
+            # 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/ruby/roles/method_parameter.rb

@@ -0,0 +1,84 @@
+module Inch
+  module Language
+    module Ruby
+      module Evaluation
+        module Role
+          # Roles assigned to method parameters
+          #
+          # @note The +object+ is a MethodParameterObject here!
+          module MethodParameter
+            # Role assigned to parameters that are mentioned in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#mentioned?
+            class WithMention < Base
+              applicable_if :mentioned?
+            end
+
+            # Role assigned to parameters that are not mentioned in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#mentioned?
+            class WithoutMention < Missing
+              applicable_unless :mentioned?
+
+              def suggestion
+                "Describe the parameter '#{object.name}'"
+              end
+            end
+
+            # Role assigned to parameters that are typed in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#typed?
+            class WithType < Base
+              applicable_if :typed?
+            end
+
+            # Role assigned to parameters that are not typed in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#typed?
+            class WithoutType < Missing
+              applicable_unless :typed?
+            end
+
+            # Role assigned to parameters that are spalts, e.g. +*args+
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#splat?
+            class Splat < Base
+              applicable_if :splat?
+              priority      +1
+            end
+
+            # Role assigned to parameters that are blocks, e.g. +&block+
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#block?
+            class Block < Base
+              applicable_if :block?
+              priority      +1
+            end
+
+            # Role assigned to parameters that are documented, but not part of
+            # the method signature
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#wrongly_mentioned?
+            class WithWrongMention < Base
+              applicable_if :wrongly_mentioned?
+              priority      +1
+
+              def suggestion
+                "The parameter '#{object.name}' seems not to be part of the " \
+                  "signature."
+              end
+            end
+
+            # Role assigned to parameters that have a 'bad' name
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#bad_name?
+            class WithBadName < Base
+              applicable_if :bad_name?
+              priority      +1
+            end
+          end
+        end
+      end
+    end
+  end
+end