inch 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef6e8adf9c15caf207085b29dfd1645055779b1d
-  data.tar.gz: 742b78011452c52a063b5bdfb753704b8cff4a13
+  metadata.gz: 23c7cb734a65a10fc7e06dc15dae0ca5b845aa8e
+  data.tar.gz: 599a33be129999facc125af4435facc9bf7f4ab6
 SHA512:
-  metadata.gz: 06175a21a0890883b2385cb667d2b6e3520508c42bd0e7567e3463be0bca921497d595f87c5ab7cfd64f5eee41edc18c38c4dc98047048715624f32a7711fee1
-  data.tar.gz: f8b9a873aa09601d5346aded469c0e11612ad1553e3c646a5d4bc8fe0b19484160517df21f7dbe8e18be44c124df405a385bc5f7e43d89fa0841ae37df6f6846
+  metadata.gz: 5b3402fe65142f5c2700ea5bcdec56ded001b44c5341ef72d6caf6a2f287ed6deca1bd2415d8dca953f777bc061181f3bb6f7afafdcf1bfe93c45a3109f57bc4
+  data.tar.gz: 0fe53ec630e0a1dec9763b59b1aebb0cf6c9941c79b6f1824a75eb5364b3bc2e2b5ce3cacecf2c749a0d7edf17f953570ef185413f55a26f7fa2b85004a2c093

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - '**/*.gemspec'
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+    - 'test/fixtures/**/*'
+
+Style/Encoding:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,113 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-08-06 21:26:49 +0900 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/AmbiguousOperator:
+  Enabled: false
+
+# Offense count: 87
+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
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 3
+Style/AsciiComments:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Style/ClassLength:
+  Max: 201
+
+# Offense count: 2
+Style/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 87
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 11
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 31
+# Configuration parameters: AllowURI.
+Style/LineLength:
+  Max: 123
+
+# Offense count: 22
+# 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:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: Methods.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Offense count: 45
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 
+## 0.5.0 (pre)
+
+- CLI classes must be required seperately from now on
+- external data read by NoDocHelper is encoded as UTF-8
+
+
 ## 0.4.6
 
 - Do not count @yield tag if it is auto-assigned via YARD

data/Gemfile

@@ -1,6 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in inch.gemspec
 gemspec
 
-gem 'simplecov', :require => false, :group => :test
+group :test do
+  gem "simplecov", require: false
+  gem "rubocop", require: false
+end

data/README.md

@@ -1,4 +1,4 @@
-# Inch [![Build Status](https://travis-ci.org/rrrene/inch.png)](https://travis-ci.org/rrrene/inch) [![Code Climate](https://codeclimate.com/github/rrrene/inch.png)](https://codeclimate.com/github/rrrene/inch) [![Inline docs](http://inch-pages.github.io/github/rrrene/inch.png)](http://inch-pages.github.io/github/rrrene/inch)
+# Inch [![Build Status](https://travis-ci.org/rrrene/inch.png)](https://travis-ci.org/rrrene/inch) [![Code Climate](https://codeclimate.com/github/rrrene/inch.png)](https://codeclimate.com/github/rrrene/inch) [![Inline docs](http://inch-ci.org/github/rrrene/inch.png)](http://inch-ci.org/github/rrrene/inch)
 
 `inch` gives you hints where to improve your docs. One Inch at a time.
 
@@ -18,7 +18,7 @@ If there are no inline-docs yet, `inch` can tell you where to start.
 
 Add this line to your application's Gemfile:
 
-    gem 'inch'
+    gem 'inch', require: false
 
 And then execute:
 

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
   t.pattern = "test/**/*_test.rb"
@@ -14,4 +14,4 @@ Rake::TestTask.new(:"test:integration") do |t|
   t.pattern = "test/integration/**/*_test.rb"
 end
 
-task :default => :test
+task default: :test

data/bin/inch

@@ -12,11 +12,12 @@ def find_lib_path
   while File.symlink?(path)
     path = File.expand_path(File.readlink(path), File.dirname(path))
   end
-  File.join(File.dirname(File.expand_path(path)), '..', 'lib')
+  File.join(File.dirname(File.expand_path(path)), "..", "lib")
 end
 
 $LOAD_PATH.unshift(find_lib_path)
 
-require 'inch'
+require "inch"
+require "inch/cli"
 
 Inch::CLI::CommandParser.run(*ARGV)

data/config/defaults.rb

@@ -64,6 +64,13 @@ Inch::Config.run do
       unconsidered_tag    0.2
     end
 
+    schema(:ClassVariableObject) do
+      docstring           1.0
+
+      # optional:
+      unconsidered_tag    0.2
+    end
+
     schema(:ClassObject) do
       docstring           1.0
 

data/inch.gemspec

@@ -1,21 +1,21 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'inch/version'
+require "inch/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "inch"
   spec.version       = Inch::VERSION
   spec.authors       = ["René Föhring"]
   spec.email         = ["rf@bamaru.de"]
-  spec.summary       = %q{Documentation measurement tool for Ruby}
-  spec.description   = %q{Documentation measurement tool for Ruby, based on YARD.}
+  spec.summary       = "Documentation measurement tool for Ruby"
+  spec.description   = "Documentation measurement tool for Ruby, based on YARD."
   spec.homepage      = "http://trivelop.de/inch/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.2"
 
   spec.add_dependency "pry"
-  spec.add_dependency 'sparkr', ">= 0.2.0"
+  spec.add_dependency "sparkr", ">= 0.2.0"
   spec.add_dependency "term-ansicolor"
   spec.add_dependency "yard", "~> 0.8.7"
 end

data/lib/inch.rb

@@ -1,16 +1,15 @@
-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/cli'
+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/config"
+require File.join(File.dirname(__FILE__), "..", "config", "defaults.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
@@ -20,10 +20,10 @@ module Inch
         @work_dir = dir
         @codebase_old = codebase_for(before_rev)
         @codebase_new = if after_rev.nil?
-            Codebase.parse(work_dir)
-          else
-            codebase_for(after_rev)
-          end
+                          Codebase.parse(work_dir)
+                        else
+                          codebase_for(after_rev)
+                        end
         @comparer = API::Compare::Codebases.new(@codebase_old, @codebase_new)
       end
 
@@ -42,9 +42,7 @@ 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)
@@ -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/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/suggest.rb

@@ -1,4 +1,4 @@
-require 'inch/evaluation/proxy/base'
+require "inch/evaluation/proxy/base"
 
 module Inch
   module API

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,4 +1,4 @@
-require 'inch/utils/weighted_list'
+require "inch/utils/weighted_list"
 
 module Inch
   module API
@@ -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