brice 0.0.1

data/README

@@ -0,0 +1,56 @@
+= brice - Extra cool IRb goodness for the masses
+
+== VERSION
+
+This documentation refers to brice version 0.0.1
+
+
+== DESCRIPTION
+
+Enhances your IRb experience by adding new functionality and by providing
+a framework that you can utilize to add your own extensions. It comes with
+a set of pre-selected features, but is highly configurable in that regard.
+
+Add this to your <tt>.irbrc</tt> and receive the default goodness:
+
+  require 'rubygems'
+  require 'brice/init'  # equivalent to: require 'brice'; Brice.init
+
+Or get some more control over the configuration:
+
+  require 'rubygems'
+  require 'brice'
+
+  Brice.init { |config|
+    ...
+  }
+
+See Brice::Config for what you can configure, and how.
+
+It will even load your own extensions that you place in your <tt>~/.brice</tt>
+directory. See Brice::DSL for helpers provided.
+
+Please note that further changes to the configuration for brice can't be
+guaranteed to have any effect after <tt>Brice.init</tt> has been called.
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@uni-koeln.de>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2008 Jens Wille
+
+brice is free software: you can redistribute it and/or modify it under the
+terms of the GNU 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+brice. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,24 @@
+require %q{lib/brice/version}
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    :rubyforge => {
+      :project => %q{prometheus},
+      :package => %q{brice}
+    },
+
+    :gem => {
+      :version      => Brice::VERSION,
+      :summary      => %q{Extra cool IRb goodness for the masses},
+      :files        => FileList['lib/**/*.rb'].to_a,
+      :extra_files  => FileList['[A-Z]*'].to_a,
+      :dependencies => %w[ruby-nuggets]
+    }
+  }}
+rescue LoadError
+  abort "Please install the 'hen' gem first."
+end
+
+### Place your custom Rake tasks here.

data/lib/brice/config.rb

@@ -0,0 +1,159 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of brice, the extra cool IRb goodness donator                   #
+#                                                                             #
+# Copyright (C) 2008 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 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 General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with brice. If not, see <http://www.gnu.org/licenses/>.                     #
+#                                                                             #
+###############################################################################
+#++
+
+require 'ostruct'
+
+class Brice
+
+  # Exclude unwanted packages:
+  #
+  #   config.exclude 'foo', 'bar'
+  #   Brice.config -= %w[quix quux]
+  #
+  # Include non-default packages:
+  #
+  #   config.include 'foo', 'bar'
+  #   Brice.config += %w[quix quux]
+  #
+  # Configure individual packages (depends on package):
+  #
+  #   # set property
+  #   config.foo.bar = 'baz'
+  #
+  #   # set multiple properties
+  #   config.foo = %w[bar baz]
+  #   # equivalent to:
+  #   #config.foo.bar = true
+  #   #config.foo.baz = true
+  #
+  #   # reset package configuration
+  #   config.foo!
+  #
+  #   # see whether package is enabled/included
+  #   config.foo?
+
+  class Config
+
+    attr_reader :packages
+
+    def initialize(packages = [])
+      @packages = Hash.new { |h, k| h[k] = PackageConfig.new }
+      packages.each { |package| self[package] }
+    end
+
+    # call-seq:
+    #   config[package]
+    #
+    # Accessor for package +package+.
+    def [](package)
+      @packages[package.to_s]
+    end
+
+    # call-seq:
+    #   config.include(*packages)
+    #   config += packages
+    #
+    # Enable/include packages +packages+.
+    def include(*packages)
+      packages.each { |package| self[package] }
+      self
+    end
+
+    alias_method :+, :include
+
+    # call-seq:
+    #   config.exclude(*packages)
+    #   config -= packages
+    #
+    # Disable/exclude packages +packages+.
+    def exclude(*packages)
+      packages.each { |package| @packages.delete(package.to_s) }
+      self
+    end
+
+    alias_method :-, :exclude
+
+    # call-seq:
+    #   config.clear
+    #
+    # Clear all packages.
+    def clear
+      @packages.clear
+    end
+
+    # call-seq:
+    #   config.include?(package) => true or false
+    #   config.have?(package) => true or false
+    #
+    # See whether package +package+ is enabled/included.
+    def include?(package)
+      @packages.include?(package.to_s)
+    end
+
+    alias_method :have?, :include?
+
+    # call-seq:
+    #   config.package                # package configuration
+    #   config.package = 'foo'        # equivalent to: config.package.foo = true
+    #   config.package = %w[foo bar]  # see above, multiple
+    #   config.package!               # reset package configuration
+    #   config.package?               # see whether package is enabled/included
+    #
+    # Convenience accessors to individual package configurations.
+    def method_missing(method, *args)
+      package, punctuation = method.to_s.sub(/([=!?])?\z/, ''), $1
+
+      raise ArgumentError, "wrong number of arguments (#{args.size} for 0)" \
+        unless punctuation == '=' || args.empty?
+
+      case punctuation
+        when '='
+          @packages[package] = PackageConfig.new
+          [*args.first].each { |arg| @packages[package].send("#{arg}=", true) }
+        when '!'
+          @packages[package] = PackageConfig.new
+        when '?'
+          self.include?(package)
+        else
+          self[package]
+      end
+    end
+
+    class PackageConfig < OpenStruct
+
+      # call-seq:
+      #   pkgconfig.entries => anArray
+      #
+      # Returns all entries/keys.
+      def entries
+        instance_variable_get(:@table).keys.map { |key| key.to_s }.sort
+      end
+
+    end
+
+  end
+
+end

data/lib/brice/dsl.rb

@@ -0,0 +1,161 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of brice, the extra cool IRb goodness donator                   #
+#                                                                             #
+# Copyright (C) 2008 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 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 General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with brice. If not, see <http://www.gnu.org/licenses/>.                     #
+#                                                                             #
+###############################################################################
+#++
+
+class Brice
+
+  # Certain global helper methods for use inside IRb extensions. Also
+  # available inside the IRb session.
+
+  module DSL
+
+    # call-seq:
+    #   irb_rc { ... }
+    #
+    # Add IRB_RC proc (to be executed whenever a (sub-)session is started).
+    def irb_rc
+      Brice.irb_rc << Proc.new
+    end
+
+    # call-seq:
+    #   irb_def(symbol) { ... }
+    #   irb_def(symbol, method)
+    #
+    # Define a method for use inside the IRb session.
+    def irb_def(symbol, method = nil)
+      irb_rc {
+        Object.instance_eval {
+          if method
+            define_method(symbol, method)
+          else
+            define_method(symbol, &Proc.new)
+          end
+        }
+      }
+    end
+
+    alias_method :define_irb_method, :irb_def
+
+    # call-seq:
+    #   silence { ... }
+    #
+    # Silence warnings for block execution.
+    def silence
+      verbose, $VERBOSE = $VERBOSE, nil
+      yield
+    ensure
+      $VERBOSE = verbose
+    end
+
+    # call-seq:
+    #   brice_rescue(what, args = [], error = Exception)
+    #
+    # Call +what+ with +args+ and rescue potential +error+, optionally
+    # executing block in case of success. Gives a nicer error location
+    # instead of the full backtrace.
+    #
+    # Returns either the result of the executed method or of the block.
+    def brice_rescue(what, args = [], error = Exception)
+      res = send(what, *args)
+
+      block_given? ? yield : res
+    rescue Exception => err
+      raise unless err.is_a?(error)
+
+      unless Brice.quiet
+        # FIXME: ideally, we'd want the __FILE__ and __LINE__ of the
+        # rc file where the error occurred.
+        location = caller.find { |c| c !~ %r{(?:\A|/)lib/brice[/.]} }
+        warn "#{err.class}: #{err} [#{location}]"
+      end
+    end
+
+    # call-seq:
+    #   brice_require(string)
+    #
+    # Kernel#require the library named +string+ and optionally execute
+    # block in case of success.
+    #
+    # Returns either the result of the executed method or of the block.
+    def brice_require(string)
+      args = [:require, [string], LoadError]
+
+      if block_given?
+        brice_rescue(*args) { |*a| yield(*a) }
+      else
+        brice_rescue(*args)
+      end
+    end
+
+    # call-seq:
+    #   brice_load(filename, wrap = false)
+    #
+    # Kernel#load the file named +filename+ and optionally execute
+    # block in case of success.
+    #
+    # Returns either the result of the executed method or of the block.
+    def brice_load(filename, wrap = false)
+      args = [:load, [filename, wrap]]
+
+      if block_given?
+        brice_rescue(*args) { |*a| yield(*a) }
+      else
+        brice_rescue(*args)
+      end
+    end
+
+    # call-seq:
+    #   brice(package)  # package == lib
+    #   brice(package => lib)
+    #   brice(package => [lib, ...])
+    #
+    # Declare package +package+. Optionally load given libraries (see below)
+    # and configure the package if it has been enabled/included.
+    #
+    # +package+ can be a String which already names the library to be loaded
+    # or a Hash of the form <tt>package => lib</tt> or <tt>package => [lib, ...]</tt>.
+    def brice(package)
+      package, libs = case package
+        when Hash
+          raise ArgumentError, "Too many package names: #{package.keys.join(' ')}" \
+            if package.size > 1
+          raise ArgumentError, 'No package name given' \
+            if package.size < 1
+
+          [package.keys.first, [*package.values.first]]
+        else
+          [package, [package]]
+      end
+
+      if Brice.include?(package)
+        if libs.all? { |lib| !lib || brice_require(lib) { true } }
+          yield Brice.config[package] if block_given?
+        end
+      end
+    end
+
+  end
+
+end

data/lib/brice/init.rb

@@ -0,0 +1,3 @@
+# just a short-cut
+require File.dirname(__FILE__)
+Brice.init

data/lib/brice/version.rb

@@ -0,0 +1,27 @@
+class Brice
+
+  module Version
+
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end

data/lib/brice.rb

@@ -0,0 +1,170 @@
+#--
+###############################################################################
+#                                                                             #
+# brice -- Extra cool IRb goodness for the masses                             #
+#                                                                             #
+# Copyright (C) 2008 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 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 General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with brice. If not, see <http://www.gnu.org/licenses/>.                     #
+#                                                                             #
+###############################################################################
+#++
+
+require 'irb'
+require 'rubygems'
+require 'nuggets/env/user_home'
+
+%w[config dsl version].each { |lib|
+  lib = "brice/#{lib}"
+  require lib
+}
+
+class Brice
+
+  BRICE_HOME = File.join(ENV.user_home, '.brice')
+
+  @verbose = false
+  @quiet   = false
+
+  class << self
+
+    include DSL
+
+    attr_reader :config, :irb_rc
+
+    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+_/, '')
+      })
+
+      options.each { |key, value|
+        method = "#{key}="
+
+        if respond_to?(method)
+          send(method, value)
+        else
+          raise ArgumentError, "illegal option: #{key}"
+        end
+      }
+
+      yield config if block_given?
+
+      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 = config
+    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?
+
+    # 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
+
+    private
+
+    # 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)
+
+      res = rc_files.each { |rc|
+        warn "Loading #{rc}..." if verbose
+        brice_load rc
+      }
+
+      include_custom_extensions ? res += load_custom_extensions : res
+    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:
+    #   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:
+    #   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
+
+end

data/lib/rc/004_wirble.rb

@@ -0,0 +1,27 @@
+# Configure wirble[http://pablotron.org/software/wirble/]
+
+brice 'wirble' do |config|
+
+  # Save history newest-first, instead of default oldest-first.
+  class Wirble::History
+    def save_history
+      if Object.const_defined?(:IRB)
+        path, max_size, perms = %w[path size perms].map { |v| cfg(v) }
+
+        lines = Readline::HISTORY.to_a.reverse.uniq.reverse
+        lines = lines[-max_size..-1] if lines.size > max_size
+
+        real_path = File.expand_path(path)
+        File.open(real_path, perms) { |fh| fh.puts lines }
+        say 'Saved %d lines to history file %s.' % [lines.size, path]
+      end
+    end
+  end
+
+  # Make wirble and ruby-debug use the same histfile
+  silence { FILE_HISTORY = Wirble::History::DEFAULTS[:history_path] }
+
+  Wirble.init(:skip_prompt => true)
+  Wirble.colorize
+
+end

data/lib/rc/005_added_methods.rb

@@ -0,0 +1,24 @@
+# Load Util::AddedMethods[http://prometheus.rubyforge.org/ruby-nuggets/classes/Util/AddedMethods.html]
+# from ruby-nuggets[http://prometheus.rubyforge.org/ruby-nuggets/] 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-delimited list of class names
+
+brice 'added_methods' => 'nuggets/util/added_methods' do |config|
+
+  regexp  = ENV['WATCH_FOR_ADDED_METHODS']
+  klasses = ENV['WATCH_FOR_ADDED_METHODS_IN']
+
+  if regexp || klasses
+    if regexp == 'true'
+      Util::AddedMethods.init
+    else
+      regexp  = Regexp.new(regexp || '')
+      klasses = (klasses || '').split
+
+      Util::AddedMethods.init(regexp, klasses)
+    end
+  end
+
+end

data/lib/rc/010_libs.rb

@@ -0,0 +1,16 @@
+# Load libraries
+
+brice 'libs' => nil do |config|
+
+  libs = config.entries
+  libs = %w[
+    yaml
+    tempfile
+    benchmark
+    backports
+    what_methods
+  ] if libs.empty?
+  
+  libs.each { |lib| brice_require lib }
+
+end

data/lib/rc/015_utility_belt.rb

@@ -0,0 +1,15 @@
+# Load selected pieces from {Utility Belt}[http://utilitybelt.rubyforge.org/]
+
+brice 'utility_belt' => %w[
+  utility_belt/interactive_editor
+  utility_belt/irb_verbosity_control
+] do |config|
+
+  brice_require 'utility_belt/language_greps' do
+
+    alias :mgrep :grep_methods
+    alias :cgrep :grep_classes
+
+  end
+
+end