mysql2-cs-bind 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mysql2-cs-bind.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Brian Lopez - http://github.com/brianmario
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# mysql-cs-bind
+
+'mysql-cs-bind' is extension of 'mysql2', to add method of client-side variable binding (pseudo prepared statement).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mysql2-cs-bind'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2-cs-bind
+
+## Usage
+
+Require 'mysql2-cs-bind' instead of (or after) 'mysql2', you can use Mysql2::Client#xquery with bound variables like below:
+
+    use 'mysql2-cs-bind'
+    client = Mysql2::Client.new(...)
+    client.xquery('SELECT x,y,z FROM tbl WHERE x=? AND y=?', val1, val2) #=> Mysql2::Result
+
+Mysql2::Client#xquery receives query, variables, and options(hash) for Mysql2::Client#query.
+
+    client.xquery(sql)
+    client.xquery(sql, :as => :array)
+    client.xquery(sql, val1, val2)
+    client.xquery(sql, [val1, val2])
+    client.xquery(sql, val1, val2, :as => :array)
+    client.xquery(sql, [val1, val2], :as => :array)
+    
+Mysql2::Client#xquery raises ArgumentError if mismatch found between placeholder number and arguments
+
+    client.xquery('SELECT x FROM tbl', 1)                   # ArgumentError
+    client.xquery('SELECT x FROM tbl WHERE x=? AND y=?', 1) # ArgumentError
+    client.xquery('SELECT x FROM tbl WHERE x=?', 1, 2)      # ArgumentError
+
+Formatting for nil and Time objects:
+
+    client.xquery('INSERT INTO tbl (val1,created_at) VALUES (?,?)', nil, Time.now)
+    #execute "INSERT INTO tbl (val1,created_at) VALUES (NULL,'2012-01-02 13:45:01')"
+
+### Type Conversion of Numbers
+
+Mysql2::Client#xquery quotes any values as STRING. This may not be problems for almost all kind of queries, but sometimes you may be confused by return value types:
+
+    client.query('SELECT 1', :as => :array).first #=> [1]
+    client.xquery('SELECT ?', 1, :as => :array).first #=> ['1']
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+
+## License
+MIT (see MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mysql2-cs-bind.rb

@@ -0,0 +1,43 @@
+require 'mysql2'
+
+class Mysql2::Client
+
+  def xquery(sql, *args)
+    options = if args.size > 0 and args[-1].is_a?(Hash)
+                args.pop
+              else
+                {}
+              end
+    if args.size < 1
+      query(sql, options)
+    else
+      query(pseudo_bind(sql, args.flatten), options)
+    end
+  end
+
+  private
+  def pseudo_bind(sql, values)
+    sql = sql.dup
+
+    placeholders = []
+    search_pos = 0
+    while pos = sql.index('?', search_pos)
+      placeholders.push(pos)
+      search_pos = pos + 1
+    end
+    raise ArgumentError, "mismatch between placeholders number and values arguments" if placeholders.length != values.length
+
+    while pos = placeholders.pop()
+      rawvalue = values.pop()
+      if rawvalue.nil?
+        sql[pos] = 'NULL'
+      elsif rawvalue.is_a?(Time)
+        sql[pos] = "'" + rawvalue.strftime('%Y-%m-%d %H:%M:%S') + "'"
+      else
+        sql[pos] = "'" + Mysql2::Client.escape(rawvalue.to_s) + "'"
+      end
+    end
+    sql
+  end
+
+end

data/mysql2-cs-bind.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "mysql2-cs-bind"
+  gem.version       = "0.0.1"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.homepage      = "https://github.com/tagomoris/mysql2-cs-bind"
+  gem.summary       = %q{extension for mysql2 to add client-side variable binding}
+  gem.description   = %q{extension for mysql2 to add client-side variable binding, by adding method Mysql2::Client#xquery}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "mysql2"  
+
+  # tests
+  gem.add_development_dependency "mysql2"
+  gem.add_development_dependency 'eventmachine'
+  gem.add_development_dependency 'rake-compiler', "~> 0.7.7"
+  gem.add_development_dependency 'rake', '0.8.7' # NB: 0.8.7 required by rake-compiler 0.7.9
+  gem.add_development_dependency 'rspec'
+end

data/spec/mysql2/client_spec.rb

@@ -0,0 +1,98 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Mysql2::Client do
+  before(:each) do
+    @client = Mysql2::Client.new
+  end
+
+  it "should respond to #query" do
+    @client.should respond_to(:query)
+  end
+
+  context "#pseudo_bind" do
+    it "should return query just same as argument, if without any placeholders" do
+      @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x WHERE x='1'", []).should eql("SELECT x,y,z FROM x WHERE x='1'")
+    end
+
+    it "should return replaced query if with placeholders" do
+      @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x WHERE x=?", [1]).should eql("SELECT x,y,z FROM x WHERE x='1'")
+      @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x WHERE x=? AND y=?", [1, 'X']).should eql("SELECT x,y,z FROM x WHERE x='1' AND y='X'")
+    end
+      
+    it "should raise ArgumentError if mismatch exists between placeholders and arguments" do
+      expect {
+        @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x", [1])
+      }.should raise_exception(ArgumentError)
+      expect {
+        @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x WHERE x=?", [1,2])
+      }.should raise_exception(ArgumentError)
+      expect {
+        @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x WHERE x=? AND y=?", [1])
+      }.should raise_exception(ArgumentError)
+      expect {
+        @client.__send__(:pseudo_bind, "SELECT x,y,z FROM x WHERE x=?", [])
+      }.should raise_exception(ArgumentError)
+    end
+
+    it "should replace placeholder with NULL about nil" do
+      @client.__send__(:pseudo_bind, "UPDATE x SET y=? WHERE x=?", [nil,1]).should eql("UPDATE x SET y=NULL WHERE x='1'")
+    end
+
+    it "should replace placeholder with formatted timestamp string about Time object" do
+      require 'time'
+      t = Time.strptime('2012/04/20 16:50:45', '%Y/%m/%d %H:%M:%S')
+      @client.__send__(:pseudo_bind, "UPDATE x SET y=? WHERE x=?", [t,1]).should eql("UPDATE x SET y='2012-04-20 16:50:45' WHERE x='1'")
+    end
+  end
+
+  context "#xquery" do
+    it "should let you query again if iterating is finished when streaming" do
+      @client.xquery("SELECT 1 UNION SELECT ?", 2, :stream => true, :cache_rows => false).each {}
+
+      expect {
+        @client.xquery("SELECT 1 UNION SELECT ?", 2, :stream => true, :cache_rows => false)
+      }.to_not raise_exception(Mysql2::Error)
+    end
+
+    it "should accept an options hash that inherits from Mysql2::Client.default_query_options" do
+      @client.xquery "SELECT ?", 1, :something => :else
+      @client.query_options.should eql(@client.query_options.merge(:something => :else))
+    end
+
+    it "should return results as a hash by default" do
+      @client.xquery("SELECT ?", 1).first.class.should eql(Hash)
+    end
+
+    it "should be able to return results as an array" do
+      @client.xquery("SELECT ?", 1, :as => :array).first.class.should eql(Array)
+      @client.xquery("SELECT ?", 1).each(:as => :array)
+      @client.query("SELECT 1").first.should eql([1])
+      @client.query("SELECT '1'").first.should eql(['1'])
+      @client.xquery("SELECT 1", :as => :array).first.should eql([1])
+      @client.xquery("SELECT ?", 1).first.should eql(['1'])
+      @client.xquery("SELECT ?+1", 1).first.should eql([2.0])
+    end
+
+    it "should be able to return results with symbolized keys" do
+      @client.xquery("SELECT 1", :symbolize_keys => true).first.keys[0].class.should eql(Symbol)
+    end
+
+    it "should require an open connection" do
+      @client.close
+      lambda {
+        @client.xquery "SELECT ?", 1
+      }.should raise_error(Mysql2::Error)
+    end
+  end
+
+  it "should respond to escape" do
+    Mysql2::Client.should respond_to(:escape)
+  end
+
+  if RUBY_VERSION =~ /1.9/
+    it "should respond to #encoding" do
+      @client.should respond_to(:encoding)
+    end
+  end
+end

data/spec/mysql2/error_spec.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Mysql2::Error do
+  before(:each) do
+    @client = Mysql2::Client.new :encoding => "utf8"
+    begin
+      @client.query("HAHAHA")
+    rescue Mysql2::Error => e
+      @error = e
+    end
+
+    @client2 = Mysql2::Client.new :encoding => "big5"
+    begin
+      @client2.query("HAHAHA")
+    rescue Mysql2::Error => e
+      @error2 = e
+    end
+  end
+
+  it "should respond to #error_number" do
+    @error.should respond_to(:error_number)
+  end
+
+  it "should respond to #sql_state" do
+    @error.should respond_to(:sql_state)
+  end
+
+  # Mysql gem compatibility
+  it "should alias #error_number to #errno" do
+    @error.should respond_to(:errno)
+  end
+
+  it "should alias #message to #error" do
+    @error.should respond_to(:error)
+  end
+
+  if RUBY_VERSION =~ /1.9/
+    it "#message encoding should match the connection's encoding, or Encoding.default_internal if set" do
+      if Encoding.default_internal.nil?
+        @error.message.encoding.should eql(@client.encoding)
+        @error2.message.encoding.should eql(@client2.encoding)
+      else
+        @error.message.encoding.should eql(Encoding.default_internal)
+        @error2.message.encoding.should eql(Encoding.default_internal)
+      end
+    end
+
+    it "#error encoding should match the connection's encoding, or Encoding.default_internal if set" do
+      if Encoding.default_internal.nil?
+        @error.error.encoding.should eql(@client.encoding)
+        @error2.error.encoding.should eql(@client2.encoding)
+      else
+        @error.error.encoding.should eql(Encoding.default_internal)
+        @error2.error.encoding.should eql(Encoding.default_internal)
+      end
+    end
+
+    it "#sql_state encoding should match the connection's encoding, or Encoding.default_internal if set" do
+      if Encoding.default_internal.nil?
+        @error.sql_state.encoding.should eql(@client.encoding)
+        @error2.sql_state.encoding.should eql(@client2.encoding)
+      else
+        @error.sql_state.encoding.should eql(Encoding.default_internal)
+        @error2.sql_state.encoding.should eql(Encoding.default_internal)
+      end
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,3 @@
+--exclude spec,gem
+--text-summary
+--sort coverage --sort-reverse

data/spec/spec_helper.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+
+require 'rspec'
+# require 'mysql2'
+require 'mysql2-cs-bind'
+require 'timeout'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    client = Mysql2::Client.new :host => "localhost", :username => "root", :database => 'test'
+    client.query %[
+      CREATE TABLE IF NOT EXISTS mysql2_test (
+        id MEDIUMINT NOT NULL AUTO_INCREMENT,
+        null_test VARCHAR(10),
+        bit_test BIT(64),
+        tiny_int_test TINYINT,
+        bool_cast_test TINYINT(1),
+        small_int_test SMALLINT,
+        medium_int_test MEDIUMINT,
+        int_test INT,
+        big_int_test BIGINT,
+        float_test FLOAT(10,3),
+        float_zero_test FLOAT(10,3),
+        double_test DOUBLE(10,3),
+        decimal_test DECIMAL(10,3),
+        decimal_zero_test DECIMAL(10,3),
+        date_test DATE,
+        date_time_test DATETIME,
+        timestamp_test TIMESTAMP,
+        time_test TIME,
+        year_test YEAR(4),
+        char_test CHAR(10),
+        varchar_test VARCHAR(10),
+        binary_test BINARY(10),
+        varbinary_test VARBINARY(10),
+        tiny_blob_test TINYBLOB,
+        tiny_text_test TINYTEXT,
+        blob_test BLOB,
+        text_test TEXT,
+        medium_blob_test MEDIUMBLOB,
+        medium_text_test MEDIUMTEXT,
+        long_blob_test LONGBLOB,
+        long_text_test LONGTEXT,
+        enum_test ENUM('val1', 'val2'),
+        set_test SET('val1', 'val2'),
+        PRIMARY KEY (id)
+      )
+    ]
+    client.query "DELETE FROM mysql2_test;"
+    client.query %[
+      INSERT INTO mysql2_test (
+        null_test, bit_test, tiny_int_test, bool_cast_test, small_int_test, medium_int_test, int_test, big_int_test,
+        float_test, float_zero_test, double_test, decimal_test, decimal_zero_test, date_test, date_time_test, timestamp_test, time_test,
+        year_test, char_test, varchar_test, binary_test, varbinary_test, tiny_blob_test,
+        tiny_text_test, blob_test, text_test, medium_blob_test, medium_text_test,
+        long_blob_test, long_text_test, enum_test, set_test
+      )
+
+      VALUES (
+        NULL, b'101', 1, 1, 10, 10, 10, 10,
+        10.3, 0, 10.3, 10.3, 0, '2010-4-4', '2010-4-4 11:44:00', '2010-4-4 11:44:00', '11:44:00',
+        2009, "test", "test", "test", "test", "test",
+        "test", "test", "test", "test", "test",
+        "test", "test", 'val1', 'val1,val2'
+      )
+    ]
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-cs-bind
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: extension for mysql2 to add client-side variable binding, by adding method
+  Mysql2::Client#xquery
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mysql2-cs-bind.rb
+- mysql2-cs-bind.gemspec
+- spec/mysql2/client_spec.rb
+- spec/mysql2/error_spec.rb
+- spec/rcov.opts
+- spec/spec_helper.rb
+homepage: https://github.com/tagomoris/mysql2-cs-bind
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: extension for mysql2 to add client-side variable binding
+test_files:
+- spec/mysql2/client_spec.rb
+- spec/mysql2/error_spec.rb
+- spec/rcov.opts
+- spec/spec_helper.rb