brice 0.2.3 → 0.2.4

data/README

@@ -2,17 +2,18 @@
 
 == VERSION
 
-This documentation refers to brice version 0.2.3
+This documentation refers to brice version 0.2.4
 
 
 == 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 (see the files in {lib/rc}[link:../lib/rc]),
-but is highly configurable in that regard.
+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 (see the files in
+{lib/brice/rc}[link:../lib/brice/rc]), but is highly configurable
+in that regard.
 
-Add this to your <tt>.irbrc</tt> and receive the default goodness:
+Add this to your <tt>~/.irbrc</tt> and receive the default goodness:
 
   require 'rubygems'
   require 'brice/init'  # equivalent to: require 'brice'; Brice.init
@@ -35,6 +36,32 @@ 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.
 
 
+== DEFAULT FEATURES
+
++added_methods+:: Loads AddedMethods[http://blackwinter.github.com/added_methods]
+                  if one (or both) of the following environment variables has
+                  been set:
+
+                  +WATCH_FOR_ADDED_METHODS+::    Regular expression or +true+
+                  +WATCH_FOR_ADDED_METHODS_IN+:: Space- or comma-delimited list of class names
++libs+::          Loads libraries, either a set of default ones or those you
+                  configure with <tt>config.libs = %w[...]</tt>.
++history+::       Configures IRb history support. See Brice::History for more
+                  information.
++colours+::       Configures IRb colour support. See Brice::Colours for more
+                  information.
++shortcuts+::     Includes convenient shortcut methods. See Brice::Shortcuts
+                  and Brice::Shortcuts::ObjectShortcuts for more information.
++init+::          Does some basic initialization for IRb.
++prompt+::        Configures the IRb prompt, providing <tt>:BRICE_SIMPLE</tt>
+                  and <tt>:BRICE_VERBOSE</tt> prompt modes.
++rails+::         Provides some Rails settings, such as adding the
+                  <tt>:BRICE_RAILS</tt> prompt mode, setting the Rails logger
+                  to +STDOUT+, and defining convenience accessors for your
+                  models.
++devel+::         Provides some useful settings when developing Ruby libraries.
+
+
 == LINKS
 
 <b></b>
@@ -50,7 +77,7 @@ RubyForge project:: http://rubyforge.org/projects/prometheus
 
 == LICENSE AND COPYRIGHT
 
-Copyright (C) 2008-2011 Jens Wille
+Copyright (C) 2008-2012 Jens Wille
 
 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

data/lib/brice/colours.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # A component of brice, the extra cool IRb goodness donator                   #
 #                                                                             #
-# Copyright (C) 2008-2011 Jens Wille                                          #
+# Copyright (C) 2008-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -29,6 +29,10 @@ require 'brice'
 module Brice
 
   # Add colour support to IRb.
+  #
+  # Set your own colours with <tt>config.colours.opt = { :colours => { ... } }</tt>
+  # or modify the default scheme (DEFAULT_COLOURS) with <tt>config.colours.opt =
+  # { :colours => Brice::Colours::DEFAULT_COLOURS.merge(...) }</tt>.
 
   module Colours
 

data/lib/brice/dsl.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # A component of brice, the extra cool IRb goodness donator                   #
 #                                                                             #
-# Copyright (C) 2008-2011 Jens Wille                                          #
+# Copyright (C) 2008-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -62,21 +62,22 @@ module Brice
     alias_method :define_irb_method, :irb_def
 
     # call-seq:
-    #   brice_rescue(what, args = [], error = Exception)
+    #   brice_rescue(what[, args[, error[, quiet]]])
     #
     # 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.
+    # instead of the full backtrace. Doesn't warn about any errors when
+    # +quiet+ is +true+.
     #
     # Returns either the result of the executed method or of the block.
-    def brice_rescue(what, args = [], error = Exception)
+    def brice_rescue(what, args = [], error = Exception, quiet = Brice.quiet)
       res = send(what, *args)
 
       block_given? ? yield : res
     rescue Exception => err
       raise unless err.is_a?(error)
 
-      unless Brice.quiet
+      unless 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[/.]} }
@@ -89,25 +90,29 @@ module Brice
     end
 
     # call-seq:
-    #   brice_require(string)
+    #   brice_require(string[, quiet])
+    #   brice_require(string[, quiet]) { ... }
     #
     # Kernel#require the library named +string+ and optionally execute
-    # block in case of success.
+    # the block in case of success. Doesn't warn about load errors when
+    # +quiet+ is +true+.
     #
     # Returns either the result of the executed method or of the block.
-    def brice_require(string, &block)
-      brice_rescue(:require, [string], LoadError, &block)
+    def brice_require(string, quiet = Brice.quiet, &block)
+      brice_rescue(:require, [string], LoadError, quiet, &block)
     end
 
     # call-seq:
-    #   brice_load(filename, wrap = false)
+    #   brice_load(filename[, wrap[, quiet]])
+    #   brice_load(filename[, wrap[, quiet]]) { ... }
     #
-    # Kernel#load the file named +filename+ and optionally execute
-    # block in case of success.
+    # Kernel#load the file named +filename+ with argument +wrap+ and
+    # optionally execute the block in case of success. Doesn't warn
+    # about load errors when +quiet+ is +true+.
     #
     # Returns either the result of the executed method or of the block.
-    def brice_load(filename, wrap = false, &block)
-      brice_rescue(:load, [filename, wrap], &block)
+    def brice_load(filename, wrap = false, quiet = Brice.quiet, &block)
+      brice_rescue(:load, [filename, wrap], Exception, quiet, &block)
     end
 
     # call-seq:

data/lib/brice/history.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # A component of brice, the extra cool IRb goodness donator                   #
 #                                                                             #
-# Copyright (C) 2008-2011 Jens Wille                                          #
+# Copyright (C) 2008-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -29,6 +29,18 @@ require 'brice'
 module Brice
 
   # IRb history support.
+  #
+  # Configure with <tt>config.history.opt = { ... }</tt>, where the following
+  # keys are recognized (see DEFAULTS):
+  #
+  # <tt>:path</tt>::  The path to your +.irb_history+ file.
+  # <tt>:size</tt>::  The number of entries to keep in the history file.
+  # <tt>:perms</tt>:: The mode to open the history file with.
+  # <tt>:uniq</tt>::  Whether only unique history entries shall be saved.
+  #                   May also be <tt>:reverse</tt> to keep the most recent
+  #                   ones.
+  # <tt>:merge</tt>:: Whether to preserve, i.e. merge, the history across
+  #                   overlapping sessions.
 
   class History
 

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

@@ -1,8 +1,8 @@
-# Load AddedMethods[http://added_methods.rubyforge.org/] if one
-# (or both) of the following environment variables has been set:
+# Load AddedMethods[http://blackwinter.github.com/added_methods] 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
+# +WATCH_FOR_ADDED_METHODS+::    Regular expression or +true+
+# +WATCH_FOR_ADDED_METHODS_IN+:: Space- or comma-delimited list of class names
 
 brice 'added_methods' do |config|
 

data/lib/brice/rc/020_libs.rb

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

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

@@ -1,4 +1,4 @@
-# Prompt configuration
+# Configure the IRb prompt
 
 brice 'prompt' => nil do |config|
 
@@ -10,11 +10,13 @@ brice 'prompt' => nil do |config|
       }
     }
 
-    alias_method :_brice_original_evaluate, :evaluate
+    if Object.const_defined?(:Benchmark)
+      alias_method :_brice_original_evaluate, :evaluate
 
-    # Capture execution time
-    def evaluate(line, line_no)
-      @runtime = Benchmark.realtime { _brice_original_evaluate(line, line_no) }
+      # Capture execution time
+      def evaluate(*args)
+        @runtime = Benchmark.realtime { _brice_original_evaluate(*args) }
+      end
     end
   end
 
@@ -30,18 +32,21 @@ brice 'prompt' => nil do |config|
   prefix = "#{RUBY_VERSION}"
   prefix << "p#{RUBY_PATCHLEVEL}" if defined?(RUBY_PATCHLEVEL)
 
+  prompt_return = Object.const_defined?(:Benchmark) ?
+    lambda { |rt| "#{rt} => %s\n" } : "=> %s\n"
+
   IRB.conf[:PROMPT].update(
     :BRICE_SIMPLE => {
       :PROMPT_I => '  ',
       :PROMPT_S => '  ',
       :PROMPT_C => '  ',
-      :RETURN   => lambda { |rt| "#{rt} => %s\n" }
+      :RETURN   => prompt_return
     },
     :BRICE_VERBOSE => {
       :PROMPT_I => "#{prefix}> ",
       :PROMPT_S => "#{prefix}> ",
       :PROMPT_C => "#{prefix}> ",
-      :RETURN   => lambda { |rt| "#{rt} => %s\n" }
+      :RETURN   => prompt_return
     }
   )
 

data/lib/brice/shortcuts.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # A component of brice, the extra cool IRb goodness donator                   #
 #                                                                             #
-# Copyright (C) 2008-2011 Jens Wille                                          #
+# Copyright (C) 2008-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -30,6 +30,11 @@ require 'brice'
 module Brice
 
   # Convenient shortcut methods.
+  #
+  # Set <tt>config.shortcuts.opt = { :object => false }</tt> to disable
+  # ObjectShortcuts, or <tt>config.shortcuts.opt = { :ri => false }</tt>
+  # to disable #ri shortcuts.
+
   module Shortcuts
 
     extend self

data/lib/brice/version.rb

@@ -4,7 +4,7 @@ module Brice
 
     MAJOR = 0
     MINOR = 2
-    TINY  = 3
+    TINY  = 4
 
     class << self
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brice
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Jens Wille
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 Z
+date: 2012-01-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-nuggets
@@ -44,44 +44,44 @@ extra_rdoc_files:
 - COPYING
 - ChangeLog
 files: 
+- lib/brice/shortcuts.rb
+- lib/brice/version.rb
 - lib/brice/config.rb
+- lib/brice/init.rb
 - lib/brice/dsl.rb
 - lib/brice/colours.rb
+- lib/brice/history.rb
+- lib/brice/rc/060_init.rb
+- lib/brice/rc/090_devel.rb
+- lib/brice/rc/050_shortcuts.rb
 - lib/brice/rc/040_colours.rb
 - lib/brice/rc/070_prompt.rb
 - lib/brice/rc/030_history.rb
-- lib/brice/rc/050_shortcuts.rb
-- lib/brice/rc/090_devel.rb
+- lib/brice/rc/080_rails.rb
 - lib/brice/rc/020_libs.rb
-- lib/brice/rc/060_init.rb
 - lib/brice/rc/010_added_methods.rb
-- lib/brice/rc/080_rails.rb
-- lib/brice/version.rb
-- lib/brice/history.rb
-- lib/brice/init.rb
-- lib/brice/shortcuts.rb
 - lib/brice.rb
+- TODO
+- README
 - ChangeLog
 - COPYING
-- README
 - Rakefile
-- TODO
 - spec/brice/history_spec.rb
 - spec/spec_helper.rb
 - .rspec
-homepage: http://prometheus.rubyforge.org/brice
+homepage: http://prometheus.rubyforge.org/
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --line-numbers
 - --all
 - --main
 - README
 - --charset
 - UTF-8
 - --title
-- brice Application documentation (v0.2.3)
+- brice Application documentation (v0.2.4)
+- --line-numbers
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: prometheus
-rubygems_version: 1.8.12
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Extra cool IRb goodness for the masses