rib 1.5.1 → 1.5.2

data/lib/rib/more/beep.rb

@@ -1,8 +1,8 @@
 
 require 'rib'
 
-module Rib::Beep
-  extend Rib::Plugin
+module Rib; module Beep
+  extend Plugin
   Shell.use(self)
 
   # --------------- Rib API ---------------
@@ -10,7 +10,7 @@ module Rib::Beep
   def before_loop
     super
     return self if Beep.disabled?
-    beep if (Time.now - config[:started_at]) > beep_threshold
+    beep if started_at && (Time.now - started_at) > beep_threshold
     Beep.disable
     self
   end
@@ -23,4 +23,4 @@ module Rib::Beep
   def beep_threshold
     config[:beep_threshold] ||= 5
   end
-end
+end; end

data/lib/rib/more/bottomup_backtrace.rb

@@ -1,8 +1,8 @@
 
 require 'rib'
 
-module Rib::BottomupBacktrace
-  extend Rib::Plugin
+module Rib; module BottomupBacktrace
+  extend Plugin
   Shell.use(self)
 
   # --------------- Rib API ---------------
@@ -16,4 +16,4 @@ module Rib::BottomupBacktrace
   def format_backtrace backtrace
     super(backtrace).reverse
   end
-end
+end; end

data/lib/rib/more/caller.rb

@@ -1,8 +1,8 @@
 
 require 'rib'
 
-module Rib::Caller
-  extend Rib::Plugin
+module Rib; module Caller
+  extend Plugin
   Shell.use(self)
 
   module Imp
@@ -34,4 +34,4 @@ module Rib::Caller
   end
 
   Rib.extend(Imp)
-end
+end; end

data/lib/rib/more/color.rb

@@ -1,8 +1,8 @@
 
 require 'rib'
 
-module Rib::Color
-  extend Rib::Plugin
+module Rib; module Color
+  extend Plugin
   Shell.use(self)
 
   # --------------- Rib API ---------------
@@ -14,7 +14,7 @@ module Rib::Color
 
   def format_result result
     return super if Color.disabled?
-    config[:result_prompt] + format_color(result)
+    "#{result_prompt}#{format_color(result)}"
   end
 
   def get_error err
@@ -23,6 +23,11 @@ module Rib::Color
     [format_color(err, message), format_backtrace(backtrace)]
   end
 
+  def warn message
+    return super if Color.disabled?
+    super(red{message})
+  end
+
   # --------------- Plugin API ---------------
 
   def colors
@@ -39,7 +44,7 @@ module Rib::Color
       Object     => :yellow }
   end
 
-  def format_color result, display=result.inspect
+  def format_color result, display=inspect_result(result)
     case result
       when String ; send(colors[String ]){ display }
       when Numeric; send(colors[Numeric]){ display }
@@ -66,7 +71,7 @@ module Rib::Color
       else        ; if color = find_color(colors, result)
                     send(color){ display }
                     else
-                    send(colors[Object      ]){ display }
+                    send(colors[Object]){ display }
                     end
     end
   end
@@ -110,7 +115,7 @@ module Rib::Color
   def    cyan █ color(36, &block); end
   def   white █ color(37, &block); end
   def   reset █ color( 0, &block); end
-end
+end; end
 
 begin
   require 'win32console' if defined?(Gem) && Gem.win_platform?

data/lib/rib/more/edit.rb

@@ -2,8 +2,8 @@
 require 'rib'
 require 'tempfile'
 
-module Rib::Edit
-  extend Rib::Plugin
+module Rib; module Edit
+  extend Plugin
   Shell.use(self)
 
   module Imp
@@ -35,4 +35,4 @@ module Rib::Edit
   end
 
   Rib.extend(Imp)
-end
+end; end

data/lib/rib/more/multiline_history.rb

@@ -2,8 +2,8 @@
 require 'rib/core/history'   # dependency
 require 'rib/core/multiline' # dependency
 
-module Rib::MultilineHistory
-  extend Rib::Plugin
+module Rib; module MultilineHistory
+  extend Plugin
   Shell.use(self)
 
   # --------------- Rib API ---------------
@@ -45,4 +45,4 @@ module Rib::MultilineHistory
   def multiline_trash
     @multiline_trash ||= 0
   end
-end
+end; end

data/lib/rib/more/multiline_history_file.rb

@@ -1,8 +1,8 @@
 
 require 'rib/more/multiline_history'
 
-module Rib::MultilineHistoryFile
-  extend Rib::Plugin
+module Rib; module MultilineHistoryFile
+  extend Plugin
   Shell.use(self)
 
   # --------------- Rib API ---------------
@@ -46,4 +46,4 @@ module Rib::MultilineHistoryFile
   def multiline_history_file_token
     config[:multiline_history_file_token] ||= ' '
   end
-end
+end; end

data/lib/rib/plugin.rb

@@ -1,6 +1,5 @@
 
-module Rib; end
-module Rib::Plugin
+module Rib; module Plugin
   attr_accessor :disabled
 
   def enable
@@ -25,8 +24,20 @@ module Rib::Plugin
     !!disabled
   end
 
+  # Backward compatibility
+  def const_missing mod
+    if Rib.const_defined?(mod)
+      Rib.warn("Using #{mod} is deprecated, please change to Rib::#{mod}",
+               "This compatibility layer would be removed in Rib 1.6+",
+               "Called: #{caller.first}")
+      Rib.const_get(mod)
+    else
+      super
+    end
+  end
+
   def self.extended mod
-    mod.send(:include, Rib)
+    return unless mod.name
 
     snake_name = mod.name.sub(/(\w+::)+?(\w+)$/, '\2').
       gsub(/([A-Z][a-z]*)/, '\\1_').downcase[0..-2]
@@ -47,4 +58,4 @@ module Rib::Plugin
 
     Rib.singleton_class.module_eval(code, __FILE__, __LINE__)
   end
-end
+end; end

data/lib/rib/runner.rb

@@ -1,7 +1,7 @@
 
 require 'rib'
 
-module Rib::Runner
+module Rib; module Runner
   module_function
   def options
     @options ||=
@@ -60,7 +60,8 @@ module Rib::Runner
 
   # Extract the text below __END__ in the bin file as the description
   def command_descriptions_find path
-    File.read(path) =~ /Gem\.bin_path\(['"](.+)['"], ['"](.+)['"],/
+    # FIXME: Can we do better? This is not reliable
+    File.read(path) =~ /Gem\.activate_bin_path\(['"](.+)['"], ['"](.+)['"],/
     (File.read(Gem.bin_path($1, $2))[/\n__END__\n(.+)$/m, 1] || '').strip
   end
 
@@ -185,4 +186,4 @@ module Rib::Runner
   rescue Errno::ENOENT # probably a windows platform, try where
     `where #{bin}`.lines.first.strip
   end
-end
+end; end

data/lib/rib/shell.rb

@@ -2,8 +2,8 @@
 require 'rib/plugin'
 require 'rib/api'
 
-class Rib::Shell
-  include Rib::API
+module Rib; class Shell
+  include API
   trap('INT'){ raise Interrupt }
 
   def self.use mod
@@ -41,27 +41,40 @@ class Rib::Shell
                    :prompt        => '>> ',
                    :exit          => [nil],
                    :line          => 1    }.merge(config)
-    @running = false
+    stop
   end
 
   # Loops shell until user exits
   def loop
     before_loop
-    @running = true
+    start
     in_loop
+    stop
     self
   rescue Exception => e
     Rib.warn("Error while running loop:\n  #{format_error(e)}")
     raise
   ensure
-    @running = false
+
     after_loop
   end
 
+  def start
+    @running = true
+  end
+
+  def stop
+    @running = false
+  end
+
   def running?
     !!@running
   end
 
+  def warnings
+    @warnings ||= []
+  end
+
   protected
   attr_writer :config
 
@@ -79,4 +92,4 @@ class Rib::Shell
       ret
     RUBY
   end
-end
+end; end

data/lib/rib/test.rb

@@ -7,18 +7,40 @@ Pork::Suite.include(Muack::API)
 require 'rib'
 
 copy :rib do
+  before do
+    Rib.disable_plugins
+  end
+
   after do
     Muack.verify
   end
 
+  def shell opts={}
+    @shell ||= new_shell(opts)
+  end
+
   def new_shell opts={}
-    shell = Rib::Shell.new(
-      {:binding => Object.new.instance_eval{binding}}.merge(opts)
-    )
+    shell = Rib::Shell.new(opts)
     yield(shell) if block_given?
     shell.before_loop
   end
 
+  def stub_output
+    stub(shell).print(is_a(String)){}
+    stub(shell).puts(is_a(String)){}
+  end
+
+  def readline?
+    Rib.constants.map(&:to_s).include?('Readline') &&
+      Rib::Readline.enabled?
+  end
+
+  def stub_readline meth=:stub
+    send(meth, ::Readline).readline(is_a(String), true) do
+      (::Readline::HISTORY << str.chomp).last
+    end
+  end
+
   singleton_class.module_eval do
     def test_for *plugins, &block
       require 'rib/all' # exhaustive tests
@@ -68,17 +90,6 @@ copy :rib do
       test_level3(rest[1..-1], block)
     end
   end
-
-  def readline?
-    Rib.constants.map(&:to_s).include?('Readline') &&
-    Rib::Readline.enabled?
-  end
-
-  def stub_readline
-    stub(::Readline).readline(is_a(String), true){
-      (::Readline::HISTORY << str.chomp).last
-    }
-  end
 end
 
 def main

data/lib/rib/test/history.rb

@@ -0,0 +1,25 @@
+
+require 'tempfile'
+
+copy :setup_history do
+  before do
+    if readline?
+      ::Readline::HISTORY.clear
+      stub_readline
+    end
+
+    shell(:history_file => history_file)
+  end
+
+  after do
+    tempfile.unlink if @tempfile
+  end
+
+  def tempfile
+    @tempfile ||= Tempfile.new('rib')
+  end
+
+  def history_file
+    tempfile.path
+  end
+end

data/lib/rib/test/multiline.rb

@@ -1,16 +1,8 @@
 
 copy :setup_multiline do
-  def setup_shell
-    @shell = new_shell
-    stub(@shell).print{}.with_any_args
-    stub(@shell).puts{} .with_any_args
-  end
-
   def setup_input str
     if readline?
-      mock(::Readline).readline(is_a(String), true){
-        (::Readline::HISTORY << str.chomp)[-1]
-      }
+      stub_readline(:mock)
     else
       mock($stdin).gets{ str.chomp }
     end
@@ -18,17 +10,17 @@ copy :setup_multiline do
 
   def input str
     setup_input(str)
-    mock(@shell).throw(:rib_multiline)
+    mock(shell).throw(:rib_multiline)
   end
 
   def input_done str, err=nil
     setup_input(str)
     if err
-      mock(@shell).print_eval_error(is_a(err)){}
+      mock(shell).print_eval_error(is_a(err)){}
     else
-      mock(@shell).print_result(is_a(Object)){}
+      mock(shell).print_result(is_a(Object)){}
     end
-    @shell.loop_once
+    shell.loop_once
     ok
   end
 
@@ -36,7 +28,7 @@ copy :setup_multiline do
     lines = str.split("\n")
     lines[0...-1].each{ |line|
       input(line)
-      @shell.loop_once
+      shell.loop_once
     }
     input_done(lines.last, err)
   end
@@ -44,11 +36,11 @@ end
 
 copy :multiline do
   before do
-    setup_shell
+    stub_output
   end
 
   would 'work with no prompt' do
-    @shell.config[:prompt] = ''
+    shell.config[:prompt] = ''
     check <<-RUBY
       def f
         0

data/lib/rib/version.rb

@@ -1,4 +1,4 @@
 
 module Rib
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

data/rib.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rib 1.5.1 ruby lib
+# stub: rib 1.5.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rib".freeze
-  s.version = "1.5.1"
+  s.version = "1.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Lin Jen-Shin (godfat)".freeze]
-  s.date = "2017-03-09"
+  s.date = "2017-05-01"
   s.description = "Ruby-Interactive-ruBy -- Yet another interactive Ruby shell\n\nRib is based on the design of [ripl][] and the work of [ripl-rc][], some of\nthe features are also inspired by [pry][]. The aim of Rib is to be fully\nfeatured and yet very easy to opt-out or opt-in other features. It shall\nbe simple, lightweight and modular so that everyone could customize Rib.\n\n[ripl]: https://github.com/cldwalker/ripl\n[ripl-rc]: https://github.com/godfat/ripl-rc\n[pry]: https://github.com/pry/pry".freeze
   s.email = ["godfat (XD) godfat.org".freeze]
   s.executables = [
@@ -67,6 +67,7 @@ Gem::Specification.new do |s|
   "lib/rib/runner.rb".freeze,
   "lib/rib/shell.rb".freeze,
   "lib/rib/test.rb".freeze,
+  "lib/rib/test/history.rb".freeze,
   "lib/rib/test/multiline.rb".freeze,
   "lib/rib/version.rb".freeze,
   "rib.gemspec".freeze,
@@ -79,8 +80,8 @@ Gem::Specification.new do |s|
   "test/core/test_readline.rb".freeze,
   "test/core/test_squeeze_history.rb".freeze,
   "test/core/test_strip_backtrace.rb".freeze,
-  "test/extra/test_anchor.rb".freeze,
   "test/extra/test_autoindent.rb".freeze,
+  "test/more/test_anchor.rb".freeze,
   "test/more/test_beep.rb".freeze,
   "test/more/test_caller.rb".freeze,
   "test/more/test_color.rb".freeze,
@@ -90,7 +91,7 @@ Gem::Specification.new do |s|
   "test/test_runner.rb".freeze,
   "test/test_shell.rb".freeze]
   s.homepage = "https://github.com/godfat/rib".freeze
-  s.licenses = ["Apache License 2.0".freeze]
+  s.licenses = ["Apache-2.0".freeze]
   s.rubygems_version = "2.6.10".freeze
   s.summary = "Ruby-Interactive-ruBy -- Yet another interactive Ruby shell".freeze
   s.test_files = [
@@ -101,8 +102,8 @@ Gem::Specification.new do |s|
   "test/core/test_readline.rb".freeze,
   "test/core/test_squeeze_history.rb".freeze,
   "test/core/test_strip_backtrace.rb".freeze,
-  "test/extra/test_anchor.rb".freeze,
   "test/extra/test_autoindent.rb".freeze,
+  "test/more/test_anchor.rb".freeze,
   "test/more/test_beep.rb".freeze,
   "test/more/test_caller.rb".freeze,
   "test/more/test_color.rb".freeze,