rib 0.9.0 → 0.9.1

data/CHANGES.md

@@ -1,5 +1,22 @@
 # Rib CHANGES
 
+## Rib 0.9.1 -- 2011-08-19
+
+* [extra/autoindent] Autoindent plugin help you indent multiline editing.
+  Note: This plugin is depending on [readline_buffer][], thus GNU Readline.
+
+* [ripl] After `require 'rib/ripl'`, ripl plugins should be usable for rib.
+
+* [rib] Introduce `ENV['RIB_HOME']` to set where to store config and history.
+  By default, it's `~/.rib` now, but it would first search for existing
+  config or history, which would first try to see `~/.rib/config.rb`, and
+  then `~/.rib/history.rb`. If Rib can find anything there, then `RIB_HOME`
+  would be set to `~/.rib`, the same goes to `~/.config/rib`.
+  In short, by default `RIB_HOME` is `~/.rib`, but the old `~/.config/rib`
+  still works.
+
+[readline_buffer]: https://github.com/godfat/readline_buffer
+
 ## Rib 0.9.0 -- 2011-08-14
 
 * First serious release!

data/README.md

@@ -6,6 +6,7 @@ by Lin Jen-Shin ([godfat](http://godfat.org))
 
 * [github](https://github.com/godfat/rib)
 * [rubygems](http://rubygems.org/gems/rib)
+* [rdoc](http://rdoc.info/github/godfat/rib)
 
 ## DESCRIPTION:
 
@@ -38,7 +39,7 @@ be simple, lightweight and modular so that everyone could customize Rib.
 
 ### As an interactive shell
 
-As IRB (reads `~/.config/rib/config.rb` writes `~/.config/rib/history.rb`)
+As IRB (reads `~/.rib/config.rb` writes `~/.rib/history.rb`)
 
     rib
 
@@ -63,18 +64,23 @@ As a fully featured app console (yes, some commands could be used together)
 
     rib all auto # or `rib auto all`, the order doesn't really matter
 
-You can customize Rib's behaviour by setting `~/.config/rib/config.rb` (by
-default). Since it's merely a Ruby script which would be loaded into memory
-before launching Rib shell session, You can put any customization or monkey
-patch there. Personally, I use all plugins provided by Rib.
+You can customize Rib's behaviour by setting a config file located at
+`~/.rib/config.rb` or `~/.config/rib/config.rb`, or `$RIB_HOME/config.rb` by
+setting `$RIB_HOME` environment variable. Since it's merely a Ruby script
+which would be loaded into memory before launching Rib shell session, You can
+put any customization or monkey patch there. Personally, I use all plugins
+provided by Rib.
 
 <https://github.com/godfat/dev-tool/blob/master/.config/rib/config.rb>
 
 As you can see, putting `require 'rib/all'` into config file is exactly the
 same as running `rib all` without a config file. What `rib all` would do is
-merely require the file, and that file is also merely requiring all plugins.
-Suppose you only want to use the core plugins and color plugin, you'll put
-this into your config file:
+merely require the file, and that file is also merely requiring all plugins,
+but without **extra plugins**, which you should enable them one by one. This
+is because most extra plugins are depending on other gems, or hard to work
+with other plugins, or having strong personal tastes, so you won't want to
+enable them all. Suppose you only want to use the core plugins and color
+plugin, you'll put this into your config file:
 
     require 'rib/core'
     require 'rib/more/color'
@@ -97,27 +103,43 @@ So that we override the original format_result to pretty_inspect the result.
 You can also build your own gem and then simply require it in your config
 file. To see a list of overridable API, please read [api.rb][]
 
+Currently, there are two **extra plugins**.
+
+* `require 'rib/extra/autoindent'` This plugin is depending on:
+
+  1. [readline_buffer][]
+  2. readline plugin
+  3. multiline plugin
+
+* `require 'rib/extra/hirb'` This plugin is depending on:
+
+  1. [hirb][]
+
 [api.rb]: https://github.com/godfat/rib/blob/master/lib/rib/api.rb
+[readline_buffer]: https://github.com/godfat/readline_buffer
+[hirb]: https://github.com/cldwalker/hirb
 
 #### Basic configuration
 
-<pre>
+Rib.config                 | Functionality
+-------------------------- | -------------------------------------------------
+ENV['RIB_HOME']            | Specify where Rib should store config and history
 Rib.config[:config]        | The path where config should be located
 Rib.config[:name]          | The name of this shell
 Rib.config[:result_prompt] | Default is "=>"
 Rib.config[:prompt]        | Default is ">>"
 Rib.config[:binding]       | Context, default: TOPLEVEL_BINDING
 Rib.config[:exit]          | Commands to exit, default [nil, 'exit', 'quit']
-</pre>
 
 #### Plugin specific configuration
 
-<pre>
-Rib.config[:completion]    | Completion: Bond config
-Rib.config[:history_file]  | Default is "~/.rib/config/history.rb"
-Rib.config[:history_size]  | Default is 500
-Rib.config[:color]         | A hash of Class => :color mapping
-</pre>
+Rib.config                     | Functionality
+------------------------------ | ---------------------------------------------
+Rib.config[:completion]        | Completion: Bond config
+Rib.config[:history_file]      | Default is "~/.rib/config/history.rb"
+Rib.config[:history_size]      | Default is 500
+Rib.config[:color]             | A hash of Class => :color mapping
+Rib.config[:autoindent_spaces] | How to indent? Default is two spaces: '  '
 
 ### As a debugging/interacting tool
 

data/Rakefile

@@ -14,8 +14,10 @@ task 'gem:spec' do
     %w[].each{ |g| s.add_runtime_dependency(g) }
     %w[bond
        hirb
+       readline_buffer
        bacon
-       rr]  .each{ |g| s.add_development_dependency(g) }
+       rr
+       rake].each{ |g| s.add_development_dependency(g) }
   end
 
   Gemgem.write

data/TODO.md

@@ -2,5 +2,4 @@
 
 * Runner tests
 * Documentation
-* Fix Rubinius weird Runtime BOOM error
 * Implement exception_spy

data/lib/rib/core/history.rb

@@ -10,16 +10,18 @@ module Rib::History
 
   def before_loop
     return super if History.disabled?
-    config[:history_file] ||= '~/.config/rib/history.rb'
+    config[:history_file] ||= File.join(Rib.home, 'history.rb')
     config[:history_size] ||= 500
     FileUtils.mkdir_p(File.dirname(history_file_path))
     read_history
+    Rib.say("History read from: #{history_file_path}") if $VERBOSE
     super
   end
 
   def after_loop
     return super if History.disabled?
     write_history
+    Rib.say("History wrote to: #{history_file_path}") if $VERBOSE
     super
   end
 

data/lib/rib/core/squeeze_history.rb

@@ -1,5 +1,5 @@
 
-require 'rib/core/history'
+require 'rib/core/history' # dependency
 
 module Rib::SqueezeHistory
   include Rib::Plugin
@@ -11,6 +11,7 @@ module Rib::SqueezeHistory
   def loop_once
     return super if SqueezeHistory.disabled?
     begin
+      # TODO: history[-1] is MRI 1.9+
       input, last_input = history[-1], history[-2]
     rescue IndexError # EditLine is really broken, to_a is needed for it
       array = history.to_a
@@ -34,6 +35,7 @@ module Rib::SqueezeHistory
 
   private
   def squeezed_history
+    # TODO: history.inject is MRI 1.9+
     history.to_a.inject([]){ |result, item|
       if result.last == item || item.strip == ''
         result

data/lib/rib/extra/autoindent.rb

@@ -0,0 +1,123 @@
+
+require 'rib/core/readline'  # dependency
+require 'rib/core/multiline' # dependency
+
+module Rib::Autoindent
+  include Rib::Plugin
+  Shell.use(self)
+
+  # begin block could be simpler, because it should also trigger
+  # SyntaxError, otherwise indention would be wiped out.
+  # but end block should be exactly match, because we don't have
+  # SyntaxError information, also triggering SyntaxError doesn't
+  # mean it's not an end block, thinking about nested multiline!
+  BLOCK_REGEXP = {
+    # rescue Expression? (=> VariableName)?
+    # consider cases:
+    # rescue
+    # rescue=>e
+    # rescue => e
+    # rescue =>e
+    # rescue E=>e
+    # rescue E
+    # rescue E => e
+    # rescue E=> e
+    # rescue E =>e
+    /^begin$/        => /^(end)\b|^else$|^rescue *((\w+)? *(=> *\w+)?)?$/,
+    # elsif Expression
+    # consider cases:
+    # elsif(true)
+    # elsif true
+    # elsif true == true
+    # elsif (a = true) && false
+    /^if/            => /^(end)\b|^else$|^elsif\b/,
+    /^unless/        => /^(end)\b|^else$|^elsif\b/,
+    /^case/          => /^(end)\b|^when\b/        ,
+    /^def/           => /^(end)\b/                ,
+    /^class/         => /^(end)\b/                ,
+    /^module/        => /^(end)\b/                ,
+    /^while/         => /^(end)\b/                ,
+    /^until/         => /^(end)\b/                ,
+    # consider cases:
+    # 'do
+    # "do
+    # /do
+    # '{
+    # "{
+    # /{
+    /[^'"\/]do( *\|.*\|)?$/ => /^(end)\b/         ,
+    /[^'"\/]\{( *\|.*\|)?$/ => /^(\})\B/          ,
+  }
+
+  # --------------- Rib API ---------------
+
+  def before_loop
+    return super if Autoindent.disabled?
+    config[:autoindent_spaces] ||= '  '
+    super
+  end
+
+  def get_input
+    return super if Autoindent.disabled?
+    autoindent_stack.clear if multiline_buffer.empty?
+    Thread.new do
+      sleep(0.01)
+      # this should be called after ::Readline.readline, but it's blocking,
+      # and i don't know if there's any hook to do this, so here we use thread
+      ::Readline.line_buffer = current_autoindent
+    end
+    super
+  end
+
+  def loop_eval input
+    return super if Autoindent.disabled?
+    if indented = handle_autoindent(input.strip)
+      super(indented)
+    else
+      super
+    end
+  end
+
+  # --------------- Plugin API ---------------
+
+  def handle_autoindent input
+    _, up = BLOCK_REGEXP.find{ |key,  _| input =~ key }
+    if up
+      autoindent_stack << up
+      nil
+    elsif input =~ autoindent_stack.last
+      if $1 # e.g. end, }, etc
+        autoindent_stack.pop
+        handle_last_line(input)
+      else # e.g. elsif, rescue, etc
+        handle_last_line(input, current_autoindent(autoindent_stack.size-1))
+      end
+    end
+  end
+
+  def handle_last_line input, indent=current_autoindent
+    new_input = "#{indent}#{input}"
+    puts("\e[1A\e[K#{prompt}#{new_input}")
+    new_input
+  end
+
+
+
+  private
+  def current_autoindent size=autoindent_stack.size
+    config[:autoindent_spaces] * size
+  end
+
+  def autoindent_stack
+    @autoindent_stack ||= []
+  end
+end
+
+begin
+  require 'readline_buffer'
+rescue LoadError
+  Rib.warn("Please install readline_buffer to use autoindent plugin:\n",
+           "    gem install readline_buffer\n",
+           "Or add readline_buffer to Gemfile if that's the case")
+  Rib::Autoindent.disable
+end

data/lib/rib/{dep → extra}/hirb.rb

@@ -5,6 +5,8 @@ module Rib::Hirb
   include Rib::Plugin
   Shell.use(self)
 
+  # --------------- Rib API ---------------
+
   def format_result result
     return super if Hirb.disabled?
     ::Hirb::View.view_or_page_output(result) || super

data/lib/rib/more/multiline_history.rb

@@ -36,6 +36,7 @@ module Rib::MultilineHistory
   def handle_multiline
     if multiline_buffer.size > 1
       # so multiline editing is considering done here
+      # TODO: there's no history.pop(size)
       (multiline_buffer.size + @multiline_trash).times{ history.pop }
       history << "\n" + multiline_buffer.join("\n")
     end

data/lib/rib/more/multiline_history_file.rb

@@ -33,6 +33,7 @@ module Rib::MultilineHistoryFile
 
   def write_history
     return super if MultilineHistoryFile.disabled?
+    # TODO: hisotroy.map is MRI 1.9+
     config[:history] = history.to_a.map{ |line|
       line.gsub("\n", "#{config[:multiline_history_file_token]}\n")
     }

data/lib/rib/ripl.rb

@@ -0,0 +1,3 @@
+
+Ripl = Rib
+Ripl::Shell.singleton_class.send(:public, :include)

data/lib/rib/test.rb

@@ -69,6 +69,15 @@ shared :rib do
       (::Readline::HISTORY << str.chomp)[-1]
     }
   end
+
+  # TODO: history.clear is MRI 1.9+
+  def clear_history history
+    if history.respond_to?(:clear)
+      history.clear
+    else
+      history.pop until history.empty?
+    end
+  end
 end
 
 module Kernel

data/lib/rib/version.rb

@@ -1,4 +1,4 @@
 
 module Rib
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/lib/rib.rb

@@ -6,7 +6,7 @@ module Rib
   # All default Rib configs, would be passed to Shell.new in Rib.shell,
   # but calling Shell.new directly won't bring this in.
   def config
-    @config ||= {:config => '~/.config/rib/config.rb', :name => 'rib'}
+    @config ||= {:config => File.join(home, 'config.rb'), :name => 'rib'}
   end
 
   # All shells in the memory
@@ -19,6 +19,17 @@ module Rib
     @vars   ||= {}
   end
 
+  # Rib.home is where Rib storing things
+  def home
+    ENV['RIB_HOME'] ||= begin
+      ['~/.rib', '~/.config/rib'].find{ |path|
+        p = File.expand_path(path)
+        File.exist?(File.join(p, 'config.rb')) ||
+        File.exist?(File.join(p, 'history.rb'))
+      } || '~/.rib'
+    end
+  end
+
   # Convenient shell accessor, which would just give you current last shell
   # or create one and load ~/.config/rib/config.rb if non has existed. If you
   # need a clean shell which does not load rc file, use Shell.new instead.
@@ -54,7 +65,10 @@ module Rib
   # Load (actually require) ~/.config/rib/config.rb if exists.
   # This might emit warnings if there's some error while loading it.
   def require_config
-    config_path && require(config_path)
+    return unless config_path
+    result = require(config_path)
+    Rib.say("Config loaded from: #{config_path}") if $VERBOSE && result
+    result
   rescue Exception => e
     Rib.warn("Error loading #{config[:config]}\n" \
              "  #{Rib::API.format_error(e)}")

data/rib.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rib}
-  s.version = "0.9.0"
+  s.version = "0.9.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Lin Jen-Shin (godfat)}]
-  s.date = %q{2011-08-14}
+  s.date = %q{2011-08-19}
   s.description = %q{Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
 
 Rib is based on the design of [ripl][] and the work of [ripl-rc][], some of
@@ -25,12 +25,6 @@ be simple, lightweight and modular so that everyone could customize Rib.
   %q{rib-min},
   %q{rib-rails},
   %q{rib-ramaze}]
-  s.extra_rdoc_files = [
-  %q{CONTRIBUTORS},
-  %q{LICENSE},
-  %q{CHANGES.md},
-  %q{TODO.md},
-  %q{CONTRIBUTORS}]
   s.files = [
   %q{.gitignore},
   %q{.gitmodules},
@@ -39,7 +33,6 @@ be simple, lightweight and modular so that everyone could customize Rib.
   %q{CONTRIBUTORS},
   %q{Gemfile},
   %q{LICENSE},
-  %q{README},
   %q{README.md},
   %q{Rakefile},
   %q{TODO.md},
@@ -65,7 +58,8 @@ be simple, lightweight and modular so that everyone could customize Rib.
   %q{lib/rib/core/strip_backtrace.rb},
   %q{lib/rib/core/underscore.rb},
   %q{lib/rib/debug.rb},
-  %q{lib/rib/dep/hirb.rb},
+  %q{lib/rib/extra/autoindent.rb},
+  %q{lib/rib/extra/hirb.rb},
   %q{lib/rib/more.rb},
   %q{lib/rib/more/anchor.rb},
   %q{lib/rib/more/color.rb},
@@ -73,6 +67,7 @@ be simple, lightweight and modular so that everyone could customize Rib.
   %q{lib/rib/more/multiline_history.rb},
   %q{lib/rib/more/multiline_history_file.rb},
   %q{lib/rib/plugin.rb},
+  %q{lib/rib/ripl.rb},
   %q{lib/rib/runner.rb},
   %q{lib/rib/shell.rb},
   %q{lib/rib/test.rb},
@@ -94,9 +89,6 @@ be simple, lightweight and modular so that everyone could customize Rib.
   %q{test/test_plugin.rb},
   %q{test/test_shell.rb}]
   s.homepage = %q{https://github.com/godfat/rib}
-  s.rdoc_options = [
-  %q{--main},
-  %q{README}]
   s.require_paths = [%q{lib}]
   s.rubygems_version = %q{1.8.7}
   s.summary = %q{Ruby-Interactive-ruBy -- Yet another interactive Ruby shell}
@@ -119,18 +111,24 @@ be simple, lightweight and modular so that everyone could customize Rib.
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<bond>, [">= 0"])
       s.add_development_dependency(%q<hirb>, [">= 0"])
+      s.add_development_dependency(%q<readline_buffer>, [">= 0"])
       s.add_development_dependency(%q<bacon>, [">= 0"])
       s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
     else
       s.add_dependency(%q<bond>, [">= 0"])
       s.add_dependency(%q<hirb>, [">= 0"])
+      s.add_dependency(%q<readline_buffer>, [">= 0"])
       s.add_dependency(%q<bacon>, [">= 0"])
       s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
     end
   else
     s.add_dependency(%q<bond>, [">= 0"])
     s.add_dependency(%q<hirb>, [">= 0"])
+    s.add_dependency(%q<readline_buffer>, [">= 0"])
     s.add_dependency(%q<bacon>, [">= 0"])
     s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
   end
 end

data/task/gemgem.rb

@@ -12,17 +12,13 @@ module Gemgem
       s.authors     = ['Lin Jen-Shin (godfat)']
       s.email       = ['godfat (XD) godfat.org']
 
-      description   = File.read("#{Gemgem.dir}/README").
+      description   = readme.
                       match(/DESCRIPTION:\n\n(.+?)(?=\n\n[^\n]+:\n)/m)[1].
                       lines.to_a
 
       s.description = description.join
       s.summary     = description.first
 
-      s.extra_rdoc_files = %w[CHANGES    TODO    CONTRIBUTORS LICENSE
-                              CHANGES.md TODO.md CONTRIBUTORS].select{ |f|
-                             File.exist?(f) }
-      s.rdoc_options     = %w[--main README]
       s.rubygems_version = Gem::VERSION
       s.date             = Time.now.strftime('%Y-%m-%d')
       s.files            = gem_files
@@ -34,6 +30,17 @@ module Gemgem
     spec
   end
 
+  def readme
+    path = %w[README.md README].find{ |name|
+      File.exist?("#{Gemgem.dir}/#{name}")
+    }
+    if path
+      File.read(path)
+    else
+      "DESCRIPTION:\n\n \n\nEND:\n"
+    end
+  end
+
   def gem_tag
     "#{spec.name}-#{spec.version}"
   end

data/test/core/test_history.rb

@@ -5,8 +5,10 @@ require 'rib/core/history'
 shared :history do
   should '#after_loop save history' do
     inputs = %w[blih blah]
-    @shell.history.clear
+    # TODO: history.replace(input) is MRI 1.9+
+    clear_history(@shell.history)
     @shell.history.push(*inputs)
+
     @shell.after_loop
     File.read(@history_file).should.eq "#{inputs.join("\n")}\n"
   end
@@ -50,7 +52,7 @@ describe Rib::History do
 
   before do
     if readline?
-      ::Readline::HISTORY.clear
+      clear_history(::Readline::HISTORY)
       stub_readline
     end
     @history_file = "/tmp/test_rib_#{rand}"

data/test/core/test_squeeze_history.rb

@@ -36,7 +36,7 @@ describe Rib::SqueezeHistory do
     @history = "/tmp/test_rib_#{rand}"
     @shell   = Rib::Shell.new(:history_file => @history).before_loop
     @input   = %w[foo bar bar foo bar]
-    @shell.history.clear
+    clear_history(@shell.history)
   end
 
   after do

data/test/more/test_multiline_history.rb

@@ -8,12 +8,12 @@ describe Rib::MultilineHistory do
   behaves_like :setup_multiline
 
   def check str, err=nil
-    @shell.history.clear
+    clear_history(@shell.history)
     with_history(str, err)
 
     setup_shell
 
-    @shell.history.clear
+    clear_history(@shell.history)
     @shell.history << 'old history'
     with_history(str, err, 'old history')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rib
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-14 00:00:00.000000000Z
+date: 2011-08-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bond
-  requirement: &2169075740 !ruby/object:Gem::Requirement
+  requirement: &2166446500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169075740
+  version_requirements: *2166446500
 - !ruby/object:Gem::Dependency
   name: hirb
-  requirement: &2169075260 !ruby/object:Gem::Requirement
+  requirement: &2166446020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169075260
+  version_requirements: *2166446020
+- !ruby/object:Gem::Dependency
+  name: readline_buffer
+  requirement: &2166445540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2166445540
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &2169074780 !ruby/object:Gem::Requirement
+  requirement: &2166445060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169074780
+  version_requirements: *2166445060
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &2169074300 !ruby/object:Gem::Requirement
+  requirement: &2166444580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2166444580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2166444100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169074300
+  version_requirements: *2166444100
 description: ! 'Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
 
 
@@ -82,11 +104,7 @@ executables:
 - rib-rails
 - rib-ramaze
 extensions: []
-extra_rdoc_files:
-- CONTRIBUTORS
-- LICENSE
-- CHANGES.md
-- TODO.md
+extra_rdoc_files: []
 files:
 - .gitignore
 - .gitmodules
@@ -95,7 +113,6 @@ files:
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
-- README
 - README.md
 - Rakefile
 - TODO.md
@@ -121,7 +138,8 @@ files:
 - lib/rib/core/strip_backtrace.rb
 - lib/rib/core/underscore.rb
 - lib/rib/debug.rb
-- lib/rib/dep/hirb.rb
+- lib/rib/extra/autoindent.rb
+- lib/rib/extra/hirb.rb
 - lib/rib/more.rb
 - lib/rib/more/anchor.rb
 - lib/rib/more/color.rb
@@ -129,6 +147,7 @@ files:
 - lib/rib/more/multiline_history.rb
 - lib/rib/more/multiline_history_file.rb
 - lib/rib/plugin.rb
+- lib/rib/ripl.rb
 - lib/rib/runner.rb
 - lib/rib/shell.rb
 - lib/rib/test.rb
@@ -152,9 +171,7 @@ files:
 homepage: https://github.com/godfat/rib
 licenses: []
 post_install_message: 
-rdoc_options:
-- --main
-- README
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/README

@@ -1,184 +0,0 @@
-# Rib
-
-by Lin Jen-Shin ([godfat](http://godfat.org))
-
-## LINKS:
-
-* [github](https://github.com/godfat/rib)
-* [rubygems](http://rubygems.org/gems/rib)
-
-## DESCRIPTION:
-
-Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
-
-Rib is based on the design of [ripl][] and the work of [ripl-rc][], some of
-the features are also inspired by [pry][]. The aim of Rib is to be fully
-featured and yet very easy to opt-out or opt-in other features. It shall
-be simple, lightweight and modular so that everyone could customize Rib.
-
-[ripl]: https://github.com/cldwalker/ripl
-[ripl-rc]: https://github.com/godfat/ripl-rc
-[pry]: https://github.com/pry/pry
-
-## REQUIREMENTS:
-
-* Tested with MRI 1.8.7, 1.9.2 and Rubinius 1.2, JRuby 1.6
-* All gem dependencies are optional, but it's highly recommended to use
-  Rib with [bond][] for tab completion.
-
-[bond]: https://github.com/cldwalker/bond
-
-## INSTALLATION:
-
-    gem install rib
-
-## SYNOPSIS:
-
-![Screenshot](https://github.com/godfat/rib/raw/master/screenshot.png)
-
-### As an interactive shell
-
-As IRB (reads `~/.config/rib/config.rb` writes `~/.config/rib/history.rb`)
-
-    rib
-
-As Rails console
-
-    rib rails
-
-As Ramaze console
-
-    rib ramaze
-
-As a console for whichever the app in the current path
-it should be (for now, it's either Rails or Ramaze)
-
-    rib auto
-
-As a fully featured interactive Ruby shell (as ripl-rc)
-
-    rib all
-
-As a fully featured app console (yes, some commands could be used together)
-
-    rib all auto # or `rib auto all`, the order doesn't really matter
-
-You can customize Rib's behaviour by setting `~/.config/rib/config.rb` (by
-default). Since it's merely a Ruby script which would be loaded into memory
-before launching Rib shell session, You can put any customization or monkey
-patch there. Personally, I use all plugins provided by Rib.
-
-<https://github.com/godfat/dev-tool/blob/master/.config/rib/config.rb>
-
-As you can see, putting `require 'rib/all'` into config file is exactly the
-same as running `rib all` without a config file. What `rib all` would do is
-merely require the file, and that file is also merely requiring all plugins.
-Suppose you only want to use the core plugins and color plugin, you'll put
-this into your config file:
-
-    require 'rib/core'
-    require 'rib/more/color'
-
-You can also write your plugins there. Here's another example:
-
-    require 'rib/core'
-    require 'pp'
-    Rib.config[:prompt] = '$ '
-
-    module RibPP
-      Rib::Shell.send(:include, self)
-
-      def format_result result
-        result_prompt + result.pretty_inspect
-      end
-    end
-
-So that we override the original format_result to pretty_inspect the result.
-You can also build your own gem and then simply require it in your config
-file. To see a list of overridable API, please read [api.rb][]
-
-[api.rb]: https://github.com/godfat/rib/blob/master/lib/rib/api.rb
-
-#### Basic configuration
-
-<pre>
-Rib.config[:config]        | The path where config should be located
-Rib.config[:name]          | The name of this shell
-Rib.config[:result_prompt] | Default is "=>"
-Rib.config[:prompt]        | Default is ">>"
-Rib.config[:binding]       | Context, default: TOPLEVEL_BINDING
-Rib.config[:exit]          | Commands to exit, default [nil, 'exit', 'quit']
-</pre>
-
-#### Plugin specific configuration
-
-<pre>
-Rib.config[:completion]    | Completion: Bond config
-Rib.config[:history_file]  | Default is "~/.rib/config/history.rb"
-Rib.config[:history_size]  | Default is 500
-Rib.config[:color]         | A hash of Class => :color mapping
-</pre>
-
-### As a debugging/interacting tool
-
-Rib could be used as a kind of debugging tool which you can set break point
-in the source program.
-
-    require 'rib/config' # This would load your ~/.config/rib/config.rb
-    require 'rib/anchor' # If you enabled this in config, then needed not.
-    Rib.anchor binding   # This would give you an interactive shell
-                         # when your program has been executed here.
-    Rib.anchor 123       # You can also anchor on an object.
-
-But this might be called in a loop, you might only want to
-enter the shell under certain circumstance, then you'll do:
-
-    require 'rib/debug'
-    Rib.enable_anchor do
-      # Only `Rib.anchor` called in the block would launch a shell
-    end
-
-    Rib.anchor binding # No effect (no-op) outside the block
-
-Anchor could also be nested. The level would be shown on the prompt,
-starting from 1.
-
-### In place editing
-
-Whenever you called:
-
-    Rib.edit
-
-Rib would open an editor according to $EDITOR (`ENV['EDITOR']`) for you.
-After save and leave the editor, Rib would evaluate what you had input.
-This also works inside an anchor. To use it, require either rib/more/edit
-or rib/more or rib/all.
-
-### As a shell framework
-
-The essence is:
-
-    require 'rib'
-
-All others are optional. The core plugins are lying in `rib/core/*.rb`, and
-more plugins are lying in `rib/more/*.rb`. You can read `rib/app/ramaze.rb`
-and `bin/rib-ramaze` as a Rib App reference implementation, because it's very
-simple, simpler than rib-rails.
-
-## LICENSE:
-
-Apache License 2.0
-
-Copyright (c) 2010-2011, Lin Jen-Shin (godfat)
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-<http://www.apache.org/licenses/LICENSE-2.0>
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.