console_util 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in console_util.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,6 @@
+= ConsoleUtil
+
+Contains various utilities for working in the Rails console.
+
+Author::  Clyde Law (mailto:clyde@futureadvisor.com)
+License:: Released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/console_util.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "console_util/version"
+
+Gem::Specification.new do |s|
+  s.name        = "console_util"
+  s.version     = ConsoleUtil::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Clyde Law"]
+  s.email       = ["clyde@futureadvisor.com"]
+  s.homepage    = %q{http://github.com/FutureAdvisor/console_util}
+  s.summary     = %q{Contains various utilities for working in the Rails console.}
+  s.description = %q{Contains various utilities for working in the Rails console.}
+  s.license     = 'MIT'
+
+  s.add_dependency('rails', '>= 2.1.0')
+
+  s.rubyforge_project = "console_util"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/console_util/color.rb

@@ -0,0 +1,88 @@
+module ConsoleUtil
+  class Color
+    @@colors = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
+
+    @@color_codes = {
+      :reset        =>  0,  # Reset all current console color attributes.
+      :bright       =>  1,  # Set intensity of current console foreground color to bright.
+      :underline    =>  4,  # Underline console output.
+      :blink        =>  5,  # Blink console output.
+      :negative     =>  7,  # Invert the current console foreground and background colors.
+      :normal       => 22,  # Set intensity of current console foreground color to normal.
+      :no_underline => 24,  # Do not underline console output.
+      :no_blink     => 25,  # Do not blink console output.
+      :positive     => 27   # Do not invert the current console foreground and background colors.
+    }
+
+    @@fg_color_base = 30
+    @@bg_color_base = 40
+
+    # Define constants that return the ANSI escape codes corresponding to each
+    # of the predefined color attributes.
+    @@color_codes.each do |color_attr, code|
+      color_const = color_attr.to_s.upcase
+      self.class_eval <<-COLOR_CONST, __FILE__, __LINE__ + 1
+        #{color_const} = "\e[#{code}m"
+      COLOR_CONST
+    end
+
+    class << self
+      # Used to create magic constants for every supported color combination.
+      def const_missing(const)
+        # Attempt to parse the method name as a color string.
+        color_escape_code = convert_color_string(const.to_s)
+
+        if color_escape_code
+          # Define a constant for the ANSI escape code that corresponds to the
+          # specified color and return it.
+          self.class_eval <<-COLOR_CONST, __FILE__, __LINE__ + 1
+            #{const} = "#{color_escape_code}"
+          COLOR_CONST
+        else
+          super
+        end
+      end
+
+      def valid_escape_code?(color_escape_code)
+        !color_escape_code.match(/^\e\[[0-9;]*m$/).nil?
+      end
+
+    private
+      def convert_color_string(color_string)
+        bright = nil
+        fg = nil
+        bg = nil
+
+        # Parse the color string; supported formats are:
+        # - FG
+        # - FG_ON_BG
+        # - ON_BG
+        # - BRIGHT_FG
+        # - BRIGHT_FG_ON_BG
+        case color_string
+        when /^ON_([A-Z]+)$/
+          bg = @@colors.index($1.downcase.to_sym)
+          return nil if bg.nil?
+        when /^(BRIGHT_)?([A-Z]+)(_ON_([A-Z]+))?$/
+          bright = !$1.nil?
+          fg = @@colors.index($2.downcase.to_sym)
+          return nil if fg.nil?
+          if $4
+            bg = @@colors.index($4.downcase.to_sym)
+            return nil if bg.nil?
+          end
+        else
+          return nil
+        end
+
+        # Convert the color to an ANSI escape code sequence that sets the current
+        # console color.
+        color_codes = []
+        color_codes << (bright ? @@color_codes[:bright] : @@color_codes[:normal]) unless bright.nil?
+        color_codes << (fg + @@fg_color_base).to_s if fg
+        color_codes << (bg + @@bg_color_base).to_s if bg
+        "\e[#{color_codes.join(';')}m"
+      end
+    end
+  end
+end

data/lib/console_util/version.rb

@@ -0,0 +1,3 @@
+module ConsoleUtil
+  VERSION = "0.1.0"
+end

data/lib/console_util.rb

@@ -0,0 +1,32 @@
+require 'console_util/color'
+
+module ConsoleUtil
+  class << self
+    # Monkey-patch the ActiveRecord connection to output the SQL query before
+    # executing it.
+    def output_sql_to_console(options = {})
+      color = Color::CYAN
+      if options[:color]
+        raise ArgumentError.new("invalid color option: #{options[:color].inspect}") unless Color.valid_escape_code?(options[:color])
+        color = options[:color]
+      end
+
+      ActiveRecord::Base.connection.class_eval do
+        define_method(:execute) do |sql, *name|
+          puts "#{color}#{sql}#{Color::RESET}"
+          super
+        end
+      end
+      
+      true
+    end
+
+    # Load all models into the environment
+    def load_all_models
+      Rails.root.join('app/models').each_entry do |model_file|
+        model_match = model_file.to_s.match(/^(.*)\.rb$/)
+        model_match[1].classify.constantize if model_match
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: console_util
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Clyde Law
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+description: Contains various utilities for working in the Rails console.
+email: 
+- clyde@futureadvisor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- console_util.gemspec
+- lib/console_util.rb
+- lib/console_util/color.rb
+- lib/console_util/version.rb
+homepage: http://github.com/FutureAdvisor/console_util
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: console_util
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Contains various utilities for working in the Rails console.
+test_files: []
+