inch 0.4.6 → 0.4.7

data/lib/inch/code_object/provider/yard/object/method_parameter_object.rb

@@ -67,7 +67,7 @@ module Inch
               if @method.docstring.describes_parameter?(name)
                 true
               else
-                unsplatted = name.gsub(/^[\&\*]/, '')
+                unsplatted = name.gsub(/^[\&\*]/, "")
                 @method.docstring.describes_parameter?(unsplatted)
               end
             end
@@ -76,7 +76,7 @@ module Inch
               if @method.docstring.mentions_parameter?(name)
                 true
               else
-                unsplatted = name.gsub(/^[\&\*]/, '')
+                unsplatted = name.gsub(/^[\&\*]/, "")
                 @method.docstring.mentions_parameter?(unsplatted)
               end
             end

data/lib/inch/code_object/provider/yard/object/method_signature.rb

@@ -8,11 +8,12 @@ module Inch
             attr_reader :method, :docstring
 
             # @param method [Provider::YARD::Object::MethodObject]
-            # @param method [::YARD::Tags::Tag,nil] if nil, the method's normal signature is used
+            # @param yard_tag [::YARD::Tags::Tag,nil] if nil, the method's normal signature is used
             def initialize(method, yard_tag = nil)
               @method = method
               @yard_tag = yard_tag
-              @docstring = Provider::YARD::Docstring.new(relevant_object.docstring)
+              @docstring =
+                Provider::YARD::Docstring.new(relevant_object.docstring)
             end
 
             def all_signature_parameter_names
@@ -43,26 +44,28 @@ module Inch
             # @param name [String,Symbol]
             # @return [MethodParameterObject]
             def parameter(name)
-              parameters.detect { |p| p.name == name.to_s }
+              parameters.find { |p| p.name == name.to_s }
             end
 
             # Returns +true+ if the other signature is identical to self
             # @param other [MethodSignature]
             # @return [Boolean]
             def same?(other)
-              all_signature_parameter_names == other.all_signature_parameter_names
+              all_signature_parameter_names ==
+                other.all_signature_parameter_names
             end
 
             # Returns the actual signature of the method.
             # @return [String]
             def signature
-              relevant_object.signature.gsub(/^(def\ )/, '')
+              relevant_object.signature.gsub(/^(def\ )/, "")
             end
 
             private
 
             def all_parameter_names
-              all_names = all_signature_parameter_names + parameter_tags.map(&:name)
+              all_names = all_signature_parameter_names +
+                parameter_tags.map(&:name)
               all_names.map do |name|
                 normalize_parameter_name(name) if name
               end.compact.uniq
@@ -90,11 +93,11 @@ module Inch
             # @param name [String] parameter name
             # @return [String]
             def normalize_parameter_name(name)
-              name.gsub(/[\&\*\$\[\]]/, '')
+              name.gsub(/[\&\*\$\[\]]/, "")
             end
 
             def parameter_tag(param_name)
-              parameter_tags.detect do |tag|
+              parameter_tags.find do |tag|
                 tag.name == param_name
               end
             end

data/lib/inch/code_object/provider/yard/object/namespace_object.rb

@@ -28,9 +28,7 @@ module Inch
 
             # called by MethodObject#getter?
             def child(name)
-              if children
-                children.detect { |child| child.name == name }
-              end
+              children.find { |child| child.name == name } if children
             end
 
             def children
@@ -38,7 +36,6 @@ module Inch
                 YARD::Object.for(o)
               end
             end
-
           end
         end
       end

data/lib/inch/code_object/provider/yard/parser.rb

@@ -11,7 +11,7 @@ module Inch
           # @see #parse
           # @return [CodeObject::Provider::YARD::Parser] the instance that ran
           def self.parse(*args)
-            parser = self.new
+            parser = new
             parser.parse(*args)
             parser
           end
@@ -46,7 +46,7 @@ module Inch
               object.base_dir = dir
 
               object.aliases_fullnames.each do |fullname|
-                _alias = objects.detect { |o| o.fullname == fullname }
+                _alias = objects.find { |o| o.fullname == fullname }
                 _alias.aliased_object_fullname = object.fullname
               end
             end

data/lib/inch/code_object/proxy.rb

@@ -11,7 +11,7 @@ module Inch
         # @return [CodeObject::Proxy::Base]
         def for(code_object)
           attributes = Converter.to_hash(code_object)
-          proxy_object = class_for(code_object).new(attributes)
+          class_for(code_object).new(attributes)
         end
 
         private
@@ -21,7 +21,7 @@ module Inch
         # @param code_object [YARD::CodeObject]
         # @return [Class]
         def 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
@@ -29,10 +29,11 @@ module Inch
   end
 end
 
-require 'inch/code_object/proxy/base'
-require 'inch/code_object/proxy/namespace_object'
-require 'inch/code_object/proxy/class_object'
-require 'inch/code_object/proxy/constant_object'
-require 'inch/code_object/proxy/method_object'
-require 'inch/code_object/proxy/method_parameter_object'
-require 'inch/code_object/proxy/module_object'
+require "inch/code_object/proxy/base"
+require "inch/code_object/proxy/namespace_object"
+require "inch/code_object/proxy/class_object"
+require "inch/code_object/proxy/class_variable_object"
+require "inch/code_object/proxy/constant_object"
+require "inch/code_object/proxy/method_object"
+require "inch/code_object/proxy/method_parameter_object"
+require "inch/code_object/proxy/module_object"

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

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Inch
   module CodeObject
@@ -42,9 +42,9 @@ module Inch
 
         # @return [Symbol]
         def grade
-          @grade ||= Evaluation.new_grade_lists.detect { |range|
-                range.scores.include?(score)
-              }.grade
+          @grade ||= Evaluation.new_grade_lists.find do |range|
+            range.scores.include?(score)
+          end.grade
         end
 
         # @return [Boolean] if the current object is an alias for something else
@@ -54,7 +54,7 @@ module Inch
 
         # @return [CodeObject::Proxy::Base] the object the current object is an alias of
         def aliased_object
-          object_lookup.find( self[:aliased_object_fullname] )
+          object_lookup.find(self[:aliased_object_fullname])
         end
 
         # @return [Boolean] +true+ if the object has an @api tag
@@ -172,7 +172,7 @@ module Inch
 
         # @return [CodeObject::Proxy::Base,nil] the parent of the current object or +nil+
         def parent
-          object_lookup.find( self[:parent_fullname] )
+          object_lookup.find(self[:parent_fullname])
         end
 
         def private?
@@ -205,7 +205,7 @@ module Inch
         end
 
         def type
-          self.class.to_s.gsub(/Object$/, '')
+          self.class.to_s.gsub(/Object$/, "")
         end
 
         # @return [Boolean] +true+ if the object has no documentation at all
@@ -233,7 +233,7 @@ module Inch
         end
 
         def inspect
-          "#<#{self.class.to_s}: #{fullname}>"
+          "#<#{self.class}: #{fullname}>"
         end
       end
     end

data/lib/inch/code_object/proxy/class_variable_object.rb

@@ -0,0 +1,8 @@
+module Inch
+  module CodeObject
+    module Proxy
+      class ClassVariableObject < Base
+      end
+    end
+  end
+end

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

@@ -36,7 +36,7 @@ module Inch
         end
 
         def parameter(name)
-          parameters.detect { |p| p.name == name.to_s }
+          parameters.find { |p| p.name == name.to_s }
         end
 
         def parameters
@@ -50,7 +50,8 @@ module Inch
         end
 
         def overridden_method
-          @overridden_method ||= object_lookup.find(self[:overridden_method_fullname])
+          @overridden_method ||=
+            object_lookup.find(self[:overridden_method_fullname])
         end
 
         def return_mentioned?

data/lib/inch/code_object/proxy/method_parameter_object.rb

@@ -38,7 +38,7 @@ module Inch
         def name
           self[:name]
         end
-        alias fullname name
+        alias_method :fullname, :name
 
         # @return [Boolean] +true+ if the parameter is a splat argument
         def splat?

data/lib/inch/codebase.rb

@@ -15,8 +15,7 @@ module Inch
   end
 end
 
-require 'inch/codebase/proxy'
-require 'inch/codebase/objects'
-require 'inch/codebase/objects_filter'
-require 'inch/codebase/serializer'
-
+require "inch/codebase/proxy"
+require "inch/codebase/objects"
+require "inch/codebase/objects_filter"
+require "inch/codebase/serializer"

data/lib/inch/codebase/objects_filter.rb

@@ -41,16 +41,14 @@ module Inch
       end
 
       def filter_depth
-        if options.depth
-          @list = @list.select { |o| o.depth <= options.depth }
-        end
+        @list = @list.select { |o| o.depth <= options.depth } if options.depth
       end
 
       def filter_visibility
         @list = @list.select do |o|
           options.visibility.include?(o.visibility)
         end
-        if !options.visibility.include?(:private)
+        unless options.visibility.include?(:private)
           @list = @list.reject do |o|
             o.tagged_as_private?
           end

data/lib/inch/codebase/serializer.rb

@@ -9,12 +9,12 @@ module Inch
 
       def self.save(codebase, filename)
         content = Marshal.dump(codebase)
-        FileUtils.mkdir_p( File.dirname(filename) )
-        File.open(filename, 'wb') { |file| file.write(content) }
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename, "wb") { |file| file.write(content) }
       end
 
       def self.load(filename)
-        codebase = Marshal.load( File.binread(filename) )
+        codebase = Marshal.load(File.binread(filename))
         codebase.objects.each do |object|
           object.object_lookup = codebase.objects
         end

data/lib/inch/config.rb

@@ -20,5 +20,5 @@ module Inch
   end
 end
 
-require 'inch/config/base'
-require 'inch/config/codebase'
+require "inch/config/base"
+require "inch/config/codebase"

data/lib/inch/config/base.rb

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

data/lib/inch/config/codebase.rb

@@ -57,9 +57,9 @@ module Inch
 
       def update_files(files)
         return if files.nil?
-        include_files expand_files(files["included"]) if files["included"]
-        exclude_files expand_files(files["excluded"]) if files["excluded"]
+        @included_files = expand_files(files["included"]) if files["included"]
+        @excluded_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,26 +9,27 @@ 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/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/proxy'
+require "inch/evaluation/proxy"

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,16 +10,17 @@ 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/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/class_variable_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

@@ -95,13 +95,19 @@ 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 => object.alias? ? object.aliased_object.score : nil,
+            Role::Object::Alias =>
+              if object.alias?
+                object.aliased_object.score
+              else
+                nil
+              end
           }
         end
 
@@ -124,9 +130,8 @@ module Inch
 
         def __evaluate(object, role_classes)
           role_classes.each do |role_class, score|
-            if role_class.applicable?(object)
-              add_role role_class.new(object, score)
-            end
+            next unless role_class.applicable?(object)
+            add_role role_class.new(object, score)
           end
         end
 
@@ -144,7 +149,7 @@ module Inch
 
         # @return [Float]
         def __score
-          value = @roles.inject(0) { |sum,r| sum + r.score.to_f }.to_i
+          value = @roles.reduce(0) { |sum, r| sum + r.score.to_f }.to_i
           if value < min_score
             min_score
           elsif value > max_score
@@ -156,7 +161,7 @@ module Inch
 
         # @return [Fixnum]
         def __priority
-          @roles.inject(0) { |sum,r| sum + r.priority.to_i }
+          @roles.reduce(0) { |sum, r| sum + r.priority.to_i }
         end
       end
     end