RubyGems - rib - Versions diffs - 0.1.0 → 0.9.0 - Mend

rib 0.1.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

data/.gitignore +0 -4
data/CHANGES.md +6 -0
data/README +107 -113
data/README.md +107 -113
data/Rakefile +5 -3
data/TODO.md +6 -0
data/bin/rib-all +5 -0
data/bin/rib-auto +9 -0
data/bin/rib-min +5 -0
data/bin/rib-rails +9 -0
data/bin/rib-ramaze +9 -0
data/lib/rib.rb +70 -6
data/lib/rib/all.rb +0 -1
data/lib/rib/api.rb +60 -64
data/lib/rib/app/auto.rb +25 -0
data/lib/rib/app/rails.rb +41 -0
data/lib/rib/app/ramaze.rb +25 -0
data/lib/rib/config.rb +3 -0
data/lib/rib/core.rb +13 -1
data/lib/rib/core/completion.rb +15 -3
data/lib/rib/core/history.rb +56 -0
data/lib/rib/core/multiline.rb +104 -0
data/lib/rib/core/readline.rb +3 -1
data/lib/rib/core/squeeze_history.rb +45 -0
data/lib/rib/core/strip_backtrace.rb +45 -0
data/lib/rib/core/underscore.rb +17 -8
data/lib/rib/debug.rb +2 -1
data/lib/rib/dep/hirb.rb +24 -0
data/lib/rib/more.rb +4 -3
data/lib/rib/more/anchor.rb +85 -0
data/lib/rib/more/color.rb +44 -43
data/lib/rib/{zore → more}/edit.rb +3 -3
data/lib/rib/more/multiline_history.rb +24 -12
data/lib/rib/more/multiline_history_file.rb +7 -3
data/lib/rib/plugin.rb +2 -4
data/lib/rib/runner.rb +84 -49
data/lib/rib/shell.rb +4 -2
data/lib/rib/test.rb +55 -2
data/lib/rib/test/multiline.rb +140 -0
data/lib/rib/version.rb +1 -1
data/rib.gemspec +54 -22
data/screenshot.png +0 -0
data/task/gemgem.rb +3 -1
data/test/core/{test_history_file.rb → test_history.rb} +29 -19
data/test/core/test_multiline.rb +22 -0
data/test/core/test_readline.rb +13 -8
data/test/{more → core}/test_squeeze_history.rb +24 -18
data/test/core/test_underscore.rb +32 -21
data/test/more/test_multiline_history.rb +42 -0
data/test/test_shell.rb +13 -8
metadata +72 -27
data/2011-02-28.md +0 -203
data/CHANGES +0 -86
data/TODO +0 -6
data/lib/rib/core/history_file.rb +0 -38
data/lib/rib/more/multiline.rb +0 -77
data/lib/rib/more/squeeze_history.rb +0 -37
data/lib/rib/more/strip_backtrace.rb +0 -43
data/lib/rib/zore.rb +0 -3
data/lib/rib/zore/anchor.rb +0 -69

data/.gitignore CHANGED Viewed

@@ -1,6 +1,2 @@
 pkg
-rdoc
 *.rbc
-.bundle
-.yardoc
-Gemfile.lock

data/CHANGES.md ADDED Viewed

@@ -0,0 +1,6 @@
+# Rib CHANGES
+## Rib 0.9.0 -- 2011-08-14
+* First serious release!
+* So much enhancement over ripl-rc!

data/README CHANGED Viewed

@@ -1,175 +1,169 @@
-# ripl-rc
+# Rib
 by Lin Jen-Shin ([godfat](http://godfat.org))
 ## LINKS:
-* [github](https://github.com/godfat/ripl-rc)
-* [rubygems](http://rubygems.org/gems/ripl-rc)
+* [github](https://github.com/godfat/rib)
+* [rubygems](http://rubygems.org/gems/rib)
 ## DESCRIPTION:
-ripl plugins collection, take you want, leave you don't.
+Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
-## REQUIREMENTS:
-* Tested with MRI 1.8.7, 1.9.2 and Rubinius 1.2.3, JRuby 1.6.0
-* ripl
-## INSTALLATION:
-    gem install ripl-rc
+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.
-## SYNOPSIS:
-If you don't know what is __ripl__, or just want to have an
-overview of what does __ripl-rc__ do, then you can use it as
-a command line tool:
+[ripl]: https://github.com/cldwalker/ripl
+[ripl-rc]: https://github.com/godfat/ripl-rc
+[pry]: https://github.com/pry/pry
-    ripl rc
+## REQUIREMENTS:
-This can be used to run rails console, too. First install
-_ripl-rails_ by `gem install ripl-rails` then run this:
+* 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.
-    ripl rc rails
+[bond]: https://github.com/cldwalker/bond
-Then you'll have a _ripl-rc_ flavored rails console without
-setting anything (i.e. `~/.riplrc`)
+## INSTALLATION:
-If you already know what is _ripl_, you might want to setup
-yourself, to be better control what you might want and what
-you might not want. Then checkout FEATURES for all plugins
-you can put in `~/.riplrc`.
+    gem install rib
-If you want to enable all plugins, the use this:
+## SYNOPSIS:
-    require 'ripl/rc'
+![Screenshot](https://github.com/godfat/rib/raw/master/screenshot.png)
-Another thing which might worth to be mentioned is
-`ripl/rc/anchor`, which is a _pry_ like feature built into
-ripl. You can embed two things into ripl, one is any object:
+### As an interactive shell
-    Ripl.anchor your_object_want_to_be_viewed_as_self
+As IRB (reads `~/.config/rib/config.rb` writes `~/.config/rib/history.rb`)
-Another one is local binding inside a method:
+    rib
-    Ripl.anchor binding
+As Rails console
-Then you can look through local variables inside a method
-with an interactive environment. Anchor could be nested, too.
-You can anchor another object inside a _ripl_ session. The number
-shown in prompt is the level of anchors, started from 1.
+    rib rails
-![Screenshot](https://github.com/godfat/ripl-rc/raw/master/screenshot.png)
+As Ramaze console
-Please read this blog post for other detail since I haven't
-had time to update this README... Sorry about that.
+    rib ramaze
-* [a new feature mainly for anchor in ripl-rc ](http://blogger.godfat.org/2011/06/new-feature-mainly-for-anchor-in-ripl.html)
+As a console for whichever the app in the current path
+it should be (for now, it's either Rails or Ramaze)
-## FEATURES:
+    rib auto
-upon session ends:
+As a fully featured interactive Ruby shell (as ripl-rc)
-* `require 'ripl/rc/squeeze_history'`
+    rib all
-  Which squeezes the same input in history, both in memory
-  and history file.
+As a fully featured app console (yes, some commands could be used together)
-* `require 'ripl/rc/mkdir_history'`
+    rib all auto # or `rib auto all`, the order doesn't really matter
-  Which calls `mkdir -p` on directory which contains history
-  file. For example, I put my irb_history in an directory
-  might not exist before use: `~/.config/irb/irb_history`
+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.
-* `require 'ripl/rc/ctrld_newline'`
+<https://github.com/godfat/dev-tool/blob/master/.config/rib/config.rb>
-  Ruby 1.9.2 has no this problem in irb, but 1.8 and ripl do.
-  When hitting ctrl+d to exit ripl, it would print a newline
-  instead of messing up with shell prompt.
+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:
-upon exception occurs:
+    require 'rib/core'
+    require 'rib/more/color'
-* `require 'ripl/rc/last_exception'`
+You can also write your plugins there. Here's another example:
-  We can't access $! for last exception because input evaluation
-  is not in the block which rescues the exception, neither can we
-  update $! because it's a read only pseudo global variable.
+    require 'rib/core'
+    require 'pp'
+    Rib.config[:prompt] = '$ '
-  This plugin makes last rescued exception stored in `Ripl.last_exception`
+    module RibPP
+      Rib::Shell.send(:include, self)
-upon formatting output:
+      def format_result result
+        result_prompt + result.pretty_inspect
+      end
+    end
-* `require 'ripl/rc/strip_backtrace'`
+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][]
-  ripl prints the full backtrace upon exceptions, even the
-  exceptions come from interactive environment, making it
-  very verbose. This ripl plugin strips those backtrace.
+[api.rb]: https://github.com/godfat/rib/blob/master/lib/rib/api.rb
-* `require 'ripl/rc/color'`
+#### Basic configuration
-  There's ripl-color_result that make use of <a href="https://github.com/michaeldv/awesome_print">awesome_print</a>,
-  <a href="http://coderay.rubychan.de/">coderay</a>, or <a href="https://github.com/janlelis/wirb">wirb</a>. The problem of awesome_print is it's too
-  awesome and too verbose, and the problem of coderay and
-  wirb is that they are both parser based. In ripl, this should
-  be as simple as just print different colors upon different
-  objects, instead of inspecting it and parsing it.
+<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>
-  ripl/rc/color just uses a hash with Class to color mapping
-  to pick up which color should be used upon a ruby object.
+#### Plugin specific configuration
-  To customize the color schema, inspect `Ripl.config[:rc_color]`
+<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>
-upon input:
+### As a debugging/interacting tool
-* `require 'ripl/rc/multiline'`
+Rib could be used as a kind of debugging tool which you can set break point
+in the source program.
-  I need some modification on ripl-multi_line to make prompt
-  work better, but not sure if I can come up a good fix and
-  try to convince the author to accept those patches. So I
-  just bundle and maintain it on my own. If you're using
-  ripl-rc, you could use this plugin, otherwise, keep using
-  ripl-multi_line.
+    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.
-* `require 'ripl/rc/eat_whites'`
+But this might be called in a loop, you might only want to
+enter the shell under certain circumstance, then you'll do:
-  irb will just give you another prompt upon an empty input,
-  while ripl would show you that your input is nil. I don't like
-  this, because sometimes I'll keep hitting enter to separate
-  between inspects. This plugin would skip inspect if the input
-  is empty just like irb.
+    require 'rib/debug'
+    Rib.enable_anchor do
+      # Only `Rib.anchor` called in the block would launch a shell
+    end
-special tool:
+    Rib.anchor binding # No effect (no-op) outside the block
-* `require 'ripl/rc/anchor'`
+Anchor could also be nested. The level would be shown on the prompt,
+starting from 1.
-  So this is my attempt to emulate pry in ripl. Instead
-  trying to make pry support irb_history, colorizing, etc.,
-  I think implement pry like feature in ripl is a lot easier.
-  No need to be fancy, I just need the basic functionality.
+### In place editing
-  To use it, use:
-  <pre><code>Ripl.anchor your_object_want_to_be_viewed_as_self</code></pre>
-  or
-  <pre><code>Ripl.anchor binding</code></pre>
-  in your code. Other than pry ripl support, you might be
-  interested in <a href="https://github.com/cldwalker/ripl-rails">ripl-rails</a> and <a href="https://github.com/cldwalker/ripl-hijack">ripl-hijack</a>, too.
+Whenever you called:
-about config:
+    Rib.edit
-* `require 'ripl/rc/noirbrc'`
+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.
-  By default ripl is reading `~/.irbrc`. I don't think this
-  is what people still using irb would want, because the
-  configuration is totally different. This suppress that,
-  make it only read `~/.riplrc`
+### As a shell framework
-for lazies:
+The essence is:
-* `require 'ripl/rc'`
+    require 'rib'
-  This requires anything above for you, and is what `ripl rc`
-  and `ripl rc rails` shell commands did.
+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:

data/README.md CHANGED Viewed

@@ -1,175 +1,169 @@
-# ripl-rc
+# Rib
 by Lin Jen-Shin ([godfat](http://godfat.org))
 ## LINKS:
-* [github](https://github.com/godfat/ripl-rc)
-* [rubygems](http://rubygems.org/gems/ripl-rc)
+* [github](https://github.com/godfat/rib)
+* [rubygems](http://rubygems.org/gems/rib)
 ## DESCRIPTION:
-ripl plugins collection, take you want, leave you don't.
+Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
-## REQUIREMENTS:
-* Tested with MRI 1.8.7, 1.9.2 and Rubinius 1.2.3, JRuby 1.6.0
-* ripl
-## INSTALLATION:
-    gem install ripl-rc
+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.
-## SYNOPSIS:
-If you don't know what is __ripl__, or just want to have an
-overview of what does __ripl-rc__ do, then you can use it as
-a command line tool:
+[ripl]: https://github.com/cldwalker/ripl
+[ripl-rc]: https://github.com/godfat/ripl-rc
+[pry]: https://github.com/pry/pry
-    ripl rc
+## REQUIREMENTS:
-This can be used to run rails console, too. First install
-_ripl-rails_ by `gem install ripl-rails` then run this:
+* 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.
-    ripl rc rails
+[bond]: https://github.com/cldwalker/bond
-Then you'll have a _ripl-rc_ flavored rails console without
-setting anything (i.e. `~/.riplrc`)
+## INSTALLATION:
-If you already know what is _ripl_, you might want to setup
-yourself, to be better control what you might want and what
-you might not want. Then checkout FEATURES for all plugins
-you can put in `~/.riplrc`.
+    gem install rib
-If you want to enable all plugins, the use this:
+## SYNOPSIS:
-    require 'ripl/rc'
+![Screenshot](https://github.com/godfat/rib/raw/master/screenshot.png)
-Another thing which might worth to be mentioned is
-`ripl/rc/anchor`, which is a _pry_ like feature built into
-ripl. You can embed two things into ripl, one is any object:
+### As an interactive shell
-    Ripl.anchor your_object_want_to_be_viewed_as_self
+As IRB (reads `~/.config/rib/config.rb` writes `~/.config/rib/history.rb`)
-Another one is local binding inside a method:
+    rib
-    Ripl.anchor binding
+As Rails console
-Then you can look through local variables inside a method
-with an interactive environment. Anchor could be nested, too.
-You can anchor another object inside a _ripl_ session. The number
-shown in prompt is the level of anchors, started from 1.
+    rib rails
-![Screenshot](https://github.com/godfat/ripl-rc/raw/master/screenshot.png)
+As Ramaze console
-Please read this blog post for other detail since I haven't
-had time to update this README... Sorry about that.
+    rib ramaze
-* [a new feature mainly for anchor in ripl-rc ](http://blogger.godfat.org/2011/06/new-feature-mainly-for-anchor-in-ripl.html)
+As a console for whichever the app in the current path
+it should be (for now, it's either Rails or Ramaze)
-## FEATURES:
+    rib auto
-upon session ends:
+As a fully featured interactive Ruby shell (as ripl-rc)
-* `require 'ripl/rc/squeeze_history'`
+    rib all
-  Which squeezes the same input in history, both in memory
-  and history file.
+As a fully featured app console (yes, some commands could be used together)
-* `require 'ripl/rc/mkdir_history'`
+    rib all auto # or `rib auto all`, the order doesn't really matter
-  Which calls `mkdir -p` on directory which contains history
-  file. For example, I put my irb_history in an directory
-  might not exist before use: `~/.config/irb/irb_history`
+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.
-* `require 'ripl/rc/ctrld_newline'`
+<https://github.com/godfat/dev-tool/blob/master/.config/rib/config.rb>
-  Ruby 1.9.2 has no this problem in irb, but 1.8 and ripl do.
-  When hitting ctrl+d to exit ripl, it would print a newline
-  instead of messing up with shell prompt.
+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:
-upon exception occurs:
+    require 'rib/core'
+    require 'rib/more/color'
-* `require 'ripl/rc/last_exception'`
+You can also write your plugins there. Here's another example:
-  We can't access $! for last exception because input evaluation
-  is not in the block which rescues the exception, neither can we
-  update $! because it's a read only pseudo global variable.
+    require 'rib/core'
+    require 'pp'
+    Rib.config[:prompt] = '$ '
-  This plugin makes last rescued exception stored in `Ripl.last_exception`
+    module RibPP
+      Rib::Shell.send(:include, self)
-upon formatting output:
+      def format_result result
+        result_prompt + result.pretty_inspect
+      end
+    end
-* `require 'ripl/rc/strip_backtrace'`
+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][]
-  ripl prints the full backtrace upon exceptions, even the
-  exceptions come from interactive environment, making it
-  very verbose. This ripl plugin strips those backtrace.
+[api.rb]: https://github.com/godfat/rib/blob/master/lib/rib/api.rb
-* `require 'ripl/rc/color'`
+#### Basic configuration
-  There's ripl-color_result that make use of <a href="https://github.com/michaeldv/awesome_print">awesome_print</a>,
-  <a href="http://coderay.rubychan.de/">coderay</a>, or <a href="https://github.com/janlelis/wirb">wirb</a>. The problem of awesome_print is it's too
-  awesome and too verbose, and the problem of coderay and
-  wirb is that they are both parser based. In ripl, this should
-  be as simple as just print different colors upon different
-  objects, instead of inspecting it and parsing it.
+<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>
-  ripl/rc/color just uses a hash with Class to color mapping
-  to pick up which color should be used upon a ruby object.
+#### Plugin specific configuration
-  To customize the color schema, inspect `Ripl.config[:rc_color]`
+<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>
-upon input:
+### As a debugging/interacting tool
-* `require 'ripl/rc/multiline'`
+Rib could be used as a kind of debugging tool which you can set break point
+in the source program.
-  I need some modification on ripl-multi_line to make prompt
-  work better, but not sure if I can come up a good fix and
-  try to convince the author to accept those patches. So I
-  just bundle and maintain it on my own. If you're using
-  ripl-rc, you could use this plugin, otherwise, keep using
-  ripl-multi_line.
+    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.
-* `require 'ripl/rc/eat_whites'`
+But this might be called in a loop, you might only want to
+enter the shell under certain circumstance, then you'll do:
-  irb will just give you another prompt upon an empty input,
-  while ripl would show you that your input is nil. I don't like
-  this, because sometimes I'll keep hitting enter to separate
-  between inspects. This plugin would skip inspect if the input
-  is empty just like irb.
+    require 'rib/debug'
+    Rib.enable_anchor do
+      # Only `Rib.anchor` called in the block would launch a shell
+    end
-special tool:
+    Rib.anchor binding # No effect (no-op) outside the block
-* `require 'ripl/rc/anchor'`
+Anchor could also be nested. The level would be shown on the prompt,
+starting from 1.
-  So this is my attempt to emulate pry in ripl. Instead
-  trying to make pry support irb_history, colorizing, etc.,
-  I think implement pry like feature in ripl is a lot easier.
-  No need to be fancy, I just need the basic functionality.
+### In place editing
-  To use it, use:
-  <pre><code>Ripl.anchor your_object_want_to_be_viewed_as_self</code></pre>
-  or
-  <pre><code>Ripl.anchor binding</code></pre>
-  in your code. Other than pry ripl support, you might be
-  interested in <a href="https://github.com/cldwalker/ripl-rails">ripl-rails</a> and <a href="https://github.com/cldwalker/ripl-hijack">ripl-hijack</a>, too.
+Whenever you called:
-about config:
+    Rib.edit
-* `require 'ripl/rc/noirbrc'`
+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.
-  By default ripl is reading `~/.irbrc`. I don't think this
-  is what people still using irb would want, because the
-  configuration is totally different. This suppress that,
-  make it only read `~/.riplrc`
+### As a shell framework
-for lazies:
+The essence is:
-* `require 'ripl/rc'`
+    require 'rib'
-  This requires anything above for you, and is what `ripl rc`
-  and `ripl rc rails` shell commands did.
+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: