inch 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23c7cb734a65a10fc7e06dc15dae0ca5b845aa8e
-  data.tar.gz: 599a33be129999facc125af4435facc9bf7f4ab6
+  metadata.gz: 4c31501ddee3364461246eb390c64f95d04f7af3
+  data.tar.gz: 8f43411cc6757e519799d3d47c394ccd92641d3b
 SHA512:
-  metadata.gz: 5b3402fe65142f5c2700ea5bcdec56ded001b44c5341ef72d6caf6a2f287ed6deca1bd2415d8dca953f777bc061181f3bb6f7afafdcf1bfe93c45a3109f57bc4
-  data.tar.gz: 0fe53ec630e0a1dec9763b59b1aebb0cf6c9941c79b6f1824a75eb5364b3bc2e2b5ce3cacecf2c749a0d7edf17f953570ef185413f55a26f7fa2b85004a2c093
+  metadata.gz: 208f12e02a0725d03b5b7e255534272deb0497d59aece0480a40c3173bfda2b9ae3e6b3d2861df7636f9b6933019c4de0462539c7c4816a2957a5aba3324d609
+  data.tar.gz: 23376ecad96b2146c8ad18690b3bb44826f4315c80685858b8b8c4c7c219fd55794d237c56acae6fd49f7e9a4436b1302029825984e73ff153414ab40ce1c9f5

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-08-06 21:26:49 +0900 using RuboCop version 0.24.1.
+# on 2014-08-09 22:59:20 +0200 using RuboCop version 0.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,25 +13,16 @@ Lint/AmbiguousOperator:
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
 
-# Offense count: 9
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Enabled: false
-
 # Offense count: 1
 Lint/Debugger:
   Enabled: false
 
 # Offense count: 3
-Lint/UnderscorePrefixedVariableName:
-  Enabled: false
-
-# Offense count: 6
 # Cop supports --auto-correct.
 Lint/UnusedMethodArgument:
   Enabled: false
 
-# Offense count: 6
+# Offense count: 5
 Style/AccessorMethodName:
   Enabled: false
 
@@ -47,13 +38,13 @@ Style/ClassAndModuleChildren:
 # Offense count: 5
 # Configuration parameters: CountComments.
 Style/ClassLength:
-  Max: 201
+  Max: 195
 
 # Offense count: 2
 Style/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 87
+# Offense count: 85
 Style/Documentation:
   Enabled: false
 
@@ -71,21 +62,16 @@ Style/GuardClause:
 Style/IfUnlessModifier:
   Enabled: false
 
-# Offense count: 31
+# Offense count: 10
 # Configuration parameters: AllowURI.
 Style/LineLength:
-  Max: 123
+  Max: 111
 
-# Offense count: 22
+# Offense count: 23
 # Configuration parameters: CountComments.
 Style/MethodLength:
   Max: 34
 
-# Offense count: 2
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MethodName:
-  Enabled: false
-
 # Offense count: 22
 # Configuration parameters: NamePrefixBlacklist.
 Style/PredicateName:
@@ -101,12 +87,7 @@ Style/SingleLineBlockParams:
 Style/SingleSpaceBeforeFirstArg:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
-  Enabled: false
-
-# Offense count: 9
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
 Style/TrivialAccessors:

data/CHANGELOG.md

@@ -1,11 +1,15 @@
 # Changelog
 
 
-## 0.5.0 (pre)
+## 0.4.7
 
 - CLI classes must be required seperately from now on
 - external data read by NoDocHelper is encoded as UTF-8
-
+- YARD's attribute directive is now interpreted correctly
+- Docs are now evaluated for class variables as well
+- TomDoc support has been improved
+- Method parameter name recognition has been improved for RDoc style comments
+- Compliance with the Ruby Style Guide has been improved (thanks @yous)
 
 ## 0.4.6
 

data/lib/inch/api/diff.rb

@@ -30,7 +30,7 @@ module Inch
       private
 
       def codebase_for(revision)
-        if cached = codebase_from_cache(revision)
+        if (cached = codebase_from_cache(revision))
           cached
         else
           codebase = codebase_from_copy(work_dir, revision)

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

@@ -18,7 +18,7 @@ module Inch
       # @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)
+          if (object = codebase.objects.find(object_name))
             object
           else
             codebase.objects.starting_with(object_name)

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

@@ -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/suggest.rb

@@ -5,7 +5,7 @@ module Inch
     class Suggest < Filter
       def initialize(codebase, options)
         super
-        @options = Options::Suggest(options)
+        @options = Options::Suggest.new(options)
       end
 
       def files

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/base.rb

@@ -87,8 +87,8 @@ module Inch
         #
         # @abstract
         # @note Override with implementation
-        # @param *args [Array<String>]
-        def run(*args)
+        # @param *_args [Array<String>]
+        def run(*_args)
           fail NotImplementedError
         end
 

data/lib/inch/cli/command/options/diff.rb

@@ -65,7 +65,7 @@ module Inch
             end
             opts.on("-p", "--since-last-push",
                     "Run diff against last pushed commit") do
-              @before_rev = get_pushed_rev
+              @before_rev = pushed_rev
               @since_last_push = true
             end
           end
@@ -73,8 +73,8 @@ module Inch
           # @return [String] the reference for the pushed revision
           #
           # @example
-          #   get_pushed_rev # => "origin/master"
-          def get_pushed_rev
+          #   pushed_rev # => "origin/master"
+          def pushed_rev
             "#{remote}/#{current_branch}"
           end
 

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

@@ -24,9 +24,9 @@ module Inch
             end
           end
 
-          def print_file_info(o, _color)
+          def print_file_info(o, color)
             o.files.each do |f|
-              echo "-> #{f.filename}:#{f.line_no}".color(_color)
+              echo "-> #{f.filename}:#{f.line_no}".color(color)
             end
             echo separator
           end

data/lib/inch/cli/command/output/suggest.rb

@@ -18,7 +18,8 @@ module Inch
           }
 
           # @param options [Command::Options::Suggest]
-          # @param relevant_objects [Array<CodeObject::Proxy::Base>] the objects meeting the criteria defined in +options+
+          # @param relevant_objects [Array<CodeObject::Proxy::Base>] the objects
+          #   meeting the criteria defined in +options+
           # @param objects_to_display [Array<CodeObject::Proxy::Base>]
           # @param grade_lists [Array<Evaluation::GradeList>]
           # @param files [Array<Evaluation::File>]

data/lib/inch/cli/sparkline_helper.rb

@@ -1,10 +1,10 @@
 module Inch
   module CLI
     module SparklineHelper
-      def grade_lists_sparkline(_grade_lists)
-        grade_lists = _grade_lists.reverse
-        list = grade_lists.map { |r| r.objects.size }
-        __sparkline(list, grade_lists)
+      def grade_lists_sparkline(grade_lists)
+        new_grade_lists = grade_lists.reverse
+        list = new_grade_lists.map { |r| r.objects.size }
+        __sparkline(list, new_grade_lists)
       end
 
       def grades_sparkline(objects)

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

@@ -65,8 +65,8 @@ module Inch
           end
 
           # Returns the last lines of the docstring.
-          # @return [Array<String>] the last line and, if the last line(s) is indented,
-          #   the last unindented line
+          # @return [Array<String>] the last line and, if the last line(s) is
+          #   indented, the last unindented line
           def last_lines
             @last_lines ||= begin
               list = []
@@ -99,14 +99,14 @@ module Inch
           # Returns patterns in which method parameters are mentioned
           # in inline docs.
           #
-          # @param _name [String] the name of the method parameter
+          # @param name [String] the name of the method parameter
           # @return [Array<Regexp>]
-          def mention_parameter_patterns(_name)
-            name = Regexp.escape(_name)
+          def mention_parameter_patterns(name)
+            escaped_name = Regexp.escape(name)
             type = /<[^>]+>/
-            arr = [
-              name,
-              /#{name}#{type}/ # matches "param1<String,nil>"
+            [
+              escaped_name,
+              /#{escaped_name}#{type}/ # matches "param1<String,nil>"
             ].map do |expr|
               [
                 /#{expr}\:\:/,            # param1::

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

@@ -81,7 +81,7 @@ module Inch
           def get_line_no(filename, line_number)
             f = File.open(filename)
             line_number.times { f.gets }
-            result = $_
+            result = $LAST_READ_LINE
             f.close
             result.encode("UTF-8", "binary",
                           invalid: :replace, undef: :replace, replace: "")

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

@@ -16,7 +16,7 @@ module Inch
             # @return [Provider::YARD::Object]
             def for(yard_object)
               @cache ||= {}
-              if proxy_object = @cache[cache_key(yard_object)]
+              if (proxy_object = @cache[cache_key(yard_object)])
                 proxy_object
               else
                 @cache[cache_key(yard_object)] =

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

@@ -25,12 +25,13 @@ module Inch
                            :type, :namespace, :source, :source_type, :group,
                            :dynamic, :visibility
 
-            # @param object [YARD::CodeObjects::Base] the actual (YARD) code object
+            # @param object [YARD::CodeObjects::Base] the actual (YARD) code
+            #   object
             def initialize(object)
               @object = object
-              @__api_tag = __api_tag
-              @__parent = __parent
-              @__private_tag = __private_tag
+              @api_tag = __api_tag
+              @parent = __parent
+              @private_tag = __private_tag
             end
 
             # Returns the fullname of the object that the current object
@@ -47,18 +48,18 @@ module Inch
               !api_tag.nil?
             end
 
-            def api_tag
-              @__api_tag
-            end
+            attr_reader :api_tag
 
             # To be overridden
             # @see Proxy::NamespaceObject
-            # @return [CodeObject::Proxy::Base,nil] the child inside the current object or +nil+
-            def child(name)
+            # @return [CodeObject::Proxy::Base,nil] the child inside the current
+            #   object or +nil+
+            def child(_name)
               nil
             end
 
-            # @return [Array,nil] the full names of the children of the current object
+            # @return [Array,nil] the full names of the children of the current
+            #   object
             def children_fullnames
               []
             end
@@ -156,9 +157,9 @@ module Inch
               if tags(:example).size > 1 || docstring.code_examples.size > 1
                 true
               else
-                if tag = tag(:example)
+                if (tag = tag(:example))
                   multi_code_examples?(tag.text)
-                elsif text = docstring.code_examples.first
+                elsif (text = docstring.code_examples.first)
                   multi_code_examples?(text)
                 else
                   false
@@ -210,9 +211,7 @@ module Inch
             end
 
             # @return [Array,nil] the parent of the current object or +nil+
-            def parent
-              @__parent
-            end
+            attr_reader :parent
 
             def __parent
               YARD::Object.for(object.parent) if object.parent
@@ -267,9 +266,7 @@ module Inch
               !private_tag.nil?
             end
 
-            def private_tag
-              @__private_tag
-            end
+            attr_reader :private_tag
 
             def private_api_tag?
               api_tag && api_tag.text == "private"

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

@@ -7,9 +7,11 @@ module Inch
           class MethodParameterObject
             attr_reader :name # @return [String]
 
-            # @param method [YARD::Object::MethodObject] the method the parameter belongs to
+            # @param method [YARD::Object::MethodObject] the method the
+            #   parameter belongs to
             # @param name [String] the name of the parameter
-            # @param in_signature [String] how the parameter is noted in the method's signature
+            # @param in_signature [String] how the parameter is noted in the
+            #   method's signature
             # @param tag [YARD::Tags::Tag] the Tag object for the parameter
             def initialize(method, name, in_signature, tag)
               @method = method
@@ -21,7 +23,8 @@ module Inch
             BAD_NAME_EXCEPTIONS = %w(id)
             BAD_NAME_THRESHOLD = 3
 
-            # @return [Boolean] +true+ if the name of the parameter is uncommunicative
+            # @return [Boolean] +true+ if the name of the parameter is
+            #   uncommunicative
             def bad_name?
               return false if BAD_NAME_EXCEPTIONS.include?(name)
               name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
@@ -52,7 +55,8 @@ module Inch
               @tag && @tag.types && !@tag.types.empty?
             end
 
-            # @return [Boolean] +true+ if the parameter is mentioned in the docs, but not present in the method's signature
+            # @return [Boolean] +true+ if the parameter is mentioned in the
+            #   docs, but not present in the method's signature
             def wrongly_mentioned?
               mentioned? && !@in_signature
             end

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

@@ -8,7 +8,8 @@ module Inch
             attr_reader :method, :docstring
 
             # @param method [Provider::YARD::Object::MethodObject]
-            # @param yard_tag [::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

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

@@ -46,8 +46,8 @@ module Inch
               object.base_dir = dir
 
               object.aliases_fullnames.each do |fullname|
-                _alias = objects.find { |o| o.fullname == fullname }
-                _alias.aliased_object_fullname = object.fullname
+                alias_object = objects.find { |o| o.fullname == fullname }
+                alias_object.aliased_object_fullname = object.fullname
               end
             end
           end

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

@@ -52,7 +52,8 @@ module Inch
           !aliased_object.nil?
         end
 
-        # @return [CodeObject::Proxy::Base] the object the current object is an alias of
+        # @return [CodeObject::Proxy::Base] the object the current object is an
+        #   alias of
         def aliased_object
           object_lookup.find(self[:aliased_object_fullname])
         end
@@ -170,7 +171,8 @@ module Inch
           self[:nodoc?]
         end
 
-        # @return [CodeObject::Proxy::Base,nil] the parent of the current object or +nil+
+        # @return [CodeObject::Proxy::Base,nil] the parent of the current object
+        #   or +nil+
         def parent
           object_lookup.find(self[:parent_fullname])
         end

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

@@ -14,7 +14,8 @@ module Inch
         BAD_NAME_EXCEPTIONS = %w(id)
         BAD_NAME_THRESHOLD = 3
 
-        # @return [Boolean] +true+ if the name of the parameter is uncommunicative
+        # @return [Boolean] +true+ if the name of the parameter is
+        #   uncommunicative
         def bad_name?
           return false if BAD_NAME_EXCEPTIONS.include?(name)
           name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
@@ -50,7 +51,8 @@ module Inch
           self[:typed?]
         end
 
-        # @return [Boolean] +true+ if the parameter is mentioned in the docs, but not present in the method's signature
+        # @return [Boolean] +true+ if the parameter is mentioned in the docs,
+        #   but not present in the method's signature
         def wrongly_mentioned?
           self[:wrongly_mentioned?]
         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

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/proxy/base.rb

@@ -67,9 +67,7 @@ module Inch
         end
 
         # @return [Array<Evaluation::Role::Base>]
-        def roles
-          @roles
-        end
+        attr_reader :roles
 
         protected
 

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

@@ -32,7 +32,8 @@ 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

data/lib/inch/rake/suggest.rb

@@ -2,6 +2,7 @@
 
 require "rake"
 require "rake/tasklib"
+require "inch/cli"
 
 module Inch
   # Holds all Rake tasks

data/lib/inch/version.rb

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

data/test/unit/code_object/provider/yard/docstring_test.rb

@@ -139,7 +139,8 @@ returns nothing
     assert docstring.describes_return?
   end
 
-  it "should understand 'Returns ...' with a visibility modifier in front of it" do
+  it "should understand 'Returns ...' with a visibility modifier in front of" \
+     " it" do
     text = "Public: Returns the Integer color."
     docstring = described_class.new(text)
     assert docstring.mentions_return?

data/test/unit/code_object/provider/yard/nodoc_helper_test.rb

@@ -30,7 +30,8 @@ describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
       "Foo::Qux::Quux::PUBLIC_VALUE",
       "Foo::Qux::DOCCED_VALUE",
       "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass",
-      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass#method_with_implicit_doc"
+      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass" \
+        "#method_with_implicit_doc"
     ].each do |query|
       m = @objects.find { |o| o.fullname == query }
       refute m.nodoc?, "nodoc? should return false for #{query}"

data/test/unit/code_object/proxy/method_object_test.rb

@@ -163,7 +163,8 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
       assert m.score
     end
 
-    it "should handle methods (without parameters) that have only a docstring (text comment)" do
+    it "should handle methods (without parameters) that have only a docstring" \
+       " (text comment)" do
       m = @objects.find("Foo::Bar#method_without_params_or_return_type")
       assert m.has_doc?
       refute m.has_parameters?
@@ -215,7 +216,8 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
       assert_equal 0, m.score
     end
 
-    it "should recognize a getter in a getter/setter pair defined via attr_accessor" do
+    it "should recognize a getter in a getter/setter pair defined via" \
+       " attr_accessor" do
       m = @objects.find("InchTest#attr_getset")
       assert m.getter?, "should be a getter"
       refute m.setter?
@@ -223,7 +225,8 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
       assert_equal 0, m.score
     end
 
-    it "should recognize a setter in a getter/setter pair defined via attr_accessor" do
+    it "should recognize a setter in a getter/setter pair defined via" \
+       " attr_accessor" do
       m = @objects.find("InchTest#attr_getset=")
       refute m.getter?
       assert m.setter?, "should be a setter"
@@ -247,13 +250,15 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
       assert_equal 0, m.score
     end
 
-    it "should recognize docs on a getter in a getter/setter pair defined via attr_accessor" do
+    it "should recognize docs on a getter in a getter/setter pair defined via" \
+       " attr_accessor" do
       m = @objects.find("Attributes#username")
       refute_equal 0, m.score
       refute m.undocumented?
     end
 
-    it "should recognize docs on a setter in a getter/setter pair defined via attr_accessor" do
+    it "should recognize docs on a setter in a getter/setter pair defined via" \
+       " attr_accessor" do
       m = @objects.find("Attributes#username=")
       refute_equal 0, m.score
       refute m.undocumented?
@@ -324,7 +329,8 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
         m, Inch::Evaluation::Role::MethodParameter::WithoutMention, "block")
     end
 
-    it "should work if @param tags are only present in the @overload tags, but not on the actual method" do
+    it "should work if @param tags are only present in the @overload tags," \
+       " but not on the actual method" do
       m = @objects.find("Overloading#params_only_in_overloads")
       unexpected_roles = [
         Inch::Evaluation::Role::Object::WithoutCodeExample,
@@ -430,7 +436,8 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
       assert m.score >= 50 # TODO: don't use magic numbers
     end
 
-    it "should recognize question mark methods with description and parameters" do
+    it "should recognize question mark methods with description and" \
+       " parameters" do
       m = @objects.find("InchTest#method_with_description_and_parameters?")
       refute m.has_doc?
       assert m.has_parameters?

data/test/unit/evaluation/role/base_test.rb

@@ -13,7 +13,7 @@ class MockPublicRole < ::Inch::Evaluation::Role::Base
 end
 
 class MockIndifferentRole < ::Inch::Evaluation::Role::Base
-  def self.applicable?(object)
+  def self.applicable?(_object)
     true
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler