brice 0.1.1 → 0.2.0

data/lib/brice/history.rb

@@ -0,0 +1,168 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of brice, the extra cool IRb goodness donator                   #
+#                                                                             #
+# Copyright (C) 2008-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# brice is free software: you can redistribute it and/or modify it under the  #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# brice is distributed in the hope that it will be useful, but WITHOUT ANY    #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with brice. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+require 'brice'
+
+module Brice
+
+  # IRb history support.
+
+  class History
+
+    DEFAULTS = {
+      :path   =>  ENV['IRB_HISTORY_FILE'] || File.join(ENV.user_home, '.irb_history'),
+      :size   => (ENV['IRB_HISTORY_SIZE'] || 1000).to_i,
+      :perms  => File::WRONLY | File::CREAT | File::TRUNC,
+      :uniq   => :reverse,
+      :merge  => true
+    }
+
+    def self.init(opt = {})
+      new(opt)
+    end
+
+    def initialize(opt = {}, history = defined?(Readline::HISTORY) && Readline::HISTORY)
+      DEFAULTS.each { |key, val|
+        instance_variable_set("@#{key}", Brice.opt(opt, key, val))
+      }
+
+      @path    = File.expand_path(@path)
+      @reverse = @uniq.to_s == 'reverse'
+
+      init_history(history) if history
+    end
+
+    private
+
+    def init_history(history)
+      @history = history
+
+      @libedit = begin
+        Readline.emacs_editing_mode
+        true
+      rescue NotImplementedError
+        false
+      end
+
+      load_history
+      extend_history
+
+      Kernel.at_exit { save_history }
+    end
+
+    def read_history
+      File.foreach(@path) { |line|
+        line.chomp!
+        yield line
+      }
+    end
+
+    def load_history(history = @history)
+      return unless File.readable?(@path)
+      read_history { |line| history << line }
+
+      return unless @libedit
+      @first_line = read_history { |line| break line }
+    end
+
+    def extend_history
+      @history.extend(Tee) if @merge && class << @history; !include?(Tee); end
+    end
+
+    def save_history
+      if @merge
+        load_history(lines = [])
+        @history.tee! { |t| lines.concat(t) }
+      else
+        lines = @history.to_a
+      end
+
+      lines.unshift(@first_line) if @first_line
+
+      lines.reverse! if @reverse
+      lines.uniq!    if @uniq
+      lines.reverse! if @reverse
+
+      lines.slice!(0, lines.size - @size)
+
+      File.open(@path, @perms) { |f| f.puts(lines) }
+    end
+
+    module Tee
+
+      def self.extended(base)
+        class << base
+          alias_method :push_without_tee,   :<<
+          alias_method :push_m_without_tee, :push
+
+          alias_method :<<,   :push_with_tee
+          alias_method :push, :push_m_with_tee
+        end
+      end
+
+      def tee
+        @tee ||= []
+      end
+
+      def tee!
+        yield tee
+      ensure
+        tee.clear
+      end
+
+      def push_with_tee(arg)
+        _tee_delete(arg)
+
+        tee << arg
+        push_without_tee(arg)
+      end
+
+      def push_m_with_tee(*args)
+        _tee_delete(*args)
+
+        tee.concat(args)
+        push_m_without_tee(*args)
+      end
+
+      private
+
+      def _tee_delete(*args)
+        args.each { |arg| tee.delete(arg) }
+
+        indexes = []
+
+        each_with_index { |line, index|
+          indexes << index if args.include?(line)
+        }
+
+        indexes.reverse_each { |index| delete_at(index) }
+      end
+
+    end
+
+  end
+
+end

data/lib/brice/rc/010_added_methods.rb

@@ -0,0 +1,17 @@
+# Load AddedMethods[http://added_methods.rubyforge.org/] if one
+# (or both) of the following environment variables has been set:
+#
+# <tt>WATCH_FOR_ADDED_METHODS</tt>::    Regular expression or <tt>true</tt>
+# <tt>WATCH_FOR_ADDED_METHODS_IN</tt>:: Space- or comma-delimited list of class names
+
+brice 'added_methods' do |config|
+
+  pattern = ENV['WATCH_FOR_ADDED_METHODS']
+  list    = ENV['WATCH_FOR_ADDED_METHODS_IN']
+
+  AddedMethods.init(
+    (pattern != 'true' || list) && Regexp.new(pattern || ''),
+    (list || '').split(/\s|,/).reject { |name| name.empty? }
+  ) if pattern || list
+
+end

data/lib/{rc/010_libs.rb → brice/rc/020_libs.rb}

@@ -2,15 +2,14 @@
 
 brice 'libs' => nil do |config|
 
-  libs = config.entries
-  libs = %w[
+  (config.empty? ? %w[
+    pp
     yaml
     tempfile
     benchmark
     backports
     what_methods
-  ] if libs.empty?
-  
-  libs.each { |lib| brice_require lib }
+    irb/completion
+  ] : config).each { |lib| brice_require lib }
 
 end

data/lib/brice/rc/030_history.rb

@@ -0,0 +1,7 @@
+# Configure IRb history support
+
+brice 'history' => 'brice/history' do |config|
+
+  Brice::History.init(config.opt)
+
+end

data/lib/brice/rc/040_colours.rb

@@ -0,0 +1,7 @@
+# Configure IRb colour support
+
+brice 'colours' => 'brice/colours' do |config|
+
+  Brice::Colours.init(config.opt)
+
+end

data/lib/brice/rc/050_shortcuts.rb

@@ -0,0 +1,7 @@
+# Include convenient shortcut methods
+
+brice 'shortcuts' => 'brice/shortcuts' do |config|
+
+  Brice::Shortcuts.init(config.opt)
+
+end

data/lib/brice/rc/070_init.rb

@@ -0,0 +1,9 @@
+# Basic initialization for IRb
+
+brice 'init' => nil do |config|
+
+  $KCODE = 'u' if RUBY_VERSION < '1.9'
+
+  IRB.conf[:AUTO_INDENT] = true
+
+end

data/lib/{rc/030_prompt.rb → brice/rc/080_prompt.rb}

@@ -18,7 +18,7 @@ brice 'prompt' => nil do |config|
     end
   end
 
-  IRB.conf[:PROMPT] ||= {}  # prevent error in webrick
+  IRB.conf[:PROMPT] ||= {}
 
   # prompt configuration:
   #

data/lib/{rc/040_rails.rb → brice/rc/090_rails.rb}

@@ -18,7 +18,7 @@ brice 'rails' => nil do |config|
       prompt = File.basename(Dir.pwd) << hint
     end
 
-    # add "ENV['RAILS_SANDBOX'] = 'true'" in rails-X.X.X/lib/commands/console.rb
+    # add "ENV['RAILS_SANDBOX'] = 'true'" in rails/lib/commands/console.rb
     prompt << "#{ENV['RAILS_SANDBOX'] ? '>' : '$'} "
 
     IRB.conf[:PROMPT] ||= {}

data/lib/brice/shortcuts.rb

@@ -0,0 +1,110 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of brice, the extra cool IRb goodness donator                   #
+#                                                                             #
+# Copyright (C) 2008-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# brice is free software: you can redistribute it and/or modify it under the  #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# brice is distributed in the hope that it will be useful, but WITHOUT ANY    #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with brice. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+require 'brice'
+
+module Brice
+
+  # Convenient shortcut methods.
+  module Shortcuts
+
+    extend self
+
+    def init(opt = {})
+      init_object if Brice.opt(opt, :object)
+      init_ri     if Brice.opt(opt, :ri)
+    end
+
+    def init_object
+      Object.send(:include, ObjectShortcuts)
+    end
+
+    def init_ri
+      Module.class_eval {
+        def ri(*args)
+          ri!('--no-pager', *args)
+        end
+
+        def ri!(*args)
+          opts, args = args.partition { |arg| arg.to_s =~ /\A--/ }
+
+          args.empty? ? args << name : args.map! { |arg|
+            arg, method = arg.to_s, nil
+
+            delim = [['#', :instance_method], ['::', :method]].find { |i, m|
+              match  = arg.sub!(/\A#{i}/, '')
+              method = begin; send(m, arg); rescue NameError; end
+
+              break i if match || method
+            } or next arg
+
+            "#{method && method.to_s[/\((\w+)\)/, 1] || name}#{delim}#{arg}"
+          }
+
+          system('ri', *opts.concat(args))
+        end
+      }
+
+      instance_eval {
+        def ri(*args);  Kernel.ri(*args);  end
+        def ri!(*args); Kernel.ri!(*args); end
+      }
+    end
+
+    module ObjectShortcuts
+
+      # Print object methods, sorted by name. (excluding methods that
+      # exist in the class Object)
+      def po(obj = self)
+        obj.methods.sort - Object.methods
+      end
+
+      # Print object constants, sorted by name.
+      def poc(obj = self)
+        obj.constants.sort if obj.respond_to?(:constants)
+      end
+
+      # Cf. <http://rubyforge.org/snippet/detail.php?type=snippet&id=22>
+      def aorta(obj = self)
+        tempfile = Tempfile.new('aorta')
+        YAML.dump(obj, tempfile)
+        tempfile.close
+
+        path = tempfile.path
+
+        system(ENV['VISUAL'] || ENV['EDITOR'] || 'vi', path)
+        return obj unless File.exists?(path)
+
+        content = YAML.load_file(path)
+        tempfile.unlink
+        content
+      end
+
+    end
+
+  end
+
+end

data/lib/brice/version.rb

@@ -1,10 +1,10 @@
-class Brice
+module Brice
 
   module Version
 
     MAJOR = 0
-    MINOR = 1
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
 
     class << self
 

data/lib/brice.rb

@@ -25,146 +25,156 @@
 #++
 
 require 'irb'
-require 'rubygems'
 require 'nuggets/env/user_home'
 
-%w[config dsl version].each { |lib|
-  lib = "brice/#{lib}"
-  require lib
-}
+require 'brice/version'
 
-class Brice
+module Brice
+
+  autoload :Config,    'brice/config'
+  autoload :Colours,   'brice/colours'
+  autoload :DSL,       'brice/dsl'
+  autoload :History,   'brice/history'
+  autoload :Shortcuts, 'brice/shortcuts'
+
+  RC_DIR = __FILE__.sub(/\.rb\z/, '/rc')
 
   BRICE_HOME = File.join(ENV.user_home, '.brice')
 
   @verbose = false
   @quiet   = false
 
-  class << self
-
-    include DSL
+  extend self
+  include DSL
 
-    attr_reader :config, :irb_rc
+  attr_reader :config, :irb_rc
 
-    attr_accessor :verbose, :quiet
+  attr_accessor :verbose, :quiet
 
-    # call-seq:
-    #   Brice.init { |config| ... }
-    #   Brice.init(:verbose => true) { |config| ... }
-    #
-    # Initialize Brice and optionally configure any packages.
-    def init(options = {})
-      @irb_rc = []
-      @config = Config.new(rc_files(true).map { |rc|
-        File.basename(rc, '.rb').sub(/\A\d+_/, '')
-      })
+  # call-seq:
+  #   Brice.init { |config| ... }
+  #   Brice.init(:verbose => true) { |config| ... }
+  #
+  # Initialize Brice and optionally configure any packages.
+  def init(options = {})
+    @irb_rc = []
 
-      options.each { |key, value|
-        method = "#{key}="
+    @config = Config.new(rc_files(true).map { |rc|
+      File.basename(rc, '.rb').sub(/\A\d+_/, '')
+    })
 
-        if respond_to?(method)
-          send(method, value)
-        else
-          raise ArgumentError, "illegal option: #{key}"
-        end
-      }
+    options.each { |key, value|
+      if respond_to?(method = "#{key}=")
+        send(method, value)
+      else
+        raise ArgumentError, "illegal option: #{key}"
+      end
+    }
 
-      yield config if block_given?
+    yield config if block_given?
 
-      load_rc_files(true)
-      finalize_irb_rc!
+    load_rc_files(true)
+    finalize_irb_rc!
 
-      config
-    end
-
-    # call-seq:
-    #   Brice.config = config
-    #
-    # Set config to +config+. Raises a TypeError if +config+ is not a
-    # Brice::Config.
-    def config=(config)
-      raise TypeError, "expected Brice::Config, got #{config.class}" \
-        unless config.is_a?(Config)
+    config
+  end
 
+  # call-seq:
+  #   Brice.config = config
+  #
+  # Set config to +config+. Raises a TypeError if +config+ is not a
+  # Brice::Config.
+  def config=(config)
+    if config.is_a?(Config)
       @config = config
+    else
+      raise TypeError, "expected Brice::Config, got #{config.class}"
     end
+  end
 
-    # call-seq:
-    #   Brice.include?(package) => true or false
-    #   Brice.have?(package) => true or false
-    #
-    # See whether package +package+ is enabled/included.
-    def include?(package)
-      config.include?(package)
-    end
+  # call-seq:
+  #   Brice.include?(package) => true or false
+  #   Brice.have?(package) => true or false
+  #
+  # See whether package +package+ is enabled/included.
+  def include?(package)
+    config.include?(package)
+  end
 
-    alias_method :have?, :include?
+  alias_method :have?, :include?
 
-    # call-seq:
-    #   Brice.rc_files(include_custom_extensions = false) => anArray
-    #
-    # Get the extension files, optionally including custom extensions
-    # if +include_custom_extensions+ is true.
-    def rc_files(include_custom_extensions = false)
-      @rc_files ||= find_rc_files
-      include_custom_extensions ? @rc_files + custom_extensions : @rc_files
-    end
+  # call-seq:
+  #   Brice.rc_files(include_custom_extensions = false) => anArray
+  #
+  # Get the extension files, optionally including custom extensions
+  # if +include_custom_extensions+ is true.
+  def rc_files(include_custom_extensions = false)
+    @rc_files ||= find_rc_files
+    include_custom_extensions ? @rc_files + custom_extensions : @rc_files
+  end
 
-    # call-seq:
-    #   Brice.custom_extensions => anArray
-    #
-    # Get the custom extension files.
-    def custom_extensions
-      @custom_extensions ||= find_rc_files(BRICE_HOME)
-    end
+  # call-seq:
+  #   Brice.custom_extensions => anArray
+  #
+  # Get the custom extension files.
+  def custom_extensions
+    @custom_extensions ||= find_rc_files(BRICE_HOME)
+  end
 
-    private
+  # call-seq:
+  #   Brice.opt(opt, key, default = true) -> anObject
+  #
+  # Returns the value of +opt+ at +key+ if present, or +default+
+  # otherwise.
+  def opt(opt, key, default = true)
+    opt.is_a?(Hash) && opt.has_key?(key) ? opt[key] : default
+  end
 
-    # call-seq:
-    #   load_rc_files(include_custom_extensions = false) => anArray
-    #
-    # Load the extension files, optionally including custom extensions
-    # if +include_custom_extensions+ is true.
-    def load_rc_files(include_custom_extensions = false)
-      Object.send(:include, DSL)
+  private
 
-      res = rc_files.each { |rc|
-        warn "Loading #{rc}..." if verbose
-        brice_load rc
-      }
+  # call-seq:
+  #   load_rc_files(include_custom_extensions = false) => anArray
+  #
+  # Load the extension files, optionally including custom extensions
+  # if +include_custom_extensions+ is true.
+  def load_rc_files(include_custom_extensions = false)
+    Object.send(:include, DSL)
 
-      include_custom_extensions ? res += load_custom_extensions : res
-    end
+    res = rc_files.each { |rc|
+      warn "Loading #{rc}..." if verbose
+      brice_load rc
+    }
 
-    # call-seq:
-    #   load_custom_extensions => anArray
-    #
-    # Load the custom extension files.
-    def load_custom_extensions
-      custom_extensions.each { |rc|
-        warn "Loading custom #{rc}..." if verbose
-        brice_load rc
-      }
-    end
+    include_custom_extensions ? res += load_custom_extensions : res
+  end
 
-    # call-seq:
-    #   find_rc_files(dir = ...) => anArray
-    #
-    # Find the actual extension files in +dir+.
-    def find_rc_files(dir = File.join(File.dirname(__FILE__), 'rc'))
-      File.directory?(dir) ? Dir["#{dir}/*.rb"].sort : []
-    end
+  # call-seq:
+  #   load_custom_extensions => anArray
+  #
+  # Load the custom extension files.
+  def load_custom_extensions
+    custom_extensions.each { |rc|
+      warn "Loading custom #{rc}..." if verbose
+      brice_load rc
+    }
+  end
 
-    # call-seq:
-    #   finalize_irb_rc! => aProc
-    #
-    # Generate proc for IRB_RC from all added procs.
-    def finalize_irb_rc!
-      IRB.conf[:IRB_RC] = lambda { |context|
-        irb_rc.each { |rc| rc[context] }
-      } unless irb_rc.empty?
-    end
+  # call-seq:
+  #   find_rc_files(dir = ...) => anArray
+  #
+  # Find the actual extension files in +dir+.
+  def find_rc_files(dir = RC_DIR)
+    File.directory?(dir) ? Dir["#{dir}/*.rb"].sort : []
+  end
 
+  # call-seq:
+  #   finalize_irb_rc! => aProc
+  #
+  # Generate proc for IRB_RC from all added procs.
+  def finalize_irb_rc!
+    IRB.conf[:IRB_RC] = lambda { |context|
+      irb_rc.each { |rc| rc[context] }
+    } unless irb_rc.empty?
   end
 
 end