rib 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727360f1321ba8190d0b2316745c26d5b1e26897
-  data.tar.gz: 1ae6ffef657e408088ee7778cd764e85a90f7697
+  metadata.gz: 1a52587cf79d9a191c020346fa3ba53bd5fc12b2
+  data.tar.gz: 522742f98cf7356531ae48892815444978971b31
 SHA512:
-  metadata.gz: 50beef0233c1d1ef514f19f660be5a3941bf564041f69fa740c2e4663cda721e09c7310d59732dacb5d4c12f0f475160f1ebb84b36aaaa5aceb91d39078792db
-  data.tar.gz: 1c68d1f84c0d2c5b26e6302b75fac4aebcdc4a549b8037feab9dda1e38d0d8bf2e0e1dbd8d03b56bca5664a8d212e86b5f1229945fc512ae2d13c4bf6481ac23
+  metadata.gz: be4aed6f46a7a7c73f6713885903d0ed8309a6265bcece16c7dafa1539660c0571735f9b5464dc3435df5692c0a8b4c7603bace1eb7727b132d589f7443fb5f4
+  data.tar.gz: dcbbaadd88bed8fae8508e13840d908a82851a630d05d35e93d7d065bf698d4b5a995cec68ee940489f3e8b1e102142c61e1643cea1958441adcb35c5c4ae06b

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## Rib 1.2.1 -- 2014-01-18
+
+* Fixed a bug where it cannot properly elegantly handle errors when loading
+  the config file.
+
+* [extra/paging] This plugin would try to use $PAGER and by default less to
+  paginate for output which cannot fit in a screen.
+
+* [more/edit] Now by default it would pick vim if $EDITOR is not set.
+
 ## Rib 1.2.0 -- 2014-01-17
 
 * We no longer really eval on TOPLEVEL_BINDING, but a private binding

data/README.md

@@ -100,42 +100,32 @@ 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'
+``` ruby
+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] = '$ '
+``` ruby
+require 'rib/core'
+require 'pp'
+Rib.config[:prompt] = '$ '
 
-    module RibPP
-      Rib::Shell.send(:include, self)
+module RibPP
+  Rib::Shell.send(:include, self)
 
-      def format_result result
-        result_prompt + result.pretty_inspect
-      end
-    end
+  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][]
 
-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
 
@@ -159,27 +149,129 @@ 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: '  '
 
+#### List of core plugins
+
+``` ruby
+require 'rib/core' # You get all of the followings:
+```
+
+* `require 'rib/core/completion'`
+
+  Completion from [bond][].
+
+* `require 'rib/core/history'`
+
+  Remember history in a history file.
+
+* `require 'rib/core/strip_backtrace'`
+
+  Strip backtrace before Rib.
+
+* `require 'rib/core/readline'`
+
+  Readline support.
+
+* `require 'rib/core/multiline'`
+
+  You can interpret multiple lines.
+
+* `require 'rib/core/squeeze_history'`
+
+  Remove duplicated input from history.
+
+* `require 'rib/core/underscore'`
+
+  Save the last result in `_` and the last exception in `__`.
+
+#### List of more plugins
+
+``` ruby
+require 'rib/more' # You get all of the followings:
+```
+
+* `require 'rib/more/multiline_history_file'`
+
+  Not only readline could have multiline history, but also the history file.
+
+* `require 'rib/more/color'`
+
+  Class based colorizing.
+
+* `require 'rib/more/multiline_history'`
+
+  Make readline aware of multiline history.
+
+* `require 'rib/more/anchor'`
+
+  See _As a debugging/interacting tool_.
+
+* `require 'rib/more/edit'`
+
+  See _In place editing_.
+
+### List of extra plugins
+
+There's no `require 'rib/extra'` for extra plugins because they might not
+be doing what you would expect or want, or having an external dependency,
+or having conflicted semantics.
+
+* `require 'rib/extra/autoindent'` This plugin is depending on:
+
+  1. [readline_buffer][]
+  2. readline plugin
+  3. multiline plugin
+
+  Which would autoindent your input.
+
+* `require 'rib/extra/hirb'` This plugin is depending on:
+
+  1. [hirb][]
+
+  Which would print the result with hirb.
+
+* `require 'rib/extra/debugger'` This plugin is depending on:
+
+  1. [debugger][]
+
+  Which introduces `Rib.debug`, which would do similar things as
+  `Rib.anchor` but only more powerful. However, this is not well
+  tested and might not work well. Please let me know if you have
+  any issue using it, thanks!
+
+* `require 'rib/extra/paging'` This plugin is depending on `less`.
+
+  Which would pass the result to `less` (or `$PAGER` if set) if
+  the result string is longer than the screen.
+
+[readline_buffer]: https://github.com/godfat/readline_buffer
+[hirb]: https://github.com/cldwalker/hirb
+[debugger]: https://github.com/cldwalker/debugger
+
 ### 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 Rib config
-    require 'rib/more/anchor'
-                         # If you enabled anchor 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.
+``` ruby
+require 'rib/config' # This would load your Rib config
+require 'rib/more/anchor'
+                     # If you enabled anchor 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
+``` ruby
+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
+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.
@@ -188,19 +280,23 @@ starting from 1.
 
 Whenever you called:
 
-    require 'rib/more/edit'
-    Rib.edit
+``` ruby
+require 'rib/more/edit'
+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.
+Rib would open an editor according to `$EDITOR` (`ENV['EDITOR']`) for you.
+By default it would pick vim if no `$EDITOR` was set. 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'
+``` ruby
+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`

data/lib/rib.rb

@@ -68,7 +68,7 @@ module Rib
     result = require(config_path)
     Rib.say("Config loaded from: #{config_path}") if $VERBOSE && result
     result
-  rescue Exception => e
+  rescue StandardError, LoadError, SyntaxError => e
     Rib.warn("Error loading #{config[:config]}\n" \
              "  #{Rib::API.format_error(e)}")
   end

data/lib/rib/api.rb

@@ -100,11 +100,12 @@ module Rib::API
   def format_error err
     "#{err.class}: #{err.message}\n    #{err.backtrace.join("\n    ")}"
   end
+  module_function :format_error
 
   private
   def equal_rib_skip result
     result == Rib::Skip
-  rescue Exception
+  rescue
     # do nothing, it cannot respond to == correctly, it can't be Rib::Skip
   end
 end

data/lib/rib/extra/paging.rb

@@ -0,0 +1,41 @@
+
+require 'rib'
+
+module Rib::Paging
+  extend Rib::Plugin
+  Shell.use(self)
+
+  # --------------- Rib API ---------------
+
+  # Print result if the it fits one screen,
+  # paging it through a pager otherwise.
+  def print_result result
+    output = format_result(result)
+    if one_screen?(output)
+      puts output
+    else
+      page_result(output)
+    end
+  rescue StandardError, SyntaxError => e
+    Rib.warn("Error while printing result:\n  #{format_error(e)}")
+  end
+
+  # `less -F` can't cat the output, so we need to detect by ourselves.
+  # `less -X` would mess up the buffers, so it's not desired, either.
+  def one_screen? output
+    cols, lines = `tput cols`.to_i, `tput lines`.to_i
+    output.count("\n") <= lines && output.size <= cols * lines
+  end
+
+  def page_result output
+    less = IO.popen(pager, 'w')
+    less.write(output)
+    less.close_write
+  rescue Errno::EPIPE => e
+    Rib.warn("Error while paging result:\n  #{format_error(e)}")
+  end
+
+  def pager
+    ENV['PAGER'] || 'less -R'
+  end
+end

data/lib/rib/more/edit.rb

@@ -13,9 +13,10 @@ module Rib::Edit
       file.puts(Rib.vars[:edit])
       file.close
 
-      system("#{ENV['EDITOR']} #{file.path}")
+      shell = Rib.shell
+      system("#{shell.editor} #{file.path}")
 
-      if (shell = Rib.shell).running?
+      if shell.running?
         shell.send(:multiline_buffer).pop
       else
         shell.before_loop
@@ -29,5 +30,9 @@ module Rib::Edit
     end
   end
 
+  def editor
+    ENV['EDITOR'] || 'vim'
+  end
+
   Rib.extend(Imp)
 end

data/lib/rib/version.rb

@@ -1,4 +1,4 @@
 
 module Rib
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/rib.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rib 1.2.0 ruby lib
+# stub: rib 1.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rib"
-  s.version = "1.2.0"
+  s.version = "1.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-01-17"
+  s.date = "2014-01-18"
   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"
   s.email = ["godfat (XD) godfat.org"]
   s.executables = [
@@ -56,6 +56,7 @@ Gem::Specification.new do |s|
   "lib/rib/extra/autoindent.rb",
   "lib/rib/extra/debugger.rb",
   "lib/rib/extra/hirb.rb",
+  "lib/rib/extra/paging.rb",
   "lib/rib/more.rb",
   "lib/rib/more/anchor.rb",
   "lib/rib/more/color.rb",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rib
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
@@ -70,6 +70,7 @@ files:
 - lib/rib/extra/autoindent.rb
 - lib/rib/extra/debugger.rb
 - lib/rib/extra/hirb.rb
+- lib/rib/extra/paging.rb
 - lib/rib/more.rb
 - lib/rib/more/anchor.rb
 - lib/rib/more/color.rb