mcmire-ar_oo_select 0.1

data/README.rdoc

@@ -0,0 +1,66 @@
+= ar_oo_select
+
+== About
+
+Let's face it, ActiveRecord is slow. Sometimes you need a way to bypass ActiveRecord
+but still enjoy the typecasting and object oriented goodness it provides.
+ar_oo_select (for lack of a better name) allows you to do just that.
+
+ActiveRecord gives you four methods to perform a low-level SQL query through the
+connection object itself:
+
+* connection.select_all
+* connection.select_rows
+* connection.select_one
+* connection.select_value
+
+Likewise, ar_oo_select gives you four methods that are simply a wrapper for their
+builtin counterparts:
+
+* oo_select_all
+* oo_select_rows
+* oo_select_one
+* oo_select_value
+
+The difference is that 1) your query goes through AR's <tt>sanitize_sql</tt> method before
+reaching the connection methods and 2) the values in the result set are typecasted
+depending on what they look like (date, time, integer, float, or boolean).
+In the case of <tt>oo_select_all</tt>, the hashes that come from the result set
+are converted to special hashes whose values you can access using an object-oriented
+syntax (or openhashes for short), so it still feels like ActiveRecord. This is made
+available using whichever library you have installed:
+
+* the {OpenHash library}[http://github.com/mcmire/openhash] I've also written
+* {OpenObject}[http://facets.rubyforge.org/doc/api/more/classes/OpenObject.html], a comparable library within Ruby Facets
+* {OpenStruct}[http://apidock.com/ruby/OpenStruct], included in the Ruby standard library
+
+== Usage
+
+All four methods receive the same arguments as <tt>find_by_sql</tt>: either a statement,
+or statement + bind variables.
+
+== Installation
+
+Put this in your environment.rb:
+
+  config.gem 'mcmire-ar_oo_select', :lib => 'ar_oo_select', :source => 'http://gems.github.com'
+
+Then run:
+
+  rake gems:install
+  
+and, optionally:
+
+  rake gems:unpack
+  
+== Support
+
+If you find any bugs with this plugin, feel free to:
+
+* file a bug report in the {Issues area on Github}[http://github.com/mcmire/ar_oo_select/issues]
+* fork the {project on Github}[http://github.com/mcmire/ar_oo_select] and send me a pull request
+* email me (_firstname_ dot _lastname_ at gmail dot com)
+
+== Author/License
+
+(c) 2009 Elliot Winkler. Released under the MIT license.

data/lib/ar_oo_select/ar_ext.rb

@@ -0,0 +1,60 @@
+module ArOoSelect
+  module ArExt
+    def self.included(base)
+      base.class_eval do
+        alias_method :oo_select, :oo_select_all
+      end
+    end
+    
+    # Executes the query and returns an array of openhashes.
+    def oo_select_all(query)
+      query = sanitize_sql(query)
+      rows = connection.select_all(query)
+      rows.map do |row|
+        oh = OpenHash.new(row)
+        oh.each {|k, v| oh[k] = oo_select_type_cast(v) }
+        oh
+      end
+    end
+    
+    # Executes the query and returns an array of rows.
+    def oo_select_rows(query)
+      query = sanitize_sql(query)
+      rows = connection.select_rows(query)
+      rows.map do |row|
+        row.map {|v| oo_select_type_cast(v) }
+      end
+    end
+    
+    # Executes the query and returns the first row as an openhash.
+    def oo_select_one(query)
+      oo_select_all(query).first
+    end
+    
+    # Executes the query and returns the value of the first column in the first row.
+    def oo_select_value(query)
+      query = sanitize_sql(query)
+      connection.select_value(query)
+    end
+    
+  private
+    def oo_select_type_cast(v)
+      return unless v
+      if md = v.match(/^(\d{4})-(\d{2})-(\d{2})$/)
+        Date.new(*md.captures.map(&:to_i)) rescue v
+      elsif md = v.match(/^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$/)
+        Time.local(*md.captures.map(&:to_i)) rescue v
+      elsif v =~ /^(?:-|\+)?\d+$/
+        v.to_i
+      elsif v =~ /^(?:-|\+)?\d+(?:\.\d+)+$/
+        v.to_f
+      elsif v == "true"
+        true
+      elsif v == "false"
+        false
+      else
+        v
+      end
+    end
+  end
+end

data/lib/ar_oo_select/will_paginate_ext.rb

@@ -0,0 +1,26 @@
+module ArOoSelect
+  module WillPaginateExt
+    # Patch to use our oo_select_all instead of connection.select_all
+    def oo_select_paginate(sql, options)
+      WillPaginate::Collection.create(*wp_parse_options(options)) do |pager|
+        query = sanitize_sql(sql)
+        original_query = query.dup
+        # add limit, offset
+        add_limit! query, :offset => pager.offset, :limit => pager.per_page
+        # perform the find
+        pager.replace oo_select_all(query)
+
+        unless pager.total_entries
+          count_query = original_query.sub /\bORDER\s+BY\s+[\w`,\s]+$/mi, ''
+          count_query = "SELECT COUNT(*) FROM (#{count_query})"
+
+          unless ['oracle', 'oci'].include?(self.connection.adapter_name.downcase)
+            count_query << ' AS count_table'
+          end
+          # perform the count query
+          pager.total_entries = count_by_sql(count_query)
+        end
+      end
+    end
+  end
+end

data/lib/ar_oo_select.rb

@@ -0,0 +1,25 @@
+$:.unshift File.dirname(__FILE__)
+
+# Try to load our OpenHash gem,
+# then try Facets' OpenObject gem,
+# then just use OpenStruct which is in the standard library
+begin
+  require 'openhash'
+rescue LoadError
+  begin
+    require 'facets/openobject'
+    OpenHash = OpenObject
+  rescue LoadError
+    require 'ostruct'
+    OpenHash = OpenStruct
+  end
+end
+
+require 'ar_oo_select/ar_ext'
+ActiveRecord::Base.extend(ArOoSelect::ArExt)
+
+# I'm not sure if this should be here?
+#if defined?(WillPaginate)
+#  require 'ar_oo_select/will_paginate_ext'
+#  ActiveRecord::Base.extend(ArOoSelect::WillPaginateExt)
+#end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: mcmire-ar_oo_select
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Elliot Winkler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Let's face it, ActiveRecord is slow. Sometimes you need a way to bypass ActiveRecord, but still enjoy the typecasting and object oriented goodness it provides.
+email: elliot.winkler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/ar_oo_select.rb
+- lib/ar_oo_select/ar_ext.rb
+- lib/ar_oo_select/will_paginate_ext.rb
+has_rdoc: false
+homepage: http://github.com/mcmire/ar_oo_select
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Use find_by_sql without going through ActiveRecord
+test_files: []
+