richrc 0.0.2 → 0.0.3

data/README.md

@@ -1,33 +1,81 @@
 # RichRC
 
-RichRC (Rich Rails Console) loads [hirb](https://github.com/cldwalker/hirb) and [wirble](http://pablotron.org/software/wirble/) in rails 3 console without editing files in rails app directory. 
+RichRC (Rich Rails Console) is a customization tool for Rails 3 console.
 
-Hirb and wirble are excellent IRB-extension which makes data more readable. In rails 2, we can simply require gems in IRB and start using them. However, In Rails 3, it's needed to add gems into `Gemfile` before using it. Sometimes it doesn't make sense to add IRB-extension gems into rails app Gemfile (Maybe not all developers want hirb and wirble, and it's annoying to add the gems whenever cloning a project). 
+There are some useful gems which extends function of IRB and makes IRB more convenient. For example, [hirb](https://github.com/cldwalker/hirb) and [wirble](http://pablotron.org/software/wirble/) are excellent gems which makes data more readable. In rails 2, we can simply require gems in IRB.
 
-Inspired from [xdite's article](http://blog.xdite.net/?p=1839), the extra gems cloud be loaded before `Bundler.setup` is invoked. RichRC mimics the bootstrap process of rails console, loads and initializes extra gems, and starts console normally. 
+However, In Rails 3, it's needed to add gems into `Gemfile` before using them. Sometimes it doesn't make sense to add IRB-extension gems into `Gemfile`. Maybe not all developers want hirb and wirble, and it's quite annoying to edit files whenever cloning a project.
+
+Inspired from [xdite's article](http://blog.xdite.net/?p=1839), the extra gems cloud be loaded before `Bundler.setup` is invoked. RichRC mimics the bootstrap process of rails console, run extra code before or after specified event (such as `bundler.setup`).
 
 ## Installation
 
     $ gem install richrc hirb wirble
 
-P.S. In RichRC's gemspec, it doesn't depend on hirb and wirble. If some of the gems are missing, RichRC simply ignore them.
+P.S. RichRC loads hirb and wirble by default, but RichRC doesn't have dependency to these gems. If you don't want them, read **Customization** section.
+
+## Quick Start
 
-## Running RichRC
+Though RichRC provides customization, you can simply start with default configuration:
 
     $ cd railsapp
     $ richrc # instead of `rails console`
 
-That's all :)
+This will automatically:
+
+* Enables `wirble` gem
+* Enables `hirb` gem
+* Makes ActiveRecord log outputted in console
+
+P.S. The original rails console is not affected. If problems occured with RichRC, you can fallback to `rails console`.
+
+## Customization
+
+When running `richrc`, it try to load configuration file in following sequence:
+
+* `.richrc` in current directory
+* `.richrc` in user's home directory
+* The default configuration file in richrc gem
+
+Run `richrc customize` to copy default configuration file to `.richrc` into your current directory:
+
+    before(:setup_bundler) do
+      # You can load extra gems here.
+      require 'irb'
+
+      begin
+        gem 'wirble'
+        require 'wirble'
+        Wirble.init
+        Wirble.colorize
+      rescue LoadError
+        puts "Failed to load wirble"
+      end
+
+      begin
+        gem 'hirb'
+        require 'hirb'
+        Hirb.enable
+      rescue LoadError
+        puts "Failed to load hirb"
+      end
+    end
+
+    after(:load_application) do
+      ActiveRecord::Base.logger = Logger.new(STDOUT)
+    end
+
+If you want to load any extra gems, write in `before(:setup_bundler)` section. After that, the gem loading process is controlled by bundler. If you want to do any setting to rails, Write in `after(:load_application)` section, which ensures rails and application environment is loaded.
 
-The original rails console is not affected. If problems occured with RichRC, you can simply fallback to `rails console`.
+## Notice
 
-## Possible Issues
+Loading a gem which conflict with gems (and their dependencies) in `Gemfile` will cause problem.
 
-* Theoretically, if hirb and wirble(and their dependent gems) conflict with gems in `Gemfile`, it may cause problems. However, I never encounter this situation. Hacking Bundler.setup might be a better way. 
+## Issue Report
 
-Fell free to report issues in Github's issue tracker. 
+Fell free to report issues in Github's issue tracker. If it's an error report, I strongly recommand to write your `Gemfile` and `.richrc` in your issue.
 
 ## License
 
-See MIT-LICENSE file for details. 
+See MIT-LICENSE file for details.
 

data/bin/richrc

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
 
-require "richrc"
+require 'richrc'
 
-rails_loader = Richrc::RailsLoader.new
-if rails_loader.app_path
-  Richrc.wirble!
-  Richrc.hirb!
-  rails_loader.start_console! 
+if ARGV.empty?
+  Richrc::RailsLoader.new.run
 else
-  puts "You are not in rails app path!"
+  # In order to keep gemset clean, thor is not loaded when executing rails console
+  # Thus we need to require rubygems and thor here
+  gem 'thor'
+  require 'thor'
+  require 'richrc/cli'
+  Richrc::CLI.start
 end
-

data/config/default.rb

@@ -0,0 +1,28 @@
+before(:setup_bundler) do
+  # You can load extra gems here.
+
+  require 'irb'
+
+  begin
+    gem 'wirble'
+    require 'wirble'
+    Wirble.init
+    Wirble.colorize
+  rescue LoadError
+    puts "Failed to load wirble"
+  end
+
+  begin
+    gem 'hirb'
+    require 'hirb'
+    Hirb.enable
+  rescue LoadError
+    puts "Failed to load hirb"
+  end
+
+end
+
+after(:load_application) do
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+end
+

data/lib/richrc.rb

@@ -1,4 +1,3 @@
 require 'richrc/version'
 require 'richrc/rails_loader'
-require 'richrc/ext_loader'
-
+require 'richrc/config'

data/lib/richrc/cli.rb

@@ -0,0 +1,13 @@
+module Richrc
+  class CLI < Thor
+
+    include Thor::Actions
+
+    desc 'customize', 'generate .richrc config file in current path'
+    def customize
+      default_config = File.expand_path(File.join(__FILE__, "../../../config/default.rb"))
+      create_file(".richrc", File.read(default_config))
+    end
+
+  end
+end

data/lib/richrc/config.rb

@@ -0,0 +1,23 @@
+module Richrc
+
+  class ConfigLoader
+
+    def initialize(rails_loader)
+      @rails_loader = rails_loader
+    end
+
+    def load(path)
+      instance_eval(File.read(path))
+    end
+
+    def method_missing(method, *args, &block)
+      if %w{before after}.include?(method.to_s)
+        @rails_loader.add_callback(method.to_sym, args.first, block)
+      else
+        super
+      end
+    end
+
+  end
+
+end

data/lib/richrc/rails_loader.rb

@@ -1,15 +1,36 @@
 module Richrc
   class RailsLoader
-
     SCRIPT_RAILS = File.join('script', 'rails')
 
+    def initialize
+      @callbacks = Hash.new []
+    end
+
+    def run
+      if app_path
+        start_console
+      else
+        puts "You are not in rails app path!"
+      end
+    end
+
     def app_path
       @app_path ||= find_app_path
     end
 
+    def add_callback(timing, kind, task)
+      key = [timing, kind]
+      @callbacks[key] = [] unless @callbacks.has_key?(key)
+      @callbacks[key] << task
+    end
+
+    private
+
+    # Find app path and chdir to app path
     def find_app_path
+      # The algorithm is mimicking from rails source code, I think there should be a smarter way
       last_dir = Dir.pwd
-      until in_app_path?
+      until File.exists?(SCRIPT_RAILS)
         Dir.chdir("..")
         return nil if Dir.pwd==last_dir
         last_dir = Dir.pwd
@@ -19,18 +40,46 @@ module Richrc
       nil
     end
 
-    def in_app_path?
-      File.exists?(SCRIPT_RAILS)
+    def run_callbacks(kind)
+      @callbacks[[:before, kind]].each { |blk| Object.new.instance_eval(&blk) }
+      yield
+      @callbacks[[:after, kind]].each { |blk| Object.new.instance_eval(&blk) }
     end
 
-    def start_console!
-      require File.expand_path(File.join(app_path, "config/boot"))
-      require 'rails/commands/console'
-      require File.expand_path(File.join(app_path, "config/application"))
+    def start_console
+      puts "Loading RichRC environment"
+      load_config
+
+      run_callbacks(:setup_bundler) do
+        require File.expand_path(File.join(app_path, "config/boot"))
+      end
+
+      run_callbacks(:load_application) do
+        require 'rails/commands/console'
+        require File.expand_path(File.join(app_path, "config/application"))
+        Rails.application.require_environment!
+      end
 
-      Rails.application.require_environment!
       Rails::Console.start(Rails.application)
     end
 
+    def load_config
+      current_config = File.expand_path(File.join(".", ".richrc"))
+      home_config = File.expand_path(File.join(ENV["HOME"], ".richrc"))
+      default_config = File.expand_path(File.join(__FILE__, "../../../config/default.rb"))
+
+      [current_config, home_config, default_config].each do |path|
+        if File.exists?(path)
+          ConfigLoader.new(self).load(path)
+          if path==default_config
+            puts "RichRC: Loading default config file"
+          else
+            puts "RichRC: Loading config: #{path}"
+          end
+          break
+        end
+      end
+    end
+
   end
 end

data/lib/richrc/version.rb

@@ -1,3 +1,3 @@
 module Richrc
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: richrc
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
+  hash: 25
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - miaout17
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +08:00
+date: 2011-02-13 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -35,8 +35,10 @@ files:
 - README.md
 - Rakefile
 - bin/richrc
+- config/default.rb
 - lib/richrc.rb
-- lib/richrc/ext_loader.rb
+- lib/richrc/cli.rb
+- lib/richrc/config.rb
 - lib/richrc/rails_loader.rb
 - lib/richrc/version.rb
 - richrc.gemspec
@@ -70,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: richrc
-rubygems_version: 1.4.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rich Rails Console

data/lib/richrc/ext_loader.rb

@@ -1,28 +0,0 @@
-module Richrc
-  class << self
-    def wirble!
-      require "irb"
-      begin
-        gem 'wirble'
-        require 'wirble'
-        Wirble.init
-        Wirble.colorize
-        puts "Wirble is loaded"
-      rescue LoadError
-        puts "Wirble is not loaded!!(Did you install wirble gem?)"
-      end
-    end
-
-    def hirb!
-      begin
-        gem 'hirb'
-        require 'hirb'
-        Hirb.enable
-        puts "Hirb is loaded"
-      rescue LoadError
-        puts "Hirb is not loaded!!(Did you install hirb gem?)"
-      end
-    end
-  end
-end
-