inch 0.2.3 → 0.3.0.rc1

data/lib/inch/code_object/docstring.rb

@@ -1,102 +0,0 @@
-module Inch
-  module CodeObject
-    class Docstring
-      def initialize(text)
-        @text = text.to_s
-      end
-
-      def empty?
-        @text.strip.empty?
-      end
-
-      def contains_code_example?
-        !code_examples.empty?
-      end
-
-      def code_examples
-        @code_examples ||= parse_code_examples
-      end
-
-      def describes_parameter?(name)
-        describe_parameter_regexps(name).any? do |pattern|
-          @text.index(pattern)
-        end
-      end
-
-      def mentions_parameter?(name)
-        mention_parameter_regexps(name).any? do |pattern|
-          @text.index(pattern)
-        end
-      end
-
-      def mentions_return?
-        @text.lines.to_a.last =~ /^Returns\ /
-      end
-
-      def describes_return?
-        @text.lines.to_a.last =~ /^Returns\ (\w+\s){2,}/
-      end
-
-      def parse_code_examples
-        code_examples = []
-        example = nil
-        @text.lines.each_with_index do |line, index|
-          if line =~/^\s*+$/
-            code_examples << example if example
-            example = []
-          elsif line =~/^\ {2,}\S+/
-            example << line if example
-          else
-            code_examples << example if example
-            example = nil
-          end
-        end
-        code_examples << example if example
-        code_examples.delete_if(&:empty?).map(&:join)
-      end
-
-      private
-
-      def mention_parameter_patterns(name)
-        [
-          "+#{name}+",
-          "+#{name}+::",
-          "<tt>#{name}</tt>",
-          "<tt>#{name}</tt>::",
-          "#{name}::",
-          /^#{name}\ \-\ /
-        ]
-      end
-
-      def describe_parameter_extra_regexps(name)
-        [
-          "#{name}::",
-          "+#{name}+::",
-          "<tt>#{name}</tt>::",
-        ].map do |pattern|
-          r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
-          /#{r}\n\ {2,}.+/m
-        end
-      end
-
-      def describe_parameter_regexps(name)
-        same_line_regexps = mention_parameter_patterns(name).map do |pattern|
-          r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
-          /^#{r}\s?\S+/
-        end
-        same_line_regexps + describe_parameter_extra_regexps(name)
-      end
-
-      def mention_parameter_regexps(name)
-        mention_parameter_patterns(name).map do |pattern|
-          if pattern.is_a?(Regexp)
-            pattern
-          else
-            r = Regexp.escape(pattern)
-            /\W#{r}\W/
-          end
-        end
-      end
-    end
-  end
-end

data/lib/inch/code_object/nodoc_helper.rb

@@ -1,107 +0,0 @@
-module Inch
-  module CodeObject
-    module NodocHelper
-
-      # Returns true if the code object is somehow marked not to be
-      # documented.
-      #
-      # @note Doesnot recognize ":startdoc:" and ":stopdoc:"
-      #
-      def nodoc?
-        private_tag? || nodoc_comment?
-      end
-
-      NO_DOC_REGEX = /#\s*\:nodoc\:/
-      NO_DOC_ALL_REGEX = /#\s*\:nodoc\:\s*all/
-      DOC_REGEX = /#\s*\:doc\:/
-
-      def nodoc_comment?
-        explicit_nodoc_comment? || implicit_nodoc_comment?
-      end
-
-      def explicit_nodoc_comment?
-        declarations.any? { |str| str =~ NO_DOC_REGEX }
-      end
-
-      def explicit_nodoc_all_comment?
-        declarations.any? { |str| str =~ NO_DOC_ALL_REGEX }
-      end
-
-      def explicit_doc_comment?
-        declarations.any? { |str| str =~ DOC_REGEX }
-      end
-
-      def implicit_nodoc_all_comment?
-        if parent
-          parent.explicit_nodoc_all_comment? ||
-            parent.implicit_nodoc_all_comment?
-        end
-      end
-
-      def implicit_nodoc_comment?
-        return false if explicit_doc_comment?
-
-        if parent
-          return false if parent.explicit_doc_comment?
-
-          if namespace?
-            if parent.explicit_nodoc_all_comment?
-              return true
-            else
-              return parent.implicit_nodoc_all_comment?
-            end
-          else
-            if parent.explicit_nodoc_comment?
-              return true
-            else
-              return parent.implicit_nodoc_all_comment?
-            end
-          end
-        end
-      end
-
-      # Returns all lines in all files declaring the object
-      #
-      # @example
-      #   declarations # => ["class Base # :nodoc:", "class Foo < Base"]
-      #
-      # @return [Array<String>]
-      def declarations
-        @declarations ||= files.map do |(filename, line_no)|
-          get_line_no(filename, line_no)
-        end
-      end
-
-      # Returns all files declaring the object in the form of an Array of
-      # Arrays containing the filename and the line number of their
-      # declaration.
-      #
-      # @example
-      #   files # => [["lib/inch.rb", 3],
-      #                ["lib/inch/cli.rb", 1],
-      #                 ["lib/inch/version.rb", 1],
-      #
-      # @return [Array<Array(String, Fixnum)>]
-      def files
-        object.files
-      rescue YARD::CodeObjects::ProxyMethodError
-        # this error is raised by YARD
-        # see broken.rb in test fixtures
-        []
-      end
-
-      # Returns a +line_number+ from a file
-      #
-      # @param filename [String]
-      # @param line_number [Fixnum]
-      # @return [String]
-      def get_line_no(filename, line_number)
-        f = File.open(filename)
-        line_number.times{f.gets}
-        result = $_
-        f.close
-        result
-      end
-    end
-  end
-end

data/lib/inch/evaluation/base.rb

@@ -1,157 +0,0 @@
-module Inch
-  module Evaluation
-    # @abstract
-    class Base
-      extend Forwardable
-
-      MIN_SCORE = 0
-      MAX_SCORE = 100
-
-      TAGGED_SCORE = 20 # assigned per unconsidered tag
-
-      # @return [CodeObject::Proxy::Base]
-      attr_accessor :object
-
-      attr_reader :min_score, :max_score
-
-      # @param object [CodeObject::Proxy::Base]
-      def initialize(object)
-        self.object = object
-        @roles = []
-        evaluate
-      end
-
-      # Evaluates the objects and assigns roles
-      # @abstract
-      def evaluate
-      end
-
-      # @return [Float]
-      def max_score
-        arr = @roles.map(&:max_score).compact
-        [MAX_SCORE].concat(arr).min
-      end
-
-      # @return [Float]
-      def min_score
-        arr = @roles.map(&:min_score).compact
-        [MIN_SCORE].concat(arr).max
-      end
-
-      # @return [Float]
-      def score
-        value = @roles.inject(0) { |sum,r| sum + r.score.to_f }
-        if value < min_score
-          min_score
-        elsif value > max_score
-          max_score
-        else
-          value
-        end
-      end
-
-      # @return [Fixnum]
-      def priority
-        @roles.inject(0) { |sum,r| sum + r.priority.to_i }
-      end
-
-      # @return [Array<Evaluation::Role::Base>]
-      def roles
-        @roles
-      end
-
-      class << self
-        attr_reader :criteria_map
-
-        # Defines the weights during evaluation for different criteria
-        #
-        #   MethodObject.criteria do
-        #     docstring           0.5
-        #     parameters          0.4
-        #     return_type         0.1
-        #
-        #     if object.constructor?
-        #       parameters        0.5
-        #       return_type       0.0
-        #     end
-        #   end
-        #
-        # @return [void]
-        def criteria(&block)
-          @criteria_map ||= {}
-          @criteria_map[to_s] ||= ObjectSchema.new(&block)
-        end
-      end
-
-      protected
-
-      def add_role(role)
-        @roles << role
-      end
-
-      def criteria
-        @criteria ||= begin
-          c = self.class.criteria_map[self.class.to_s]
-          c.evaluate(object)
-          c
-        end
-      end
-
-      def eval_visibility
-        if object.in_root?
-          add_role Role::Object::InRoot.new(object)
-        end
-        if object.public?
-          add_role Role::Object::Public.new(object)
-        end
-        if object.protected?
-          add_role Role::Object::Protected.new(object)
-        end
-        if object.private?
-          add_role Role::Object::Private.new(object)
-        end
-      end
-
-      def eval_doc
-        if object.has_doc?
-          add_role Role::Object::WithDoc.new(object, score_for(:docstring))
-        else
-          add_role Role::Object::WithoutDoc.new(object, score_for(:docstring))
-        end
-        if object.nodoc?
-          add_role Role::Object::TaggedAsNodoc.new(object)
-        end
-      end
-
-      def eval_code_example
-        if object.has_code_example?
-          if object.has_multiple_code_examples?
-            add_role Role::Object::WithMultipleCodeExamples.new(object, score_for(:code_example_multi))
-          else
-            add_role Role::Object::WithCodeExample.new(object, score_for(:code_example_single))
-          end
-        else
-          add_role Role::Object::WithoutCodeExample.new(object, score_for(:code_example_single))
-        end
-      end
-
-      def eval_tags
-        if object.api_tag?
-          if object.private_api_tag?
-            add_role Role::Object::TaggedAsPrivateAPI.new(object)
-          else
-            add_role Role::Object::TaggedAsAPI.new(object)
-          end
-        end
-        if object.has_unconsidered_tags?
-          count = object.unconsidered_tags.size
-          add_role Role::Object::Tagged.new(object, score_for(:unconsidered_tag) * count)
-        end
-      end
-
-      def score_for(criteria_name)
-        criteria.send(criteria_name) * MAX_SCORE
-      end
-    end
-  end
-end

data/lib/inch/evaluation/class_object.rb

@@ -1,6 +0,0 @@
-module Inch
-  module Evaluation
-    class ClassObject < NamespaceObject
-    end
-  end
-end

data/lib/inch/evaluation/constant_object.rb

@@ -1,33 +0,0 @@
-module Inch
-  module Evaluation
-    class ConstantObject < Base
-      def evaluate
-        eval_doc
-        eval_visibility
-      end
-
-      def eval_doc
-        if object.has_doc?
-          add_role Role::Constant::WithDoc.new(object, score_for(:docstring))
-        else
-          add_role Role::Constant::WithoutDoc.new(object, score_for(:docstring))
-        end
-        if object.nodoc?
-          add_role Role::Constant::TaggedAsNodoc.new(object)
-        end
-      end
-
-      def eval_visibility
-        if object.in_root?
-          add_role Role::Constant::InRoot.new(object)
-        end
-        if object.public?
-          add_role Role::Constant::Public.new(object)
-        end
-        if object.private?
-          add_role Role::Constant::Private.new(object)
-        end
-      end
-    end
-  end
-end

data/lib/inch/evaluation/method_object.rb

@@ -1,105 +0,0 @@
-module Inch
-  module Evaluation
-    class MethodObject < Base
-      def evaluate
-        eval_doc
-        eval_code_example
-        eval_visibility
-        eval_tags
-        
-        eval_parameters
-        eval_return_type
-        eval_method
-      end
-
-      private
-
-      def eval_method
-        if object.constructor?
-          add_role Role::Method::Constructor.new(object)
-        end
-        if object.getter?
-          add_role Role::Method::Getter.new(object)
-        end
-        if object.setter?
-          add_role Role::Method::Setter.new(object)
-        end
-        if object.overridden?
-          add_role Role::Method::Overridden.new(object, object.overridden_method.score)
-        end
-        if object.has_many_lines?
-          add_role Role::Method::WithManyLines.new(object)
-        end
-        if object.bang_name?
-          add_role Role::Method::WithBangName.new(object)
-        end
-        if object.questioning_name?
-          add_role Role::Method::WithQuestioningName.new(object)
-        end
-        if object.has_alias?
-          add_role Role::Method::HasAlias.new(object)
-        end
-      end
-
-      def eval_parameters
-        if object.has_parameters?
-          eval_all_parameters
-        else
-          eval_no_parameters
-        end
-      end
-
-      def eval_no_parameters
-        if score > min_score
-          add_role Role::Method::WithoutParameters.new(object, score_for(:parameters))
-        end
-      end
-
-      def eval_all_parameters
-        params = object.parameters
-        per_param = score_for(:parameters) / params.size
-        params.each do |param|
-          if param.mentioned?
-            if param.wrongly_mentioned?
-              add_role Role::MethodParameter::WithWrongMention.new(param, -score_for(:parameters))
-            else
-              add_role Role::MethodParameter::WithMention.new(param, per_param * 0.5)
-            end
-          else
-            add_role Role::MethodParameter::WithoutMention.new(param, per_param * 0.5)
-          end
-          if param.typed?
-            add_role Role::MethodParameter::WithType.new(param, per_param * 0.5)
-          else
-            add_role Role::MethodParameter::WithoutType.new(param, per_param * 0.5)
-          end
-          if param.bad_name?
-            add_role Role::MethodParameter::WithBadName.new(param)
-          end
-          if param.block?
-            add_role Role::MethodParameter::Block.new(param)
-          end
-          if param.splat?
-            add_role Role::MethodParameter::Splat.new(param)
-          end
-        end
-        if object.has_many_parameters?
-          add_role Role::Method::WithManyParameters.new(object)
-        end
-      end
-
-      def eval_return_type
-        if object.return_mentioned?
-          add_role Role::Method::WithReturnType.new(object, score_for(:return_type))
-        else
-          add_role Role::Method::WithoutReturnType.new(object, score_for(:return_type))
-        end
-        if object.return_described?
-          add_role Role::Method::WithReturnDescription.new(object, score_for(:return_description))
-        else
-          add_role Role::Method::WithoutReturnDescription.new(object, score_for(:return_description))
-        end
-      end
-    end
-  end
-end