inch 0.4.6 → 0.4.7

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

@@ -0,0 +1,19 @@
+module Inch
+  module Evaluation
+    module Proxy
+      class ClassVariableObject < Base
+        protected
+
+        def relevant_roles
+          {
+            Role::ClassVariable::WithDoc => score_for(:docstring),
+            Role::ClassVariable::WithoutDoc => score_for(:docstring),
+            Role::ClassVariable::TaggedAsNodoc => nil,
+            Role::ClassVariable::Public => nil,
+            Role::ClassVariable::Private => nil
+          }
+        end
+      end
+    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,17 +29,24 @@ module Inch
             Role::Method::Constructor => nil,
             Role::Method::Getter => nil,
             Role::Method::Setter => nil,
-            Role::Method::Overridden => object.overridden? ? object.overridden_method.score : nil,
+            Role::Method::Overridden =>
+              if object.overridden?
+                object.overridden_method.score
+              else
+                nil
+              end,
             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
 
@@ -52,7 +59,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/class_variable.rb

@@ -0,0 +1,55 @@
+module Inch
+  module Evaluation
+    module Role
+      # Roles assigned to class variables
+      module ClassVariable
+        class WithDoc < Object::WithDoc
+          applicable_if :has_doc?
+        end
+        class WithoutDoc < Object::WithoutDoc
+          applicable_unless :has_doc?
+        end
+
+        class TaggedAsNodoc < Object::TaggedAsNodoc
+          applicable_if :nodoc?
+        end
+        class InRoot < Object::InRoot
+          applicable_if :in_root?
+        end
+
+        class Public < Object::Public
+          applicable_if :public?
+
+          def priority
+            -1
+          end
+        end
+        class Private < Object::Private
+          applicable_if :private?
+
+          def priority
+            -3
+          end
+        end
+
+        class WithCodeExample < Object::WithCodeExample
+          applicable_if do |o|
+            o.has_code_example? && !o.has_multiple_code_examples?
+          end
+        end
+
+        class WithMultipleCodeExamples < Object::WithMultipleCodeExamples
+          applicable_if :has_multiple_code_examples?
+        end
+
+        class WithoutCodeExample < Object::WithoutCodeExample
+          applicable_unless :has_code_example?
+
+          def suggestion
+            nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -46,7 +46,6 @@ 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,7 +67,8 @@ 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,7 +1,7 @@
 # encoding: utf-8
 
-require 'rake'
-require 'rake/tasklib'
+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
-          out = sh("git #{command}")
+          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 if !use_color?
+        trace unless 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,9 +74,8 @@ module Inch
           target_count = @max_counts[index]
           @list[index].concat sublist[0...target_count]
 
-          if sublist.size < target_count
-            missing += target_count - sublist.size
-          end
+          next unless sublist.size < target_count
+          missing += target_count - sublist.size
         end
         missing
       end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

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

@@ -1,4 +1,7 @@
 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.
   #
@@ -15,13 +18,6 @@ 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]
@@ -34,9 +30,41 @@ 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.
   #

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

@@ -0,0 +1,7 @@
+module Foo
+  # Redirect to the given URL
+  # @param url [String] the destination URL
+  # @param status [Fixnum] the http code
+  def method_with_named_parameter(url, status: 302)
+  end
+end

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

@@ -0,0 +1,8 @@
+# Representation of attributes of a user in the database
+#
+# @!attribute email
+#   @return [String] E-mail address (from Devise)
+class Attributes
+  # @return [String] Username (from Devise)
+  attr_accessor :username
+end

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

@@ -72,6 +72,23 @@ module Foo
     def method_with_other_rdoc_doc(param1, param2, param3)
     end
 
+    # Injects text right after the class definition. Since it depends on
+    # insert_into_file, it's reversible.
+    #
+    # ==== Parameters
+    # param1<String>:: path of the file to be changed
+    # param2<String|Class>:: the class to be manipulated
+    #
+    # ==== Examples
+    #
+    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController, "  filter_parameter :password\n"
+    #
+    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+    #     "  filter_parameter :password\n"
+    #   end
+    def method_with_yet_another_rdoc_doc(param1, param2)
+    end
+
     # An example of a method that takes a parameter (+param1+)
     # and does nothing. But the previous sentence mentions said
     # parameter.

data/test/integration/api/compare/codebases.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
 
 describe ::Inch::API::Compare::Codebases do
   let(:described_class) { ::Inch::API::Compare::Codebases }

data/test/integration/cli/command/console_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
 
 class Inch::CLI::Command::Output::Console
   def run_pry
@@ -22,8 +22,8 @@ describe ::Inch::CLI::Command::Console do
   end
 
   it "should run without args" do
-    out, err = capture_io do
-      @prompt = @command.new.run()
+    _out, _err = capture_io do
+      @prompt = @command.new.run
     end
     assert @prompt.respond_to?(:all)
     assert @prompt.respond_to?(:ff)
@@ -34,7 +34,7 @@ describe ::Inch::CLI::Command::Console do
   end
 
   it "should run with a definitive object name" do
-    out, err = capture_io do
+    _out, _err = capture_io do
       @prompt = @command.new.run("Foo::Bar#method_with_full_doc")
     end
     assert !@prompt.all.empty?
@@ -46,7 +46,7 @@ describe ::Inch::CLI::Command::Console do
   end
 
   it "should run with a partial name" do
-    out, err = capture_io do
+    _out, _err = capture_io do
       @prompt = @command.new.run("Foo::Bar#")
     end
     assert @prompt.respond_to?(:all)

data/test/integration/cli/command/inspect_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
 
 describe ::Inch::CLI::Command::Inspect do
   before do
@@ -8,7 +8,7 @@ describe ::Inch::CLI::Command::Inspect do
 
   it "should warn and exit when run without args" do
     out, err = capture_io do
-      assert_raises(SystemExit) { @command.run() }
+      assert_raises(SystemExit) { @command.run }
     end
     assert out.empty?, "there should be no output"
     refute err.empty?, "there should be some error message"
@@ -33,7 +33,6 @@ describe ::Inch::CLI::Command::Inspect do
     assert err.empty?, "there should be no errors"
   end
 
-
   it "should output some info when run with a definitive object name" do
     out, err = capture_io do
       @command.run("Foo::Qux")
@@ -53,14 +52,14 @@ describe ::Inch::CLI::Command::Inspect do
   end
 
   it "should output colored information" do
-    out, err = capture_io do
+    out, _err = capture_io do
       @command.run("Foo::Bar#")
     end
     refute_equal out.uncolor, out, "should be colored"
   end
 
   it "should output uncolored information when asked" do
-    out, err = capture_io do
+    out, _err = capture_io do
       @command.run("Foo::Bar#", "--no-color")
     end
     assert_equal out.uncolor, out, "should not be colored"