tune_my_query 0.1.0

data/README.markdown

@@ -0,0 +1,58 @@
+tune_my_query
+============
+
+About
+-----
+**tune_my_query** is an extension of the gem **me_gusta** written by **[John Pignata]**(http://github.com/jpignata)
+
+It is a simple way to switch between standard SQL and extended SQL syntax depending on the adapter. For example: PostgreSql has an ILIKE extension which is not found in other databases like mysql. This gem(not released yet) ensures the query is adapted based on the current database. 
+
+
+Inspiration
+-----------
+Gemcutter uses PostgreSql in production and uses ILIKE in one of the queries. For anyone, hacking on their local machine will have to change it to LIKE for it to work. Also, when it comes to accepting patches from a MySql user this would again pose a minor issue. Hence, this gem. 
+
+
+Usage
+-----
+
+It is simple to use. Just install it like:
+
+    sudo gem install tune_my_query
+
+And do in the model class where you have used a database specific SQL, like this:
+
+    tune_my_query :like
+
+Here like signifies the extension to usual SQL LIKE.
+
+
+Does it only work with LIKE? What a futile effort
+-------------------------------------------------
+Yes, at the moment it only does that. But, you can fork the code and add your own commands in the commands directory inside lib. Every new command that you add should have a name ending with Command. For example: AwesomeCommand. Add a singleton execute method to it and send me a patch, I will add it in. Please do add specs. 
+
+
+Specs
+-----
+In order to run the specs you should have mysql and postgresql installed. [Here's](http://developer.apple.com/internet/opensource/postgres.html) how to install PostgreSql on a Mac. And, just do:
+
+    sudo gem install postgres-pr
+
+to install postgreSql adapter. 
+
+
+Bugs
+----
+
+Please report the issues through gitHub's issues.
+
+
+Authors
+-------
+* [John Pignata](http://github.com/jpignata)
+* [Anuj Dutta](http://github.com/andhapp) - [andHapp.com](http://www.andhapp.com/blog)
+
+
+Roadmap
+-------
+* To make it work for any database extension. At the moment it would only for SQL extensions added by PostgreSql.

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "tune_my_query"
+    gemspec.summary = "Standardises SQL syntax across databases."
+    gemspec.description = "Switches between standard SQL and extended SQL syntax depending on the adapter."
+    gemspec.email = "anuj@andhapp.com"
+    gemspec.homepage = "http://github.com/andhapp/tune_my_query"
+    gemspec.authors = ["Anuj Dutta"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,3 @@
+require "lib/tune_my_query"
+
+ActiveRecord::Base.send(:include, TuneMyQuery)

data/lib/tune_my_query/commands/LikeCommand.rb

@@ -0,0 +1,15 @@
+# LIKE COMMAND                                                                    #
+# Command for matching and substituting occurences of LIKE in the parameter given #
+# Has one singleton method called 'execute' which performs the main function      #
+#                                                                                 #
+class LikeCommand
+  class << self
+    def execute(condition)
+      if condition.is_a?(Array)
+        condition.each { |c| execute(c) } # Calling itself on each element if the supplied parameter is an Array
+      elsif condition.is_a?(String)
+        condition.gsub!(/ ilike /i, " like ") if condition.is_a?(String)          
+      end      
+    end    
+  end
+end

data/lib/tune_my_query/tune_my_query.rb

@@ -0,0 +1,49 @@
+module TuneMyQuery
+  
+  # Hook invoked in include
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      class << self
+        alias_method :super_merge_conditions, :merge_conditions
+        alias_method :merge_conditions, :standardise_sql
+      end
+    end
+  end
+  
+  #                                                                                                   #
+  # Adds tune_my_query method to ActiveRecord and its subclasses.                                     #
+  #                                                                                                   #
+  # USAGE:                                                                                            #    
+  #      tune_my_query :like                                                                          #
+  #                                                                                                   #
+  # 'like' signifies the command to be invoked.                                                       #
+  # It also makes it apparent that an extension to LIKE needs to be standardise. Works only for       #
+  # PostgreSQL specfific extensions. If MySql were to add its own extension to the standard SQL then  #
+  # this gem would cease to work.                                                                     #  
+  #                                                                                                   #
+  # METHODS:                                                                                          # 
+  #                                                                                                   #
+  # tune_my_query - Adds the command_type to to an instance variable namely, @command_type            #
+  #                                                                                                   #
+  # standardise_sql - Checks if PostgreSQLAdapter is used only then runs the conditions through the   #
+  #                   Command. if not leaves the conditions untouched                                 #
+  #                                                                                                   #
+  #                                                                                                   #  
+  module ClassMethods    
+    def tune_my_query(command_type)
+       @command_type = command_type      
+    end
+    
+    def standardise_sql(*conditions)
+      conditions = conditions.dup
+      @adapter = connection && !connection.class.to_s.include?("PostgreSQLAdapter")
+      command = "#{@command_type.to_s.camelize}Command".constantize
+      if @adapter      
+        conditions.each { |condition| command.execute(condition) }
+      end
+      super_merge_conditions(*conditions)
+    end    
+  end
+  
+end

data/lib/tune_my_query.rb

@@ -0,0 +1,4 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+require "tune_my_query/tune_my_query"
+Dir.glob("#{File.dirname(__FILE__)}/tune_my_query/commands/*.*").each{|file| require file}

data/spec/database.yml

@@ -0,0 +1,12 @@
+mysql:
+   :adapter:  mysql
+   :database: tune_my_query  
+   :username: root
+   :hostname: localhost
+      
+postgres:
+   :adapter:  postgresql
+   :database: tune_my_query
+   :username: postgres
+   :password: postgres        
+   :hostname: localhost

data/spec/lib/tune_my_query_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "TuneMyQuery" do
+  
+  shared_examples_for "a class that responds to tune_my_query method" do
+    it "should respond to method tune_my_query" do
+      Auberdine.should respond_to(:tune_my_query)
+    end
+  end
+
+  shared_examples_for "" do
+  end
+  
+  context "When connected to MySql" do
+    before do    
+      connect('mysql')
+    end
+    
+    it_should_behave_like "a class that responds to tune_my_query method"
+    
+    context "for LIKE SQL command" do
+      it "should convert from postgresql specific to standard SQL" do
+        Auberdine.merge_conditions(["name = 'joe'"], ["address ilike 'main'"]).
+                      should  be_eql("(name = 'joe') AND (address like 'main')")
+      end          
+    end          
+  end
+  
+  
+  context "When connected to PostgreSql" do
+    before do    
+      connect('postgres')
+    end
+    
+    it_should_behave_like "a class that responds to tune_my_query method"
+    
+    context "for LIKE SQL command" do
+      it "should not convert from postgresql specific to standard SQL" do
+        Auberdine.merge_conditions(["name = 'joe'"], ["address ilike 'main'"]).
+                      should be_eql("(name = 'joe') AND (address ilike 'main')")
+      end      
+    end
+              
+  end
+  
+end

data/spec/models.rb

@@ -0,0 +1,3 @@
+class Auberdine < ActiveRecord::Base
+  tune_my_query :like
+end

data/spec/schema.db

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "auberdines", :force => true do |t|
+    t.string    "name"
+    t.string    "description"
+    t.datetime  "created_at"
+    t.datetime  "updated_at"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "tune_my_query")
+
+%w(activerecord active_support yaml spec).each{|path| require path }
+
+%w(../init models).each{|path| require File.join(File.dirname(__FILE__), path) }
+  
+def connect(adapter)
+  fix_quote_ident_postgres_error if adapter == "postgres"
+  conf = YAML::load(File.open(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.establish_connection(conf[adapter])
+  load(File.join(File.dirname(__FILE__), "schema.db"))
+end
+
+def fix_quote_ident_postgres_error
+  require "postgres"
+  def PGconn.quote_ident(name); %("#{name}") end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: tune_my_query
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anuj Dutta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-15 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: Switches between standard SQL and extended SQL syntax depending on the adapter.
+email: anuj@andhapp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- HISTORY
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/tune_my_query.rb
+- lib/tune_my_query/commands/LikeCommand.rb
+- lib/tune_my_query/tune_my_query.rb
+- spec/database.yml
+- spec/lib/tune_my_query_spec.rb
+- spec/models.rb
+- spec/schema.db
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/andhapp/tune_my_query
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Standardises SQL syntax across databases.
+test_files: 
+- spec/lib/tune_my_query_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb