inch 0.2.3 → 0.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76a30cfdd0b22157bc5ef102e9f15cc96ec40147
-  data.tar.gz: 21d1a3ecb2c12294579f4406059a322e25fb15ff
+  metadata.gz: fb172151aa6a4cebe01d50b2e38a5b43bc1d10ba
+  data.tar.gz: c19f22f6081241b240eeaee8bdbf2b2d910e7c68
 SHA512:
-  metadata.gz: e60ae99656807e6731978c0b3bd29534ad313bcda1f8aabae5407dc062bb8aa3f1e589f3599b900f917973608047d1e6909bdfc52e872792d07e281b18cda16f
-  data.tar.gz: 5bd8e9097b64d1cb9e454ef47e052e1d96ca1d2f562d2c12c9ae470b26de4db456e6c901563f5c9b9267eb013a6976ee25c2f31f768577806e826d6bf6be3b79
+  metadata.gz: c612a1a55be07cc3d6d120eb21a6e94670d16f3399b260b5837fc91f427cf89f4c54d2fa6bfd73aff747353543eb242032c7325fe871553fdff483f29bfb142e
+  data.tar.gz: ea91964f803278cea9ff25d202090ac67e709a08b96e046490198a48b42ec4e87c7f672c272f01e2ef63534053b80f16b6cc5cdca5f808132cf323a7b5e10ec9

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.start do
+  add_filter '/test/'
+
+  add_group 'CLI', 'lib/inch/cli'
+  add_group 'Code Objects', 'lib/inch/code_object'
+  add_group 'Evaluation', 'lib/inch/evaluation'
+end

data/TODOS.md

@@ -3,10 +3,5 @@
 * Recognize all relevant options in .yardopts file
   * --plugin
   * --[no-]api API
-* Provide reusable context that filters code objects according to the
-  visibility options
 * Add support for multiple signatures for methods
   (realized via the @overload tag in YARD)
-
-* Think about implicit cases in terms of evaluation:
-  * attr_* methods are automatically assigned a docstring and @param tag

data/config/defaults.rb

@@ -27,6 +27,31 @@ Inch::Config.run do
       bg_color  :color105
     end
 
+    priority(:N) do
+      priorities  4..99
+      arrow       "\u2191"
+    end
+
+    priority(:NE) do
+      priorities  2...4
+      arrow       "\u2197"
+    end
+
+    priority(:E) do
+      priorities  0...2
+      arrow       "\u2192"
+    end
+
+    priority(:SE) do
+      priorities  -2...0
+      arrow       "\u2198"
+    end
+
+    priority(:S) do
+      priorities  -99...-2
+      arrow       "\u2193"
+    end
+
     schema(:ConstantObject) do
       docstring           1.0
 
@@ -62,7 +87,7 @@ Inch::Config.run do
         parameters          parameters + return_type
         return_type         0.0
       end
-      
+
       if object.constructor?
         return_description  0.0
       end

data/inch.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest", "~> 5.2"
 
   spec.add_dependency 'sparkr', ">= 0.2.0"
   spec.add_dependency "term-ansicolor"

data/lib/inch.rb

@@ -3,8 +3,9 @@ require "inch/version"
 module Inch
 end
 
+require_relative 'inch/api'
 require_relative 'inch/core_ext'
-require_relative 'inch/source_parser'
+require_relative 'inch/codebase'
 require_relative 'inch/code_object'
 require_relative 'inch/evaluation'
 require_relative 'inch/cli'

data/lib/inch/api.rb

@@ -0,0 +1,34 @@
+module Inch
+  # The API module is the entry point for Inch's APIs
+  #
+  # APIs are kind of "use cases" that are utilized by the CLI classes to
+  # actually "do things".
+  #
+  # Example:
+  #
+  #   $ inch list lib/**/*.rb --private
+  #
+  # This basically calls something like this:
+  #
+  #   codebase = Codebase::Proxy.new(Dir.pwd, ["lib/**/*.rb"], [])
+  #   options = {:visibility => [:public, :protected, :private]}
+  #   context = API::List.new(codebase, options)
+  #   context.objects # => Array
+  #
+  # The List API takes a Codebase::Proxy object and an options
+  # hash or a class in API::Options and returns objects and grade_lists
+  # matching that options.
+  #
+  module API
+  end
+end
+
+require_relative 'api/options/base'
+require_relative 'api/options/filter'
+require_relative 'api/options/suggest'
+
+require_relative 'api/filter'
+require_relative 'api/get'
+require_relative 'api/list'
+require_relative 'api/suggest'
+require_relative 'api/stats'

data/lib/inch/api/filter.rb

@@ -0,0 +1,17 @@
+module Inch
+  module API
+    # Filters a codebase's objects based on given options
+    class Filter
+      attr_reader :codebase
+      attr_reader :objects
+      attr_reader :grade_lists
+
+      def initialize(codebase, options)
+        @codebase = codebase
+        codebase.objects.filter! Options::Filter(options)
+        @objects = codebase.objects.to_a
+        @grade_lists = @codebase.grade_lists
+      end
+    end
+  end
+end

data/lib/inch/api/get.rb

@@ -0,0 +1,30 @@
+module Inch
+  module API
+    # Gets all objects matching the given +object_names+
+    class Get < Filter
+      attr_reader :object
+
+      def initialize(codebase, object_names)
+        super(codebase, {})
+        @objects = find_objects_with_names(object_names)
+        @object = objects.first
+      end
+
+      private
+
+      # 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 = codebase.objects.find(object_name)
+            object
+          else
+            codebase.objects.starting_with(object_name)
+          end
+        end.flatten
+      end
+    end
+  end
+end

data/lib/inch/api/list.rb

@@ -0,0 +1,10 @@
+module Inch
+  module API
+    class List < Filter
+      def initialize(codebase, options)
+        super
+        @options = options
+      end
+    end
+  end
+end

data/lib/inch/api/options/base.rb

@@ -0,0 +1,45 @@
+module Inch
+  module API
+    module Options
+      class Base
+        class << self
+          # Creates an attribute with an optional default value
+          #
+          # @param name [Symbol] the name of the attribute
+          # @param default [nil] the default value of the attribute
+          # @return [void]
+          def attribute(name, default = nil)
+            define_method(name) do
+              instance_variable_get("@#{name}") || default
+            end
+            @attributes ||= {}
+            @attributes[to_s] ||= []
+            @attributes[to_s] << name
+          end
+
+          def attribute_names
+            @attributes ||= {}
+            @attributes[to_s] ||= []
+          end
+        end
+
+        def initialize(options_or_hash)
+          self.class.attribute_names.each do |name|
+            read options_or_hash, name
+          end
+        end
+
+        protected
+
+        def read(options_or_hash, name)
+          value = if options_or_hash.is_a?(Hash)
+            options_or_hash[name]
+          else
+            options_or_hash.send(name)
+          end
+          instance_variable_set("@#{name}", value)
+        end
+      end
+    end
+  end
+end

data/lib/inch/api/options/filter.rb

@@ -0,0 +1,25 @@
+module Inch
+  module API
+    module Options
+      class Filter < Base
+        # This module is included here and in Command::Options::BaseList
+        # to ensure the same default values for the command-line and library
+        # interface
+        module DefaultAttributeValues
+          DEFAULT_VISIBILITY = [:public, :protected]
+        end
+
+        include DefaultAttributeValues
+
+        attribute :visibility, DEFAULT_VISIBILITY
+        attribute :namespaces
+        attribute :undocumented
+        attribute :depth
+      end
+
+      def self.Filter(options_or_hash)
+        Filter.new(options_or_hash)
+      end
+    end
+  end
+end

data/lib/inch/api/options/suggest.rb

@@ -0,0 +1,36 @@
+require 'inch/evaluation/proxy/base'
+
+module Inch
+  module API
+    module Options
+      class Suggest < Base
+        # This module is included here and in Command::Options::Suggest
+        # to ensure the same default values for the command-line and library
+        # interface
+        module DefaultAttributeValues
+          DEFAULT_OBJECT_COUNT        = 20
+          DEFAULT_FILE_COUNT          = 5
+          DEFAULT_PROPER_GRADES       = [:A, :B]
+          DEFAULT_GRADES_TO_DISPLAY   = [:B, :C, :U]
+          DEFAULT_GRADE_WEIGHTS       = [0.2, 0.4, 0.4]
+          DEFAULT_OBJECT_MIN_PRIORITY = 0
+          DEFAULT_OBJECT_MAX_SCORE    = ::Inch::Evaluation::Proxy::Base::MAX_SCORE
+        end
+
+        include 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
+      end
+
+      def self.Suggest(options_or_hash)
+        Suggest.new(options_or_hash)
+      end
+    end
+  end
+end

data/lib/inch/api/stats.rb

@@ -0,0 +1,7 @@
+module Inch
+  module API
+    class Stats < Filter
+
+    end
+  end
+end

data/lib/inch/api/suggest.rb

@@ -0,0 +1,110 @@
+require 'inch/utils/weighted_list'
+
+module Inch
+  module API
+    class Suggest < Filter
+      def initialize(codebase, options)
+        super
+        @options = Options::Suggest(options)
+      end
+
+      def files
+        list = files_sorted_by_importance
+        how_many = @options.file_count || list.size
+        list[0...how_many]
+      end
+
+      # @return [Array] the +@options.object_count+ objects the API suggests
+      def objects
+        filter_objects_to_display
+      end
+
+
+      # @return [Array] all the objects that match +@options+
+      def all_objects
+        relevant_objects
+      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 filter_objects_to_display
+        graded_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 }
+          graded_list << arr
+        end
+
+        weighted_list = Utils::WeightedList.new(graded_list, object_list_counts)
+
+        list = Codebase::Objects.sort_by_priority(weighted_list.to_a.flatten)
+
+        if list.size > object_count
+          list = list[0...object_count]
+        end
+        list
+      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
+
+        Codebase::Objects.sort_by_priority(priority_list.empty? ? list : priority_list)
+      end
+
+      def all_filenames(objects)
+        codebase.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
+        codebase.objects.map(&:grade).uniq
+      end
+
+      def grade_list(grade_symbol)
+        grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
+      end
+
+      def select_by_priority(list, min_priority)
+        list.select { |o| o.priority >= min_priority }
+      end
+
+      def relevant_grades
+        grades.size >= 2 ? grades[-2..-1] : [grades.last].compact
+      end
+
+      def relevant_objects
+        select_by_priority(codebase.objects, @options.object_min_priority)
+      end
+
+      def relevant_priorities
+        (@options.object_min_priority..99)
+      end
+    end
+  end
+end

data/lib/inch/cli.rb

@@ -1,4 +1,8 @@
 module Inch
+  # The CLI module is tasked with the deconstruction of CLI calls
+  # into API calls.
+  #
+  # @see Inch::API
   module CLI
     class << self
       # Returns the columns of the terminal window
@@ -17,7 +21,6 @@ module Inch
 end
 
 require_relative 'cli/arguments'
-require_relative 'cli/weighted_list'
 require_relative 'cli/sparkline_helper'
 require_relative 'cli/trace_helper'
 require_relative 'cli/yardopts_helper'

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

@@ -38,7 +38,7 @@ module Inch
       class Base
         include TraceHelper
 
-        attr_reader :source_parser # @return [SourceParser]
+        attr_reader :codebase # @return [Codebase::Proxy]
 
         # Helper method to run an instance with the given +args+
         #
@@ -97,22 +97,6 @@ module Inch
         def usage
           "Usage: inch #{name} [options]"
         end
-
-        private
-
-        # Returns the source parser against the given +paths+, while
-        # excluding all paths given in +excluded+
-        #
-        # @param paths [Array<String>]
-        # @param excluded [Array<String>]
-        # @return [void]
-        def run_source_parser(paths, excluded)
-          debug "Parsing:\n" \
-                "  files:    #{paths.inspect}\n" \
-                "  excluded: #{excluded.inspect}"
-
-          @source_parser = SourceParser.run(paths, excluded)
-        end
       end
     end
   end