inch 0.1.4 → 0.2.0

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

@@ -1,25 +0,0 @@
-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

@@ -1,49 +0,0 @@
-module Inch
-  module CLI
-    module Command
-      module Output
-        class Console < Base
-          extend Forwardable
-
-          attr_reader :object, :objects, :source_parser
-
-          def_delegators :source_parser, :all_objects, :find_object, :find_objects
-          alias :all :all_objects
-          alias :ff :find_objects
-          alias :f :find_object
-          alias :o :object
-
-          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 source_parser [SourceParser]
-          def initialize(options, object, objects, source_parser)
-            @options = options
-            @object = object
-            @objects = objects
-            @source_parser = source_parser
-
-            run
-          end
-
-          def run
-            trace
-            trace_header("Welcome to Inch's console", COLOR, BG_COLOR)
-            trace edged(COLOR, @options.usage)
-            @options.descriptions.each do |line|
-              trace edged(COLOR, line)
-            end
-            run_pry
-          end
-
-          def run_pry
-            binding.pry
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,129 +0,0 @@
-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)
-            trace
-            trace_header(o.path, COLOR, BG_COLOR)
-
-            print_file_info(o)
-            print_code_info(o)
-            print_doc_info(o)
-            print_namespace_info(o)
-            print_roles_info(o)
-
-            echo "Score (min: #{o.evaluation.min_score}, max: #{o.evaluation.max_score})".ljust(40) + "#{o.score.to_i}".rjust(5) + "#{o.priority.to_i}".rjust(4)
-            echo
-          end
-
-          def print_file_info(o)
-            o.files.each do |f|
-              echo "-> #{f[0]}:#{f[1]}".color(COLOR)
-            end
-            echo separator
-          end
-
-          def print_code_info(o)
-            if o.method?
-              o.comment_and_abbrev_source.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|
-                name = role.class.to_s.split('::Role::').last
-                if role.potential_score
-                  score = "(#{role.potential_score.to_i})".rjust(5).yellow.dark
-                else
-                  value = role.score.to_i
-                  score = value.abs.to_s.rjust(4)
-                  if value < 0
-                    score = ("-" + score).red
-                  elsif value > 0
-                    score = ("+" + score).green
-                  else
-                    score = " " + score
-                  end
-                end
-                priority = role.priority.to_s.rjust(4)
-                if role.priority == 0
-                  priority = priority.dark
-                end
-                echo name.ljust(40) + score + priority
-                if role.max_score
-                  echo "  (set max score to #{role.max_score})"
-                end
-                if role.min_score
-                  echo "  (set min score to #{role.min_score})"
-                end
-              end
-            end
-            echo separator
-          end
-
-          def print_doc_info(o)
-            if o.nodoc?
-              echo "The object was tagged not to be documented.".yellow
-            else
-              echo "Docstring".ljust(LJUST) + "#{o.has_doc? ? 'Yes' : 'No text'}"
-              if o.method?
-                echo "Parameters:".ljust(LJUST) + "#{o.has_parameters? ? '' : 'No parameters'}"
-                o.parameters.each do |p|
-                  echo "  " + p.name.ljust(LJUST-2) + "#{p.mentioned? ? 'Mentioned' : 'No text'} / #{p.typed? ? 'Typed' : 'Not typed'} / #{p.described? ? 'Described' : 'Not described'}"
-                end
-                echo "Return type:".ljust(LJUST) + "#{o.return_mentioned? ? 'Defined' : 'Not defined'}"
-              end
-            end
-            echo separator
-          end
-
-          def print_namespace_info(o)
-            if o.namespace?
-              echo "Children:"
-              o.children.each do |child|
-                echo "+ " + child.path.color(COLOR)
-              end
-              echo separator
-            end
-          end
-
-          def echo(msg = "")
-            trace edged(COLOR, msg)
-          end
-
-          def separator
-            "-".color(COLOR) * (CLI::COLUMNS - 2)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-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.respond_to?(:all)
-    assert @prompt.respond_to?(:ff)
-    assert @prompt.respond_to?(:f)
-    assert @prompt.respond_to?(:o)
-    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/inch/cli/command/inspect_test.rb

@@ -1,68 +0,0 @@
-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