inch 0.3.3 → 0.3.4.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9821378d8179a5f3f9c73af1f27d542930d80b34
-  data.tar.gz: 0600851646f8c4138f249f2155f9669b8655bff9
+  metadata.gz: bee5d78b05fdeb0f445662eb4249e8faaa17111e
+  data.tar.gz: 3b2fc21a47176e5dcf8585bd535586d16f6df72f
 SHA512:
-  metadata.gz: 5059edf002b331f60b680c1ce019b984cf468be470a5f58f01310701bd96e54ceadb19a15f45f51251f44bc37605d08b8d9b56e6087b8cea388fda34e0c541b0
-  data.tar.gz: 5325f36677ca63f9ad69046eb1308388639282162baae7b16abcf78082e22cf116aa92f59703cf5a2302443629fbdef494c0a7b754db5b5e3b4c639708c8b7c1
+  metadata.gz: 04a14a7a0cae1fc250381a3da92626e0149f32dd1ab2f614db0ac522f0e1b4a26ac39af5bbb3acb403c29f7b90c95a6941f3bee8a517d97e0b5ab69ee754c142
+  data.tar.gz: 6a8a0ec1621b7ea8ec9543514520ab8dabfae9ded1c483aa845a13aa78224c3ba4edebf266ec442075b721a629dfb421ced96169a580ecfbde8698ba47983455

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.inch
 .yardoc
 Gemfile.lock
 InstalledFiles

data/CHANGELOG.md

@@ -0,0 +1,109 @@
+# Changelog
+
+## 0.3.3
+
+- Fix rake task
+- Remove unused constant
+- Add support for overload tag
+- Add failing test re: method overloading
+- Update README with configuration instructions
+
+
+## 0.3.2
+
+- Fix bug when parsing .inch.yml
+- Separate test suite in unit and integration tests
+- Support regexes in .inch.yml
+- Add some basic ideas for .inch.yml support
+- Speed up tests by caching code objects
+
+
+## 0.3.1
+
+- Fix error with empty docstring
+- Do not count @raise tag if it is auto-assigned via YARD
+- Add a role to encapsulate notations of private tags
+- Update Docstring to detect internal apis
+- Fix output of priority arrows in Suggest command
+- Use original docstring to determine if an object is undocumented?
+- Fix things complained about in last commit
+- Exclude failing test
+- Don't apply transitive :since tag to children's evaluation
+- Fix bug in YARD method object proxy
+- Fix wrong detection of splat and block parameters
+- Fix 1.9.3 compatibility of Inch::Utils::UI
+- Fix #depth method
+- Add Inch::Utils::UI utility class
+- Cache some repeatedly calculated values
+
+
+## 0.3.0
+
+- Add proxy for RootObject to YARD object provider
+- Ignore some YARD code objects by type
+- Remove YARD from core_ext
+- Fix bug showing wrong paths instead of files in Suggest
+- Ensure output if Suggest has nothing to suggest
+- Merge pull request #5 from splattael/perf
+- Upgrade to Ruby 2.1 as default
+- Prefer `Module#const_get(class_name)` over `eval(class_name)`
+- Prefer `public_send(name)` over `method(name).call`
+- Perf: Index codeobjects objects by fullname
+- Merge pull request #4 from jimjeffers/master
+- Fixed minor typo in CLI for suggest command.
+- Require 'forwardable' at the very top
+- Add fix for failing test
+- Add failing test fixture
+- Refactor Evaluation namespace
+- Add doc to ObjectsFilter
+- Add CodeObject::Provider modules
+- Rewrite Evaluation Role model
+- Add some more docs
+- Extract shared specs into own file
+- Depend on minitest ~> 5.2
+- Merge pull request #3 from splattael/simplecov
+- Add docs to ReadWriteMethods
+- Move simplecov's configuration into own file
+- Add tests for new API classes
+- Rename Evaluation::WeightedList -> Utils::WeightedList
+- Fix description of stats command
+- Add PriorityRange
+- Refactor inspect/show output
+- Introduce API namespace
+- Fix wrong command registration in Command::Inspect
+- Add Codebase::ObjectsFilter
+- Update commands to use Codebase
+- Introduce Codebase namespace
+- Remove unused method alias
+- Fix bug in Docstring
+
+
+## 0.2.3
+
+- Bump version
+- Rescue error raised by YARD
+- Let Command classes register themselves in CommandParser
+- Fix failing tests (typo)
+- Refactor some more methods
+- Refactor complex methods
+- Add Getter and Setter roles
+- Refactor ScoreRanges into GradeLists
+- Add Inch::Config
+- Rename Evaluation::Criteria -> ObjectSchema
+- Add weighted_list for suggest output
+- Make CodeObject::Proxy#object an attr_reader
+
+
+## 0.2.2
+
+- Fix bug related to private @api tags (again)
+
+
+## 0.2.1
+
+- Fix bug related to private @api tags
+
+
+## 0.2.0
+
+- First public release

data/inch.gemspec

@@ -13,12 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://trivelop.de/inch/"
   spec.license       = "MIT"
 
-  all_files = `git ls-files -z`.split("\x0")
-  files_without_dev_commands = all_files.select do |f|
-    f !~ /cli\/command\/.*(console|inspect)/
-  end
-
-  spec.files         = files_without_dev_commands
+  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.require_paths = ["lib"]

data/lib/inch/cli.rb

@@ -26,9 +26,3 @@ require_relative 'cli/trace_helper'
 require_relative 'cli/yardopts_helper'
 
 require_relative 'cli/command'
-
-console_rb = File.join(File.dirname(__FILE__), 'cli', 'command', 'console.rb')
-if File.exists?(console_rb)
-  require_relative 'cli/command/console'
-  require_relative 'cli/command/inspect'
-end

data/lib/inch/cli/command.rb

@@ -14,3 +14,5 @@ require_relative 'command/list'
 require_relative 'command/show'
 require_relative 'command/stats'
 require_relative 'command/suggest'
+require_relative 'command/console'
+require_relative 'command/inspect'

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

@@ -0,0 +1,26 @@
+require 'pry'
+require_relative 'options/console'
+require_relative 'output/console'
+
+module Inch
+  module CLI
+    module Command
+      class Console < BaseObject
+        register_command_as :console
+
+        def description
+          'Shows a console'
+        end
+
+        def usage
+          'Usage: inch console [paths] [OBJECT_NAME] [options]'
+        end
+
+        def run(*args)
+          prepare_objects(*args)
+          Output::Console.new(@options, @object, @objects, codebase)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative 'options/inspect'
+require_relative 'output/inspect'
+
+module Inch
+  module CLI
+    module Command
+      class Inspect < BaseObject
+        register_command_as :inspect
+
+        def description
+          'Inspects an object'
+        end
+
+        def usage
+          'Usage: inch inspect [paths] OBJECT_NAME [[OBJECT_NAME2] ...] [options]'
+        end
+
+        def run(*args)
+          prepare_objects(*args)
+          Output::Inspect.new(@options, objects)
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/console.rb

@@ -0,0 +1,26 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Console < BaseObject
+          def descriptions
+            [
+              "",
+              "Provides a PRY based REPL to inspect objects.",
+              "",
+              "Example: " + "$ inch console lib/**/*.rb Foo::Bar#initialize".cyan,
+              "",
+              "Shortcut commands on the prompt are:",
+              "",
+              "all".ljust(5) + " returns all code objects",
+              "f".ljust(5) + " finds an object by its path",
+              "ff".ljust(5) + " finds all objects given a partial path",
+              "o".ljust(5) + " returns the code object for OBJECT_NAME (if present)",
+            ]
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/inspect.rb

@@ -0,0 +1,25 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Inspect < BaseObject
+
+          def descriptions
+            [
+              "",
+              "Example: " + "$ inch inspect lib/**/*.rb Foo::Bar#initialize".cyan,
+              "",
+              "Shows one or more objects in detail."
+            ]
+          end
+
+          def verify
+            if object_names.empty?
+              kill # "Provide a name to an object to show it's evaluation."
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Inch
+  module CLI
+    module Command
+      module Output
+        class Console < Base
+          extend Forwardable
+
+          attr_reader :object, :objects, :codebase
+
+          COLOR = :color198     # magenta-ish
+          BG_COLOR = :color207  # magenta-ish
+
+          # @param options [Options::Console]
+          # @param object [CodeObject::Proxy::Base]
+          # @param objects [Array<CodeObject::Proxy::Base>]
+          # @param codebase [Codebase::Proxy]
+          def initialize(options, object, objects, codebase)
+            @options = options
+            @object = object
+            @objects = objects
+            @codebase = codebase
+
+            run
+          end
+
+          def all_objects
+            @codebase.objects.all
+          end
+
+          def find_objects(fullname)
+            @codebase.objects.starting_with(fullname)
+          end
+
+          def find_object(fullname)
+            @codebase.objects.find(fullname)
+          end
+
+          alias :all :all_objects
+          alias :ff :find_objects
+          alias :f :find_object
+          alias :o :object
+
+
+          def run
+            ui.trace
+            ui.header("Welcome to Inch's console", COLOR, BG_COLOR)
+            ui.sub @options.usage
+            @options.descriptions.each do |line|
+              ui.sub line
+            end
+            run_pry
+          end
+
+          def run_pry
+            binding.pry
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+module Inch
+  module CLI
+    module Command
+      module Output
+        class Inspect < Base
+          attr_reader :objects
+
+          COLOR = :color198     # magenta-ish
+          BG_COLOR = :color207  # magenta-ish
+          LJUST = 20
+
+          def initialize(options, objects)
+            @options = options
+            @objects = objects
+
+            display_objects
+          end
+
+          private
+
+          def display_objects
+            objects.each do |o|
+              print_object(o)
+            end
+          end
+
+          def print_object(o)
+            ui.trace
+            ui.header(o.fullname, COLOR, BG_COLOR)
+
+            print_file_info(o, COLOR)
+            print_code_info(o)
+            print_namespace_info(o)
+            print_roles_info(o)
+
+            print_score_summary(o)
+          end
+
+          def print_score_summary(o)
+            min = o.evaluation.min_score
+            max = o.evaluation.max_score
+            echo "Score (min: #{min}, max: #{max})".ljust(40) +
+                  "#{o.score.to_i}".rjust(5) + "#{o.priority.to_i}".rjust(4)
+            echo
+          end
+
+          def print_code_info(o)
+            if o.method?
+              CommentAndAbbrevSource.new(o).lines.each do |line|
+                echo line.gsub(/\n$/m, '').dark
+              end
+              echo separator
+            end
+          end
+
+          def print_roles_info(o)
+            if o.roles.empty?
+              echo "No roles assigned.".dark
+            else
+              o.roles.each do |role|
+                print_role_info(role)
+              end
+            end
+            echo separator
+          end
+
+          def print_role_info(role)
+            name = role.class.to_s.split('::Role::').last
+            score = colored_role_score(role)
+
+            priority = role.priority.to_s.rjust(4)
+            if role.priority == 0
+              priority = priority.dark
+            end
+
+            echo name.ljust(40) + score + priority
+            print_min_max_score(role)
+          end
+
+          def print_min_max_score(role)
+            if role.max_score
+              echo "  (set max score to #{role.max_score})"
+            elsif role.min_score
+              echo "  (set min score to #{role.min_score})"
+            end
+          end
+
+          def print_namespace_info(o)
+            if o.namespace?
+              echo "Children:"
+              o.children.each do |child|
+                echo "+ " + child.fullname.color(COLOR)
+              end
+              echo separator
+            end
+          end
+
+          def colored_role_score(role)
+            if role.potential_score
+              "(#{role.potential_score.to_i})".rjust(5).yellow.dark
+            else
+              value = role.score.to_i
+              colored_score value, value.abs.to_s.rjust(4)
+            end
+          end
+
+          def colored_score(value, score)
+            if value < 0
+              ("-" + score).red
+            elsif value > 0
+              ("+" + score).green
+            else
+              " " + score
+            end
+          end
+
+          def echo(msg = "")
+            ui.edged(COLOR, msg)
+          end
+
+          def separator
+            "-".color(COLOR) * (CLI::COLUMNS - 2)
+          end
+
+          class CommentAndAbbrevSource < Struct.new(:code_object)
+            extend Forwardable
+
+            def_delegators :code_object, :source, :files
+
+            def lines
+              to_s.lines
+            end
+
+            def to_s
+              comments.join('') + abbrev_source
+            end
+
+            private
+
+            def abbrev_source
+              lines = code_object.source.to_s.lines.to_a
+              if lines.size >= 5
+                indent = lines[1].scan(/^(\s+)/).flatten.join('')
+                lines = lines[0..1] +
+                        ["#{indent}# ... snip ...\n"] +
+                        lines[-2..-1]
+              end
+              lines.join('')
+            end
+
+            def comments
+              @comments ||= code_object.files.map do |declaration|
+                get_lines_up_while(declaration.filename, declaration.line_no - 1) do |line|
+                  line =~ /^\s*#/
+                end.flatten.join('')
+              end
+            end
+
+            def get_lines_up_while(filename, line_no, &block)
+              lines = []
+              line = get_line_no(filename, line_no)
+              if yield(line) && line_no > 0
+                lines << line.gsub(/^(\s+)/, '')
+                lines << get_lines_up_while(filename, line_no - 1, &block)
+              end
+              lines.reverse
+            end
+
+            # Returns a +line_number+ from a file
+            #
+            # @param filename [String]
+            # @param line_number [Fixnum]
+            # @return [String]
+            def get_line_no(filename, line_number)
+              f = File.open(filename)
+              line_number.times{f.gets}
+              result = $_
+              f.close
+              result
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/code_object/converter.rb

@@ -16,6 +16,8 @@ module Inch
         parent_fullname
 
         api_tag?
+        aliased_object_fullname
+        aliases_fullnames
         attributes
         bang_name?
         constant?
@@ -23,7 +25,6 @@ module Inch
         depth
         docstring
         getter?
-        has_alias?
         has_children?
         has_code_example?
         has_doc?

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

@@ -6,6 +6,10 @@ module Inch
         #
         module Object
           class << self
+            def clear_cache
+              @cache = {}
+            end
+
             # Returns a Proxy object for the given +yard_object+
             #
             # @param yard_object [YARD::CodeObject]

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

@@ -30,6 +30,16 @@ module Inch
               @__private_tag = __private_tag
             end
 
+            # Returns the fullname of the object that the current object
+            # is an alias for
+            attr_accessor :aliased_object_fullname
+
+            # Returns the fullnames of the objects that are aliases
+            # for the current object
+            def aliases_fullnames
+              []
+            end
+
             def api_tag?
               !api_tag.nil?
             end
@@ -104,10 +114,6 @@ module Inch
               @name ||= object.name
             end
 
-            def has_alias?
-              false
-            end
-
             def has_children?
               !children.empty?
             end

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

@@ -5,15 +5,18 @@ module Inch
         module Object
           # Proxy class for methods
           class MethodObject < Base
-
-            def constructor?
-              name == :initialize
+            def aliases_fullnames
+              object.aliases.map(&:path)
             end
 
             def bang_name?
               name =~ /\!$/
             end
 
+            def constructor?
+              name == :initialize
+            end
+
             def getter?
               attr_info = object.attr_info || {}
               read_info = attr_info[:read]
@@ -28,10 +31,6 @@ module Inch
               super && !implicit_docstring?
             end
 
-            def has_alias?
-              !object.aliases.empty?
-            end
-
             def method?
               true
             end

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

@@ -37,6 +37,7 @@ module Inch
           private
 
           def parse_yard_objects(paths, excluded)
+            YARD::Object.clear_cache
             ::YARD::Registry.clear
             ::YARD.parse(paths, excluded)
           end
@@ -44,6 +45,11 @@ module Inch
           def inject_base_dir(dir)
             objects.each do |object|
               object.base_dir = dir
+
+              object.aliases_fullnames.each do |fullname|
+                _alias = objects.detect { |o| o.fullname == fullname }
+                _alias.aliased_object_fullname = object.fullname
+              end
             end
           end
 

data/lib/inch/code_object/proxy.rb

@@ -10,14 +10,8 @@ module Inch
         # @param code_object [YARD::Object::Base]
         # @return [CodeObject::Proxy::Base]
         def for(code_object)
-          @cache ||= {}
-          if proxy_object = @cache[cache_key(code_object)]
-            proxy_object
-          else
-            attributes = Converter.to_hash(code_object)
-            proxy_object = class_for(code_object).new(attributes)
-            @cache[cache_key(code_object)] = proxy_object
-          end
+          attributes = Converter.to_hash(code_object)
+          proxy_object = class_for(code_object).new(attributes)
         end
 
         private
@@ -30,13 +24,6 @@ module Inch
           class_name = code_object.class.to_s.split('::').last
           const_get(class_name)
         end
-
-        # Returns a cache key for the given +code_object+
-        #
-        # @return [String]
-        def cache_key(code_object)
-          code_object.fullname
-        end
       end
     end
   end

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

@@ -3,11 +3,15 @@ require 'forwardable'
 module Inch
   module CodeObject
     module Proxy
+      # This is the base class for code object proxies.
+      # Code object proxies are via an attributes Hash and provide all methods
+      # necessary for the evaluation of its documentation.
+      #
       # @abstract
       class Base
         extend Forwardable
 
-        # @return [Symbol]
+        # @return [Grade]
         #   when objects are assigned to GradeLists, this grade is set to
         #   enable easier querying for objects of a certain grade
         attr_writer :grade
@@ -43,6 +47,16 @@ module Inch
               }.grade
         end
 
+        # @return [Boolean] if the current object is an alias for something else
+        def alias?
+          !aliased_object.nil?
+        end
+
+        # @return [CodeObject::Proxy::Base] the object the current object is an alias of
+        def aliased_object
+          object_lookup.find( self[:aliased_object_fullname] )
+        end
+
         # @return [Boolean] +true+ if the object has an @api tag
         def api_tag?
           self[:api_tag?]
@@ -61,7 +75,7 @@ module Inch
         end
 
         def core?
-          self[:api_tag?]
+          self[:core?]
         end
 
         # The depth of the following is 4:
@@ -110,7 +124,7 @@ module Inch
         end
 
         def has_alias?
-          self[:has_alias?]
+          !self[:aliases_fullnames].empty?
         end
 
         def has_children?
@@ -152,7 +166,7 @@ module Inch
           self[:nodoc?]
         end
 
-        # @return [Array,nil] the parent of the current object or +nil+
+        # @return [CodeObject::Proxy::Base,nil] the parent of the current object or +nil+
         def parent
           object_lookup.find( self[:parent_fullname] )
         end

data/lib/inch/evaluation/grade.rb

@@ -1,5 +1,7 @@
 module Inch
   module Evaluation
+    # Grades are human-friendly representations of scores.
+    #
     class Grade
       extend Utils::ReadWriteMethods
 
@@ -9,14 +11,20 @@ module Inch
         @symbol = symbol
       end
 
+      # Updates the grade's configuration with the given block
+      #
+      # @param block [Proc]
+      # @return [void]
       def update(&block)
         instance_eval(&block)
       end
 
+      # @return [Symbol] the grade as a symbol (e.g. +:A+)
       def to_sym
         @symbol
       end
 
+      # @return [String] the grade as a string (e.g. "A")
       def to_s
         @symbol.to_s
       end

data/lib/inch/evaluation/proxy/base.rb

@@ -11,8 +11,6 @@ module Inch
         # @return [CodeObject::Proxy::Base]
         attr_accessor :object
 
-        attr_reader :min_score, :max_score
-
         class << self
           attr_reader :criteria_map
 
@@ -103,6 +101,7 @@ module Inch
             Role::Object::TaggedAsAPI => nil,
             Role::Object::TaggedAsInternalAPI => nil,
             Role::Object::TaggedAsPrivate => nil,
+            Role::Object::Alias => object.alias? ? object.aliased_object.score : nil,
           }
         end
 

data/lib/inch/evaluation/role/object.rb

@@ -3,6 +3,18 @@ module Inch
     module Role
       # Roles assigned to all objects
       module Object
+        # Role assigned to objects that are aliases.
+        #
+        class Alias < Base
+          applicable_if :alias?
+
+          def priority
+            # not sure about this yet,
+            # but aliases should not show up high in the reports
+            -7
+          end
+        end
+
         # Role assigned to objects with a describing comment (docstring)
         class WithDoc < Base
           applicable_if :has_doc?

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.3.3"
+  VERSION = "0.3.4.rc1"
 end

data/test/fixtures/simple/lib/role_methods.rb

@@ -95,7 +95,6 @@ module InchTest
   def public_method
   end
 
-
   def protected_method
   end
   protected :protected_method
@@ -119,4 +118,10 @@ module InchTest
   # Private: Normalize the filename.
   def private_method_with_tomdoc
   end
+
+  # @return [Boolean] something funny
+  def _aliased_method
+  end
+  alias _alias_method _aliased_method
+
 end

data/test/integration/cli/command/console_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+class Inch::CLI::Command::Output::Console
+  def run_pry
+    nil # instead of binding.pry
+  end
+end
+
+describe ::Inch::CLI::Command::Console do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Console
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--help") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+console/, out
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should run without args" do
+    out, err = capture_io do
+      @prompt = @command.new.run()
+    end
+    assert @prompt.respond_to?(:all)
+    assert @prompt.respond_to?(:ff)
+    assert @prompt.respond_to?(:f)
+    assert @prompt.respond_to?(:o)
+    assert @prompt.o.nil?
+    assert @prompt.objects.empty?
+  end
+
+  it "should run with a definitive object name" do
+    out, err = capture_io do
+      @prompt = @command.new.run("Foo::Bar#method_with_full_doc")
+    end
+    assert !@prompt.all.empty?
+    assert !@prompt.ff("Foo::Bar#").empty?
+    assert !@prompt.f("Foo::Bar").nil?
+    assert !@prompt.o.nil?
+    refute @prompt.o.nil?
+    assert_equal 1, @prompt.objects.size
+  end
+
+  it "should run with a partial name" do
+    out, err = capture_io do
+      @prompt = @command.new.run("Foo::Bar#")
+    end
+    assert @prompt.respond_to?(:all)
+    assert @prompt.respond_to?(:ff)
+    assert @prompt.respond_to?(:f)
+    assert @prompt.respond_to?(:o)
+    refute @prompt.o.nil?
+    assert @prompt.objects.size > 1
+  end
+end

data/test/integration/cli/command/inspect_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::CLI::Command::Inspect do
+  before do
+    Dir.chdir fixture_path(:simple)
+    @command = ::Inch::CLI::Command::Inspect
+  end
+
+  it "should warn and exit when run without args" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run() }
+    end
+    assert out.empty?, "there should be no output"
+    refute err.empty?, "there should be some error message"
+  end
+
+  it "should output info when run with --help" do
+    out, err = capture_io do
+      assert_raises(SystemExit) { @command.run("--help") }
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bUsage\b.+inspect/, out
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output some info when run with a definitive object name" do
+    out, err = capture_io do
+      @command.run("Foo::Bar#method_with_full_doc", "--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    refute_match(/\b Foo::Bar#method_without_doc\b/, out)
+    assert err.empty?, "there should be no errors"
+  end
+
+
+  it "should output some info when run with a definitive object name" do
+    out, err = capture_io do
+      @command.run("Foo::Qux")
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output all children info when run with a partial name" do
+    out, err = capture_io do
+      @command.run("Foo::Bar#", "--no-color")
+    end
+    refute out.empty?, "there should be some output"
+    assert_match /\bFoo::Bar#method_without_doc\b/, out
+    assert_match /\bFoo::Bar#method_with_full_doc\b/, out
+    assert err.empty?, "there should be no errors"
+  end
+
+  it "should output colored information" do
+    out, err = capture_io do
+      @command.run("Foo::Bar#")
+    end
+    refute_equal out.uncolor, out, "should be colored"
+  end
+
+  it "should output uncolored information when asked" do
+    out, err = capture_io do
+      @command.run("Foo::Bar#", "--no-color")
+    end
+    assert_equal out.uncolor, out, "should not be colored"
+  end
+end

data/test/unit/code_object/proxy/method_object_test.rb

@@ -264,6 +264,12 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert_equal m1.score, m2.score
   end
 
+  def test_alias_method
+    m1 = @objects.find("InchTest#_aliased_method")
+    m2 = @objects.find("InchTest#_alias_method")
+    assert_equal m1.score, m2.score
+  end
+
   def test_overloading1
     list = []
     list << @objects.find("Overloading#rgb")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - ".ruby-version"
 - ".simplecov"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -146,15 +147,21 @@ files:
 - lib/inch/cli/command/base.rb
 - lib/inch/cli/command/base_list.rb
 - lib/inch/cli/command/base_object.rb
+- lib/inch/cli/command/console.rb
+- lib/inch/cli/command/inspect.rb
 - lib/inch/cli/command/list.rb
 - lib/inch/cli/command/options/base.rb
 - lib/inch/cli/command/options/base_list.rb
 - lib/inch/cli/command/options/base_object.rb
+- lib/inch/cli/command/options/console.rb
+- lib/inch/cli/command/options/inspect.rb
 - lib/inch/cli/command/options/list.rb
 - lib/inch/cli/command/options/show.rb
 - lib/inch/cli/command/options/stats.rb
 - lib/inch/cli/command/options/suggest.rb
 - lib/inch/cli/command/output/base.rb
+- lib/inch/cli/command/output/console.rb
+- lib/inch/cli/command/output/inspect.rb
 - lib/inch/cli/command/output/list.rb
 - lib/inch/cli/command/output/show.rb
 - lib/inch/cli/command/output/stats.rb
@@ -242,6 +249,8 @@ files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
+- test/integration/cli/command/console_test.rb
+- test/integration/cli/command/inspect_test.rb
 - test/integration/cli/command/list_test.rb
 - test/integration/cli/command/show_test.rb
 - test/integration/cli/command/stats_test.rb
@@ -292,9 +301,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -319,6 +328,8 @@ test_files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
+- test/integration/cli/command/console_test.rb
+- test/integration/cli/command/inspect_test.rb
 - test/integration/cli/command/list_test.rb
 - test/integration/cli/command/show_test.rb
 - test/integration/cli/command/stats_test.rb