inch 0.4.10 → 0.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db784f667f4f70a4d90d9ab4ea5485e38f31590
-  data.tar.gz: ff193873fff093ae113b9efde21245b69019f0ad
+  metadata.gz: 9b627b3f3280cb1d20ff03e3a90decafe62cae3e
+  data.tar.gz: 5489c5a9d46a46e20d924aef08063bd4a2663998
 SHA512:
-  metadata.gz: ff12fd72f9f142eb7ae4217f003f5f4579f1a05f15baf4d95e583b489380096bdd2b041870b7bd5e4bc2ab8e11ebbb51aabdcc2890683e986f9f49d61440e1e8
-  data.tar.gz: 16b3b9c9a18eea2cb34db191565efeaf01f00688b445cd20417ef0446c2a541a02b9ce561da3a89463932fe6b3dc9f302c006571d5c0baba359ed52c6f0c7849
+  metadata.gz: 748f0227ada481c78e398ba26e9c30397293acdefa22244c4b2482accaac8893f0eb10076ce4eb1c2484c91cc8253acd7619b5071e2e9c8189eb1b8676905603
+  data.tar.gz: 4e82d4927c776c8c825187821af1d6e4d5abfdbd56d7c5c4f73dbe093d50d85b901d24fc8934bae81dc1c6fd22b7ceac8bc39aa0c52569bc7cb9c32be3a2bfa8

data/CHANGELOG.md

@@ -1,20 +1,11 @@
 # Changelog
 
 
-## 0.4.8
-
-- Fix a bug related to "CLI classes must be required seperately from now on"
-  Note to self: read own CHANGELOG more carefully in the future
-
-## 0.4.7
+## 0.5.0 (pre)
 
 - 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/Gemfile

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

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-ci.org/github/rrrene/inch.png)](http://inch-ci.org/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-pages.github.io/github/rrrene/inch.png)](http://inch-pages.github.io/github/rrrene/inch)
 
 `inch` gives you hints where to improve your docs. One Inch at a time.
 

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,12 +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/cli"
+require 'inch'
+require 'inch/cli'
 
 Inch::CLI::CommandParser.run(*ARGV)

data/config/defaults.rb

@@ -64,13 +64,6 @@ 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       = "Documentation measurement tool for Ruby"
-  spec.description   = "Documentation measurement tool for Ruby, based on YARD."
+  spec.summary       = %q{Documentation measurement tool for Ruby}
+  spec.description   = %q{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(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(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,15 +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/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
-            fail "@before and @after are identical ruby objects. this is bad."
+            raise "@before and @after are identical ruby objects. this is bad."
           end
         end
 
@@ -23,6 +23,7 @@ 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.find do |comparison|
+          comparisons.detect 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,17 +20,17 @@ 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
 
       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)
@@ -42,7 +42,9 @@ module Inch
 
       def codebase_from_cache(revision)
         filename = Codebase::Serializer.filename(revision)
-        Codebase::Serializer.load(filename) if File.exist?(filename)
+        if File.exist?(filename)
+          Codebase::Serializer.load(filename)
+        end
       end
 
       def codebase_from_copy(original_dir, revision)
@@ -63,6 +65,7 @@ module Inch
       def git_reset(dir, revision = nil)
         git dir, "reset --hard #{revision}"
       end
+
     end
   end
 end

data/lib/inch/api/filter.rb

@@ -8,7 +8,7 @@ module Inch
 
       def initialize(codebase, options)
         @codebase = codebase
-        codebase.objects.filter! Options::Filter.new(options)
+        codebase.objects.filter! Options::Filter(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/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/filter.rb

@@ -16,6 +16,10 @@ 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

@@ -1,4 +1,4 @@
-require "inch/evaluation/proxy/base"
+require 'inch/evaluation/proxy/base'
 
 module Inch
   module API
@@ -27,6 +27,10 @@ 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/stats.rb

@@ -1,6 +1,7 @@
 module Inch
   module API
     class Stats < Filter
+
     end
   end
 end

data/lib/inch/api/suggest.rb

@@ -1,11 +1,11 @@
-require "inch/utils/weighted_list"
+require 'inch/utils/weighted_list'
 
 module Inch
   module API
     class Suggest < Filter
       def initialize(codebase, options)
         super
-        @options = Options::Suggest.new(options)
+        @options = Options::Suggest(options)
       end
 
       def files
@@ -19,6 +19,7 @@ module Inch
         filter_objects_to_display
       end
 
+
       # @return [Array] all the objects that match +@options+
       def all_objects
         relevant_objects
@@ -51,13 +52,15 @@ module Inch
 
         list = Codebase::Objects.sort_by_priority(weighted_list.to_a.flatten)
 
-        list = list[0...object_count] if list.size > object_count
+        if list.size > object_count
+          list = list[0...object_count]
+        end
         list
       end
 
       def files_sorted_by_importance
         list = all_filenames(relevant_objects).uniq.map do |filename|
-          Evaluation::File.for(filename, relevant_objects)
+          f = Evaluation::File.for(filename, relevant_objects)
         end
 
         priority_list = list.select do |f|
@@ -65,8 +68,7 @@ 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)
@@ -85,7 +87,7 @@ module Inch
       end
 
       def grade_list(grade_symbol)
-        grade_lists.find { |r| r.grade.to_sym == grade_symbol }
+        grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
       end
 
       def select_by_priority(list, min_priority)
@@ -97,8 +99,7 @@ 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

data/lib/inch/cli.rb

@@ -11,7 +11,7 @@ module Inch
       # @return [Fixnum]
       def get_term_columns(default = 80)
         str = `stty size`
-        rows_cols = str.split(" ").map(&:to_i)
+        rows_cols = str.split(' ').map(&:to_i)
         rows_cols[1] || default
       rescue
         default
@@ -21,9 +21,9 @@ module Inch
   end
 end
 
-require "inch/cli/arguments"
-require "inch/cli/sparkline_helper"
-require "inch/cli/trace_helper"
-require "inch/cli/yardopts_helper"
+require 'inch/cli/arguments'
+require 'inch/cli/sparkline_helper'
+require 'inch/cli/trace_helper'
+require 'inch/cli/yardopts_helper'
 
-require "inch/cli/command"
+require 'inch/cli/command'

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