inch 0.5.0.rc3 → 0.5.0.rc4

data/test/unit/utils/ui_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
 
 describe ::Inch::Utils::UI do
   it "should trace" do
@@ -6,7 +6,7 @@ describe ::Inch::Utils::UI do
       @instance = ::Inch::Utils::UI.new
       @instance.trace("Test")
     end
-    refute out.empty?, "there should be no output"
+    refute out.empty?, "there should be output"
     assert err.empty?, "there should be no errors"
   end
 
@@ -15,23 +15,23 @@ describe ::Inch::Utils::UI do
       @instance = ::Inch::Utils::UI.new
       @instance.header("Test", :red)
     end
-    refute out.empty?, "there should be no output"
+    refute out.empty?, "there should be output"
     assert err.empty?, "there should be no errors"
   end
 
   it "should trace debug if ENV variable is set" do
-    ENV['DEBUG'] = "1"
+    ENV["DEBUG"] = "1"
     out, err = capture_io do
       @instance = ::Inch::Utils::UI.new
       @instance.debug("Test")
     end
-    ENV['DEBUG'] = nil
-    refute out.empty?, "there should be no output"
+    ENV["DEBUG"] = nil
+    refute out.empty?, "there should be output"
     assert err.empty?, "there should be no errors"
   end
 
   it "should not trace debug if ENV variable is set" do
-    refute ENV['DEBUG']
+    refute ENV["DEBUG"]
     out, err = capture_io do
       @instance = ::Inch::Utils::UI.new
       @instance.debug("Test")

data/test/unit/utils/weighted_list_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
 
 describe ::Inch::Utils::WeightedList do
   before do
@@ -7,8 +7,11 @@ describe ::Inch::Utils::WeightedList do
 
   def assert_weighted_list(list, counts, expected)
     weighted_list = ::Inch::Utils::WeightedList.new(list, counts)
-    # assert_equal expected.map(&:size).inject(:+), weighted_list.to_a.map(&:size).inject(:+)
-    assert_equal expected, weighted_list.to_a, "should be #{expected.map(&:size)}, was #{weighted_list.to_a.map(&:size)}"
+    # assert_equal expected.map(&:size).inject(:+),
+    #              weighted_list.to_a.map(&:size).inject(:+)
+    assert_equal expected, weighted_list.to_a,
+                 "should be #{expected.map(&:size)}, was " \
+                   "#{weighted_list.to_a.map(&:size)}"
   end
 
   def list_and_expected(counts, expected_counts)
@@ -19,7 +22,7 @@ describe ::Inch::Utils::WeightedList do
     expected = expected_counts.map.with_index do |num, index|
       (1..num).map { |i| :"#{elements[index]}#{i}" }
     end
-    return list, expected
+    [list, expected]
   end
 
   it "should work if elements are exact" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc3
+  version: 0.5.0.rc4
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".simplecov"
@@ -128,8 +130,11 @@ files:
 - Rakefile
 - TODOS.md
 - bin/inch
-- config/defaults.rb
-- config/example.yml
+- config/.inch.yml.sample
+- config/base.rb
+- config/elixir.rb
+- config/nodejs.rb
+- config/ruby.rb
 - inch.gemspec
 - lib/inch.rb
 - lib/inch/api.rb
@@ -183,31 +188,9 @@ files:
 - lib/inch/code_object.rb
 - lib/inch/code_object/converter.rb
 - lib/inch/code_object/provider.rb
-- lib/inch/code_object/provider/yard.rb
-- lib/inch/code_object/provider/yard/docstring.rb
-- lib/inch/code_object/provider/yard/nodoc_helper.rb
-- lib/inch/code_object/provider/yard/object.rb
-- lib/inch/code_object/provider/yard/object/base.rb
-- lib/inch/code_object/provider/yard/object/class_object.rb
-- lib/inch/code_object/provider/yard/object/class_variable_object.rb
-- lib/inch/code_object/provider/yard/object/constant_object.rb
-- lib/inch/code_object/provider/yard/object/method_object.rb
-- lib/inch/code_object/provider/yard/object/method_parameter_object.rb
-- lib/inch/code_object/provider/yard/object/method_signature.rb
-- lib/inch/code_object/provider/yard/object/module_object.rb
-- lib/inch/code_object/provider/yard/object/namespace_object.rb
-- lib/inch/code_object/provider/yard/object/root_object.rb
-- lib/inch/code_object/provider/yard/parser.rb
 - lib/inch/code_object/proxy.rb
-- lib/inch/code_object/proxy/base.rb
-- lib/inch/code_object/proxy/class_object.rb
-- lib/inch/code_object/proxy/class_variable_object.rb
-- lib/inch/code_object/proxy/constant_object.rb
-- lib/inch/code_object/proxy/method_object.rb
-- lib/inch/code_object/proxy/method_parameter_object.rb
-- lib/inch/code_object/proxy/module_object.rb
-- lib/inch/code_object/proxy/namespace_object.rb
 - lib/inch/codebase.rb
+- lib/inch/codebase/object.rb
 - lib/inch/codebase/objects.rb
 - lib/inch/codebase/objects_filter.rb
 - lib/inch/codebase/proxy.rb
@@ -215,58 +198,114 @@ files:
 - lib/inch/config.rb
 - lib/inch/config/base.rb
 - lib/inch/config/codebase.rb
+- lib/inch/config/evaluation.rb
 - lib/inch/core_ext.rb
 - lib/inch/core_ext/string.rb
 - lib/inch/evaluation.rb
 - lib/inch/evaluation/file.rb
 - lib/inch/evaluation/grade.rb
 - lib/inch/evaluation/grade_list.rb
-- lib/inch/evaluation/object_schema.rb
 - lib/inch/evaluation/priority_range.rb
 - lib/inch/evaluation/proxy.rb
-- lib/inch/evaluation/proxy/base.rb
-- lib/inch/evaluation/proxy/class_object.rb
-- lib/inch/evaluation/proxy/class_variable_object.rb
-- lib/inch/evaluation/proxy/constant_object.rb
-- lib/inch/evaluation/proxy/method_object.rb
-- lib/inch/evaluation/proxy/module_object.rb
-- lib/inch/evaluation/proxy/namespace_object.rb
-- lib/inch/evaluation/role/base.rb
-- lib/inch/evaluation/role/class_variable.rb
-- lib/inch/evaluation/role/constant.rb
-- lib/inch/evaluation/role/method.rb
-- lib/inch/evaluation/role/method_parameter.rb
-- lib/inch/evaluation/role/missing.rb
-- lib/inch/evaluation/role/namespace.rb
-- lib/inch/evaluation/role/object.rb
+- lib/inch/evaluation/role.rb
+- lib/inch/language.rb
+- lib/inch/language/elixir/code_object/base.rb
+- lib/inch/language/elixir/code_object/function_object.rb
+- lib/inch/language/elixir/code_object/module_object.rb
+- lib/inch/language/elixir/code_object/type_object.rb
+- lib/inch/language/elixir/evaluation/base.rb
+- lib/inch/language/elixir/evaluation/function_object.rb
+- lib/inch/language/elixir/evaluation/module_object.rb
+- lib/inch/language/elixir/evaluation/type_object.rb
+- lib/inch/language/elixir/import.rb
+- lib/inch/language/elixir/provider/reader.rb
+- lib/inch/language/elixir/provider/reader/object.rb
+- lib/inch/language/elixir/provider/reader/object/base.rb
+- lib/inch/language/elixir/provider/reader/object/function_object.rb
+- lib/inch/language/elixir/provider/reader/object/module_object.rb
+- lib/inch/language/elixir/provider/reader/object/type_object.rb
+- lib/inch/language/elixir/provider/reader/parser.rb
+- lib/inch/language/elixir/roles/base.rb
+- lib/inch/language/elixir/roles/function.rb
+- lib/inch/language/elixir/roles/module.rb
+- lib/inch/language/elixir/roles/object.rb
+- lib/inch/language/elixir/roles/type.rb
+- lib/inch/language/nodejs/import.rb
+- lib/inch/language/nodejs/provider/jsdoc.rb
+- lib/inch/language/nodejs/provider/jsdoc/object.rb
+- lib/inch/language/nodejs/provider/jsdoc/object/base.rb
+- lib/inch/language/nodejs/provider/jsdoc/parser.rb
+- lib/inch/language/ruby/code_object/base.rb
+- lib/inch/language/ruby/code_object/class_object.rb
+- lib/inch/language/ruby/code_object/class_variable_object.rb
+- lib/inch/language/ruby/code_object/constant_object.rb
+- lib/inch/language/ruby/code_object/method_object.rb
+- lib/inch/language/ruby/code_object/method_parameter_object.rb
+- lib/inch/language/ruby/code_object/module_object.rb
+- lib/inch/language/ruby/code_object/namespace_object.rb
+- lib/inch/language/ruby/evaluation/base.rb
+- lib/inch/language/ruby/evaluation/class_object.rb
+- lib/inch/language/ruby/evaluation/class_variable_object.rb
+- lib/inch/language/ruby/evaluation/constant_object.rb
+- lib/inch/language/ruby/evaluation/method_object.rb
+- lib/inch/language/ruby/evaluation/module_object.rb
+- lib/inch/language/ruby/evaluation/namespace_object.rb
+- lib/inch/language/ruby/import.rb
+- lib/inch/language/ruby/provider/yard.rb
+- lib/inch/language/ruby/provider/yard/docstring.rb
+- lib/inch/language/ruby/provider/yard/nodoc_helper.rb
+- lib/inch/language/ruby/provider/yard/object.rb
+- lib/inch/language/ruby/provider/yard/object/base.rb
+- lib/inch/language/ruby/provider/yard/object/class_object.rb
+- lib/inch/language/ruby/provider/yard/object/class_variable_object.rb
+- lib/inch/language/ruby/provider/yard/object/constant_object.rb
+- lib/inch/language/ruby/provider/yard/object/method_object.rb
+- lib/inch/language/ruby/provider/yard/object/method_parameter_object.rb
+- lib/inch/language/ruby/provider/yard/object/method_signature.rb
+- lib/inch/language/ruby/provider/yard/object/module_object.rb
+- lib/inch/language/ruby/provider/yard/object/namespace_object.rb
+- lib/inch/language/ruby/provider/yard/object/root_object.rb
+- lib/inch/language/ruby/provider/yard/parser.rb
+- lib/inch/language/ruby/roles/base.rb
+- lib/inch/language/ruby/roles/class_variable.rb
+- lib/inch/language/ruby/roles/constant.rb
+- lib/inch/language/ruby/roles/method.rb
+- lib/inch/language/ruby/roles/method_parameter.rb
+- lib/inch/language/ruby/roles/missing.rb
+- lib/inch/language/ruby/roles/namespace.rb
+- lib/inch/language/ruby/roles/object.rb
 - lib/inch/rake.rb
 - lib/inch/rake/suggest.rb
+- lib/inch/utils/buffered_ui.rb
 - lib/inch/utils/read_write_methods.rb
 - lib/inch/utils/shell_helper.rb
 - lib/inch/utils/ui.rb
 - lib/inch/utils/weighted_list.rb
 - lib/inch/version.rb
-- test/fixtures/code_examples/lib/foo.rb
-- test/fixtures/diff1/lib/diff1.rb
-- test/fixtures/diff2/lib/diff2.rb
-- test/fixtures/inch-yml/.inch.yml
-- test/fixtures/inch-yml/foo/bar.rb
-- test/fixtures/inch-yml/foo/vendor/base.rb
-- test/fixtures/parameters/lib/foo.rb
-- test/fixtures/readme/lib/foo.rb
-- test/fixtures/really_good/lib/foo.rb
-- test/fixtures/really_good_pedantic/lib/foo.rb
-- test/fixtures/simple/README
-- test/fixtures/simple/lib/broken.rb
-- test/fixtures/simple/lib/foo.rb
-- test/fixtures/simple/lib/nodoc.rb
-- test/fixtures/simple/lib/role_methods.rb
-- test/fixtures/simple/lib/role_namespaces.rb
-- test/fixtures/visibility/lib/foo.rb
-- test/fixtures/yardopts/.yardopts
-- test/fixtures/yardopts/foo/bar.rb
+- test/fixtures/ruby/code_examples/lib/foo.rb
+- test/fixtures/ruby/diff1/lib/diff1.rb
+- test/fixtures/ruby/diff2/lib/diff2.rb
+- test/fixtures/ruby/inch-yml/.inch.yml
+- test/fixtures/ruby/inch-yml/foo/bar.rb
+- test/fixtures/ruby/inch-yml/foo/vendor/base.rb
+- test/fixtures/ruby/parameters/lib/foo.rb
+- test/fixtures/ruby/readme/lib/foo.rb
+- test/fixtures/ruby/really_good/lib/foo.rb
+- test/fixtures/ruby/really_good_pedantic/lib/foo.rb
+- test/fixtures/ruby/simple/README
+- test/fixtures/ruby/simple/lib/broken.rb
+- test/fixtures/ruby/simple/lib/broken_ruby_2_0_features.rb
+- test/fixtures/ruby/simple/lib/directives.rb
+- test/fixtures/ruby/simple/lib/foo.rb
+- test/fixtures/ruby/simple/lib/nodoc.rb
+- test/fixtures/ruby/simple/lib/role_methods.rb
+- test/fixtures/ruby/simple/lib/role_namespaces.rb
+- test/fixtures/ruby/visibility/lib/foo.rb
+- test/fixtures/ruby/yardopts/.yardopts
+- test/fixtures/ruby/yardopts/foo/bar.rb
 - test/integration/api/compare/codebases.rb
 - test/integration/cli/command/console_test.rb
+- test/integration/cli/command/diff_test.rb
 - test/integration/cli/command/inspect_test.rb
 - test/integration/cli/command/list_test.rb
 - test/integration/cli/command/show_test.rb
@@ -291,17 +330,19 @@ files:
 - test/unit/cli/trace_helper_test.rb
 - test/unit/cli/yardopts_helper_test.rb
 - test/unit/code_object/converter_test.rb
-- test/unit/code_object/provider/yard/docstring_test.rb
-- test/unit/code_object/provider/yard/nodoc_helper_test.rb
-- test/unit/code_object/provider/yard/object/method_object_test.rb
-- test/unit/code_object/provider/yard_test.rb
 - test/unit/code_object/provider_test.rb
-- test/unit/code_object/proxy/method_object_test.rb
 - test/unit/code_object/proxy_test.rb
 - test/unit/codebase/objects_test.rb
 - test/unit/codebase/proxy_test.rb
 - test/unit/config/codebase_test.rb
-- test/unit/evaluation/role/base_test.rb
+- test/unit/config_test.rb
+- test/unit/evaluation/role_test.rb
+- test/unit/language/ruby/code_object/method_object_test.rb
+- test/unit/language/ruby/provider/yard/docstring_test.rb
+- test/unit/language/ruby/provider/yard/nodoc_helper_test.rb
+- test/unit/language/ruby/provider/yard/object/method_object_test.rb
+- test/unit/language/ruby/provider/yard_test.rb
+- test/unit/utils/buffered_ui_test.rb
 - test/unit/utils/ui_test.rb
 - test/unit/utils/weighted_list_test.rb
 homepage: http://trivelop.de/inch/
@@ -329,27 +370,30 @@ signing_key:
 specification_version: 4
 summary: Documentation measurement tool for Ruby
 test_files:
-- test/fixtures/code_examples/lib/foo.rb
-- test/fixtures/diff1/lib/diff1.rb
-- test/fixtures/diff2/lib/diff2.rb
-- test/fixtures/inch-yml/.inch.yml
-- test/fixtures/inch-yml/foo/bar.rb
-- test/fixtures/inch-yml/foo/vendor/base.rb
-- test/fixtures/parameters/lib/foo.rb
-- test/fixtures/readme/lib/foo.rb
-- test/fixtures/really_good/lib/foo.rb
-- test/fixtures/really_good_pedantic/lib/foo.rb
-- test/fixtures/simple/README
-- test/fixtures/simple/lib/broken.rb
-- test/fixtures/simple/lib/foo.rb
-- test/fixtures/simple/lib/nodoc.rb
-- test/fixtures/simple/lib/role_methods.rb
-- test/fixtures/simple/lib/role_namespaces.rb
-- test/fixtures/visibility/lib/foo.rb
-- test/fixtures/yardopts/.yardopts
-- test/fixtures/yardopts/foo/bar.rb
+- test/fixtures/ruby/code_examples/lib/foo.rb
+- test/fixtures/ruby/diff1/lib/diff1.rb
+- test/fixtures/ruby/diff2/lib/diff2.rb
+- test/fixtures/ruby/inch-yml/.inch.yml
+- test/fixtures/ruby/inch-yml/foo/bar.rb
+- test/fixtures/ruby/inch-yml/foo/vendor/base.rb
+- test/fixtures/ruby/parameters/lib/foo.rb
+- test/fixtures/ruby/readme/lib/foo.rb
+- test/fixtures/ruby/really_good/lib/foo.rb
+- test/fixtures/ruby/really_good_pedantic/lib/foo.rb
+- test/fixtures/ruby/simple/README
+- test/fixtures/ruby/simple/lib/broken.rb
+- test/fixtures/ruby/simple/lib/broken_ruby_2_0_features.rb
+- test/fixtures/ruby/simple/lib/directives.rb
+- test/fixtures/ruby/simple/lib/foo.rb
+- test/fixtures/ruby/simple/lib/nodoc.rb
+- test/fixtures/ruby/simple/lib/role_methods.rb
+- test/fixtures/ruby/simple/lib/role_namespaces.rb
+- test/fixtures/ruby/visibility/lib/foo.rb
+- test/fixtures/ruby/yardopts/.yardopts
+- test/fixtures/ruby/yardopts/foo/bar.rb
 - test/integration/api/compare/codebases.rb
 - test/integration/cli/command/console_test.rb
+- test/integration/cli/command/diff_test.rb
 - test/integration/cli/command/inspect_test.rb
 - test/integration/cli/command/list_test.rb
 - test/integration/cli/command/show_test.rb
@@ -374,17 +418,19 @@ test_files:
 - test/unit/cli/trace_helper_test.rb
 - test/unit/cli/yardopts_helper_test.rb
 - test/unit/code_object/converter_test.rb
-- test/unit/code_object/provider/yard/docstring_test.rb
-- test/unit/code_object/provider/yard/nodoc_helper_test.rb
-- test/unit/code_object/provider/yard/object/method_object_test.rb
-- test/unit/code_object/provider/yard_test.rb
 - test/unit/code_object/provider_test.rb
-- test/unit/code_object/proxy/method_object_test.rb
 - test/unit/code_object/proxy_test.rb
 - test/unit/codebase/objects_test.rb
 - test/unit/codebase/proxy_test.rb
 - test/unit/config/codebase_test.rb
-- test/unit/evaluation/role/base_test.rb
+- test/unit/config_test.rb
+- test/unit/evaluation/role_test.rb
+- test/unit/language/ruby/code_object/method_object_test.rb
+- test/unit/language/ruby/provider/yard/docstring_test.rb
+- test/unit/language/ruby/provider/yard/nodoc_helper_test.rb
+- test/unit/language/ruby/provider/yard/object/method_object_test.rb
+- test/unit/language/ruby/provider/yard_test.rb
+- test/unit/utils/buffered_ui_test.rb
 - test/unit/utils/ui_test.rb
 - test/unit/utils/weighted_list_test.rb
 has_rdoc: 

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

@@ -1,57 +0,0 @@
-module Inch
-  module CodeObject
-    module Provider
-      # Parses the source tree (using YARD)
-      module YARD
-
-        # Returns +true+ if the docstring was generated by YARD
-        #
-        # @param docstring [Docstring,String]
-        # @param method [MethodObject]
-        def self.implicit_docstring?(docstring, method)
-          name = method.name
-          if method.getter?
-            docstring.to_s == "Returns the value of attribute #{name}"
-          elsif method.setter?
-            basename = name.to_s.gsub(/(\=)$/, '')
-            docstring.to_s == "Sets the attribute #{basename}"
-          else
-            false
-          end
-        end
-
-        # Returns +true+ if the tag was generated by YARD
-        #
-        # @param tag [::YARD::Tag]
-        # @param method [MethodObject]
-        def self.implicit_tag?(tag, method)
-          name = method.name
-          if method.getter?
-            tag.tag_name == 'return' &&
-              tag.text == "the current value of #{name}"
-          elsif method.setter?
-            tag.tag_name == 'return' &&
-              tag.text == 'the newly set value'
-          else
-            false
-          end
-        end
-
-        def self.parse(dir, config = Inch::Config.codebase)
-          Parser.parse(dir, config)
-        end
-
-      end
-    end
-  end
-end
-
-require 'logger'
-require 'yard'
-
-log.level = ::Logger::UNKNOWN # basically disable YARD's logging
-
-require 'inch/code_object/provider/yard/parser'
-require 'inch/code_object/provider/yard/docstring'
-require 'inch/code_object/provider/yard/nodoc_helper'
-require 'inch/code_object/provider/yard/object'