mysql2 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.1.3 (April 15th, 2010)
+* added an EventMachine Deferrable API
+* added an ActiveRecord connection adapter
+** should be compatible with 2.3.5 and 3.0 (including Arel)
+
 ## 0.1.2 (April 9th, 2010)
 * fix a bug (copy/paste fail) around checking for empty TIME values and returning nil (thanks @marius)
 

data/README.rdoc

@@ -75,6 +75,32 @@ NOTE: Because of the way MySQL's query API works, this method will block until t
 So if you really need things to stay async, it's best to just monitor the socket with something like EventMachine.
 If you need multiple query concurrency take a look at using a connection pool.
 
+== ActiveRecord
+
+To use the ActiveRecord driver, all you should need to do is have this gem installed and set the adapter in your database.yml to "mysql2".
+That was easy right? :)
+
+== EventMachine
+
+The mysql2 EventMachine deferrable api allows you to make async queries using EventMachine,
+while specifying callbacks for success for failure. Here's a simple example:
+
+  require 'mysql2/em'
+
+  EM.run do
+    client1 = Mysql2::EM::Client.new
+    defer1 = client1.query "SELECT sleep(3) as first_query"
+    defer1.callback do |result|
+      puts "Result: #{result.to_a.inspect}"
+    end
+
+    client2 = Mysql2::EM::Client.new
+    defer2 = client2.query "SELECT sleep(1) second_query"
+    defer2.callback do |result|
+      puts "Result: #{result.to_a.inspect}"
+    end
+  end
+
 == Compatibility
 
 The specs pass on my system (SL 10.6.3, x86_64) in these rubies:
@@ -85,6 +111,8 @@ The specs pass on my system (SL 10.6.3, x86_64) in these rubies:
 * ruby-trunk
 * rbx-head
 
+The ActiveRecord driver should work on 2.3.5 and 3.0
+
 == Yeah... but why?
 
 Someone: Dude, the Mysql gem works fiiiiiine.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/benchmark/active_record.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'benchmark'
+require 'active_record'
+require 'ruby-debug'
+
+number_of = 1
+mysql2_opts = {
+  :adapter => 'mysql2',
+  :database => 'test'
+}
+mysql_opts = {
+  :adapter => 'mysql',
+  :database => 'test'
+}
+
+class TestModel < ActiveRecord::Base
+  set_table_name :mysql2_test
+end
+
+Benchmark.bmbm do |x|
+  x.report do
+    TestModel.establish_connection(mysql2_opts)
+    puts "Mysql2"
+    number_of.times do
+      TestModel.all(:limit => 1000)
+    end
+  end
+
+  x.report do
+    TestModel.establish_connection(mysql_opts)
+    puts "Mysql"
+    number_of.times do
+      TestModel.all(:limit => 1000)
+    end
+  end
+end

data/benchmark/escape.rb

@@ -7,12 +7,10 @@ require 'mysql2_ext'
 require 'do_mysql'
 
 number_of = 1000
-database = 'nbb_1_production'
 str = "abc'def\"ghi\0jkl%mno"
 
 Benchmark.bmbm do |x|
   mysql = Mysql.new("localhost", "root")
-  mysql.query "USE #{database}"
   x.report do
     puts "Mysql"
     number_of.times do
@@ -21,7 +19,6 @@ Benchmark.bmbm do |x|
   end
 
   mysql2 = Mysql2::Client.new(:host => "localhost", :username => "root")
-  mysql2.query "USE #{database}"
   x.report do
     puts "Mysql2"
     number_of.times do
@@ -29,7 +26,7 @@ Benchmark.bmbm do |x|
     end
   end
 
-  do_mysql = DataObjects::Connection.new("mysql://localhost/#{database}")
+  do_mysql = DataObjects::Connection.new("mysql://localhost/test")
   x.report do
     puts "do_mysql"
     number_of.times do

data/examples/eventmachine.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift 'lib'
+
+require 'rubygems'
+require 'eventmachine'
+require 'mysql2/em'
+
+EM.run do
+  client1 = Mysql2::EM::Client.new
+  defer1 = client1.query "SELECT sleep(3) as first_query"
+  defer1.callback do |result|
+    puts "Result: #{result.to_a.inspect}"
+  end
+
+  client2 = Mysql2::EM::Client.new
+  defer2 = client2.query "SELECT sleep(1) second_query"
+  defer2.callback do |result|
+    puts "Result: #{result.to_a.inspect}"
+  end
+end

data/lib/active_record/connection_adapters/mysql2_adapter.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+
+require 'mysql2' unless defined? Mysql2
+require 'active_record/connection_adapters/mysql_adapter'
+
+module ActiveRecord
+  class Base
+    def self.mysql2_connection(config)
+      client = Mysql2::Client.new(config.symbolize_keys)
+      options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
+      ConnectionAdapters::Mysql2Adapter.new(client, logger, options, config)
+    end
+  end
+
+  module ConnectionAdapters
+    class Mysql2Column < MysqlColumn
+      # Returns the Ruby class that corresponds to the abstract data type.
+      def klass
+        case type
+          when :integer       then Fixnum
+          when :float         then Float
+          when :decimal       then BigDecimal
+          when :datetime      then Time
+          when :date          then Time
+          when :timestamp     then Time
+          when :time          then Time
+          when :text, :string then String
+          when :binary        then String
+          when :boolean       then Object
+        end
+      end
+
+      def type_cast(value)
+        if type == :boolean
+          self.class.value_to_boolean(value)
+        else
+          value
+        end
+      end
+      
+      def type_cast_code(var_name)
+        nil
+      end
+    end
+
+    class Mysql2Adapter < MysqlAdapter
+      PRIMARY = "PRIMARY".freeze
+      ADAPTER_NAME = "Mysql2".freeze
+
+      def adapter_name
+        ADAPTER_NAME
+      end
+
+      # QUOTING ==================================================
+      def quote_string(string)
+        @connection.escape(string)
+      end
+
+      # CONNECTION MANAGEMENT ====================================
+
+      def active?
+        @connection.query 'select 1'
+        true
+      rescue Mysql2::Error
+        false
+      end
+
+      def reconnect!
+        reset!
+      end
+
+      def disconnect!
+        @connection = nil
+      end
+
+      def reset!
+        @connection = Mysql2::Client.new(@config)
+      end
+
+      # DATABASE STATEMENTS ======================================
+
+      def select_values(sql, name = nil)
+        result = select_rows(sql, name)
+        result.map { |row| row.values.first }
+      end
+
+      def select_rows(sql, name = nil)
+        select(sql, name)
+      end
+
+      def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
+        super sql, name
+        id_value || @connection.last_id
+      end
+      alias :create :insert_sql
+
+      # SCHEMA STATEMENTS ========================================
+
+      def tables(name = nil)
+        tables = []
+        execute("SHOW TABLES", name).each(:symbolize_keys => true) do |field|
+          tables << field.values.first
+        end
+        tables
+      end
+
+      def indexes(table_name, name = nil)
+        indexes = []
+        current_index = nil
+        result = execute("SHOW KEYS FROM #{quote_table_name(table_name)}", name)
+        result.each(:symbolize_keys => true) do |row|
+          if current_index != row[:Key_name]
+            next if row[:Key_name] == PRIMARY # skip the primary key
+            current_index = row[:Key_name]
+            indexes << IndexDefinition.new(row[:Table], row[:Key_name], row[:Non_unique] == 0, [])
+          end
+
+          indexes.last.columns << row[:Column_name]
+        end
+        indexes
+      end
+
+      def columns(table_name, name = nil)
+        sql = "SHOW FIELDS FROM #{quote_table_name(table_name)}"
+        columns = []
+        result = execute(sql, :skip_logging)
+        result.each(:symbolize_keys => true) { |field|
+          columns << Mysql2Column.new(field[:Field], field[:Default], field[:Type], field[:Null] == "YES")
+        }
+        columns
+      end
+
+      def show_variable(name)
+        variables = select_all("SHOW VARIABLES LIKE '#{name}'")
+        variables.first[:Value] unless variables.empty?
+      end
+
+      def pk_and_sequence_for(table)
+        keys = []
+        result = execute("describe #{quote_table_name(table)}")
+        result.each(:symbolize_keys) do |row|
+          keys << row[:Field] if row[:Key] == "PRI"
+        end
+        keys.length == 1 ? [keys.first, nil] : nil
+      end
+
+      private
+        def connect
+          # no-op
+        end
+
+        def select(sql, name = nil)
+          execute(sql, name).to_a
+        end
+
+        def supports_views?
+          version[0] >= 5
+        end
+
+        def version
+          @version ||= @connection.info[:version].scan(/^(\d+)\.(\d+)\.(\d+)/).flatten.map { |v| v.to_i }
+        end
+    end
+  end
+end

data/lib/arel/engines/sql/compilers/mysql2_compiler.rb

@@ -0,0 +1,11 @@
+module Arel
+  module SqlCompiler
+    class Mysql2Compiler < GenericCompiler
+      def limited_update_conditions(conditions, taken)
+        conditions << " LIMIT #{taken}"
+        conditions
+      end
+    end
+  end
+end
+

data/lib/mysql2.rb

@@ -5,5 +5,5 @@ require 'mysql2_ext'
 #
 # A modern, simple and very fast Mysql library for Ruby - binding to libmysql
 module Mysql2
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/mysql2/em.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'eventmachine' unless defined? EventMachine
+require 'mysql2' unless defined? Mysql2
+
+module Mysql2
+  module EM
+    class Client < ::Mysql2::Client
+      module Watcher
+        def initialize(client, deferable)
+          @client = client
+          @deferable = deferable
+        end
+
+        def notify_readable
+          begin
+            @deferable.succeed(@client.async_result)
+          rescue Exception => e
+            @deferable.fail(e)
+          end
+          detach
+        end
+      end
+
+      def query(sql, opts={})
+        super(sql, opts.merge(:async => true))
+        deferable = ::EM::DefaultDeferrable.new
+        ::EM.watch(self.socket, Watcher, self, deferable).notify_readable = true
+        deferable
+      end
+    end
+  end
+end

data/mysql2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mysql2}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Lopez"]
-  s.date = %q{2010-04-09}
+  s.date = %q{2010-04-15}
   s.email = %q{seniorlopez@gmail.com}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = [
@@ -22,14 +22,21 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "benchmark/active_record.rb",
      "benchmark/escape.rb",
      "benchmark/query.rb",
      "benchmark/setup_db.rb",
+     "examples/eventmachine.rb",
      "ext/extconf.rb",
      "ext/mysql2_ext.c",
      "ext/mysql2_ext.h",
+     "lib/active_record/connection_adapters/mysql2_adapter.rb",
+     "lib/arel/engines/sql/compilers/mysql2_compiler.rb",
      "lib/mysql2.rb",
+     "lib/mysql2/em.rb",
      "mysql2.gemspec",
+     "spec/active_record/active_record_spec.rb",
+     "spec/em/em_spec.rb",
      "spec/mysql2/client_spec.rb",
      "spec/mysql2/result_spec.rb",
      "spec/rcov.opts",
@@ -42,9 +49,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{A simple, fast Mysql library for Ruby, binding to libmysql}
   s.test_files = [
-    "spec/mysql2/client_spec.rb",
+    "spec/active_record/active_record_spec.rb",
+     "spec/em/em_spec.rb",
+     "spec/mysql2/client_spec.rb",
      "spec/mysql2/result_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "examples/eventmachine.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/active_record/active_record_spec.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+
+describe ActiveRecord::ConnectionAdapters::Mysql2Adapter do
+  it "should be able to connect" do
+    lambda {
+      ActiveRecord::Base.establish_connection(:adapter => 'mysql2')
+    }.should_not raise_error(Mysql2::Error)
+  end
+  
+  context "once connected" do
+    before(:each) do
+      @connection = ActiveRecord::Base.connection
+    end
+
+    it "should be able to execute a raw query" do
+      @connection.execute("SELECT 1 as one").first['one'].should eql(1)
+      @connection.execute("SELECT NOW() as n").first['n'].class.should eql(Time)
+    end
+  end
+end

data/spec/em/em_spec.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'mysql2/em'
+
+describe Mysql2::EM::Client do
+  it "should support async queries" do
+    results = []
+    EM.run do
+      client1 = Mysql2::EM::Client.new
+      defer1 = client1.query "SELECT sleep(0.05) as first_query"
+      defer1.callback do |result|
+        results << result.first
+        EM.stop_event_loop
+      end
+
+      client2 = Mysql2::EM::Client.new
+      defer2 = client2.query "SELECT sleep(0.025) second_query"
+      defer2.callback do |result|
+        results << result.first
+      end
+    end
+    
+    results[0].keys.should include("second_query")
+    results[1].keys.should include("first_query")
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Brian Lopez
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 -07:00
+date: 2010-04-15 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,14 +33,21 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- benchmark/active_record.rb
 - benchmark/escape.rb
 - benchmark/query.rb
 - benchmark/setup_db.rb
+- examples/eventmachine.rb
 - ext/extconf.rb
 - ext/mysql2_ext.c
 - ext/mysql2_ext.h
+- lib/active_record/connection_adapters/mysql2_adapter.rb
+- lib/arel/engines/sql/compilers/mysql2_compiler.rb
 - lib/mysql2.rb
+- lib/mysql2/em.rb
 - mysql2.gemspec
+- spec/active_record/active_record_spec.rb
+- spec/em/em_spec.rb
 - spec/mysql2/client_spec.rb
 - spec/mysql2/result_spec.rb
 - spec/rcov.opts
@@ -78,6 +85,9 @@ signing_key:
 specification_version: 3
 summary: A simple, fast Mysql library for Ruby, binding to libmysql
 test_files: 
+- spec/active_record/active_record_spec.rb
+- spec/em/em_spec.rb
 - spec/mysql2/client_spec.rb
 - spec/mysql2/result_spec.rb
 - spec/spec_helper.rb
+- examples/eventmachine.rb