inch 0.5.0.rc3 → 0.5.0.rc4

data/lib/inch/evaluation/role/class_variable.rb

@@ -1,55 +0,0 @@
-module Inch
-  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?
-
-          def priority
-            -1
-          end
-        end
-        class Private < Object::Private
-          applicable_if :private?
-
-          def priority
-            -3
-          end
-        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

data/lib/inch/evaluation/role/constant.rb

@@ -1,55 +0,0 @@
-module Inch
-  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?
-
-          def priority
-            -1
-          end
-        end
-        class Private < Object::Private
-          applicable_if :private?
-
-          def priority
-            -3
-          end
-        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

data/lib/inch/evaluation/role/method.rb

@@ -1,126 +0,0 @@
-module Inch
-  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::Proxy::MethodObject#has_many_parameters?
-        class WithManyParameters < Base
-          applicable_if :has_many_parameters?
-
-          def priority
-            +2
-          end
-        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::Proxy::MethodObject#has_many_lines?
-        class WithManyLines < Base
-          applicable_if :has_many_lines?
-
-          def priority
-            +2
-          end
-        end
-
-        # Role assigned to methods whose name end in a '!'
-        class WithBangName < Base
-          applicable_if :bang_name?
-
-          def priority
-            +3
-          end
-        end
-
-        # Role assigned to methods whose name end in a '?'
-        class WithQuestioningName < Base
-          applicable_if :questioning_name?
-
-          def priority
-            -4
-          end
-        end
-
-        # Role assigned to methods which are aliased
-        class HasAlias < Base
-          applicable_if :has_alias?
-
-          def priority
-            +2
-          end
-        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
-          def priority
-            -2
-          end
-
-          # 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

data/lib/inch/evaluation/role/method_parameter.rb

@@ -1,91 +0,0 @@
-module Inch
-  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::Proxy::MethodParameterObject#mentioned?
-        class WithMention < Base
-          applicable_if :mentioned?
-        end
-
-        # Role assigned to parameters that are not mentioned in the docs
-        #
-        # @see CodeObject::Proxy::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::Proxy::MethodParameterObject#typed?
-        class WithType < Base
-          applicable_if :typed?
-        end
-
-        # Role assigned to parameters that are not typed in the docs
-        #
-        # @see CodeObject::Proxy::MethodParameterObject#typed?
-        class WithoutType < Missing
-          applicable_unless :typed?
-        end
-
-        # Role assigned to parameters that are spalts, e.g. +*args+
-        #
-        # @see CodeObject::Proxy::MethodParameterObject#splat?
-        class Splat < Base
-          applicable_if :splat?
-
-          def priority
-            +1
-          end
-        end
-
-        # Role assigned to parameters that are blocks, e.g. +&block+
-        #
-        # @see CodeObject::Proxy::MethodParameterObject#block?
-        class Block < Base
-          applicable_if :block?
-
-          def priority
-            +1
-          end
-        end
-
-        # Role assigned to parameters that are documented, but not part of
-        # the method signature
-        #
-        # @see CodeObject::Proxy::MethodParameterObject#wrongly_mentioned?
-        class WithWrongMention < Base
-          applicable_if :wrongly_mentioned?
-
-          def suggestion
-            "The parameter '#{object.name}' seems not to be part of the signature."
-          end
-
-          def priority
-            +1
-          end
-        end
-
-        # Role assigned to parameters that have a 'bad' name
-        #
-        # @see CodeObject::Proxy::MethodParameterObject#bad_name?
-        class WithBadName < Base
-          applicable_if :bad_name?
-
-          def priority
-            +1
-          end
-        end
-      end
-    end
-  end
-end

data/lib/inch/evaluation/role/missing.rb

@@ -1,20 +0,0 @@
-module Inch
-  module Evaluation
-    module Role
-      # 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

data/lib/inch/evaluation/role/namespace.rb

@@ -1,85 +0,0 @@
-module Inch
-  module Evaluation
-    module Role
-      # Roles assigned to namespaces (classes and modules)
-      module Namespace
-        # Role assigned to namespaces with children
-        #
-        # @see CodeObject::Proxy::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 namespaces with many children
-        #
-        # @see CodeObject::Proxy::NamespaceObject#has_many_children?
-        class WithManyChildren < Base
-          applicable_if :has_many_children?
-
-          # +priority
-          def priority
-            +1
-          end
-        end
-
-        # Role assigned to namespaces with many attributes
-        #
-        # @see CodeObject::Proxy::NamespaceObject#has_many_attributes?
-        class WithManyAttributes < Base
-          applicable_if :has_many_attributes?
-
-          # +priority
-          def priority
-            +1
-          end
-        end
-
-        # Role assigned to namespaces without any children
-        class WithoutChildren < Base
-          applicable_unless :has_children?
-        end
-
-        # Role assigned to namespaces without any methods
-        class WithoutMethods < Base
-          applicable_unless :has_methods?
-
-          def priority
-            -2
-          end
-        end
-
-        # A 'pure' namespace has only namespaces as children
-        class Pure < Base
-          applicable_if :pure_namespace?
-
-          def priority
-            -2
-          end
-        end
-
-        # A 'core' namespace is a class or module that is part of the Ruby
-        # core. It might appear in the object tree when monkey-patching
-        # functionality.
-        # (the reasoning here is: just because we patch Hash does not mean
-        # we need to document the Hash class itself)
-        class Core < Base
-          applicable_if :core?
-
-          def priority
-            -7
-          end
-        end
-      end
-    end
-  end
-end

data/lib/inch/evaluation/role/object.rb

@@ -1,143 +0,0 @@
-module Inch
-  module Evaluation
-    module Role
-      # Roles assigned to all objects
-      module Object
-        # Role assigned to objects that are aliases.
-        #
-        class Alias < Base
-          applicable_if :alias?
-
-          def priority
-            # not sure about this yet,
-            # but aliases should not show up high in the reports
-            -7
-          end
-        end
-
-        # 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?
-
-          def priority
-            -1
-          end
-        end
-
-        # Role assigned to objects explicitly or implicitly tagged not to be
-        # documented.
-        #
-        # @see CodeObject::NodocHelper
-        class TaggedAsNodoc < Base
-          applicable_if :nodoc?
-
-          def priority
-            -7
-          end
-        end
-
-        # Role assigned to objects explicitly or implicitly tagged to be part
-        # of an API. If the API is 'private'/'internal' TaggedAsInternalAPI is assigned
-        # instead.
-        class TaggedAsAPI < Base
-          applicable_if :api_tag?
-        end
-
-        # Role assigned to objects explicitly or implicitly tagged to be part
-        # of a private API.
-        class TaggedAsInternalAPI < Base
-          applicable_if :tagged_as_internal_api?
-
-          def priority
-            -5
-          end
-        end
-
-        # Role assigned to objects explicitly or implicitly tagged to be
-        # private.
-        #
-        # @see CodeObject::NodocHelper
-        class TaggedAsPrivate < Base
-          applicable_if :tagged_as_private?
-
-          def priority
-            -5
-          end
-        end
-
-        # Role assigned to objects declared in the top-level namespace
-        class InRoot < Base
-          applicable_if :in_root?
-
-          def priority
-            +3
-          end
-        end
-
-        # Role assigned to public objects
-        class Public < Base
-          applicable_if :public?
-
-          def priority
-            +2
-          end
-        end
-
-        # Role assigned to protected objects
-        class Protected < Base
-          applicable_if :protected?
-
-          def priority
-            +1
-          end
-        end
-
-        # Role assigned to private objects
-        class Private < Base
-          applicable_if :private?
-
-          def priority
-            -2
-          end
-        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