inch 0.4.10 → 0.5.0.rc1

data/lib/inch/config/base.rb

@@ -4,6 +4,7 @@ module Inch
   # @see config/defaults.rb
   class Config
     class Base
+
       def update(&block)
         instance_eval(&block)
       end

data/lib/inch/config/codebase.rb

@@ -27,7 +27,7 @@ module Inch
       end
 
       def update_via_yaml(dir)
-        if (yaml = self.class.yaml(dir))
+        if yaml = self.class.yaml(dir)
           Dir.chdir(dir) do
             update_files yaml["files"]
           end
@@ -57,9 +57,9 @@ module Inch
 
       def update_files(files)
         return if files.nil?
-        @included_files = expand_files(files["included"]) if files["included"]
-        @excluded_files = expand_files(files["excluded"]) if files["excluded"]
+        include_files expand_files(files["included"]) if files["included"]
+        exclude_files expand_files(files["excluded"]) if files["excluded"]
       end
     end
   end
-end
+end

data/lib/inch/core_ext.rb

@@ -1 +1 @@
-require "inch/core_ext/string"
+require 'inch/core_ext/string'

data/lib/inch/core_ext/string.rb

@@ -1,3 +1,3 @@
-require "term/ansicolor"
+require 'term/ansicolor'
 
 String.send(:include, Term::ANSIColor)

data/lib/inch/evaluation.rb

@@ -9,27 +9,26 @@ module Inch
     private
 
     def self.class_for(code_object)
-      class_name = code_object.class.to_s.split("::").last
+      class_name = code_object.class.to_s.split('::').last
       const_get(class_name)
     end
   end
 end
 
-require "inch/utils/read_write_methods"
+require 'inch/utils/read_write_methods'
 
-require "inch/evaluation/file"
-require "inch/evaluation/grade"
-require "inch/evaluation/grade_list"
-require "inch/evaluation/object_schema"
-require "inch/evaluation/priority_range"
+require 'inch/evaluation/file'
+require 'inch/evaluation/grade'
+require 'inch/evaluation/grade_list'
+require 'inch/evaluation/object_schema'
+require 'inch/evaluation/priority_range'
 
-require "inch/evaluation/role/base"
-require "inch/evaluation/role/missing"
-require "inch/evaluation/role/object"
-require "inch/evaluation/role/method"
-require "inch/evaluation/role/method_parameter"
-require "inch/evaluation/role/namespace"
-require "inch/evaluation/role/constant"
-require "inch/evaluation/role/class_variable"
+require 'inch/evaluation/role/base'
+require 'inch/evaluation/role/missing'
+require 'inch/evaluation/role/object'
+require 'inch/evaluation/role/method'
+require 'inch/evaluation/role/method_parameter'
+require 'inch/evaluation/role/namespace'
+require 'inch/evaluation/role/constant'
 
-require "inch/evaluation/proxy"
+require 'inch/evaluation/proxy'

data/lib/inch/evaluation/file.rb

@@ -50,7 +50,7 @@ module Inch
       class << self
         def for(filename, objects)
           @cache ||= {}
-          if (file = @cache[filename])
+          if file = @cache[filename]
             file
           else
             @cache[filename] = new(filename, objects)

data/lib/inch/evaluation/grade_list.rb

@@ -6,8 +6,8 @@ module Inch
     class GradeList < Struct.new(:grade)
       extend Forwardable
 
-      def_delegators :grade,
-                     :scores, :label, :color, :bg_color, :to_s, :to_sym
+      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

data/lib/inch/evaluation/object_schema.rb

@@ -13,7 +13,7 @@ module Inch
         code_example_single
         code_example_multi
         unconsidered_tag
-      )
+        )
 
       attr_reader :object
 

data/lib/inch/evaluation/proxy.rb

@@ -10,17 +10,16 @@ module Inch
       private
 
       def self.class_for(code_object)
-        class_name = code_object.class.to_s.split("::").last
+        class_name = code_object.class.to_s.split('::').last
         const_get(class_name)
       end
     end
   end
 end
 
-require "inch/evaluation/proxy/base"
-require "inch/evaluation/proxy/namespace_object"
-require "inch/evaluation/proxy/class_object"
-require "inch/evaluation/proxy/class_variable_object"
-require "inch/evaluation/proxy/constant_object"
-require "inch/evaluation/proxy/method_object"
-require "inch/evaluation/proxy/module_object"
+require 'inch/evaluation/proxy/base'
+require 'inch/evaluation/proxy/namespace_object'
+require 'inch/evaluation/proxy/class_object'
+require 'inch/evaluation/proxy/constant_object'
+require 'inch/evaluation/proxy/method_object'
+require 'inch/evaluation/proxy/module_object'

data/lib/inch/evaluation/proxy/base.rb

@@ -67,7 +67,9 @@ module Inch
         end
 
         # @return [Array<Evaluation::Role::Base>]
-        attr_reader :roles
+        def roles
+          @roles
+        end
 
         protected
 
@@ -93,19 +95,13 @@ module Inch
             Role::Object::WithDoc => score_for(:docstring),
             Role::Object::WithoutDoc => score_for(:docstring),
             Role::Object::WithCodeExample => score_for(:code_example_single),
-            Role::Object::WithMultipleCodeExamples =>
-              score_for(:code_example_multi),
+            Role::Object::WithMultipleCodeExamples => score_for(:code_example_multi),
             Role::Object::WithoutCodeExample => score_for(:code_example_single),
             Role::Object::Tagged => score_for_unconsidered_tags,
             Role::Object::TaggedAsAPI => nil,
             Role::Object::TaggedAsInternalAPI => nil,
             Role::Object::TaggedAsPrivate => nil,
-            Role::Object::Alias =>
-              if object.alias?
-                object.aliased_object.score
-              else
-                nil
-              end
+            Role::Object::Alias => object.alias? ? object.aliased_object.score : nil,
           }
         end
 
@@ -128,8 +124,9 @@ module Inch
 
         def __evaluate(object, role_classes)
           role_classes.each do |role_class, score|
-            next unless role_class.applicable?(object)
-            add_role role_class.new(object, score)
+            if role_class.applicable?(object)
+              add_role role_class.new(object, score)
+            end
           end
         end
 
@@ -147,7 +144,7 @@ module Inch
 
         # @return [Float]
         def __score
-          value = @roles.reduce(0) { |sum, r| sum + r.score.to_f }.to_i
+          value = @roles.inject(0) { |sum,r| sum + r.score.to_f }.to_i
           if value < min_score
             min_score
           elsif value > max_score
@@ -159,7 +156,7 @@ module Inch
 
         # @return [Fixnum]
         def __priority
-          @roles.reduce(0) { |sum, r| sum + r.priority.to_i }
+          @roles.inject(0) { |sum,r| sum + r.priority.to_i }
         end
       end
     end

data/lib/inch/evaluation/proxy/constant_object.rb

@@ -10,7 +10,7 @@ module Inch
             Role::Constant::WithoutDoc => score_for(:docstring),
             Role::Constant::TaggedAsNodoc => nil,
             Role::Constant::Public => nil,
-            Role::Constant::Private => nil
+            Role::Constant::Private => nil,
           }
         end
       end

data/lib/inch/evaluation/proxy/method_object.rb

@@ -29,24 +29,17 @@ module Inch
             Role::Method::Constructor => nil,
             Role::Method::Getter => nil,
             Role::Method::Setter => nil,
-            Role::Method::Overridden =>
-              if object.overridden?
-                object.overridden_method.score
-              else
-                nil
-              end,
+            Role::Method::Overridden => object.overridden? ? object.overridden_method.score : nil,
             Role::Method::WithManyLines => nil,
             Role::Method::WithBangName => nil,
             Role::Method::WithQuestioningName => nil,
             Role::Method::HasAlias => nil,
             Role::Method::WithReturnType => score_for(:return_type),
             Role::Method::WithoutReturnType => score_for(:return_type),
-            Role::Method::WithReturnDescription =>
-              score_for(:return_description),
-            Role::Method::WithoutReturnDescription =>
-              score_for(:return_description),
+            Role::Method::WithReturnDescription => score_for(:return_description),
+            Role::Method::WithoutReturnDescription => score_for(:return_description),
             Role::Method::WithoutParameters => score_for(:parameters),
-            Role::Method::WithManyParameters => nil
+            Role::Method::WithManyParameters => nil,
           }
         end
 
@@ -59,7 +52,7 @@ module Inch
             Role::MethodParameter::WithoutType => per_param * 0.5,
             Role::MethodParameter::WithBadName => nil,
             Role::MethodParameter::Block => nil,
-            Role::MethodParameter::Splat => nil
+            Role::MethodParameter::Splat => nil,
           }
         end
 

data/lib/inch/evaluation/proxy/module_object.rb

@@ -5,4 +5,4 @@ module Inch
       end
     end
   end
-end
+end

data/lib/inch/evaluation/proxy/namespace_object.rb

@@ -18,7 +18,7 @@ module Inch
             Role::Namespace::WithChildren => nil,
             Role::Namespace::WithManyChildren => nil,
             Role::Namespace::WithoutMethods => nil,
-            Role::Namespace::Pure => nil
+            Role::Namespace::Pure => nil,
           }
         end
       end

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

@@ -84,7 +84,7 @@ module Inch
         end
 
         def object_type
-          object.class.to_s.split("::").last.gsub(/Object$/, "").downcase
+          object.class.to_s.split('::').last.gsub(/Object$/, '').downcase
         end
       end
     end

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

@@ -32,8 +32,7 @@ module Inch
           end
         end
 
-        # Role assigned to methods where the return value is decribed in the
-        # docs
+        # Role assigned to methods where the return value is decribed in the docs
         class WithReturnDescription < Base
           applicable_if :return_described?
         end
@@ -47,6 +46,7 @@ module Inch
           end
         end
 
+
         # Role assigned to methods with many lines
         #
         # @see CodeObject::Proxy::MethodObject#has_many_lines?

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

@@ -67,8 +67,7 @@ module Inch
           applicable_if :wrongly_mentioned?
 
           def suggestion
-            "The parameter '#{object.name}' seems not to be part of the " \
-              "signature."
+            "The parameter '#{object.name}' seems not to be part of the signature."
           end
 
           def priority

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

@@ -53,8 +53,8 @@ module Inch
         end
 
         # Role assigned to objects explicitly or implicitly tagged to be part
-        # of an API. If the API is 'private'/'internal' TaggedAsInternalAPI is
-        # assigned instead.
+        # of an API. If the API is 'private'/'internal' TaggedAsInternalAPI is assigned
+        # instead.
         class TaggedAsAPI < Base
           applicable_if :api_tag?
         end

data/lib/inch/rake.rb

@@ -1,2 +1,2 @@
-require "inch"
-require "inch/rake/suggest"
+require 'inch'
+require 'inch/rake/suggest'

data/lib/inch/rake/suggest.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
 
-require "rake"
-require "rake/tasklib"
-require "inch/cli"
+require 'rake'
+require 'rake/tasklib'
 
 module Inch
   # Holds all Rake tasks

data/lib/inch/utils/shell_helper.rb

@@ -3,7 +3,7 @@ module Inch
     module ShellHelper
       def git(dir, command)
         Dir.chdir(dir) do
-          sh("git #{command}")
+          out = sh("git #{command}")
         end
       end
 

data/lib/inch/utils/ui.rb

@@ -10,9 +10,9 @@ module Inch
       end
 
       def debug(msg)
-        return unless ENV["DEBUG"]
+        return unless ENV['DEBUG']
         msg.to_s.lines.each do |line|
-          trace edged :dark, line.gsub(/\n$/, "").dark
+          trace edged :dark, line.gsub(/\n$/,'').dark
         end
       end
 
@@ -45,12 +45,12 @@ module Inch
       def header(text, color, bg_color = nil)
         @current_header_color = color
         trace __header(text, color, bg_color)
-        trace unless use_color?
+        trace if !use_color?
       end
 
       # @return [Boolean] true if the UI uses coloring
       def use_color?
-        Term::ANSIColor.coloring?
+        Term::ANSIColor::coloring?
       end
 
       private
@@ -61,7 +61,7 @@ module Inch
 
       def __header(text, color, bg_color = nil)
         bg_color ||= "intense_#{color}"
-        bar = " #{text}".ljust(CLI::COLUMNS - 1)
+        bar = " #{text}".ljust(CLI::COLUMNS-1)
                 .on_color(bg_color).color(:color16)
         "#".color(color).on_color(color) + bar
       end

data/lib/inch/utils/weighted_list.rb

@@ -74,8 +74,9 @@ module Inch
           target_count = @max_counts[index]
           @list[index].concat sublist[0...target_count]
 
-          next unless sublist.size < target_count
-          missing += target_count - sublist.size
+          if sublist.size < target_count
+            missing += target_count - sublist.size
+          end
         end
         missing
       end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.10"
+  VERSION = "0.5.0.rc1"
 end

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

@@ -1,7 +1,4 @@
 module Foo
-  # Determines :class_variable
-  @@class_variable = {Ace: 11, Jack: 10, Queen: 10, King: 10}
-
   # The problem here is that the @param tag is not given the name of the
   # parameter it documents.
   #
@@ -18,6 +15,13 @@ module Foo
   def method_with_empty_param_tag_text(e)
   end
 
+  # The problem here is that ...
+  #
+  # @param *names [Array]
+  # @return [String]
+  def method_with_splat_parameter(*names)
+  end
+
   # The problem here is that ...
   #
   # @param names [Array]
@@ -30,41 +34,9 @@ module Foo
   # @return   HasH
   def method_with_wrong_return_tag
   end
-
-  # The problem here is that ...
-  #
-  # @param *names [Array]
-  # @return [String]
-  def method_with_splat_parameter(*names)
-  end
-
-  # Initializes a new Connection instance
-  #   @param [Hash<Symbol, >] params One or more optional params
-  #     @option params [String] :body Default text to be sent over a socket. Only used if :body absent in Connection#request params
-  #     @option params [Hash<Symbol, String>] :headers The default headers to supply in a request. Only used if params[:headers] is not supplied to Connection#request
-  def method_with_indented_param_tag(params = {})
-  end
 end
 
 module Overloading
-  # @overload many_overloads(&block)
-  # @overload many_overloads(scope, &block)
-  #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to `:example`)
-  # @overload many_overloads(scope, conditions, &block)
-  #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to `:example`)
-  #   @param conditions [Hash]
-  #     constrains this hook to examples matching these conditions e.g.
-  #     `many_overloads(:example, :ui => true) { ... }` will only run with examples or
-  #     groups declared with `:ui => true`.
-  # @overload many_overloads(conditions, &block)
-  #   @param conditions [Hash]
-  #     constrains this hook to examples matching these conditions e.g.
-  #     `many_overloads(:example, :ui => true) { ... }` will only run with examples or
-  #     groups declared with `:ui => true`.
-  def many_overloads(*args, &block)
-    hooks.register :append, :before, *args, &block
-  end
-
   # Creates a {Sass::Script::Value::Color Color} object from red, green, and
   # blue values.
   #