inch 0.2.3 → 0.3.0.rc1

data/lib/inch/cli/command/base_list.rb

@@ -10,78 +10,18 @@ module Inch
       #
       # @abstract
       class BaseList < Base
-        attr_writer :objects
-
-        def initialize
-          super
-          @grade_lists = Evaluation.new_grade_lists
-        end
+        attr_accessor :objects
 
         # Prepares the list of objects and grade_lists, parsing arguments and
         # running the source parser.
         #
         # @param *args [Array<String>] the list of arguments.
         # @return [void]
-        def prepare_list(*args)
+        def prepare_codebase(*args)
           @options.parse(args)
           @options.verify
-          run_source_parser(@options.paths, @options.excluded)
-          filter_objects
-          assign_objects_to_grade_lists
-        end
-
-        private
-
-        # Assigns the objects returned by {#objects} to the grade_lists
-        # based on their score
-        #
-        def assign_objects_to_grade_lists
-          @grade_lists.each do |range|
-            list = objects.select { |o| range.scores.include?(o.score) }
-            range.objects = sort_by_priority(list)
-          end
-        end
-
-        # Filters the +@objects+ based on the settings in +@options+
-        #
-        # @return [void]
-        def filter_objects
-          if @options.namespaces == :only
-            self.objects = objects.select(&:namespace?)
-          end
-          if @options.namespaces == :none
-            self.objects = objects.reject(&:namespace?)
-          end
-          if @options.undocumented == :only
-            self.objects = objects.select(&:undocumented?)
-          end
-          if @options.undocumented == :none
-            self.objects = objects.reject(&:undocumented?)
-          end
-          if @options.depth
-            self.objects = objects.select { |o| o.depth <= @options.depth }
-          end
-          self.objects = objects.select do |o|
-            @options.visibility.include?(o.visibility)
-          end
-          if !@options.visibility.include?(:private)
-            self.objects = objects.reject do |o|
-              o.private_tag?
-            end
-          end
-        end
-
-        # @return [Array<CodeObject::Proxy::Base>]
-        def objects
-          @objects ||= sort_by_priority(source_parser.all_objects)
-        end
 
-        # @param objects [Array<CodeObject::Proxy::Base>]
-        # @return [Array<CodeObject::Proxy::Base>]
-        def sort_by_priority(objects)
-          objects.sort_by do |o|
-            [o.priority, o.score, o.path.size]
-          end.reverse
+          @codebase = ::Inch::Codebase.parse(Dir.pwd, @options.paths, @options.excluded)
         end
       end
     end

data/lib/inch/cli/command/base_object.rb

@@ -10,13 +10,8 @@ module Inch
       #   $ inch COMMAND [paths] OBJECT_NAME [, OBJECT_NAME2, ...] [options]
       #
       # @abstract
-      class BaseObject < Base
-        attr_accessor :object, :objects
-
-        def initialize
-          super
-          @grade_lists = Evaluation.new_grade_lists
-        end
+      class BaseObject < BaseList
+        attr_accessor :object
 
         # Prepares the given objects, parsing arguments and
         # running the source parser.
@@ -24,28 +19,11 @@ module Inch
         # @param *args [Array<String>] the list of arguments
         # @return [void]
         def prepare_objects(*args)
-          @options.parse(args)
-          @options.verify
-          run_source_parser(@options.paths, @options.excluded)
-
-          self.objects = find_objects_with_names(@options.object_names)
-          self.object = @objects.first
-        end
-
-        private
+          prepare_codebase(*args)
 
-        # Returns all objects matching the given +object_names+
-        #
-        # @param object_names [Array<String>]
-        # @return [Array<CodeObject::Proxy::Base>]
-        def find_objects_with_names(object_names)
-          object_names.map do |object_name|
-            if object = source_parser.find_object(object_name)
-              object
-            else
-              source_parser.find_objects(object_name)
-            end
-          end.flatten
+          context = API::Get.new(codebase, @options.object_names)
+          self.objects = context.objects
+          self.object = context.object
         end
       end
     end

data/lib/inch/cli/command/list.rb

@@ -21,8 +21,9 @@ module Inch
         # @param [Array<String>] args the list of arguments.
         # @return [void]
         def run(*args)
-          prepare_list(*args)
-          Output::List.new(@options, objects, @grade_lists)
+          prepare_codebase(*args)
+          context = API::List.new(codebase, @options)
+          Output::List.new(@options, context.objects, context.grade_lists)
         end
       end
     end

data/lib/inch/cli/command/options/base.rb

@@ -91,7 +91,7 @@ module Inch
           #
           # @return [String]
           def description_hint_arrows
-            arrows = Output::Base::PRIORITY_ARROWS.join(' ')
+            arrows = Evaluation::PriorityRange.all.map(&:arrow).join(' ')
             "Arrows (#{arrows}) hint at the importance of the object " +
               "being documented."
           end

data/lib/inch/cli/command/options/base_list.rb

@@ -6,12 +6,14 @@ module Inch
         #
         # @abstract Subclass and override #set_options
         class BaseList < Base
-          attribute :show_all, false
-          attribute :visibility, [:public, :protected]
+          include API::Options::Filter::DefaultAttributeValues
+
+          attribute :visibility, DEFAULT_VISIBILITY
           attribute :namespaces
           attribute :undocumented
           attribute :depth
 
+          attribute :show_all, false
           alias :show_all? :show_all
 
           def parse(args)

data/lib/inch/cli/command/options/suggest.rb

@@ -3,14 +3,15 @@ module Inch
     module Command
       module Options
         class Suggest < BaseList
-          attribute :object_count, 20
-          attribute :file_count, 5
-
-          attribute :proper_grades, [:A, :B]
-          attribute :grades_to_display, [:B, :C, :U]
-          attribute :grade_weights, [0.2, 0.4, 0.4]
-          attribute :object_min_priority, 0
-          attribute :object_max_score, ::Inch::Evaluation::Base::MAX_SCORE
+          include API::Options::Suggest::DefaultAttributeValues
+
+          attribute :object_count, DEFAULT_OBJECT_COUNT
+          attribute :file_count, DEFAULT_FILE_COUNT
+          attribute :proper_grades, DEFAULT_PROPER_GRADES
+          attribute :grades_to_display, DEFAULT_GRADES_TO_DISPLAY
+          attribute :grade_weights, DEFAULT_GRADE_WEIGHTS
+          attribute :object_min_priority, DEFAULT_OBJECT_MIN_PRIORITY
+          attribute :object_max_score, DEFAULT_OBJECT_MAX_SCORE
 
           attribute :pedantic, false
 

data/lib/inch/cli/command/output/base.rb

@@ -18,22 +18,20 @@ module Inch
         class Base
           include TraceHelper
 
-          PRIORITY_MAP = {
-              (4..99) => "\u2191", # north
-              (2...4) => "\u2197", # north-east
-              (0..1)  => "\u2192", # east
-              (-2..-1) => "\u2198", # south-east
-              (-99..-3) => "\u2193", # south-east
-            }
-          PRIORITY_ARROWS = PRIORITY_MAP.values
-
           def priority_arrow(priority, color = :white)
-            PRIORITY_MAP.each do |range, str|
+            Evaluation::PriorityRange.all.each do |range|
               if range.include?(priority)
-                return str.color(color).dark
+                return range.arrow.color(color).dark
               end
             end
           end
+
+          def print_file_info(o, _color)
+            o.files.each do |f|
+              echo "-> #{f[0]}:#{f[1]}".color(_color)
+            end
+            echo separator
+          end
         end
       end
     end

data/lib/inch/cli/command/output/list.rb

@@ -70,14 +70,14 @@ module Inch
             grade = object.grade.to_s
             grade = grade.ljust(2).color(color)
             priority = object.priority
-            " #{grade} #{priority_arrow(priority, color)}  #{object.path}"
+            " #{grade} #{priority_arrow(priority, color)}  #{object.fullname}"
           end
 
           def result_numbers(object, color)
             score = object.score.to_i.to_s
             score = score.rjust(3).color(color)
             priority = object.priority
-            "#{score}  #{priority}  #{object.path}"
+            "#{score}  #{priority}  #{object.fullname}"
           end
 
         end

data/lib/inch/cli/command/output/show.rb

@@ -26,19 +26,11 @@ module Inch
 
           def print_object(o)
             trace
-            trace_header(o.path, COLOR, BG_COLOR)
+            trace_header(o.fullname, COLOR, BG_COLOR)
 
-            print_file_info(o)
+            print_file_info(o, COLOR)
             print_grade_info(o)
             print_roles_info(o)
-
-          end
-
-          def print_file_info(o)
-            o.files.each do |f|
-              echo "-> #{f[0]}:#{f[1]}".color(COLOR)
-            end
-            echo separator
           end
 
           def print_grade_info(o)

data/lib/inch/cli/command/output/stats.rb

@@ -46,10 +46,10 @@ module Inch
           def print_grades_by_priority
             puts 'Grade distribution by priority:'
             puts
-            PRIORITY_MAP.each do |priority_range, arrow|
+            Evaluation::PriorityRange.all.each do |priority_range|
               list = objects.select { |o| priority_range.include?(o.priority) }
               sparkline = grades_sparkline(list).to_s(' ')
-              puts "        #{arrow}   #{sparkline}  " +
+              puts "        #{priority_range.arrow}   #{sparkline}  " +
                     "#{list.size.to_s.rjust(5)} objects"
               puts
             end
@@ -73,9 +73,10 @@ module Inch
           end
 
           def print_priorities
+            arrows = Evaluation::PriorityRange.all.map(&:arrow)
             puts "Priority distribution in grades: (low to high)"
             puts
-            puts "      #{PRIORITY_MAP.values.reverse.join('      ')}"
+            puts "      #{arrows.reverse.join('      ')}"
             @grade_lists.reverse.each do |grade_list|
               print_grade_list(grade_list)
             end

data/lib/inch/cli/command/output/suggest.rb

@@ -18,11 +18,11 @@ module Inch
           }
 
           # @param options [Command::Options::Suggest]
-          # @param objects_to_display [Array<CodeObject::Proxy::Base>]
           # @param relevant_objects [Array<CodeObject::Proxy::Base>] the objects meeting the criteria defined in +options+
+          # @param objects_to_display [Array<CodeObject::Proxy::Base>]
           # @param grade_lists [Array<Evaluation::GradeList>]
           # @param files [Array<Evaluation::File>]
-          def initialize(options, objects_to_display, relevant_objects, grade_lists, files)
+          def initialize(options, relevant_objects, objects_to_display, grade_lists, files)
             @options = options
             @objects = objects_to_display
             @relevant_objects = relevant_objects
@@ -63,7 +63,7 @@ module Inch
             trace
 
             files.each do |f|
-              trace edged(FILE_COLOR, f.path.color(FILE_COLOR))
+              trace edged(FILE_COLOR, f.fullname.color(FILE_COLOR))
             end
             trace
           end
@@ -78,7 +78,7 @@ module Inch
                 grade_objects.each do |o|
                   grade = o.grade.to_s.ljust(2).color(r.color)
                   priority = o.priority
-                  trace edged(r.color, " #{grade} #{priority_arrow(priority, r.color)}  #{o.path}")
+                  trace edged(r.color, " #{grade} #{priority_arrow(priority, r.color)}  #{o.fullname}")
                 end
               end
             end
@@ -89,7 +89,7 @@ module Inch
           end
 
           def priority_arrows_gte(min_priority)
-            PRIORITY_MAP.map do |range, str|
+            Evaluation::PriorityRange.all.map do |range, str|
               str if range.min >= min_priority
             end.compact
           end

data/lib/inch/cli/command/stats.rb

@@ -8,7 +8,7 @@ module Inch
         register_command_as :stats
 
         def description
-          'Lists all objects with their results'
+          'Show statistics'
         end
 
         def usage
@@ -16,8 +16,9 @@ module Inch
         end
 
         def run(*args)
-          prepare_list(*args)
-          Output::Stats.new(@options, objects, @grade_lists)
+          prepare_codebase(*args)
+          context = API::Stats.new(codebase, @options)
+          Output::Stats.new(@options, context.objects, context.grade_lists)
         end
       end
     end

data/lib/inch/cli/command/suggest.rb

@@ -21,100 +21,10 @@ module Inch
         # @param [Array<String>] args the list of arguments.
         # @return [void]
         def run(*args)
-          prepare_list(*args)
-          Output::Suggest.new(@options, objects_to_display, relevant_objects, @grade_lists, files)
-        end
-
-        private
-
-        # @return [Fixnum] how many objects should be displayed in the output
-        def object_count
-          @options.object_count
-        end
-
-        # @return [Array<Fixnum>]
-        #   how many objects of each grade should be displayed in the output
-        def object_list_counts
-          @options.grade_weights.map { |w| w * object_count }
-        end
-
-        # @return [Array] the objects that should be displayed in the output
-        def objects_to_display
-          @objects_to_display ||= filter_objects_to_display
-        end
-
-        # @return [Array] the objects that should be displayed in the output
-        def filter_objects_to_display
-          grade_list = []
-          @options.grades_to_display.map do |grade|
-            r = grade_list(grade)
-            arr = select_by_priority(r.objects, @options.object_min_priority)
-            arr = arr.select { |o| o.score <= @options.object_max_score }
-            grade_list << arr
-          end
-
-          weighted_list = WeightedList.new(grade_list, object_list_counts)
-
-          list = sort_by_priority(weighted_list.to_a.flatten)
-
-          if list.size > object_count
-            list = list[0...object_count]
-          end
-          list
-        end
-
-        def files
-          list = files_sorted_by_importance
-          how_many = @options.file_count || list.size
-          list[0...how_many]
-        end
-
-        def files_sorted_by_importance
-          list = all_filenames(relevant_objects).uniq.map do |filename|
-            f = Evaluation::File.for(filename, relevant_objects)
-          end
-
-          priority_list = list.select do |f|
-            relevant_grades.include?(f.grade) &&
-              relevant_priorities.include?(f.priority)
-          end
-
-          sort_by_priority(priority_list.empty? ? list : priority_list)
-        end
-
-        def all_filenames(objects)
-          objects.map do |o|
-            o.files.map(&:first)
-          end.flatten
-        end
-
-        # Returns the unique grades assigned to objects
-        #
-        #   grades # => [:A, :B, :C, :U]
-        #
-        # @return [Array<Symbol>]
-        def grades
-          objects.map(&:grade).uniq
-        end
-
-        def grade_list(grade_symbol)
-          @grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
-        end
-
-        def relevant_objects
-          select_by_priority(objects, @options.object_min_priority)
-        end
-
-        def relevant_grades
-          grades.size >= 2 ? grades[-2..-1] : [grades.last].compact
-        end
-
-        def relevant_priorities
-          (@options.object_min_priority..99)
-        end
-
-        def select_by_priority(list, min_priority)
-          list.select { |o| o.priority >= min_priority }
+          prepare_codebase(*args)
+          context = API::Suggest.new(codebase, @options)
+          Output::Suggest.new(@options, context.all_objects,
+            context.objects, context.grade_lists, context.files)
         end
       end
     end