inch 0.5.0.rc5 → 0.5.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93877a4281619360271a03029ae4368cf71c7e57
-  data.tar.gz: f76a3b46211e7d258a41bef437839a56ee66826c
+  metadata.gz: a4da0938bb922b49c4e2ee392f2db88c6f595801
+  data.tar.gz: f194abcef2bdd725e022e785f2a210443681d2ec
 SHA512:
-  metadata.gz: fb8cb6914e685eed7eb4b008757bf91d4ab56efe96e74b6d4faa57321cc9b75fb259a05b085ff6a90b34321e5f2d2d8b8c07b0cfbdc7df4d03a5ea6afb5b6b3c
-  data.tar.gz: 1804964c134ae38cf0108cdeeafe5809af0114da80b65d583a6edb2bf20f7070c38142a10fc532d0121c59900e91fb8542ac8467a0044f2fe2f6b551731e18bc
+  metadata.gz: c350116143d6e69ae97387b14b35b5fd9616d984c60b83a148b2f534f33e2b848dc5bef0d4a596ee39d7841d840e6c49274ca16a0b9f083c6366a0c3151d83f1
+  data.tar.gz: 80c6b9ffea8dd775b836a27fdea8e496421e9ebedd2185df4d95c4055d0a58c1c453bc26bb74b2fc66941510dd658c592d52a1bbf930cef59325e0cfb337d48c

data/.rubocop.yml

@@ -7,9 +7,3 @@ AllCops:
     - '**/Rakefile'
   Exclude:
     - 'test/fixtures/**/*'
-
-Style/Encoding:
-  Enabled: true
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -1,50 +1,60 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-08-09 22:59:20 +0200 using RuboCop version 0.24.1.
+# on 2014-08-31 11:34:00 +0200 using RuboCop version 0.25.0.
 # 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
+# Offense count: 34
 Lint/AmbiguousOperator:
   Enabled: false
 
-# Offense count: 87
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
 # Offense count: 1
 Lint/Debugger:
   Enabled: false
 
-# Offense count: 3
+# Offense count: 16
+Lint/SpaceBeforeFirstArg:
+  Enabled: false
+
+# Offense count: 9
 # Cop supports --auto-correct.
 Lint/UnusedMethodArgument:
   Enabled: false
 
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 197
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 1
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 81
+
+# Offense count: 27
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 34
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 10
+
 # Offense count: 5
 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: 195
-
-# Offense count: 2
-Style/CyclomaticComplexity:
-  Max: 7
-
-# Offense count: 85
+# Offense count: 87
 Style/Documentation:
   Enabled: false
 
@@ -57,22 +67,18 @@ Style/DoubleNegation:
 Style/GuardClause:
   Enabled: false
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/HashSyntax:
+  Enabled: false
+
 # Offense count: 1
 # Configuration parameters: MaxLineLength.
 Style/IfUnlessModifier:
   Enabled: false
 
-# Offense count: 10
-# Configuration parameters: AllowURI.
-Style/LineLength:
-  Max: 111
-
-# Offense count: 23
-# Configuration parameters: CountComments.
-Style/MethodLength:
-  Max: 34
-
-# Offense count: 22
+# Offense count: 43
 # Configuration parameters: NamePrefixBlacklist.
 Style/PredicateName:
   Enabled: false
@@ -82,12 +88,12 @@ Style/PredicateName:
 Style/SingleLineBlockParams:
   Enabled: false
 
-# Offense count: 45
+# Offense count: 82
 # Cop supports --auto-correct.
 Style/SingleSpaceBeforeFirstArg:
   Enabled: false
 
-# Offense count: 5
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
 Style/TrivialAccessors:

data/Gemfile

@@ -1,9 +1,9 @@
-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
+  gem 'simplecov', require: false
+  gem 'rubocop', '~> 0.25.0', require: false
 end

data/Rakefile

@@ -1,21 +1,25 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-require "rake/testtask"
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.pattern = "test/**/*_test.rb"
+  t.pattern = 'test/**/*_test.rb'
 end
 
 Rake::TestTask.new(:"test:unit") do |t|
-  t.pattern = "test/unit/**/*_test.rb"
+  t.pattern = 'test/unit/**/*_test.rb'
+end
+
+Rake::TestTask.new(:"test:elixir") do |t|
+  t.pattern = 'test/unit/language/elixir/**/*_test.rb'
 end
 
 Rake::TestTask.new(:"test:ruby") do |t|
-  t.pattern = "test/unit/language/ruby/**/*_test.rb"
+  t.pattern = 'test/unit/language/ruby/**/*_test.rb'
 end
 
 Rake::TestTask.new(:"test:integration") do |t|
-  t.pattern = "test/integration/**/*_test.rb"
+  t.pattern = 'test/integration/**/*_test.rb'
 end
 
 task default: :test

data/bin/inch

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
 # hit Control + C to stop
-Signal.trap("INT") do
-  warn "  cancelled by user (INT)"
+Signal.trap('INT') do
+  warn '  cancelled by user (INT)'
   exit 1
 end
 
@@ -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/base.rb

@@ -2,25 +2,25 @@ Inch::Config.base do
   evaluation do
     grade(:A) do
       scores    80..100
-      label     "Seems really good"
+      label     'Seems really good'
       color     :green
     end
 
     grade(:B) do
       scores    50...80
-      label     "Proper documentation present"
+      label     'Proper documentation present'
       color     :yellow
     end
 
     grade(:C) do
       scores    1...50
-      label     "Needs work"
+      label     'Needs work'
       color     :red
     end
 
     grade(:U) do
       scores    0..0
-      label     "Undocumented"
+      label     'Undocumented'
       color     :color141
       bg_color  :color105
     end

data/config/nodejs.rb

@@ -4,7 +4,50 @@
 Inch::Config.register(:nodejs) do
   codebase do
     object_provider :JSDoc
-    include_files   ["src/**/*.js"]
+    include_files   ['src/**/*.js']
     exclude_files   []
   end
+
+  evaluation do
+    schema(:MemberObject) do
+      docstring           1.0
+
+      # optional:
+      code_example_single 0.1
+      code_example_multi  0.2
+      unconsidered_tag    0.2
+    end
+
+    schema(:ModuleObject) do
+      docstring           1.0
+
+      # optional:
+      code_example_single 0.1
+      code_example_multi  0.2
+      unconsidered_tag    0.2
+    end
+
+    schema(:FunctionObject) do
+      docstring           0.5
+      parameters          0.4
+      return_type         0.1
+      return_description  0.3
+
+      if object.questioning_name?
+        parameters          parameters + return_type
+        return_type         0.0
+      end
+
+      if !object.has_parameters? || object.setter?
+        return_description  docstring + parameters
+        docstring           docstring + parameters
+        parameters          0.0
+      end
+
+      # optional:
+      code_example_single 0.1
+      code_example_multi  0.25
+      unconsidered_tag    0.2
+    end
+  end
 end

data/config/ruby.rb

@@ -3,7 +3,7 @@
 Inch::Config.register(:ruby) do
   codebase do
     object_provider :YARD
-    include_files   ["lib/**/*.rb", "app/**/*.rb"]
+    include_files   ['lib/**/*.rb', 'app/**/*.rb']
     exclude_files   []
   end
 

data/inch.gemspec

@@ -1,29 +1,29 @@
 # 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.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.homepage      = "http://trivelop.de/inch/"
-  spec.license       = "MIT"
+  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.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.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", "~> 5.2"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.2'
 
-  spec.add_dependency "pry"
-  spec.add_dependency "sparkr", ">= 0.2.0"
-  spec.add_dependency "term-ansicolor"
-  spec.add_dependency "yard", "~> 0.8.7"
+  spec.add_dependency 'pry'
+  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,20 +1,20 @@
-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/language"
+require 'inch/language'
 
-require "inch/config"
-require File.join(File.dirname(__FILE__), "..", "config", "base.rb")
-require File.join(File.dirname(__FILE__), "..", "config", "ruby.rb")
-require File.join(File.dirname(__FILE__), "..", "config", "nodejs.rb")
-require File.join(File.dirname(__FILE__), "..", "config", "elixir.rb")
+require 'inch/config'
+require File.join(File.dirname(__FILE__), '..', 'config', 'base.rb')
+require File.join(File.dirname(__FILE__), '..', 'config', 'ruby.rb')
+require File.join(File.dirname(__FILE__), '..', 'config', 'nodejs.rb')
+require File.join(File.dirname(__FILE__), '..', 'config', 'elixir.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

@@ -7,7 +7,7 @@ module Inch
         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."
+            fail '@before and @after are identical ruby objects. this is bad.'
           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

data/lib/inch/api/options/suggest.rb

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