irbtools 3.0.5 → 4.0.1

data/Rakefile

@@ -11,27 +11,19 @@ def gemspec2
   @gemspec2 ||= eval(File.read('irbtools.gemspec'), binding, 'irbtools.gemspec')
 end
 
-def gemspec3
-  @gemspec3 ||= eval(File.read('irbtools-more.gemspec'), binding, 'irbtools-more.gemspec')
-end
-
 desc "Build the gems"
 task :gem => :gemspec do
   sh "gem build #{gemspec2.name}.gemspec"
-  sh "gem build #{gemspec3.name}.gemspec"
   FileUtils.mkdir_p 'pkg'
   FileUtils.mv "#{gemspec2.name}-#{gemspec2.version}.gem", 'pkg'
-  FileUtils.mv "#{gemspec3.name}-#{gemspec3.version}.gem", 'pkg'
 end
 
 desc "Install the gem locally (without docs)"
 task :install => :gem do
   sh %{gem install pkg/#{gemspec2.name}-#{gemspec2.version}.gem --no-document}
-  sh %{gem install pkg/#{gemspec3.name}-#{gemspec3.version}.gem --no-document}
 end
 
 desc "Validate the gemspec"
 task :gemspec do
   gemspec2.validate
-  gemspec3.validate
 end

data/irbtools.gemspec

@@ -5,59 +5,41 @@ Gem::Specification.new do |s|
   s.name = 'irbtools'
   s.version = Irbtools::VERSION
 
-  s.homepage              = 'https://irb.tools'
+  s.homepage              = 'https://github.com/janlelis/irbtools'
   s.authors               = ["Jan Lelis"]
   s.email                 = ["hi@ruby.consulting"]
   s.summary               = 'Irbtools happy IRB.'
   s.description           = "The Irbtools make working with Ruby's IRB console more fun & productive."
-  s.files                 = %w[
-    lib/irbtools.rb
-    lib/irbtools/version.rb
-    lib/irbtools/configure.rb
-    lib/irbtools/implementation.rb
-    lib/irbtools/libraries.rb
-    lib/irbtools/non_fancy.rb
-    lib/irbtools/hirb.rb
-    lib/irbtools/minimal.rb
-    lib/irbtools/binding.rb
-    Rakefile
-    irbtools.gemspec
-  ]
-  s.extra_rdoc_files      = %w[
-    README.md
-    CONFIGURE.md
-    CHANGELOG.md
-    MIT-LICENSE.txt
-  ]
+  s.files                 = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^pkg/ }
+  s.metadata              = { "rubygems_mfa_required" => "true" }
   s.license               = 'MIT'
 
-  s.required_ruby_version = '>= 2.0', '< 4.0'
+  s.required_ruby_version = '>= 3.0', '< 4.0'
 
   # # #
   # Dependencies
 
   # Core Functionality
-  s.add_dependency %q<irb>,           ">= 0.9.6"
-  s.add_dependency %q<every_day_irb>, "~> 2.0"
+  s.add_dependency %q<irb>,           "~> 1.6.2"
+  s.add_dependency %q<every_day_irb>, "~> 2.2"
   s.add_dependency %q<fancy_irb>,     "~> 1.2", ">= 1.2.1"
   s.add_dependency %q<wirb>,          "~> 2.0", ">= 2.2.1"
   s.add_dependency %q<hirb>,          "~> 0.7", ">= 0.7.3"
-  s.add_dependency %q<binding.repl>,  "~> 3.0"
 
   # Utils
   s.add_dependency %q<paint>,         ">= 0.9", "< 3.0"
   s.add_dependency %q<clipboard>,     "~> 1.3"
   s.add_dependency %q<interactive_editor>, "~> 0.0", ">= 0.0.10"
   s.add_dependency %q<coderay>,       "~> 1.1"
-  s.add_dependency %q<debugging>,     "~> 1.1"
+  s.add_dependency %q<debugging>,     "~> 2.1"
 
   # Introspection / Docs
+  s.add_dependency %q<looksee>,       "~> 5.0"
   s.add_dependency %q<object_shadow>, "~> 1.1"
-  s.add_dependency %q<code>,          ">= 0.9.2", "< 2.0"
-  s.add_dependency %q<ori>,           "~> 0.1.0"
-  s.add_dependency %q<methodfinder>,  "~> 2.2", ">= 2.2.2"
+  s.add_dependency %q<code>,          ">= 0.9.4", "< 2.0"
+  s.add_dependency %q<core_docs>,     "~> 0.9.9"
+  s.add_dependency %q<methodfinder>,  "~> 2.2", ">= 2.2.5"
   s.add_dependency %q<ruby_version>,  "~> 1.0"
-  s.add_dependency %q<ruby_engine>,   "~> 1.0"
-  s.add_dependency %q<ruby_info>,     "~> 1.0"
-  s.add_dependency %q<os>
+  s.add_dependency %q<ruby_engine>,   "~> 2.0"
+  s.add_dependency %q<os>,            "~> 1.1", ">= 1.1.4"
 end

data/lib/irbtools/binding.rb

@@ -3,27 +3,10 @@ begin
 rescue LoadError
 end
 
-if RUBY_VERSION >= "2.5.0"
-  if defined? BindingOfCaller
-    module Kernel
-      private def irb
-        binding.of_caller(1).irb
-      end
-    end
-  end
-else
-  require 'binding.repl'
-  BindingRepl.auto = %w[irb ripl ir rib pry]
-
-  class Binding
-    alias irb repl!
-  end
-
-  if defined? BindingOfCaller
-    require 'debugging/repl'
-
-    module Debugging
-      alias irb repl
+if defined? BindingOfCaller
+  module Kernel
+    private def irb
+      binding.of_caller(1).irb
     end
   end
 end

data/lib/irbtools/commands/code.rb

@@ -0,0 +1,35 @@
+require "irb/cmd/nop"
+
+module IRB
+  module ExtendCommand
+    class Code < Nop
+      category "Introspection"
+      description "Shows the syntax-highlighted source code of a method"
+
+      class << self
+        def transform_args(args)
+          if args.strip =~ /\A(?:([\w:]+)([#.]))?(\w+)\z/
+            if $1
+              if $2 == "#"
+                "#{$1}, #{$1}.instance_method(:#{$3})"
+              else
+                "#{$1}, :#{$3}"
+              end
+            else
+              ":" + $3
+            end
+          else
+            args
+          end
+        end
+      end
+
+      def execute(*args)
+        @irb_context.workspace.binding.send(:code, *args)
+      rescue NameError
+        warn "code: Class or method not found."
+      end
+    end
+  end
+end
+

data/lib/irbtools/commands/howtocall.rb

@@ -0,0 +1,35 @@
+require "irb/cmd/nop"
+
+module IRB
+  module ExtendCommand
+    class Howtocall < Nop
+      category "Introspection"
+      description "Displays method signatures based on Method#parameters"
+
+      class << self
+        def transform_args(args)
+          if args.strip =~ /\A(?:([\w:]+)([#.]))?(\w+)\z/
+            if $1
+              if $2 == "#"
+                "#{$1}, #{$1}.instance_method(:#{$3})"
+              else
+                "#{$1}, :#{$3}"
+              end
+            else
+              ":" + $3
+            end
+          else
+            args
+          end
+        end
+      end
+
+      def execute(*args)
+        @irb_context.workspace.binding.send(:howtocall, *args)
+      rescue NameError
+        warn "howtocall: Class or method not found"
+      end
+    end
+  end
+end
+

data/lib/irbtools/commands/look.rb

@@ -0,0 +1,20 @@
+require "irb/cmd/nop"
+
+module IRB
+  module ExtendCommand
+    class Look < Nop
+      category "Introspection"
+      description 'Method list and lookup path inspection based on looksee gem'
+
+      def execute(*args)
+        if args.empty?
+          @irb_context.workspace.binding.look
+        else
+          obj, *params = *args
+          obj.look(*params)
+        end
+      end
+    end
+  end
+end
+

data/lib/irbtools/commands/shadow.rb

@@ -0,0 +1,20 @@
+require "irb/cmd/nop"
+
+module IRB
+  module ExtendCommand
+    class Shadow < Nop
+      category "Introspection"
+      description 'Method list and lookup path inspection based on object shadow gem'
+
+      def execute(*args)
+        if args.empty?
+          @irb_context.workspace.binding.shadow
+        else
+          obj, *params = *args
+          obj.shadow(*params)
+        end
+      end
+    end
+  end
+end
+

data/lib/irbtools/commands/sys.rb

@@ -0,0 +1,25 @@
+require "irb/cmd/nop"
+
+module IRB
+  module ExtendCommand
+    class Sys < Nop
+      category "Misc"
+      description 'Run a system command'
+
+      class << self
+        def transform_args(args)
+          if args.empty? || string_literal?(args)
+            args
+          else
+            args.strip.dump
+          end
+        end
+      end
+
+      def execute(*args)
+        system(*args)
+      end
+    end
+  end
+end
+

data/lib/irbtools/commands.rb

@@ -0,0 +1,5 @@
+require_relative "commands/code"
+require_relative "commands/howtocall"
+require_relative "commands/look"
+require_relative "commands/shadow"
+require_relative "commands/sys"

data/lib/irbtools/configure.rb

@@ -1,4 +1,5 @@
 require_relative 'version'
 
 require_relative 'implementation'
+require_relative "commands"
 require_relative 'libraries' unless Irbtools.minimal

data/lib/irbtools/implementation.rb

@@ -1,7 +1,6 @@
 module Irbtools
   @libraries       = { :start => [], :sub_session => [], :autoload => [], :thread => {}, :late => [], :late_thread => {} }
   @lib_hooks       = Hash.new{|h,k| h[k] = [] }
-  @packages        = []
   @shell_name      = File.split($0)[-1].upcase
   @welcome_message = "Welcome to #{ @shell_name }. You are using #{ RUBY_DESCRIPTION }. Have fun ;)"
   @minimal         ||= false
@@ -20,9 +19,6 @@ module Irbtools
     # keys determine if lib is required, required on sub-session or autoloaded
     attr_accessor :libraries
 
-    # an array of extension packages that get loaded (e.g. irbtools-more)
-    attr_accessor :packages
-
     # add a library. the block gets executed, when the library was loaded.
     # if the second param is true, it's hooked in into IRB.conf[:IRB_RC] instead of the start.
     def add_library(lib, options = {}, &block)
@@ -83,23 +79,6 @@ module Irbtools
       @lib_hooks.delete lib
     end
 
-    # add extensions packages
-    def add_package(pkg)
-      @packages << pkg.to_s
-    end
-
-    # remove extension package
-    def remove_package(pkg)
-      @packages.delete pkg.to_s
-    end
-
-    # actually require registered packages
-    def load_packages
-      @packages.each{ |pkg|
-        require "irbtools/#{pkg}"
-      }
-    end
-
     # te be triggered when a library has loaded
     def library_loaded(lib)
       @lib_hooks[lib.to_s].each{ |hook| hook.call }
@@ -122,30 +101,62 @@ module Irbtools
       $VERBOSE, $DEBUG = remember_verbose_and_debug
     end
 
-    # configure irb
     def configure_irb!
       if defined?(IRB)
         IRB.conf[:AUTO_INDENT]  = true                 # simple auto indent
         IRB.conf[:EVAL_HISTORY] = 42424242424242424242 # creates the special __ variable
         IRB.conf[:SAVE_HISTORY] = 2000                 # how many lines will go to ~/.irb_history
-
-        # prompt
-        (IRB.conf[:PROMPT] ||= {} ).merge!( {:IRBTOOLS => {
-          :PROMPT_I => ">> ",    # normal
-          :PROMPT_N => "|  ",    # indenting
-          :PROMPT_C => " > ",    # continuing a statement
-          :PROMPT_S => "%l> ",   # continuing a string
-          :RETURN   => "=> %s \n",
-          :AUTO_INDENT => true,
-        }})
-
-        IRB.conf[:PROMPT_MODE] = :IRBTOOLS
+        set_propmt
+        load_commands
+        add_command_aliases
+        rename_ls_to_ils
       end
     end
 
-    # check if we are in a RIPL session
-    def ripl?
-      defined?(Ripl) && Ripl.started?
+    def set_propmt
+      (IRB.conf[:PROMPT] ||= {} ).merge!( {:IRBTOOLS => {
+        :PROMPT_I => ">> ",    # normal
+        :PROMPT_N => "|  ",    # indenting
+        :PROMPT_C => " > ",    # continuing a statement
+        :PROMPT_S => "%l> ",   # continuing a string
+        :RETURN   => "=> %s \n",
+        :AUTO_INDENT => true,
+      }})
+
+      IRB.conf[:PROMPT_MODE] = :IRBTOOLS
+    end
+
+    def load_commands
+      ec = IRB::ExtendCommandBundle.instance_variable_get(:@EXTEND_COMMANDS)
+
+      [
+        [:code, :Code, nil, [:code, IRB::ExtendCommandBundle::OVERRIDE_ALL]],
+        [:howtocall, :Howtocall, nil, [:howtocall, IRB::ExtendCommandBundle::OVERRIDE_ALL]],
+        [:look, :Look, nil, [:look, IRB::ExtendCommandBundle::OVERRIDE_ALL]],
+        [:shadow, :Shadow, nil, [:shadow, IRB::ExtendCommandBundle::OVERRIDE_ALL]],
+        [:sys, :Sys, nil, [:sys, IRB::ExtendCommandBundle::OVERRIDE_ALL]],
+      ].each{ |ecconfig|
+        ec.push(ecconfig)
+        IRB::ExtendCommandBundle.def_extend_command(*ecconfig)
+      }
+    end
+
+    def add_command_aliases
+      IRB.conf[:COMMAND_ALIASES] = (IRB.conf[:COMMAND_ALIASES] || {}).merge({
+        :ri => :show_doc,
+        :co => :chws,
+        :'$' => :sys,
+        :'+' => :shadow,
+      })
+    end
+
+    # prevent clash between IRB's ls and FileUtil's ls
+    def rename_ls_to_ils
+      if aliases = IRB::ExtendCommandBundle.instance_variable_get(:@ALIASES)
+        if irb_ls = aliases.find{|a,*| a == :ls}
+          irb_ls[0] = :ils
+        end
+      end
     end
 
     # loads all the stuff

data/lib/irbtools/libraries.rb

@@ -21,14 +21,11 @@ Irbtools.add_library 'wirb/wp', thread: :paint do
   Wirb.start
 end
 
-unless Irbtools.ripl?
-  Irbtools.add_library :fancy_irb, thread: :paint do
-    FancyIrb.start
-  end
+Irbtools.add_library :fancy_irb, thread: :paint do
+  FancyIrb.start
 end
 
 Irbtools.add_library 'debugging/q',         thread: :paint
-Irbtools.add_library 'debugging/mof',       thread: :paint
 Irbtools.add_library 'debugging/re',        thread: :paint
 Irbtools.add_library 'debugging/beep',      thread: :paint
 Irbtools.add_library 'debugging/howtocall', thread: :paint
@@ -39,41 +36,23 @@ Irbtools.add_library 'object_shadow', thread: :paint do
   ObjectShadow.include(ObjectShadow::DeepInspect)
 end
 
-Irbtools.add_library 'readline', thread: :ori
-Irbtools.add_library 'ori', thread: :ori do
-  # TODO Readline history can be empty (issue)
-  module ORI::Internals
-    def self.get_ri_arg_prefix(cmd)
-      if cmd && (mat = cmd.match /\A(\s*.+?\.ri)\s+\S/)
-        mat[1]
-      end
-    end
-  end
+Irbtools.add_library 'readline', thread: :readline
+Irbtools.add_library 'os', thread: :os
+Irbtools.add_library 'ruby_engine', thread: :re
+Irbtools.add_library 'ruby_version', thread: :rv
 
-  class Object
-    # patch ori to also allow shell-like "Array#slice" syntax
-    def ri(*args)
-      if  args[0] &&
-          self == TOPLEVEL_BINDING.eval('self') &&
-          args[0] =~ /\A(.*)(?:#|\.)(.*)\Z/
-        begin
-          klass = Object.const_get $1
-          klass.ri $2
-        rescue
-          super
-        end
-      else
-        super
-      end
+begin
+  # Object#l method for inspecting its lookup path
+  Irbtools.add_library 'looksee', thread: :ls do
+    Looksee.rename :lp
+    class Object
+      alias look lp
     end
   end
+rescue LoadError
+  # do not load if not supported
 end
 
-Irbtools.add_library 'ruby_info', thread: :ri
-Irbtools.add_library 'os', thread: :os
-Irbtools.add_library 'ruby_engine', thread: :re
-Irbtools.add_library 'ruby_version', thread: :rv
-
 # # # load via autoload
 
 Irbtools.add_library 'code', :autoload => :Code do
@@ -105,12 +84,6 @@ Irbtools.add_library :clipboard, :autoload => :Clipboard do
     Clipboard.paste
   end
 
-  # copies everything you have entered in this irb session
-  def copy_input
-    copy session_history
-    "The session input history has been copied to the clipboard."
-  end
-
   # copies the output of all irb commands in this irb session
   def copy_output
     copy context.instance_variable_get(:@eval_history_values).inspect.gsub(/^\d+ (.*)/, '\1')

data/lib/irbtools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Irbtools
-  VERSION = "3.0.5"
+  VERSION = "4.0.1"
 end

data/lib/irbtools.rb

@@ -1,13 +1,5 @@
 require_relative 'irbtools/configure'
-
-# # # # #
-# Make sure we load IRB if we are not in RIPL
-
-require 'irb' unless Irbtools.ripl?
-
-# # # # #
-# Load irbtools extension packages
-Irbtools.load_packages
+require 'irb'
 
 # # # # #
 # Load: start
@@ -27,19 +19,11 @@ Irbtools.configure_irb!
 
 # # # # #
 # Load: sub-session / after_rc
-if Irbtools.ripl?
-  if defined? Ripl::AfterRc
-    Irbtools.libraries[:sub_session].each{ |r| Ripl.after_rcs << r }
-  elsif !Irbtools.libraries[:sub_session].empty?
-    warn "Couldn't load libraries in Irbtools.libraries[:sub_session]. Please install ripl-after_rc to use this feature in Ripl!"
-  end
-else
-  original_irbrc_proc = IRB.conf[:IRB_RC]
-  IRB.conf[:IRB_RC] = proc{
-    Irbtools.load_libraries(Irbtools.libraries[:sub_session])
-    original_irbrc_proc.call if original_irbrc_proc
-  }
-end
+original_irbrc_proc = IRB.conf[:IRB_RC]
+IRB.conf[:IRB_RC] = proc{
+  Irbtools.load_libraries(Irbtools.libraries[:sub_session])
+  original_irbrc_proc.call if original_irbrc_proc
+}
 
 # # # # #
 # Load: threads

data/spec/irbtools_commands_spec.rb

@@ -0,0 +1,17 @@
+require "irbtools/commands"
+
+describe "irbtools commands" do
+  describe "[introspection]" do
+    describe "howtocall / code" do
+      it "support ri Syntax like String.name or String#gsub" do
+        expect(
+          IRB::ExtendCommand::Howtocall.transform_args("String.name")
+        ).to eq "String, :name"
+
+        expect(
+          IRB::ExtendCommand::Code.transform_args("String#gsub")
+        ).to eq "String, String.instance_method(:gsub)"
+      end
+    end
+  end
+end

data/spec/irbtools_extra_methods_spec.rb

@@ -0,0 +1,81 @@
+require "irbtools"
+
+describe "irbtools extra methods" do
+  describe "[introspection]" do
+    describe "code()" do
+      it "delegates to Code.for() to show the method's source code" do
+        allow(Code).to receive(:for)
+        code "require"
+        expect(Code).to have_received(:for)
+      end
+    end
+
+    describe "mf()" do
+      it "returns the MethodFinder class object when no arguments given" do
+        expect(mf).to equal(MethodFinder)
+      end
+
+      it "delegates to MethodFinder.find() when arguments given" do
+        allow(MethodFinder).to receive(:find)
+        mf("bla")
+        expect(MethodFinder).to have_received(:find)
+      end
+    end
+  end
+
+  describe "[utils]" do
+    describe "page()" do
+      it "will page long content" do
+        allow(Hirb::Pager).to receive(:command_pager)
+        page "idiosyncratic"
+        expect(Hirb::Pager).to have_received(:command_pager)
+      end
+    end
+
+    describe "colorize()" do
+      it "delegate to CodeRay.scan to syntax highlight given string" do
+        allow(CodeRay).to receive(:scan).and_return(CodeRay::TokensProxy.new("", :ruby))
+        colorize "def hello() end"
+        expect(CodeRay).to have_received(:scan)
+      end
+    end
+
+    describe "ray()" do
+      it "delegate to CodeRay.scan to syntax highlight given file" do
+        allow(CodeRay).to receive(:scan).and_return(CodeRay::TokensProxy.new("", :ruby))
+        allow(File).to receive(:read).and_return("stuff")
+        ray "/tmp/something"
+        expect(File).to have_received(:read)
+        expect(CodeRay).to have_received(:scan)
+      end
+    end
+
+    describe "copy()" do
+      it "delegate to Clipboard.copy to copy string to clipboard" do
+        allow(Clipboard).to receive(:copy)
+        copy "idiosyncratic"
+        expect(Clipboard).to have_received(:copy)
+      end
+    end
+
+    describe "paste()" do
+      it "delegate to Clipboard.paste to paste clipboard contents" do
+        allow(Clipboard).to receive(:paste)
+        paste
+        expect(Clipboard).to have_received(:paste)
+      end
+    end
+
+    describe "copy_input()" do
+      it "Copies everything you have entered in this IRB session to the clipboard" do
+        # pending
+      end
+    end
+
+    describe "copy_output()" do
+      it "Copies the output of all IRB commands from the current IRB session to the clipboard" do
+        # pending
+      end
+    end
+  end
+end