inch 0.3.0.rc2 → 0.3.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 046545a24888cdc2d037b07d709243a04baba11b
-  data.tar.gz: 2ab6a0eafc028456a47f17df493fd54b1fab12ec
+  metadata.gz: 5b1114bf285aefdab3d5ce943131521fb16f30e7
+  data.tar.gz: 9a658e477c9b85e871361a609c69d7776c5a6acb
 SHA512:
-  metadata.gz: 340b586066c472db633786ae08498716b6c8a2ae2d897baf9a333fec477872604d1176430d4f05f881a1f0beafc87566e6476bb8478be622c58e4c7919b25316
-  data.tar.gz: ce72b2c5a035a68fb53839b31db58e2e6087e2cab9a5bbe140fcddd50307a040cc25ffbe4c9c88e19849a79770e0a5e5392233ac4bb119acc0965bad61b2a032
+  metadata.gz: a8f1cbeed106ce59753024ee7d283865dbd61b49e3b92d714822dafec40be16ee5d8932dee7d74ec4c62dea0641c477ff4f9da1ae971ad98a87d8240fbe3a762
+  data.tar.gz: 3880bab38166a913aa39a2d165bd273141143a537189f716947416f6e47cfd0efefc206b08796dcd0e41768b038e11a393d7e8001437e4d0230cdaaa56481455

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0
+ruby-2.1.0

data/TODOS.md

@@ -5,3 +5,5 @@
   * --[no-]api API
 * Add support for multiple signatures for methods
   (realized via the @overload tag in YARD)
+
+* Add message to `inch suggest` when no objects are found

data/lib/inch/api/suggest.rb

@@ -73,7 +73,7 @@ module Inch
 
       def all_filenames(objects)
         codebase.objects.map do |o|
-          o.files.map(&:first)
+          o.files.map(&:filename)
         end.flatten
       end
 

data/lib/inch/cli/command/base.rb

@@ -60,8 +60,9 @@ module Inch
         end
 
         def initialize
-          options_class = "Command::Options::#{self.class.to_s.split('::').last}"
-          @options = eval(options_class).new
+          name = self.class.to_s.split('::').last
+          options_class = Command::Options.const_get(name)
+          @options = options_class.new
           @options.usage = usage
         end
 

data/lib/inch/cli/command/output/base.rb

@@ -28,7 +28,7 @@ module Inch
 
           def print_file_info(o, _color)
             o.files.each do |f|
-              echo "-> #{f[0]}:#{f[1]}".color(_color)
+              echo "-> #{f.filename}:#{f.line_no}".color(_color)
             end
             echo separator
           end

data/lib/inch/cli/command/output/suggest.rb

@@ -30,7 +30,7 @@ module Inch
             @files = files
 
             if objects.empty?
-              # TODO: show hint
+              display_no_objects_hint
             else
               display_list
               display_files
@@ -40,6 +40,10 @@ module Inch
 
           private
 
+          def base_dir
+            "#{Dir.pwd}/"
+          end
+
           def display_distribution
             sparkline = grades_sparkline(@relevant_objects).to_s(' ')
             puts "Grade distribution (undocumented, C, B, A):  " + sparkline
@@ -62,8 +66,9 @@ module Inch
             trace "You might want to look at these files:"
             trace
 
-            files.each do |f|
-              trace edged(FILE_COLOR, f.fullname.color(FILE_COLOR))
+            files.each do |file|
+              filename = file.fullname.gsub(base_dir, '')
+              trace edged(FILE_COLOR, filename.color(FILE_COLOR))
             end
             trace
           end
@@ -84,6 +89,15 @@ module Inch
             end
           end
 
+          def display_no_objects_hint
+            hint = if @options.pedantic
+              "Even by my standards."
+            else
+              "Try --pedantic to be excessively concerned with minor details and rules."
+            end
+            trace "Nothing to suggest.".color(:green) + " #{hint}"
+          end
+
           def min_priority_arrows
             priority_arrows_gte(@options.object_min_priority).join(' ')
           end

data/lib/inch/cli/command/suggest.rb

@@ -8,7 +8,7 @@ module Inch
         register_command_as :suggest, true
 
         def description
-          'Suggests some objects to be doucmented (better)'
+          'Suggests some objects to be documented (better)'
         end
 
         def usage

data/lib/inch/code_object/converter.rb

@@ -70,14 +70,14 @@ module Inch
         attributes = {}
         OBJECT_ATTRIBUTES.each do |name|
           if o.respond_to?(name)
-            attributes[name] = o.method(name).call
+            attributes[name] = o.public_send(name)
           end
         end
         attributes[:parameters] = o.parameters.map do |parameter|
           hash = {}
           PARAMETER_ATTRIBUTES.each do |pname|
             if parameter.respond_to?(pname)
-              hash[pname] = parameter.method(pname).call
+              hash[pname] = parameter.public_send(pname)
             end
           end
           hash

data/lib/inch/code_object/provider.rb

@@ -27,7 +27,7 @@ module Inch
 
       # @return [Module]
       def self.provider_for(type)
-        eval("::Inch::CodeObject::Provider::#{type}")
+        const_get(type)
       end
     end
   end

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

@@ -27,8 +27,8 @@ module Inch
             # @return [Class]
             def class_for(yard_object)
               class_name = yard_object.class.to_s.split('::').last
-              eval("::Inch::CodeObject::Provider::YARD::Object::#{class_name}")
-            rescue
+              const_get(class_name)
+            rescue NameError
               Base
             end
 

data/lib/inch/code_object/proxy.rb

@@ -28,9 +28,7 @@ module Inch
         # @return [Class]
         def class_for(code_object)
           class_name = code_object.class.to_s.split('::').last
-          eval("::Inch::CodeObject::Proxy::#{class_name}")
-        rescue
-          Base
+          const_get(class_name)
         end
 
         # Returns a cache key for the given +code_object+

data/lib/inch/codebase/objects.rb

@@ -21,6 +21,7 @@ module Inch
           proxy
         end
         @list = list
+        index_by_fullname
         # the @list has to be set for the priority sorting
         # since the priority needs the object_lookup, which
         # in turn depends on @list - it's a crazy world
@@ -45,7 +46,7 @@ module Inch
       # @param fullname [String] partial fullname/name of an object
       # @return [CodeObject::Proxy::Base]
       def find(fullname)
-        all.detect { |o| o.fullname == fullname }
+        @by_fullname[fullname]
       end
 
       # Returns all objects where the +fullname+ starts_with the given
@@ -67,6 +68,15 @@ module Inch
       # @return [void]
       def filter!(options)
         @list = ObjectsFilter.new(all, options).objects
+        index_by_fullname
+      end
+
+      private
+
+      def index_by_fullname
+        @by_fullname = @list.map.with_object({}) do |object, index|
+          index[object.fullname] = object
+        end
       end
     end
   end

data/lib/inch/config.rb

@@ -45,7 +45,7 @@ module Inch
       end
 
       def schema(constant_name, &block)
-        constant = eval("::Inch::Evaluation::Proxy::#{constant_name}")
+        constant = ::Inch::Evaluation::Proxy.const_get(constant_name)
         constant.criteria(&block)
       end
     end

data/lib/inch/evaluation.rb

@@ -10,7 +10,7 @@ module Inch
 
     def self.class_for(code_object)
       class_name = code_object.class.to_s.split('::').last
-      eval(class_name)
+      const_get(class_name)
     end
   end
 end

data/lib/inch/evaluation/proxy.rb

@@ -11,7 +11,7 @@ module Inch
 
       def self.class_for(code_object)
         class_name = code_object.class.to_s.split('::').last
-        eval(class_name)
+        const_get(class_name)
       end
     end
   end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.3.0.rc2"
+  VERSION = "0.3.0.rc3"
 end

data/test/fixtures/really_good/lib/foo.rb

@@ -0,0 +1,22 @@
+# Foo is the classical name for a module
+class Foo
+  # A complicated method
+  def complicated
+    # ... snip ...
+  end
+
+  # An example of a method that takes a parameter (+param1+)
+  # and does nothing.
+  #
+  # param1 - The first param
+  #
+  # Returns nil
+  def nothing(param1)
+  end
+
+  private
+
+  def filename
+    "#{self.class}_#{id}.foo"
+  end
+end

data/test/fixtures/really_good_pedantic/lib/foo.rb

@@ -0,0 +1,23 @@
+# Foo is the classical name for a module
+class Foo
+  # A complicated method
+  # @return [void]
+  def complicated
+    # ... snip ...
+  end
+
+  # An example of a method that takes a parameter (+param1+)
+  # and does nothing.
+  #
+  # param1 - The first param
+  #
+  # Returns a String or nil
+  def nothing(param1)
+  end
+
+  private
+
+  def filename
+    "#{self.class}_#{id}.foo"
+  end
+end

data/test/inch/cli/command/suggest_test.rb

@@ -45,7 +45,7 @@ describe ::Inch::CLI::Command::Suggest do
     #assert out.empty?, "there should be no output"
     #assert err.empty?, "there should be no errors"
   end
-  
+
   it "should run with --objects switch" do
     out, err = capture_io do
       @command.run("lib/**/*.rb", "app/**/*.rb", "--objects=30")
@@ -80,4 +80,25 @@ describe ::Inch::CLI::Command::Suggest do
     assert_match /inch\ \d\.\d\.\d/, out
     assert err.empty?, "there should be no errors"
   end
+
+  # Edge case: Really good codebase
+
+  it "should run without args on really good fixture" do
+    out, err = capture_io do
+      Dir.chdir fixture_path(:really_good)
+      @command.run()
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should run with --pedantic switch" do
+    out, err = capture_io do
+      Dir.chdir fixture_path(:really_good)
+      @command.run("--pedantic")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+  end
+
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc2
+  version: 0.3.0.rc3
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
   name: sparkr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
 description: Documentation measurement tool for Ruby, based on YARD.
@@ -116,11 +116,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .simplecov
-- .travis.yml
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -223,6 +223,8 @@ files:
 - lib/inch/version.rb
 - test/fixtures/code_examples/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
@@ -275,23 +277,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby
 test_files:
 - test/fixtures/code_examples/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