irb-history 1.0.0

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2005 Sam Stephenson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,63 @@
+= irb-history
+
+irb-history gives IRB <b>persistent, shared Readline history</b> by way of
+Distributed Ruby (DRb).  What does that mean?
+
+==== Persistent
+
+<tt>irb-history-server</tt> stores its history in YAML in a file of your 
+choice (the default is <tt>~/.irb_history</tt>).
+
+==== Shared
+
+Load the irb-history client in your <tt>~/.irbrc</tt>, and you'll instantly
+have access to the irb-history store. Every line you type is sent to the 
+server and will appear in other clients' histories immediately.
+
+Because irb-history uses DRb, you can share your history with other IRB 
+sessions:
+
+* on the same computer
+* on other computers on your local network
+* on computers connected to the Internet (fun, but not recommended :))
+
+=== Installation and usage
+
+It's a simple process:
+
+1. <b>Install the gem</b>.
+     $ gem install irb-history
+   
+2. <b>Start a history server</b> listening on <tt>127.0.0.1</tt>,
+   port <tt>26501</tt> (see the {irb-history-server
+   documentation}[link:files/bin/irb-history-server.html] for more options).
+     $ irb-history-server -d
+    
+   Note: If you wish to use irb-history on a network, you'll need to pass
+   the <tt>-h</tt> flag with an appropriate address to listen on.
+    
+3. <b>Add three lines to your <tt>~/.irbrc</tt></b>.
+     require 'rubygems'
+     require 'irb/history'
+     IRB::History.start_client
+   This connects to the history server on <tt>127.0.0.1</tt>, port 
+   <tt>26501</tt>. If you need to specify a different host and/or port, just
+   pass a DRb URI to <tt>start_client</tt>. For example:
+     IRB::History.start_client 'druby://galt:4000'
+   connects to the history server on host <tt>galt</tt>, port <tt>4000</tt>.
+
+=== Source code
+
+Check out the darcs[http://darcs.net/] repository:
+
+  $ darcs get http://dev.conio.net/repos/irb-history
+
+=== License
+
+irb-history is freely distributable under the terms of a {MIT-style 
+license}[link:files/LICENSE.html].
+
+=== Author
+
+Sam Stephenson <{sam@conio.net}[mailto:sam@conio.net]>
+

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+class String
+  def unquote
+    self.gsub /^(['"])(.*)\1$/, '\2'
+  end
+end
+
+PKG_NAME         = 'irb-history'
+PKG_VERSION      = '1.0.0'
+PKG_DESCRIPTION  = 'Persistent, shared IRB Readline history'
+PKG_FILE_NAME    = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_DESTINATION  = "pkg/#{PKG_NAME}"
+PKG_AUTHOR       = 'Sam Stephenson'
+PKG_AUTHOR_EMAIL = 'sam@conio.net'
+PKG_DOC_DIR      = 'rdoc'
+
+task :default => [:rdoc, :package]
+
+SOURCE_FILES = FileList[
+  '[A-Z]*',
+  'bin/**',
+  'lib/**/*.rb'
+].to_a
+
+RDOC_FILES = SOURCE_FILES - %w(Rakefile)
+
+desc 'Generate documentation'
+rdoc = Rake::RDocTask.new do |rd|
+  rd.main     = 'README'
+  rd.title    = PKG_NAME
+  rd.rdoc_dir = PKG_DOC_DIR
+  rd.options += %w(--inline-source --line-numbers)
+  rd.rdoc_files.include RDOC_FILES
+end
+
+spec = Gem::Specification.new do |s|
+  s.name         = PKG_NAME
+  s.version      = PKG_VERSION
+  s.summary      = PKG_DESCRIPTION
+  s.description  = PKG_DESCRIPTION
+  s.author       = PKG_AUTHOR
+  s.email        = PKG_AUTHOR_EMAIL
+  
+  s.files        = SOURCE_FILES
+  s.bindir       = 'bin'
+  s.require_path = 'lib'
+  s.executables  = %w(irb-history-server)
+  
+  s.has_rdoc     = true
+  s.rdoc_options = rdoc.option_list.map {|o| o.unquote}
+  s.extra_rdoc_files = RDOC_FILES
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+desc 'Removes documentation and package files'
+task :clean => [:clobber_rdoc, :clobber_package]

data/THANKS

@@ -0,0 +1,5 @@
+Many thanks, as always, go to:
+
+* Scott Barron -- http://scott.elitists.net/
+* Mikael Brockman -- http://www.deepwood.net/~mikael/tumblelog/
+* Marcel Molina, Jr -- http://vernix.org/marcel/

data/bin/irb-history-server

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+# = irb-history-server
+#
+# Manages an irb-history YAML store and starts a DRb service for irb-history 
+# clients.
+#
+# Usage: <tt>irb-history-server [options]</tt>
+# 
+#     -p, --port=port                  listen on the specified port
+#                                      (default: 26501)
+#     -h, --host=host                  bind to the specified host
+#                                      (default: "127.0.0.1")
+#     -f, --filename=filename          use the specified history file
+#                                      (default: ~/.irb_history)
+#     -d, --daemon                     make irb-history-server run as a daemon
+
+begin
+  require 'rubygems'
+  require 'irb/history'
+rescue LoadError
+  $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+  require 'irb/history'
+end
+
+require 'optparse'
+
+OPTIONS = {
+  :port => IRB::History::DEFAULT_PORT,
+  :host => IRB::History::DEFAULT_HOST,
+  :file => IRB::History::DEFAULT_FILE,
+  :fork => false
+}
+
+SCRIPT_NAME = File.basename(__FILE__)
+
+ARGV.options do |opts|
+  opts.banner = "Usage: #{SCRIPT_NAME} [options]"
+  
+  opts.separator ''
+  
+  opts.on('-p', '--port=port', Integer,
+          "listen on the specified port",
+          "(default: #{OPTIONS[:port]})") {|OPTIONS[:port]|}
+  opts.on('-h', '--host=host', String,
+          "bind to the specified host",
+          "(default: #{OPTIONS[:host].inspect})") {|OPTIONS[:host]|}
+  opts.on('-f', '--filename=filename', String,
+          "use the specified history file",
+          "(default: #{OPTIONS[:file]})") {|OPTIONS[:file]|}
+  opts.on('-d', '--daemon', 
+          "make #{SCRIPT_NAME} run as a daemon") {|OPTIONS[:fork]|}
+          
+  opts.separator ''
+  
+  opts.on(nil, '--help', 'show this help message') {puts opts; exit}
+  
+  opts.parse!
+end
+
+uri = "druby://#{OPTIONS[:host]}:#{OPTIONS[:port]}"
+puts "*** #{SCRIPT_NAME} starting on #{uri}"
+puts "*** history file: #{OPTIONS[:file]}"
+
+if OPTIONS[:fork]
+  exit if fork
+  Process.setsid
+  exit if fork
+  Dir.chdir '/'
+  [STDIN, STDOUT, STDERR].each {|io| io.reopen('/dev/null', 'r+')}
+else
+  trap :INT do
+    puts "*** #{SCRIPT_NAME} exiting"
+    exit!
+  end
+end
+
+IRB::History.start_server uri, OPTIONS[:file]
+DRb.thread.join

data/lib/irb/history.rb

@@ -0,0 +1,5 @@
+require 'irb'
+
+%w(client server).each do |filename|
+  require File.join(File.dirname(__FILE__), 'history', filename)
+end

data/lib/irb/history/base.rb

@@ -0,0 +1,26 @@
+module IRB #:nododc:
+  module History
+    DEFAULT_HOST = '127.0.0.1'
+    DEFAULT_PORT = 26501
+    DEFAULT_URI  = "druby://#{DEFAULT_HOST}:#{DEFAULT_PORT}"
+    DEFAULT_FILE = '~/.irb_history'
+  end
+end
+
+module Kernel
+  # A Ruby-ized realization of the K combinator, courtesy of Mikael Brockman.
+  #
+  #   def foo
+  #     returning values = [] do
+  #       values << 'bar'
+  #       values << 'baz'
+  #     end
+  #   end
+  #
+  #   foo # => ['bar', 'baz']
+  #  
+  def returning(value) 
+    yield
+    value
+  end
+end

data/lib/irb/history/client.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), 'base')
+
+module IRB #:nodoc:
+  module History
+    # Reconfigures a running IRB session to use the given remote history
+    # service specified by +uri+, initially retrieving +lines_to_recall+ 
+    # lines of history.
+    #
+    # Note: This method overrides +gets+ in IRB::ReadlineInputMethod; it
+    # can't be "stopped," and you shouldn't call it more than once.
+    #
+    def self.start_client(uri = DEFAULT_URI, lines_to_recall = 100)
+      require 'drb'
+  
+      DRb.start_service
+      history = DRbObject.new nil, uri
+  
+      IRB::ReadlineInputMethod.instance_eval do
+        alias_method :old_gets, :gets
+
+        define_method :gets do
+          returning old_gets do
+            line = Readline::HISTORY[-1]
+            history.remember line unless @eof rescue nil
+          end
+        end
+      end
+
+      Readline::HISTORY.push *history.recall(lines_to_recall)
+
+      at_exit {history.unsubscribe_from Readline::HISTORY} if
+        history.subscribe_to Readline::HISTORY
+    rescue   
+    end
+  end
+end

data/lib/irb/history/server.rb

@@ -0,0 +1,95 @@
+require 'drb'
+require 'yaml'
+
+require File.join(File.dirname(__FILE__), 'base')
+
+module IRB #:nodoc:
+  module History
+    class Server
+      attr_accessor :service
+      
+      # Creates a new Server with the YAML history store file specified
+      # by +filename+.
+      def initialize(filename)
+        @filename = File.expand_path(filename)
+        @subscriptions = []
+        @mutex = Mutex.new
+        load
+      end
+  
+      # Returns the number of lines in the history store.
+      def length
+        @store.length
+      end
+  
+      # Stores the given +values+ in the history store, saves the history
+      # store to disk, and notifies any subscribers of the added lines.
+      def remember(*values)
+        @mutex.synchronize do
+          @store += values
+          notify_subscriptions_with *values
+          save
+        end
+      end
+  
+      # Returns the last +limit+ history lines from the history store. If
+      # +limit+ is 0 (the default value), a copy of the entire history
+      # store is returned.
+      def recall(limit = 0)
+        @mutex.synchronize do
+          limit = length if limit > length
+          @store[-limit..-1] || []
+        end
+      end
+  
+      # Subscribes to the given +readline_history+ (which can be any object
+      # that responds to +push+, but is intended to be used with the
+      # Readline::HISTORY object). When new history lines are added, they'll
+      # be pushed onto subscriptions.
+      def subscribe_to(readline_history)
+        @subscriptions |= [readline_history]
+        true
+      end
+  
+      # Removes the given +readline_history+ object from the subscription
+      # list. This should be called from +at_exit+ in history clients.
+      def unsubscribe_from(readline_history)
+        @subscriptions -= [readline_history]
+        true
+      end
+
+    protected
+      def load
+        @store = YAML.load_file(@filename) rescue []
+      end
+  
+      def save
+        File.open(@filename, 'w+') {|file| file << YAML.dump(@store)}
+      end
+  
+      def notify_subscriptions_with(*values)
+        @subscriptions.each do |readline_history|
+          Thread.new do
+            readline_history.push *values rescue nil or
+              unsubscribe_from readline_history
+          end
+        end
+      end
+    end
+    
+    # Starts a Server on the given +uri+ and using the YAML history
+    # file specified by +store_path+. The Server object is instantiated,
+    # a DRb service is started on it, and the Server object is returned.
+    # The DRb service object is accessible via Server#service.
+    def self.start_server(uri = DEFAULT_URI, store_path = DEFAULT_FILE)
+      returning server = Server.new(store_path) do
+        server.service = DRb.start_service uri, server
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  IRB::History.start_server *ARGV
+  DRb.thread.join
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: irb-history
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2005-06-17
+summary: "Persistent, shared IRB Readline history"
+require_paths: 
+  - lib
+email: sam@conio.net
+homepage: 
+rubyforge_project: 
+description: "Persistent, shared IRB Readline history"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Sam Stephenson
+files: 
+  - LICENSE
+  - Rakefile
+  - README
+  - THANKS
+  - bin/irb-history-server
+  - lib/irb/history.rb
+  - lib/irb/history/server.rb
+  - lib/irb/history/client.rb
+  - lib/irb/history/base.rb
+test_files: []
+rdoc_options: 
+  - "--inline-source"
+  - "--line-numbers"
+  - "--main"
+  - README
+  - "--title"
+  - irb-history
+  - "-T"
+  - html
+extra_rdoc_files: 
+  - LICENSE
+  - README
+  - THANKS
+  - bin/irb-history-server
+  - lib/irb/history.rb
+  - lib/irb/history/server.rb
+  - lib/irb/history/client.rb
+  - lib/irb/history/base.rb
+executables: 
+  - irb-history-server
+extensions: []
+requirements: []
+dependencies: []