readline_buffer 0.9.1 → 0.9.2

data/CHANGES.md

@@ -1,5 +1,10 @@
 # readline_buffer CHANGES
 
+## readline_buffer 0.9.2 -- 2011-12-14
+
+* Puts a warning for Editline (libedit) instead of failing to install it.
+  If you're using Editline, then readline_buffer would do nothing at all.
+
 ## readline_buffer 0.9.1 -- 2011-08-19
 
 * Fixed a segfault whenever rl_line_buffer is NULL

data/README.md

@@ -9,13 +9,13 @@ by Lin Jen-Shin ([godfat](http://godfat.org))
 
 ## DESCRIPTION:
 
-Let you manipulate Readline.line_buffer
+Let you manipulate `Readline.line_buffer`
 
-Note, only GNU Readline is supported
+Note, only GNU Readline is supported at the moment.
 
 ## REQUIREMENTS:
 
-* GNU Readline, not EditLine
+* GNU Readline, not Editline
 
 ## INSTALLATION:
 
@@ -27,18 +27,7 @@ Note, only GNU Readline is supported
 
 ## LICENSE:
 
-Apache License 2.0
+GPL 3 if you're compiling against Readline,
+otherwise Apache License 2.0
 
 Copyright (c) 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.

data/ext/readline_buffer_ext/extconf.rb

@@ -4,11 +4,10 @@ dir_config('readline')
 have_library('readline')
 
 if have_header('readline/readline.h')
-  if have_func('rl_delete_text', 'readline/readline.h')
-    create_makefile 'readline_buffer_ext'
-  else
-    abort 'Only Readline (not EditLine) is supported'
-  end
+  # editline (libedit) doesn't have rl_delete_text
+  have_func('rl_delete_text', 'readline/readline.h')
+  create_makefile 'readline_buffer_ext'
+
 else
   abort 'Readline not found'
 end

data/ext/readline_buffer_ext/readline_buffer_ext.c

@@ -1,8 +1,5 @@
 
-#ifdef HAVE_READLINE_READLINE_H
 #include "ruby.h"
-#include <errno.h>
-#include <stdio.h>
 #include <readline/readline.h>
 
 static VALUE readline_buffer_ext(VALUE self, VALUE str){
@@ -12,7 +9,11 @@ static VALUE readline_buffer_ext(VALUE self, VALUE str){
   if(rl_line_buffer == NULL)
     return Qnil;
 
+#ifdef HAVE_RL_DELETE_TEXT
   rl_delete_text(0, rl_end);
+#else
+  rl_line_buffer[rl_end = 0] = '\0';
+#endif
   rl_insert_text(RSTRING_PTR(str));
   rl_redisplay();
 
@@ -24,5 +25,3 @@ void Init_readline_buffer_ext() {
     "line_buffer=",
     readline_buffer_ext, 1);
 }
-
-#endif

data/lib/readline_buffer.rb

@@ -1,3 +1,9 @@
 
 require 'readline'
 require 'readline_buffer_ext'
+
+if Readline::VERSION =~ /EditLine/i
+  puts "WARN: Editline (libedit) doesn't work with readline_buffer."
+  puts "      A working patch is wanted, please submit to:"
+  puts "      https://github.com/godfat/readline_buffer    Thanks!!"
+end

data/lib/readline_buffer/version.rb

@@ -1,4 +1,4 @@
 
 module ReadlineBuffer
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/readline_buffer.gemspec

@@ -1,39 +1,32 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{readline_buffer}
-  s.version = "0.9.1"
+  s.name = "readline_buffer"
+  s.version = "0.9.2"
 
   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-19}
-  s.description = %q{Let you manipulate Readline.line_buffer
-
-Note, only GNU Readline is supported}
-  s.email = [%q{godfat (XD) godfat.org}]
-  s.extensions = [%q{ext/readline_buffer_ext/extconf.rb}]
-  s.extra_rdoc_files = [%q{CHANGES.md}]
+  s.authors = ["Lin Jen-Shin (godfat)"]
+  s.date = "2011-12-14"
+  s.description = "Let you manipulate `Readline.line_buffer`\n\nNote, only GNU Readline is supported at the moment."
+  s.email = ["godfat (XD) godfat.org"]
+  s.extensions = ["ext/readline_buffer_ext/extconf.rb"]
   s.files = [
-  %q{.gitignore},
-  %q{.gitmodules},
-  %q{CHANGES.md},
-  %q{README},
-  %q{README.md},
-  %q{Rakefile},
-  %q{ext/readline_buffer_ext/extconf.rb},
-  %q{ext/readline_buffer_ext/readline_buffer_ext.c},
-  %q{lib/readline_buffer.rb},
-  %q{lib/readline_buffer/version.rb},
-  %q{readline_buffer.gemspec},
-  %q{task/.gitignore},
-  %q{task/gemgem.rb}]
-  s.homepage = %q{https://github.com/godfat/readline_buffer}
-  s.rdoc_options = [
-  %q{--main},
-  %q{README}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.7}
-  s.summary = %q{Let you manipulate Readline.line_buffer}
+  ".gitignore",
+  ".gitmodules",
+  "CHANGES.md",
+  "README.md",
+  "Rakefile",
+  "ext/readline_buffer_ext/extconf.rb",
+  "ext/readline_buffer_ext/readline_buffer_ext.c",
+  "lib/readline_buffer.rb",
+  "lib/readline_buffer/version.rb",
+  "readline_buffer.gemspec",
+  "task/.gitignore",
+  "task/gemgem.rb"]
+  s.homepage = "https://github.com/godfat/readline_buffer"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.12"
+  s.summary = "Let you manipulate `Readline.line_buffer`"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/task/gemgem.rb

@@ -12,17 +12,9 @@ module Gemgem
       s.authors     = ['Lin Jen-Shin (godfat)']
       s.email       = ['godfat (XD) godfat.org']
 
-      description   = File.read("#{Gemgem.dir}/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 +26,72 @@ module Gemgem
     spec
   end
 
+  def readme
+    path = %w[README.md README].find{ |name|
+      File.exist?("#{Gemgem.dir}/#{name}")
+    }
+    @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
@@ -88,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
@@ -105,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
@@ -133,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
@@ -153,7 +219,7 @@ task :test do
   Bacon.extend(Bacon::TestUnitOutput)
   Bacon.summary_on_exit
   $LOAD_PATH.unshift('lib')
-  Dir['test/**/test_*.rb'].each{ |file| load file }
+  Dir['./test/**/test_*.rb'].each{ |file| require file[0..-4] }
 end
 
 desc 'Run tests with shell'
@@ -166,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))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readline_buffer
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2011-12-14 00:00:00.000000000 Z
 dependencies: []
-description: ! 'Let you manipulate Readline.line_buffer
+description: ! 'Let you manipulate `Readline.line_buffer`
 
 
-  Note, only GNU Readline is supported'
+  Note, only GNU Readline is supported at the moment.'
 email:
 - godfat (XD) godfat.org
 executables: []
 extensions:
 - ext/readline_buffer_ext/extconf.rb
-extra_rdoc_files:
-- CHANGES.md
+extra_rdoc_files: []
 files:
 - .gitignore
 - .gitmodules
 - CHANGES.md
-- README
 - README.md
 - Rakefile
 - ext/readline_buffer_ext/extconf.rb
@@ -39,9 +37,7 @@ files:
 homepage: https://github.com/godfat/readline_buffer
 licenses: []
 post_install_message: 
-rdoc_options:
-- --main
-- README
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -58,8 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.7
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
-summary: Let you manipulate Readline.line_buffer
+summary: Let you manipulate `Readline.line_buffer`
 test_files: []

data/README

@@ -1,44 +0,0 @@
-# readline_buffer
-
-by Lin Jen-Shin ([godfat](http://godfat.org))
-
-## LINKS:
-
-* [github](https://github.com/godfat/readline_buffer)
-* [rubygems](http://rubygems.org/gems/readline_buffer)
-
-## DESCRIPTION:
-
-Let you manipulate Readline.line_buffer
-
-Note, only GNU Readline is supported
-
-## REQUIREMENTS:
-
-* GNU Readline, not EditLine
-
-## INSTALLATION:
-
-    gem install readline_buffer
-
-## SYNOPSIS:
-
-    Readline.line_buffer = 'p "replace rl_line_buffer"'
-
-## LICENSE:
-
-Apache License 2.0
-
-Copyright (c) 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.