inch 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 252dd36f4749f380d6f1a5c6c78ebf39cbb6a02b
-  data.tar.gz: 189e4afb63928cfda6dceab1f855b8633a5490d7
+  metadata.gz: ac5ffa0638f44fe70c196dd422392a913745cc95
+  data.tar.gz: 23f1ce2ebdcd812be31f6bb530406c81518b2cbf
 SHA512:
-  metadata.gz: 41efced3e37aac30b9a83ce7c278f0ea2e35d952f087242e24c11a59c2ad8ec8d4dd4a565023d8350c462afc46d21258478ce475c83bcf5cc4fe6126583fde3d
-  data.tar.gz: 4f5b2baba065d521af008bffeaa1f911e0d54024865fa31c5167bf9a677aa42863a20231c7e52c9dbab55f51710babfd6951f3b16aabc57480555c740a2cb9ed
+  metadata.gz: 63f0021f750e0cfe86042fc54d668ccaccdee94cf240f8f39670ab5707f335bce7dca7798bb33f47e870b83c983c682c66590c975fbff2df34f09b86a1afb559
+  data.tar.gz: 80c5d8393b89fc3296f1f43873d30ac6069ce144b8369042d8a76f0f8b8630d570afe6bd5cb0d91fec23287173e9fe16f12ff551219449703f276aab12c1129a

data/README.md

@@ -1,10 +1,12 @@
 # Inch
 
+[![Build Status](https://travis-ci.org/rrrene/inch.png)](https://travis-ci.org/rrrene/inch)
+
 Inch is a documentation measurement tool for Ruby, based on
 [YARD](http://yardoc.org/).
 
-It does not measure *coverage*, but grades your documentation to give you
-hints where to improve your docs. One Inch at a time.
+It does not measure *coverage*, but gives you hints where to improve your
+docs. One Inch at a time.
 
 
 ## Installation

data/TODOS.md

@@ -7,4 +7,3 @@
   visibility options
 * Add support for multiple signatures for methods
   (realized via the @overload tag in YARD)
-* Make `inch lib/optparse.rb` work (without explicit `suggest`)

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

@@ -55,12 +55,12 @@ module Inch
             f = Evaluation::File.for(filename, relevant_objects)
           end
 
-          list = list.select do |f|
+          priority_list = list.select do |f|
             relevant_grades.include?(f.grade) &&
               relevant_priorities.include?(f.priority)
           end
 
-          sort_by_priority(list)
+          sort_by_priority(priority_list.empty? ? list : priority_list)
         end
 
         def all_filenames(objects)
@@ -97,7 +97,6 @@ module Inch
         def select_by_priority(list, min_priority)
           list.select { |o| o.priority >= min_priority }
         end
-
       end
     end
   end

data/lib/inch/cli/command_parser.rb

@@ -6,9 +6,7 @@ module Inch
     #
     #   $ inch command_name [options]
     #
-    # If no command or arguments are specified, or if the arguments immediately
-    # begin with a +--opt+ (not +--help+), the {default_command} will be used
-    # (which itself defaults to +:doc+).
+    # If no command_name is specified, the {default_command} will be used.
     #
     class CommandParser
       include TraceHelper
@@ -48,18 +46,11 @@ module Inch
       # argument.
       # @return [void]
       def run(*args)
-        unless ['--help', '-h'].include?(args.join)
-          if args.size == 0 || args.first =~ /^-/
-            command_name = self.class.default_command
-          else
-            command_name = args.first.to_sym
-            args.shift
-          end
-          if commands.has_key?(command_name)
-            return commands[command_name].run(*args)
-          end
+        if ['--help', '-h'].include?(args.join)
+          list_commands
+        else
+          run_command(*args)
         end
-        list_commands
       end
 
       private
@@ -77,6 +68,23 @@ module Inch
           trace "  %-8s %s" % [command_name, command.description]
         end
       end
+
+      def run_command(*args)
+        if args.empty?
+          command_name = self.class.default_command
+        else
+          possible_command_name = args.first.to_sym
+
+          if commands.has_key?(possible_command_name)
+            command_name = possible_command_name
+            args.shift
+          else
+            command_name = self.class.default_command
+          end
+        end
+
+        commands[command_name].run(*args)
+      end
     end
   end
 end

data/lib/inch/cli/trace_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Inch
   module CLI
     module TraceHelper

data/lib/inch/code_object/docstring.rb

@@ -30,11 +30,11 @@ module Inch
       end
 
       def mentions_return?
-        @text.lines.last =~ /^Returns\ /
+        @text.lines.to_a.last =~ /^Returns\ /
       end
 
       def describes_return?
-        @text.lines.last =~ /^Returns\ (\w+\s){2,}/
+        @text.lines.to_a.last =~ /^Returns\ (\w+\s){2,}/
       end
 
       def parse_code_examples

data/lib/inch/code_object/proxy/method_object.rb

@@ -75,7 +75,7 @@ module Inch
         end
 
         def abbrev_source
-          lines = object.source.to_s.lines
+          lines = object.source.to_s.lines.to_a
           if lines.size >= 5
             indent = lines[1].scan(/^(\s+)/).flatten.join('')
             lines = lines[0..1] +

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

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

@@ -45,6 +45,12 @@ 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 give error when run with --unknown-switch" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--unknown-switch") }
+    end
+  end
 
   it "should output info when run with --help" do
     out, err = capture_io do
@@ -54,4 +60,13 @@ describe ::Inch::CLI::Command::Suggest do
     assert_match /\bUsage\b.+suggest/, out
     assert err.empty?, "there should be no errors"
   end
+
+  it "should output version when run with --version" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--version") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /inch\ \d\.\d\.\d/, out
+    assert err.empty?, "there should be no errors"
+  end
 end

data/test/inch/cli/command_parser_test.rb

@@ -3,28 +3,66 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 describe ::Inch::CLI::CommandParser do
   before do
     Dir.chdir fixture_path(:simple)
-    @command = ::Inch::CLI::CommandParser
+    @command_parser = ::Inch::CLI::CommandParser
   end
 
   it "should run without args" do
     out, err = capture_io do
-      @command.run()
+      @command = @command_parser.run()
     end
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
+    assert_equal ::Inch::CLI::Command::Suggest, @command.class
   end
 
   it "should run Command::Suggest with filelist in args" do
     out, err = capture_io do
-      @command.run("suggest", "lib/**/*.rb", "app/**/*.rb")
+      @command = @command_parser.run("suggest", "lib/**/*.rb", "app/**/*.rb")
     end
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
+    assert_equal ::Inch::CLI::Command::Suggest, @command.class
+  end
+
+  it "should run Command::Suggest with only filelist in args" do
+    out, err = capture_io do
+      @command = @command_parser.run("lib/**/*.rb", "app/**/*.rb")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_equal ::Inch::CLI::Command::Suggest, @command.class
+  end
+
+  it "should run Command::Suggest with only switches in args" do
+    out, err = capture_io do
+      @command = @command_parser.run("--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_equal ::Inch::CLI::Command::Suggest, @command.class
+  end
+
+  it "should run Command::List with filelist in args" do
+    out, err = capture_io do
+      @command = @command_parser.run("list", "lib/**/*.rb", "app/**/*.rb")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_equal ::Inch::CLI::Command::List, @command.class
+  end
+
+  it "should run Command::Show with filelist in args" do
+    out, err = capture_io do
+      @command = @command_parser.run("show", "Foo")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_equal ::Inch::CLI::Command::Show, @command.class
   end
 
   it "should output info when run with --help" do
     out, err = capture_io do
-      @command.run("--help")
+      @command = @command_parser.run("--help")
     end
     refute out.empty?, "there should be some output"
     assert_match /\bUsage\b.+inch/, out

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler