inch 0.5.0.rc3 → 0.5.0.rc4

data/lib/inch.rb

@@ -1,15 +1,20 @@
-require 'inch/version'
+require "inch/version"
 
 module Inch
 end
 
-require 'forwardable'
+require "forwardable"
 
-require 'inch/api'
-require 'inch/core_ext'
-require 'inch/codebase'
-require 'inch/code_object'
-require 'inch/evaluation'
+require "inch/api"
+require "inch/core_ext"
+require "inch/codebase"
+require "inch/code_object"
+require "inch/evaluation"
 
-require 'inch/config'
-require File.join(File.dirname(__FILE__), '..', 'config', 'defaults.rb')
+require "inch/language"
+
+require "inch/config"
+require File.join(File.dirname(__FILE__), "..", "config", "base.rb")
+require File.join(File.dirname(__FILE__), "..", "config", "ruby.rb")
+require File.join(File.dirname(__FILE__), "..", "config", "nodejs.rb")
+require File.join(File.dirname(__FILE__), "..", "config", "elixir.rb")

data/lib/inch/api.rb

@@ -23,14 +23,14 @@ module Inch
   end
 end
 
-require 'inch/api/options/base'
-require 'inch/api/options/filter'
-require 'inch/api/options/suggest'
+require "inch/api/options/base"
+require "inch/api/options/filter"
+require "inch/api/options/suggest"
 
-require 'inch/api/compare'
-require 'inch/api/filter'
-require 'inch/api/get'
-require 'inch/api/list'
-require 'inch/api/suggest'
-require 'inch/api/stats'
-require 'inch/api/diff'
+require "inch/api/compare"
+require "inch/api/filter"
+require "inch/api/get"
+require "inch/api/list"
+require "inch/api/suggest"
+require "inch/api/stats"
+require "inch/api/diff"

data/lib/inch/api/compare.rb

@@ -1,2 +1,2 @@
-require 'inch/api/compare/code_objects'
-require 'inch/api/compare/codebases'
+require "inch/api/compare/code_objects"
+require "inch/api/compare/codebases"

data/lib/inch/api/compare/code_objects.rb

@@ -3,11 +3,11 @@ module Inch
     module Compare
       class CodeObjects
         attr_reader :before, :after
-        
+
         def initialize(object1, object2)
           @before, @after = object1, object2
           if @before.object_id == @after.object_id
-            raise "@before and @after are identical ruby objects. this is bad."
+            fail "@before and @after are identical ruby objects. this is bad."
           end
         end
 
@@ -23,7 +23,6 @@ module Inch
           @after.grade
         end
 
-
         def added?
           @before.nil? && !@after.nil?
         end

data/lib/inch/api/compare/codebases.rb

@@ -31,7 +31,7 @@ module Inch
         end
 
         def find(fullname)
-          comparisons.detect do |comparison|
+          comparisons.find do |comparison|
             comparison.fullname == fullname
           end
         end

data/lib/inch/api/diff.rb

@@ -1,4 +1,4 @@
-require 'inch/utils/shell_helper'
+require "inch/utils/shell_helper"
 
 module Inch
   module API
@@ -16,24 +16,24 @@ module Inch
       # @param before_rev [String] the 'before' revision
       # @param after_rev [String,nil] the 'after' revision that the 'before'
       #   one is compared against
-      def initialize(dir, before_rev, after_rev = nil)
+      def initialize(dir, config, before_rev, after_rev = nil)
         @work_dir = dir
-        @codebase_old = codebase_for(before_rev)
+        @codebase_old = codebase_for(before_rev, config)
         @codebase_new = if after_rev.nil?
-            Codebase.parse(work_dir)
-          else
-            codebase_for(after_rev)
-          end
+                          Codebase.parse(work_dir, config)
+                        else
+                          codebase_for(after_rev, config)
+                        end
         @comparer = API::Compare::Codebases.new(@codebase_old, @codebase_new)
       end
 
       private
 
-      def codebase_for(revision)
-        if cached = codebase_from_cache(revision)
+      def codebase_for(revision, config)
+        if (cached = codebase_from_cache(revision))
           cached
         else
-          codebase = codebase_from_copy(work_dir, revision)
+          codebase = codebase_from_copy(work_dir, config, revision)
           filename = Codebase::Serializer.filename(revision)
           Codebase::Serializer.save(codebase, filename)
           codebase
@@ -42,17 +42,15 @@ module Inch
 
       def codebase_from_cache(revision)
         filename = Codebase::Serializer.filename(revision)
-        if File.exist?(filename)
-          Codebase::Serializer.load(filename)
-        end
+        Codebase::Serializer.load(filename) if File.exist?(filename)
       end
 
-      def codebase_from_copy(original_dir, revision)
+      def codebase_from_copy(original_dir, config, revision)
         codebase = nil
         Dir.mktmpdir do |tmp_dir|
           new_dir = copy_work_dir(original_dir, tmp_dir)
           git_reset(new_dir, revision)
-          codebase = Codebase.parse(new_dir)
+          codebase = Codebase.parse(new_dir, config)
         end
         codebase
       end
@@ -65,7 +63,6 @@ module Inch
       def git_reset(dir, revision = nil)
         git dir, "reset --hard #{revision}"
       end
-
     end
   end
 end

data/lib/inch/api/filter.rb

@@ -8,7 +8,7 @@ module Inch
 
       def initialize(codebase, options)
         @codebase = codebase
-        codebase.objects.filter! Options::Filter(options)
+        codebase.objects.filter! Options::Filter.new(options)
         @objects = codebase.objects.to_a
         @grade_lists = @codebase.grade_lists
       end

data/lib/inch/api/get.rb

@@ -15,10 +15,10 @@ module Inch
       # Returns all objects matching the given +object_names+
       #
       # @param object_names [Array<String>]
-      # @return [Array<CodeObject::Proxy::Base>]
+      # @return [Array<CodeObject::Proxy>]
       def find_objects_with_names(object_names)
         object_names.map do |object_name|
-          if object = codebase.objects.find(object_name)
+          if (object = codebase.objects.find(object_name))
             object
           else
             codebase.objects.starting_with(object_name)

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

@@ -33,10 +33,10 @@ module Inch
 
         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
+                    options_or_hash[name]
+                  else
+                    options_or_hash.send(name)
+                  end
           instance_variable_set("@#{name}", value)
         end
       end

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

@@ -16,10 +16,6 @@ module Inch
         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

@@ -1,4 +1,4 @@
-require 'inch/evaluation/proxy/base'
+require "inch/evaluation/proxy"
 
 module Inch
   module API
@@ -14,7 +14,7 @@ module Inch
           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
+          DEFAULT_OBJECT_MAX_SCORE    = ::Inch::Evaluation::Proxy::MAX_SCORE
         end
 
         include DefaultAttributeValues
@@ -27,10 +27,6 @@ module Inch
         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

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

data/lib/inch/api/suggest.rb

@@ -1,11 +1,11 @@
-require 'inch/utils/weighted_list'
+require "inch/utils/weighted_list"
 
 module Inch
   module API
     class Suggest < Filter
       def initialize(codebase, options)
         super
-        @options = Options::Suggest(options)
+        @options = Options::Suggest.new(options)
       end
 
       def files
@@ -19,7 +19,6 @@ module Inch
         filter_objects_to_display
       end
 
-
       # @return [Array] all the objects that match +@options+
       def all_objects
         relevant_objects
@@ -52,15 +51,13 @@ module Inch
 
         list = Codebase::Objects.sort_by_priority(weighted_list.to_a.flatten)
 
-        if list.size > object_count
-          list = list[0...object_count]
-        end
+        list = list[0...object_count] if list.size > object_count
         list
       end
 
       def files_sorted_by_importance
         list = all_filenames(relevant_objects).uniq.map do |filename|
-          f = Evaluation::File.for(filename, relevant_objects)
+          Evaluation::File.for(filename, relevant_objects)
         end
 
         priority_list = list.select do |f|
@@ -68,7 +65,8 @@ module Inch
             relevant_priorities.include?(f.priority)
         end
 
-        Codebase::Objects.sort_by_priority(priority_list.empty? ? list : priority_list)
+        Codebase::Objects.sort_by_priority(
+          priority_list.empty? ? list : priority_list)
       end
 
       def all_filenames(objects)
@@ -87,7 +85,7 @@ module Inch
       end
 
       def grade_list(grade_symbol)
-        grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
+        grade_lists.find { |r| r.grade.to_sym == grade_symbol }
       end
 
       def select_by_priority(list, min_priority)
@@ -99,7 +97,8 @@ module Inch
       end
 
       def relevant_objects
-        @relevant_objects ||= select_by_priority(codebase.objects, @options.object_min_priority)
+        @relevant_objects ||= select_by_priority(codebase.objects,
+                                                 @options.object_min_priority)
       end
 
       def relevant_priorities

data/lib/inch/cli.rb

@@ -11,7 +11,7 @@ module Inch
       # @return [Fixnum]
       def get_term_columns(default = 80)
         str = `stty size`
-        rows_cols = str.split(' ').map(&:to_i)
+        rows_cols = str.split(" ").map(&:to_i)
         rows_cols[1] || default
       rescue
         default
@@ -21,9 +21,9 @@ module Inch
   end
 end
 
-require 'inch/cli/arguments'
-require 'inch/cli/sparkline_helper'
-require 'inch/cli/trace_helper'
-require 'inch/cli/yardopts_helper'
+require "inch/cli/arguments"
+require "inch/cli/sparkline_helper"
+require "inch/cli/trace_helper"
+require "inch/cli/yardopts_helper"
 
-require 'inch/cli/command'
+require "inch/cli/command"

data/lib/inch/cli/arguments.rb

@@ -28,10 +28,10 @@ module Inch
       # @param args [Array<String>]
       # @return [void]
       def parse(args)
-        if first_non_file = args.find_index { |e| !glob_or_file?(e) }
+        if (first_non_file = args.find_index { |e| !glob_or_file?(e) })
           @files = args[0...first_non_file]
           rest = args[first_non_file..-1]
-          if first_switch = rest.find_index { |e| switch?(e) }
+          if (first_switch = rest.find_index { |e| switch?(e) })
             @object_names = rest[0...first_switch]
             @switches = rest[first_switch..-1]
           else

data/lib/inch/cli/command.rb

@@ -1,19 +1,19 @@
-require 'inch/cli/command/base'
-require 'inch/cli/command/base_list'
-require 'inch/cli/command/base_object'
+require "inch/cli/command/base"
+require "inch/cli/command/base_list"
+require "inch/cli/command/base_object"
 
-require 'inch/cli/command/options/base'
-require 'inch/cli/command/options/base_list'
-require 'inch/cli/command/options/base_object'
+require "inch/cli/command/options/base"
+require "inch/cli/command/options/base_list"
+require "inch/cli/command/options/base_object"
 
-require 'inch/cli/command/output/base'
+require "inch/cli/command/output/base"
 
-require 'inch/cli/command_parser'
+require "inch/cli/command_parser"
 
-require 'inch/cli/command/list'
-require 'inch/cli/command/show'
-require 'inch/cli/command/stats'
-require 'inch/cli/command/suggest'
-require 'inch/cli/command/console'
-require 'inch/cli/command/inspect'
-require 'inch/cli/command/diff'
+require "inch/cli/command/list"
+require "inch/cli/command/show"
+require "inch/cli/command/stats"
+require "inch/cli/command/suggest"
+require "inch/cli/command/console"
+require "inch/cli/command/inspect"
+require "inch/cli/command/diff"

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

@@ -45,7 +45,8 @@ module Inch
         # @see #run
         # @return [Command::Base] the instance that ran
         def self.run(*args)
-          command = new
+          kwargs = args.last.is_a?(Hash) ? args.pop : {}
+          command = new(kwargs)
           command.run(*args)
           command
         end
@@ -59,11 +60,9 @@ module Inch
           CLI::CommandParser.commands[name] = self
         end
 
-        def initialize
-          name = self.class.to_s.split('::').last
-          options_class = Command::Options.const_get(name)
-          @options = options_class.new
-          @options.usage = usage
+        def initialize(kwargs = {})
+          @ui = kwargs[:ui] if kwargs[:ui]
+          initialize_cli_options
         end
 
         # Returns a description of the command
@@ -87,9 +86,9 @@ module Inch
         #
         # @abstract
         # @note Override with implementation
-        # @param *args [Array<String>]
-        def run(*args)
-          raise NotImplementedError
+        # @param *_args [Array<String>]
+        def run(*_args)
+          fail NotImplementedError
         end
 
         # Returns a description of the command's usage pattern
@@ -98,6 +97,28 @@ module Inch
         def usage
           "Usage: inch #{name} [options]"
         end
+
+        protected
+
+        def initialize_cli_options
+          name = self.class.to_s.split("::").last
+          options_class = Command::Options.const_get(name)
+          @options = options_class.new
+          @options.usage = usage
+        end
+
+        # Creates a Config::Codebase object and returns it
+        # (merges relevant values of a given +options+ object before).
+        #
+        # @param options [Options::Base]
+        # @return [Config::Codebase]
+        def to_config(options)
+          config = Config.for(@options.language, Dir.pwd).codebase
+          config.included_files = options.paths unless options.paths.empty?
+          config.excluded_files = options.excluded unless options.excluded.empty?
+          config.read_dump_file = options.read_dump_file
+          config
+        end
       end
     end
   end