inch 0.2.2 → 0.2.3

data/lib/inch/config.rb

@@ -1,53 +1,46 @@
 module Inch
-  module Evaluation
-
-    ConstantObject.criteria do
-      docstring           1.0
-
-      # optional:
-      unconsidered_tag    0.2
+  class Config
+    class << self
+      attr_accessor :instance
+
+      def run(&block)
+        self.instance ||= new
+        instance.update(&block)
+        instance
+      end
     end
 
-    ClassObject.criteria do
-      docstring           1.0
-
-      # optional:
-      code_example_single 0.1
-      code_example_multi  0.2
-      unconsidered_tag    0.2
+    def update(&block)
+      instance_eval(&block)
     end
 
-    ModuleObject.criteria do
-      docstring           1.0
+    def development?
+      @development
+    end
 
-      # optional:
-      code_example_single 0.1
-      code_example_multi  0.2
-      unconsidered_tag    0.2
+    def development!
+      @development = true
     end
 
-    MethodObject.criteria do
-      docstring           0.5
-      parameters          0.4
-      return_type         0.1
-      return_description  0.3
+    def evaluation(&block)
+      @evaluation ||= Evaluation.new
+      @evaluation.update(&block) if block
+      @evaluation
+    end
 
-      if object.constructor? || object.questioning_name?
-        parameters          parameters + return_type
-        return_type         0.0
+    class Evaluation
+      def update(&block)
+        instance_eval(&block)
       end
 
-      unless object.has_parameters?
-        return_description  docstring + parameters
-        docstring           docstring + parameters
-        parameters          0.0
+      def grade(symbol, &block)
+        ::Inch::Evaluation::Grade.grade(symbol, &block)
       end
 
-      # optional:
-      code_example_single 0.1
-      code_example_multi  0.25
-      unconsidered_tag    0.2
+      def schema(constant_name, &block)
+        constant = eval("::Inch::Evaluation::#{constant_name}")
+        constant.criteria(&block)
+      end
     end
-
   end
 end

data/lib/inch/evaluation/base.rb

@@ -79,7 +79,7 @@ module Inch
         # @return [void]
         def criteria(&block)
           @criteria_map ||= {}
-          @criteria_map[to_s] ||= Criteria.new(&block)
+          @criteria_map[to_s] ||= ObjectSchema.new(&block)
         end
       end
 
@@ -97,6 +97,58 @@ module Inch
         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

data/lib/inch/evaluation/constant_object.rb

@@ -2,6 +2,11 @@ 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
@@ -10,17 +15,9 @@ module Inch
         if object.nodoc?
           add_role Role::Constant::TaggedAsNodoc.new(object)
         end
-        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 eval_visibility
         if object.in_root?
           add_role Role::Constant::InRoot.new(object)
         end

data/lib/inch/evaluation/file.rb

@@ -21,7 +21,7 @@ module Inch
       #
 
       def grade
-        median(grades.sort)
+        median(grades.sort_by(&:to_sym))
       end
 
       def priority

data/lib/inch/evaluation/grade.rb

@@ -0,0 +1,41 @@
+module Inch
+  module Evaluation
+    class Grade
+      extend Evaluation::ReadWriteMethods
+
+      rw_methods %w(scores label color bg_color)
+
+      def initialize(symbol)
+        @symbol = symbol
+      end
+
+      def update(&block)
+        instance_eval(&block)
+      end
+
+      def to_sym
+        @symbol
+      end
+
+      def to_s
+        @symbol.to_s
+      end
+
+      class << self
+        attr_reader :grade_map
+
+        def all
+          @grade_map ||= {}
+          @grade_map.values
+        end
+
+        def grade(symbol, &block)
+          @grade_map ||= {}
+          @grade_map[symbol] ||= Grade.new(symbol)
+          @grade_map[symbol].update(&block) if block
+          @grade_map[symbol]
+        end
+      end
+    end
+  end
+end

data/lib/inch/evaluation/grade_list.rb

@@ -0,0 +1,32 @@
+module Inch
+  module Evaluation
+    # These objects associate a grade with a group of objects
+    #
+    # @see .new_grade_lists
+    class GradeList < Struct.new(:grade)
+      extend Forwardable
+
+      def_delegators :grade, :scores, :label, :color, :bg_color,
+                              :to_s, :to_sym
+
+      # Returns code_objects that received a score with the defined +scores+
+      attr_reader :objects
+
+      # Assigns code_objects that received a score with the defined +scores+
+      #
+      # @param arr [Array<CodeObject::Proxy::Base>]
+      # @return [Array<CodeObject::Proxy::Base>]
+      def objects=(arr)
+        arr.each { |o| o.grade = grade }
+        @objects = arr
+      end
+    end
+
+    # Returns newly instanciated grade range objects
+    #
+    # @return [Array<GradeList>]
+    def self.new_grade_lists
+      Evaluation::Grade.all.map { |g| GradeList.new(g) }
+    end
+  end
+end

data/lib/inch/evaluation/method_object.rb

@@ -3,39 +3,27 @@ module Inch
     class MethodObject < Base
       def evaluate
         eval_doc
+        eval_code_example
+        eval_visibility
+        eval_tags
+        
         eval_parameters
         eval_return_type
-        eval_code_example
         eval_method
-        eval_misc
       end
 
       private
 
-      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
-      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_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
@@ -53,35 +41,6 @@ module Inch
         end
       end
 
-      def eval_misc
-        if object.nodoc?
-          add_role Role::Object::TaggedAsNodoc.new(object)
-        end
-        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
-        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_parameters
         if object.has_parameters?
           eval_all_parameters

data/lib/inch/evaluation/namespace_object.rb

@@ -8,37 +8,22 @@ module Inch
 
       def evaluate
         eval_doc
-        eval_children
         eval_code_example
-        eval_misc
-        eval_core
+        eval_visibility
+        eval_tags
+        
+        eval_children
+        eval_namespace
       end
 
       private
 
-      def eval_core
+      def eval_namespace
         if RUBY_CORE.include?(object.path)
           add_role Role::Namespace::Core.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_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))
+        if object.has_many_attributes?
+          add_role Role::Namespace::WithManyAttributes.new(object)
         end
       end
 
@@ -59,32 +44,6 @@ module Inch
         end
       end
 
-      def eval_misc
-        if object.has_many_attributes?
-          add_role Role::Namespace::WithManyAttributes.new(object)
-        end
-        if object.nodoc?
-          add_role Role::Object::TaggedAsNodoc.new(object)
-        end
-        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
-        if object.in_root?
-          add_role Role::Object::InRoot.new(object)
-        end
-        if object.public? # this is always true for classes and modules
-          add_role Role::Object::Public.new(object)
-        end
-      end
-
       def children
         @children ||= object.children.map(&:evaluation)
       end

data/lib/inch/evaluation/{criteria.rb → object_schema.rb}

@@ -1,18 +1,9 @@
 module Inch
   module Evaluation
-    class Criteria
-      attr_reader :object
-
-      def initialize(&block)
-        @block = block
-      end
-
-      def evaluate(object)
-        @object = object
-        instance_eval(&@block)
-      end
+    class ObjectSchema
+      extend Evaluation::ReadWriteMethods
 
-      NAMES = %w(
+      rw_methods %w(
         docstring
         parameters
         return_type
@@ -22,16 +13,15 @@ module Inch
         unconsidered_tag
         )
 
-      NAMES.each do |name|
-        class_eval """
-          def #{name}(value = nil)
-            if value.nil?
-              @#{name}.to_f
-            else
-              @#{name} = value
-            end
-          end
-        """
+      attr_reader :object
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def evaluate(object)
+        @object = object
+        instance_eval(&@block)
       end
     end
   end

data/lib/inch/evaluation/read_write_methods.rb

@@ -0,0 +1,21 @@
+module Inch
+  module Evaluation
+    module ReadWriteMethods
+      def rw_method(name)
+        class_eval """
+          def #{name}(value = nil)
+            if value.nil?
+              @#{name}
+            else
+              @#{name} = value
+            end
+          end
+        """
+      end
+
+      def rw_methods(*names)
+        [names].flatten.each { |name| rw_method(name) }
+      end
+    end
+  end
+end

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

@@ -72,6 +72,14 @@ module Inch
         class Constructor < Base
         end
 
+        # Role assigned to methods that are getters
+        class Getter < Base
+        end
+
+        # Role assigned to methods that are setters
+        class Setter < Base
+        end
+
         # Role assigned to methods that are overriding another method
         class Overridden < Base
           # It seems more important to document the overridden method,

data/lib/inch/evaluation.rb

@@ -13,9 +13,12 @@ module Inch
   end
 end
 
-require_relative 'evaluation/criteria'
+require_relative 'evaluation/read_write_methods'
+
 require_relative 'evaluation/file'
-require_relative 'evaluation/score_range'
+require_relative 'evaluation/grade'
+require_relative 'evaluation/grade_list'
+require_relative 'evaluation/object_schema'
 
 require_relative 'evaluation/role/base'
 require_relative 'evaluation/role/missing'

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/inch.rb

@@ -7,5 +7,7 @@ require_relative 'inch/core_ext'
 require_relative 'inch/source_parser'
 require_relative 'inch/code_object'
 require_relative 'inch/evaluation'
-require_relative 'inch/config'
 require_relative 'inch/cli'
+
+require_relative 'inch/config'
+require File.join(File.dirname(__FILE__), '..', 'config', 'defaults.rb')

data/test/fixtures/simple/lib/broken.rb

@@ -8,3 +8,18 @@ module Foo
 
   end
 end
+
+module YardError
+  if defined? ::Deprecate
+    Deprecate = ::Deprecate
+  elsif defined? Gem::Deprecate
+    Deprecate = Gem::Deprecate
+  else
+    class Deprecate; end
+  end
+
+  unless Deprecate.respond_to?(:skip_during)
+    def Deprecate.skip_during; yield; end
+  end
+
+end

data/test/fixtures/simple/lib/role_methods.rb

@@ -2,6 +2,21 @@ def root_method
 end
 
 module InchTest
+  attr_accessor :attr_getset
+
+  def manual_getset
+  end
+
+  def manual_getset=(val)
+  end
+
+  attr_reader :getter
+
+  def manual_setter=(val)
+  end
+
+  attr_writer :attr_setter
+
   def bang_method!
   end
 

data/test/inch/cli/weighted_list_test.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::CLI::WeightedList do
+  before do
+    @counts = [4, 8, 8]
+  end
+
+  def assert_weighted_list(list, counts, expected)
+    weighted_list = ::Inch::CLI::WeightedList.new(list, counts)
+    # assert_equal expected.map(&:size).inject(:+), weighted_list.to_a.map(&:size).inject(:+)
+    assert_equal expected, weighted_list.to_a, "should be #{expected.map(&:size)}, was #{weighted_list.to_a.map(&:size)}"
+  end
+
+  def list_and_expected(counts, expected_counts)
+    elements = [:B, :C, :U]
+    list = counts.map.with_index do |num, index|
+      (1..num).map { |i| :"#{elements[index]}#{i}" }
+    end
+    expected = expected_counts.map.with_index do |num, index|
+      (1..num).map { |i| :"#{elements[index]}#{i}" }
+    end
+    return list, expected
+  end
+
+  it "should work if elements are exact" do
+    @list, @expected = list_and_expected([4, 8, 8], [4, 8, 8])
+    assert_weighted_list(@list, @counts, @expected)
+  end
+
+  it "should work if more than enough elements are present" do
+    @list, @expected = list_and_expected([10, 10, 10], [4, 8, 8])
+    assert_weighted_list(@list, @counts, @expected)
+  end
+
+  it "should work if not enough Bs are present" do
+    @list, @expected = list_and_expected([2, 12, 15], [2, 8, 10])
+    assert_weighted_list(@list, @counts, @expected)
+  end
+
+  it "should work if not enough Cs are present" do
+    @list, @expected = list_and_expected([15, 4, 15], [4, 4, 12])
+    assert_weighted_list(@list, @counts, @expected)
+  end
+
+  it "should work if not enough Us are present" do
+    @list, @expected = list_and_expected([15, 15, 4], [4, 12, 4])
+    assert_weighted_list(@list, @counts, @expected)
+  end
+
+  it "should work if not enough Bs AND Cs and Us are present" do
+    @list, @expected = list_and_expected([2, 2, 15], [2, 2, 15])
+    assert_weighted_list(@list, @counts, @expected)
+  end
+
+end