rib 0.9.5 → 0.9.9

data/CHANGES.md

@@ -1,5 +1,20 @@
 # Rib CHANGES
 
+## Rib 0.9.9 -- 2011-10-26
+
+### Bugs fixes
+
+* [more/color] Fixed Windows coloring support.
+* [more/color] Properly reset ANSI sequence.
+
+### Enhancement
+
+* [commands] Extract commands description under `__END__` in the commands.
+  Please read [rib-rest-core][] as an example.
+* [rib] Always show original errors if anything is wrong.
+
+[rib-rest-core]: https://github.com/cardinalblue/rest-core/blob/rest-core-0.7.0/bin/rib-rest-core#L21-22
+
 ## Rib 0.9.5 -- 2011-09-03
 
 * [rib-rails] Fixed Rails3 (sandbox) and Rails2 (env) console. Thanks bootleq

data/Rakefile

@@ -8,8 +8,8 @@ desc 'Generate gemspec'
 task 'gem:spec' do
   Gemgem.spec = Gemgem.create do |s|
     require 'rib/version'
-    s.name        = 'rib'
-    s.version     = Rib::VERSION
+    s.name    = 'rib'
+    s.version = Rib::VERSION
 
     %w[].each{ |g| s.add_runtime_dependency(g) }
   end

data/lib/rib/app/auto.rb

@@ -16,7 +16,7 @@ module Rib::Auto
       begin
         app.load
       rescue LoadError => e
-        Rib.warn("Is this a #{app} app?\n  #{e}")
+        Rib.warn("Error: #{e}", "Is this a #{app} app?")
       end
     else
       Rib.warn("No app found")

data/lib/rib/app/rails.rb

@@ -5,7 +5,7 @@ module Rib::Rails
   def load
     load_rails
   rescue LoadError => e
-    Rib.abort("Is this a Rails app?\n  #{e}")
+    Rib.abort("Error: #{e}", "Is this a Rails app?")
   end
 
   def load_rails

data/lib/rib/app/ramaze.rb

@@ -5,7 +5,7 @@ module Rib::Ramaze
   def load
     load_ramaze
   rescue LoadError => e
-    Rib.abort("Is this a Ramaze app?\n  #{e}")
+    Rib.abort("Error: #{e}", "Is this a Ramaze app?")
   end
 
   def load_ramaze

data/lib/rib/core/completion.rb

@@ -26,9 +26,10 @@ end
 
 begin
   Rib.silence{require 'bond'}
-rescue LoadError
-  Rib.warn("Please install bond to use completion plugin:\n",
-           "    gem install bond\n",
-           "Or add bond to Gemfile if that's the case")
+rescue LoadError => e
+  Rib.warn("Error: #{e}"                                    ,
+           "Please install bond to use completion plugin:\n",
+           "    gem install bond\n"                         ,
+           "Or add bond to Gemfile if that's the case"      )
   Rib::Completion.disable
 end

data/lib/rib/extra/autoindent.rb

@@ -155,9 +155,10 @@ 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")
+rescue LoadError => e
+  Rib.warn("Error: #{e}"                                               ,
+           "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/extra/hirb.rb

@@ -18,9 +18,10 @@ begin
     require 'hirb'
     ::Hirb.enable
   }
-rescue LoadError
-  Rib.warn("Please install hirb to use hirb plugin:\n",
-           "    gem install hirb\n",
+rescue LoadError => e
+  Rib.warn("Error: #{e}"                              ,
+           "Please install hirb to use hirb plugin:\n",
+           "    gem install hirb\n"                   ,
            "Or add hirb to Gemfile if that's the case")
   Rib::Hirb.disable
 end

data/lib/rib/more/anchor.rb

@@ -18,7 +18,7 @@ module Rib::Anchor
 
   def prompt
     return super if Rib::Anchor.disabled?
-    return super unless config[:anchor]
+    return super unless config[:prompt_anchor]
 
     level = "(#{Rib.shells.size - 1})"
     if Rib.const_defined?(:Color) &&
@@ -53,16 +53,18 @@ module Rib::Anchor
   end
 
   module Imp
-    def anchor obj_or_binding
+    def anchor obj_or_binding, opts={}
       return if Rib::Anchor.disabled?
 
       if Rib.shell.running?
         Rib.shells << Rib::Shell.new(
-          Rib.shell.config.merge( :binding => obj_or_binding,
-                                  :anchor  => true          ))
+          Rib.shell.config.merge( :binding       => obj_or_binding,
+                                  :prompt_anchor => true         ).
+                           merge(opts))
       else
-          Rib.shell.config.merge!(:binding => obj_or_binding,
-                                  :anchor  => true          )
+          Rib.shell.config.merge!(:binding       => obj_or_binding,
+                                  :prompt_anchor => true         ).
+                           merge!(opts)
       end
 
       Rib.shell.loop

data/lib/rib/more/color.rb

@@ -84,7 +84,7 @@ module Rib::Color
   end
 
   def color rgb
-    "\x1b[#{rgb}m" + (block_given? ? "#{yield}#{reset}" : '')
+    "\e[#{rgb}m" + if block_given? then "#{yield}#{reset}" else '' end
   end
 
   def   black █ color(30, &block); end
@@ -95,5 +95,15 @@ module Rib::Color
   def magenta █ color(35, &block); end
   def    cyan █ color(36, &block); end
   def   white █ color(37, &block); end
-  def   reset █ color('', &block); end
+  def   reset █ color( 0, &block); end
+end
+
+begin
+  require 'win32console' if defined?(Gem) && Gem.win_platform?
+rescue LoadError => e
+  Rib.warn("Error: #{e}"                                                  ,
+           "Please install win32console to use color plugin on Windows:\n",
+           "    gem install win32console\n"                               ,
+           "Or add win32console to Gemfile if that's the case"            )
+  Rib::Color.disable
 end

data/lib/rib/runner.rb

@@ -32,14 +32,17 @@ module Rib::Runner
 
   def commands
      @commands ||=
-      command_names.map{ |n| [n, command_descriptions[n] || ' '] }
+      command_paths.map{ |path|
+        name = File.basename(path)[/^rib\-(.+)$/, 1]
+        [name, command_descriptions[name]      ||
+               command_descriptions_find(path) || ' '] }
   end
 
-  def command_names
-    @command_names ||=
+  def command_paths
+    @command_paths ||=
     Gem.path.map{ |path|
       Dir["#{path}/bin/*"].map{ |f|
-        (File.executable?(f) && File.basename(f) =~ /^rib\-(\w+)$/ && $1) ||
+        (File.executable?(f) && File.basename(f) =~ /^rib\-.+$/ && f) ||
          nil    # a trick to make false to be nil and then
       }.compact # this compact could eliminate them
     }.flatten
@@ -54,6 +57,12 @@ module Rib::Runner
      'ramaze' => 'Run as Ramaze console'                       }
   end
 
+  # Extract the text below __END__ in the bin file as the description
+  def command_descriptions_find path
+    File.read(path) =~ /Gem\.bin_path\(['"](.+)['"], ['"](.+)['"],/
+    File.read(Gem.bin_path($1, $2))[/\n__END__\n(.+)$/m, 1].strip
+  end
+
   def run argv=ARGV
     (@running_commands ||= []) << Rib.config[:name]
     unused = parse(argv)
@@ -71,36 +80,36 @@ module Rib::Runner
     unused = []
     until argv.empty?
       case arg = argv.shift
-      when /-e=?(.+)?/, /--eval=?(.+)?/
+      when /^-e=?(.+)?/, /^--eval=?(.+)?/
         eval($1 || argv.shift, binding, __FILE__, __LINE__)
 
-      when /-d/, '--debug'
+      when /^-d/, '--debug'
         $DEBUG = true
         argv.unshift("-#{arg[2..-1]}") if arg.size > 2
 
-      when /-w/, '--warn'
+      when /^-w/, '--warn'
         $-w, $VERBOSE = true, true
         argv.unshift("-#{arg[2..-1]}") if arg.size > 2
 
-      when /-I=?(.+)?/, /--include=?(.+)?/
+      when /^-I=?(.+)?/, /^--include=?(.+)?/
         paths = ($1 || argv.shift).split(':')
         $LOAD_PATH.unshift(*paths)
 
-      when /-r=?(.+)?/, /--require=?(.+)?/
+      when /^-r=?(.+)?/, /^--require=?(.+)?/
         require($1 || argv.shift)
 
-      when /-c=?(.+)?/, /--config=?(.+)?/
+      when /^-c=?(.+)?/, /^--config=?(.+)?/
         Rib.config[:config] = $1 || argv.shift
 
-      when /-n/, '--no-config'
+      when /^-n/, '--no-config'
         Rib.config.delete(:config)
         argv.unshift("-#{arg[2..-1]}") if arg.size > 2
 
-      when /-h/, '--help'
+      when /^-h/, '--help'
         puts(help)
         exit
 
-      when /-v/, '--version'
+      when /^-v/, '--version'
         require 'rib/version'
         puts(Rib::VERSION)
         exit

data/lib/rib/version.rb

@@ -1,4 +1,4 @@
 
 module Rib
-  VERSION = '0.9.5'
+  VERSION = '0.9.9'
 end

data/rib.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rib"
-  s.version = "0.9.5"
+  s.version = "0.9.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2011-09-03"
+  s.date = "2011-10-26"
   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 = [
@@ -81,7 +81,7 @@ Gem::Specification.new do |s|
   "test/test_shell.rb"]
   s.homepage = "https://github.com/godfat/rib"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "Ruby-Interactive-ruBy -- Yet another interactive Ruby shell"
   s.test_files = [
   "test/core/test_completion.rb",

data/task/gemgem.rb

@@ -12,10 +12,6 @@ module Gemgem
       s.authors     = ['Lin Jen-Shin (godfat)']
       s.email       = ['godfat (XD) godfat.org']
 
-      description   = readme.
-                      match(/DESCRIPTION:\n\n(.+?)(?=\n\n[^\n]+:\n)/m)[1].
-                      lines.to_a
-
       s.description = description.join
       s.summary     = description.first
 
@@ -34,13 +30,68 @@ module Gemgem
     path = %w[README.md README].find{ |name|
       File.exist?("#{Gemgem.dir}/#{name}")
     }
-    if path
-      File.read(path)
-    else
-      "DESCRIPTION:\n\n \n\nEND:\n"
+    @readme ||=
+      if path
+        ps = File.read(path).scan(/#+[^\n]+\n\n.+?(?=\n\n#+[^\n]+\n)/m)
+        ps.inject({'HEADER' => ps.first}){ |r, s, i|
+          r[s[/\w+/]] = s
+          r
+        }
+      else
+        {}
+      end
+  end
+
+  def description
+    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
+  end
+
+  def changes
+    path = %w[CHANGES.md CHANGES].find{ |name|
+      File.exist?("#{Gemgem.dir}/#{name}")
+    }
+    @changes ||=
+      if path
+        date = '\d+{4}\-\d+{2}\-\d{2}'
+        File.read(path).match(
+          /([^\n]+#{date}\n\n(.+?))(?=\n\n[^\n]+#{date}\n|\Z)/m)[1]
+      else
+        ''
+      end
+  end
+
+  def ann_md
+    "##{readme['HEADER'].sub(/([\w\-]+)/, "[\\1](#{spec.homepage})")}\n\n" \
+    "##{readme['DESCRIPTION'][/[^\n]+\n\n[^\n]+/]}\n\n"                    \
+    "### CHANGES:\n\n"                                                     \
+    "###{changes}\n\n"                                                     \
+    "##{readme['INSTALLATION']}\n\n"                                       +
+    if readme['SYNOPSIS'] then "##{readme['SYNOPSIS']}" else '' end
+  end
+
+  def ann_html
+    gem 'nokogiri'
+    gem 'kramdown'
+
+    IO.popen('kramdown', 'r+') do |md|
+      md.puts Gemgem.ann_md
+      md.close_write
+      require 'nokogiri'
+      html = Nokogiri::XML.parse("<gemgem>#{md.read}</gemgem>")
+      html.css('*').each{ |n| n.delete('id') }
+      html.root.children.to_html
     end
   end
 
+  def ann_email
+    "#{readme['HEADER'].sub(/([\w\-]+)/, "\\1 <#{spec.homepage}>")}\n\n" \
+    "#{readme['DESCRIPTION']}\n\n"                                       \
+    "#{readme['INSTALLATION']}\n\n"                                      +
+    if readme['SYNOPSIS'] then "##{readme['SYNOPSIS']}\n\n" else '' end  +
+    "## CHANGES:\n\n"                                                    \
+    "##{changes}\n\n"
+  end
+
   def gem_tag
     "#{spec.name}-#{spec.version}"
   end
@@ -95,7 +146,7 @@ module Gemgem
 
   def ignore_patterns
     @ignore_files ||= expand_patterns(
-      File.read("#{dir}/.gitignore").split("\n").reject{ |pattern|
+      gitignore.split("\n").reject{ |pattern|
         pattern.strip == ''
       }).map{ |pattern| %r{^([^/]+/)*?#{Regexp.escape(pattern)}(/[^/]+)*?$} }
   end
@@ -112,6 +163,14 @@ module Gemgem
       end
     }.flatten
   end
+
+  def gitignore
+    if File.exist?(path = "#{dir}/.gitignore")
+      File.read(path)
+    else
+      ''
+    end
+  end
 end
 
 namespace :gem do
@@ -140,14 +199,14 @@ task :check do
   ver = Gemgem.spec.version.to_s
 
   if ENV['VERSION'].nil?
-    puts("\x1b[35mExpected "                                        \
-         "\x1b[33mVERSION\x1b[35m=\x1b[33m#{ver}\x1b[m")
+    puts("\e[35mExpected "                                  \
+         "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
     exit(1)
 
   elsif ENV['VERSION'] != ver
-    puts("\x1b[35mExpected \x1b[33mVERSION\x1b[35m=\x1b[33m#{ver} " \
-         "\x1b[35mbut got\n         "                               \
-         "\x1b[33mVERSION\x1b[35m=\x1b[33m#{ENV['VERSION']}\x1b[m")
+    puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+         "\e[35mbut got\n         "                         \
+         "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
     exit(2)
   end
 end
@@ -173,13 +232,28 @@ task 'test:shell', :RUBY_OPTS do |t, args|
   sh(cmd.compact.join(' '))
 end
 
+desc 'Generate ann markdown'
+task 'ann:md' => ['gem:spec'] do
+  puts Gemgem.ann_md
+end
+
+desc 'Generate ann html'
+task 'ann:html' => ['gem:spec'] do
+  puts Gemgem.ann_html
+end
+
+desc 'Generate ann email'
+task 'ann:email' => ['gem:spec'] do
+  puts Gemgem.ann_email
+end
+
 desc 'Generate rdoc'
 task :doc => ['gem:spec'] do
   sh("yardoc -o rdoc --main README.md" \
      " --files #{Gemgem.spec.extra_rdoc_files.join(',')}")
 end
 
-desc 'Removed ignored files'
+desc 'Remove ignored files'
 task :clean => ['gem:spec'] do
   trash = "~/.Trash/#{Gemgem.spec.name}/"
   sh "mkdir -p #{trash}" unless File.exist?(File.expand_path(trash))

data/test/more/test_color.rb

@@ -18,11 +18,11 @@ describe Rib::Color do
     @color.send(:format_color,
       [{0 => :a}, 'b', [nil, {false => Object}], {true => Exception.new}]).
         should.eq \
-          "\e[34m[\e[m\e[34m{\e[m\e[31m0\e[m\e[34m=>\e[m\e[36m:a\e[m\e[" \
-          "34m}\e[m\e[34m, \e[m\e[32m\"b\"\e[m\e[34m, \e[m\e[34m[\e[m\e" \
-          "[35mnil\e[m\e[34m, \e[m\e[34m{\e[m\e[35mfalse\e[m\e[34m=>\e[" \
-          "m\e[33mObject\e[m\e[34m}\e[m\e[34m]\e[m\e[34m, \e[m\e[34m{\e" \
-          "[m\e[35mtrue\e[m\e[34m=>\e[m\e[35m#<Exception: Exception>\e[" \
-          "m\e[34m}\e[m\e[34m]\e[m"
+          "\e[34m[\e[0m\e[34m{\e[0m\e[31m0\e[0m\e[34m=>\e[0m\e[36m:a\e[0m\e" \
+          "[34m}\e[0m\e[34m, \e[0m\e[32m\"b\"\e[0m\e[34m, \e[0m\e[34m[\e[0m" \
+          "\e[35mnil\e[0m\e[34m, \e[0m\e[34m{\e[0m\e[35mfalse\e[0m\e[34m=>"  \
+          "\e[0m\e[33mObject\e[0m\e[34m}\e[0m\e[34m]\e[0m\e[34m, \e[0m\e[34m"\
+          "{\e[0m\e[35mtrue\e[0m\e[34m=>\e[0m\e[35m#<Exception: Exception>"  \
+          "\e[0m\e[34m}\e[0m\e[34m]\e[0m"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rib
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-03 00:00:00.000000000 Z
+date: 2011-10-26 00:00:00.000000000Z
 dependencies: []
 description: ! 'Ruby-Interactive-ruBy -- Yet another interactive Ruby shell
 
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby-Interactive-ruBy -- Yet another interactive Ruby shell