inch 0.5.0.rc3 → 0.5.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad7ddc303f887e07ca647f76f002aafed4dc120e
-  data.tar.gz: 7c0c21ee7be201462be99951d70c7544e9a4bc52
+  metadata.gz: 204a55bbfb702da63ab9b62d8e68b6e97b46d7e8
+  data.tar.gz: 9237fdad678102759b3924c464718181560de4d9
 SHA512:
-  metadata.gz: 582a2edf65d9d3d3bd8c95ffee5c55d94a07718a2cc94bcc9c594ffe2b106ed616755d15710ef575cdd312963e54cdd92893955d0c178eeb90a7c35940003f3c
-  data.tar.gz: b97da1277e2c3b2644ca49250288ff9031a4fee69463b11cbae485739d6aededf536f02e7892ed365d87067ffccc2c99a63eb97baf97d838a85429333a7b4924
+  metadata.gz: d5e38320c4c26fcbb2bf22f67fce5f5fc1d6c8d6acd4953e069f106b6440d31b531179284611be268b26bc8cad49cd3722b9f8dd48e669ef067fbbab07b5f79f
+  data.tar.gz: 0c5772bcc6822ef6652611ec82ec370cb5b1f7fb122078055bcb69a53ab6efefad5fa10aa15e29312cb21a9eb2035894f7d60d56e18b43a693f5f26d9780432a

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,94 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# 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
+# 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: 1
+Lint/Debugger:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# 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
+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: 10
+# Configuration parameters: AllowURI.
+Style/LineLength:
+  Max: 111
+
+# Offense count: 23
+# Configuration parameters: CountComments.
+Style/MethodLength:
+  Max: 34
+
+# 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: 5
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false

data/CHANGELOG.md

@@ -1,11 +1,35 @@
 # Changelog
 
+## 0.4.11 (pre)
 
-## 0.5.0 (pre)
+- Add `undefined` to the list of values used to indicate that a return value
+  is not intended for further use. The current list is `nil`, `nothing`,
+  `void`, and `undefined`.
+
+## 0.4.10
+
+- This patch handles cases where the docs indicate that a return value is not
+  intended for further use. After this patch, Inch won't suggest "Describe
+  what foo returns." anymore.
+
+## 0.4.9
+
+- Fixes bugs introduced in 0.4.8
+
+## 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
 
 - 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,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

@@ -267,7 +267,7 @@ Suggests places where a codebase suffers a lack of documentation.
     # Properly documented, could be improved:
 
     ┃  B  ↑  Inch::CLI::Command::BaseList#prepare_list
-    ┃  B  ↑  Inch::CodeObject::Proxy::MethodParameterObject#initialize
+    ┃  B  ↑  Inch::CodeObject::Ruby::MethodParameterObject#initialize
     ┃  B  ↗  Inch::CLI::Command::Stats#run
     ┃  B  ↗  Inch::CLI::CommandParser#run
 
@@ -362,7 +362,7 @@ Lists all objects in your codebase with their grades.
     # Seems really good
 
     ┃  A  ↑  Inch::CLI::Command::Output::Console#object
-    ┃  A  ↗  Inch::CodeObject::Proxy::Base#depth
+    ┃  A  ↗  Inch::CodeObject::Proxy#depth
     ┃  A  ↗  Inch::CLI::Command::Base#description
     ┃  A  ↗  Inch::CodeObject::NodocHelper#nodoc?
     ┃ ...  (omitting 75 objects)
@@ -370,7 +370,7 @@ Lists all objects in your codebase with their grades.
     # Proper documentation present
 
     ┃  B  ↑  Inch::CLI::Command::Suggest#run
-    ┃  B  ↑  Inch::CodeObject::Proxy::MethodParameterObject#initialize
+    ┃  B  ↑  Inch::CodeObject::Ruby::MethodParameterObject#initialize
     ┃  B  ↗  Inch::CLI::Command::Stats#run
     ┃  B  ↗  Inch::CLI::CommandParser#run
 

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"
@@ -10,8 +10,12 @@ Rake::TestTask.new(:"test:unit") do |t|
   t.pattern = "test/unit/**/*_test.rb"
 end
 
+Rake::TestTask.new(:"test:ruby") do |t|
+  t.pattern = "test/unit/language/ruby/**/*_test.rb"
+end
+
 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/{example.yml → .inch.yml.sample}

@@ -1,3 +1,4 @@
+language: ruby
 files:
   included:
     - lib/**/*.rb

data/config/base.rb

@@ -0,0 +1,53 @@
+Inch::Config.base do
+  evaluation do
+    grade(:A) do
+      scores    80..100
+      label     "Seems really good"
+      color     :green
+    end
+
+    grade(:B) do
+      scores    50...80
+      label     "Proper documentation present"
+      color     :yellow
+    end
+
+    grade(:C) do
+      scores    1...50
+      label     "Needs work"
+      color     :red
+    end
+
+    grade(:U) do
+      scores    0..0
+      label     "Undocumented"
+      color     :color141
+      bg_color  :color105
+    end
+
+    priority(:N) do
+      priorities  4..99
+      arrow       "\u2191"
+    end
+
+    priority(:NE) do
+      priorities  2...4
+      arrow       "\u2197"
+    end
+
+    priority(:E) do
+      priorities  0...2
+      arrow       "\u2192"
+    end
+
+    priority(:SE) do
+      priorities  -2...0
+      arrow       "\u2198"
+    end
+
+    priority(:S) do
+      priorities  -99...-2
+      arrow       "\u2193"
+    end
+  end
+end

data/config/elixir.rb

@@ -0,0 +1,43 @@
+# Elixir's configuration
+
+Inch::Config.register(:elixir) do
+  codebase do
+    object_provider :Reader
+    include_files   []
+    exclude_files   []
+  end
+
+  evaluation do
+    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/nodejs.rb

@@ -0,0 +1,10 @@
+# NodeJS's configuration
+# Node will be treated as a separate programming language for now
+
+Inch::Config.register(:nodejs) do
+  codebase do
+    object_provider :JSDoc
+    include_files   ["src/**/*.js"]
+    exclude_files   []
+  end
+end

data/config/{defaults.rb → ruby.rb}

@@ -1,62 +1,13 @@
-Inch::Config.run do
-  # development!
+# Ruby's configuration
 
+Inch::Config.register(:ruby) do
   codebase do
-    include_files ["lib/**/*.rb", "app/**/*.rb"]
-    exclude_files []
+    object_provider :YARD
+    include_files   ["lib/**/*.rb", "app/**/*.rb"]
+    exclude_files   []
   end
 
   evaluation do
-    grade(:A) do
-      scores    80..100
-      label     "Seems really good"
-      color     :green
-    end
-
-    grade(:B) do
-      scores    50...80
-      label     "Proper documentation present"
-      color     :yellow
-    end
-
-    grade(:C) do
-      scores    1...50
-      label     "Needs work"
-      color     :red
-    end
-
-    grade(:U) do
-      scores    0..0
-      label     "Undocumented"
-      color     :color141
-      bg_color  :color105
-    end
-
-    priority(:N) do
-      priorities  4..99
-      arrow       "\u2191"
-    end
-
-    priority(:NE) do
-      priorities  2...4
-      arrow       "\u2197"
-    end
-
-    priority(:E) do
-      priorities  0...2
-      arrow       "\u2192"
-    end
-
-    priority(:SE) do
-      priorities  -2...0
-      arrow       "\u2198"
-    end
-
-    priority(:S) do
-      priorities  -99...-2
-      arrow       "\u2193"
-    end
-
     schema(:ConstantObject) 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