xid 0.0.2 → 0.0.3

data/Gemfile

@@ -4,4 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pg'
+gem 'mysql', '>= 2.8.1'
+gem 'mysql2', '>= 0.3.10'
 gem 'activerecord', '~> 3.0'

data/README.md

@@ -4,9 +4,17 @@ Adds ability to ActiveRecord to retrieve the current transaction ID. This can be
 for the purposes of grouping operations performed on many records across many tables. In particular I
 had its usage with auditing libraries in mind.
 
-Currently supports:
+Currently supported adapters:
 
 - PostgreSQL
+- OracleEnhanced (untested, help!)
+- Mysql, Mysql2 (help! user needs PROCESS privileges and requires a query returning/modifying records before you can get an id!!!)
+
+Adapters with no support for retreiving the transactions ID:
+
+- Sqlite
+- Sqlite3
+
 
 Please fork and add functionality for other databases.
 
@@ -33,6 +41,11 @@ Simply call this to get the current ID:
 
 ## Contributing
 
+You must have the ActiveRecord test suite databases set up. The gem uses these to connect to
+for each adapter's specs. 
+
+See [ActiveRecord's RUNNING_UNIT_TESTS](https://github.com/rails/rails/blob/master/activerecord/RUNNING_UNIT_TESTS)
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/lib/xid.rb

@@ -1,9 +1,24 @@
 require "xid/version"
 
 module XID
+  class << self
+    attr_accessor :adapter, :synthetic_id
+  end
+
+  self.synthetic_id = false
+
   def self.load
-    adapter_name = ActiveRecord::Base.connection_pool.spec.config[:adapter]
-    require "xid/connection_adapters/#{adapter_name}_adapter"
+    @adapter ||= ActiveRecord::Base.connection_pool.spec.config[:adapter]
+    require "xid/connection_adapters/#{@adapter}_adapter"
+  rescue LoadError
+    puts "XID was unable to load the transaction ID extension for the '#{@adapter}' adapter"
+  end
+
+  def self.use_synthetic_id!
+    @synthetic_id = true
+    @adapter = :synthetic 
+    require "xid/connection_adapters/synthetic_adapter"
+    ActiveRecord::Base.connection.class.send :include, XID::ConnectionAdapters::SyntheticAdapter 
   end
 end
 

data/lib/xid/connection_adapters/abstract_adapter.rb

@@ -7,7 +7,20 @@ module XID
       end
 
       def transaction_id
-        nil
+        @transaction_id ||= select_transaction_id unless open_transactions == 0
+      end
+      
+      def transaction(*args, &block)
+        if block_given? && block.arity > 0
+          super(*args, &lambda { block.call(transaction_id) })
+        else
+          super
+        end
+      ensure
+        @transaction_id = nil if open_transactions == 0
+      end
+
+      def select_transaction_id
       end
 
     end

data/lib/xid/connection_adapters/mysql2_adapter.rb

@@ -0,0 +1,20 @@
+# TODO this is just duplicate of Mysql, so you know, could be DRYer.
+module XID
+  module ConnectionAdapters
+    module Mysql2Adapter
+
+      def supports_transaction_id?
+        true
+      end
+
+      def select_transaction_id
+        select_value('SELECT trx_id FROM information_schema.innodb_trx WHERE trx_mysql_thread_id = CONNECTION_ID()')
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::Mysql2Adapter.class_eval do
+  include XID::ConnectionAdapters::Mysql2Adapter
+end

data/lib/xid/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,19 @@
+module XID
+  module ConnectionAdapters
+    module MysqlAdapter
+
+      def supports_transaction_id?
+        true
+      end
+
+      def select_transaction_id
+        select_value('SELECT trx_id FROM information_schema.innodb_trx WHERE trx_mysql_thread_id = CONNECTION_ID()')
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::MysqlAdapter.class_eval do
+  include XID::ConnectionAdapters::MysqlAdapter
+end

data/lib/xid/connection_adapters/oracle_enhanced_adapter.rb

@@ -0,0 +1,20 @@
+module XID
+  module ConnectionAdapters
+    module OracleEnhancedAdapter
+
+      def supports_transaction_id?
+        true
+      end
+
+      def select_transaction_id
+        select_value('SELECT dbms_transaction.local_transaction_id FROM dual')
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.class_eval do
+  include XID::ConnectionAdapters::OracleEnhancedAdapter
+end
+

data/lib/xid/connection_adapters/postgresql_adapter.rb

@@ -6,15 +6,16 @@ module XID
         true
       end
 
-      # From the PostgreSQL manual: http://www.postgresql.org/docs/9.1/static/functions-info.html#FUNCTIONS-TXID-SNAPSHOT
+      # From the PostgreSQL manual: 
+      # http://www.postgresql.org/docs/9.1/static/functions-info.html#FUNCTIONS-TXID-SNAPSHOT
       #
       #   The internal transaction ID type (xid) is 32 bits wide and wraps around every
       #   4 billion transactions. However, these functions export a 64-bit format that
       #   is extended with an "epoch" counter so it will not wrap around during the 
       #   life of an installation.
       #
-      def transaction_id
-        select_value('SELECT txid_current()').to_i
+      def select_transaction_id
+        select_value('SELECT txid_current()')
       end
 
     end

data/lib/xid/connection_adapters/synthetic_adapter.rb

@@ -0,0 +1,17 @@
+require 'uuidtools'
+
+module XID
+  module ConnectionAdapters
+    module SyntheticAdapter
+
+      def supports_transaction_id?
+        true
+      end
+
+      def select_transaction_id
+        UUIDTools::UUID.random_create.to_s
+      end
+
+    end
+  end
+end

data/lib/xid/version.rb

@@ -1,3 +1,3 @@
 module XID
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/spec_helper.rb

@@ -4,14 +4,16 @@ require 'active_record'
 require 'xid'
 
 module SpecHelpers
-  def connect_with_adapter(adapter_name)
+  def connect_with_adapter(adapter_name, options={})
     before(:all) do
-      ActiveRecord::Base.establish_connection({:adapter => adapter_name, :database => 'activerecord_unittest'}) 
+      ActiveRecord::Base.establish_connection({:adapter => adapter_name, :database => 'activerecord_unittest'}.merge(options)) 
       require "xid/connection_adapters/#{adapter_name}_adapter"
     end
   end
 end
 
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/transaction_id_specs.rb

@@ -0,0 +1,31 @@
+shared_examples "transaction ID supported behaviour" do
+  let(:adapter) { ActiveRecord::Base.connection }
+  
+  describe "#supports_transaction_id?" do
+    it "should respond false to supports_transaction_id?" do
+      adapter.supports_transaction_id?.should be_true
+    end
+  end
+
+  describe "#transaction_id" do
+    it "should return a string" do
+      ActiveRecord::Base.transaction do
+        adapter.transaction_id.tap do |tid|
+          tid.should_not be_blank
+          tid.should be_kind_of(String)
+        end
+      end
+    end
+
+    it "should only return transaction id within an explicit transaction" do
+      adapter.transaction_id.should be_nil
+
+      ActiveRecord::Base.transaction do
+        adapter.transaction_id.should_not be_nil
+      end
+
+      adapter.transaction_id.should be_nil
+    end
+
+  end
+end

data/spec/xid/connection_adapters/mysql2_adapter_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'XID::ConnectionAdapters::Mysql2Adapter' do
+  connect_with_adapter 'mysql2', :username => 'rails'
+
+  include_examples "transaction ID supported behaviour"
+end

data/spec/xid/connection_adapters/mysql_adapter_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'XID::ConnectionAdapters::MysqlAdapter' do
+  connect_with_adapter 'mysql', :username => 'rails'
+
+  include_examples "transaction ID supported behaviour"
+end

data/spec/xid/connection_adapters/oracle_enhanced_adapter_spec.rb

@@ -0,0 +1,6 @@
+describe 'XID::ConnectionAdapters::OracleEnhancedAdapter' do
+  # TODO: little help. I got no Oracle.
+  # connect_with_adapter 'oracle_enhanced'
+
+  # include_examples "transaction ID supported behaviour"
+end

data/spec/xid/connection_adapters/postgresql_adapter_spec.rb

@@ -3,31 +3,5 @@ require 'spec_helper'
 describe 'XID::ConnectionAdapters::PostgreSQLAdapter' do
   connect_with_adapter 'postgresql'
 
-  let(:adapter) { ActiveRecord::Base.connection }
-
-  describe "#supports_transaction_id?" do
-    it "should respond false to supports_transaction_id?" do
-      adapter.supports_transaction_id?.should be_true
-    end
-  end
-
-  describe "#transaction_id" do
-    it "should return number" do
-      adapter.transaction_id.should be_kind_of(Fixnum)
-    end
-
-    it "should return a different id within an explicit transaction" do
-      tids = []
-      tids << adapter.transaction_id
-
-      ActiveRecord::Base.transaction do
-        tids << adapter.transaction_id
-      end
-
-      tids << adapter.transaction_id
-
-      tids.uniq.size.should eq 3
-    end
-
-  end
+  include_examples "transaction ID supported behaviour"
 end

data/xid.gemspec

@@ -14,4 +14,5 @@ Gem::Specification.new do |gem|
   gem.name          = "xid"
   gem.require_paths = ["lib"]
   gem.version       = XID::VERSION
+  gem.add_runtime_dependency('uuidtools', ["~> 2.1.3"])
 end

metadata

@@ -1,34 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xid
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Adam Meehan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-05 00:00:00 +10:00
-default_executable: 
-dependencies: []
-
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
 description: Adds ability to ActiveRecord to retrieve the current transaction ID
-email: 
+email:
 - adam.meehan@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -37,48 +42,50 @@ files:
 - Rakefile
 - lib/xid.rb
 - lib/xid/connection_adapters/abstract_adapter.rb
+- lib/xid/connection_adapters/mysql2_adapter.rb
+- lib/xid/connection_adapters/mysql_adapter.rb
+- lib/xid/connection_adapters/oracle_enhanced_adapter.rb
 - lib/xid/connection_adapters/postgresql_adapter.rb
+- lib/xid/connection_adapters/synthetic_adapter.rb
 - lib/xid/railtie.rb
 - lib/xid/version.rb
 - spec/spec_helper.rb
+- spec/support/transaction_id_specs.rb
 - spec/xid/connection_adapters/abstract_adapter_spec.rb
+- spec/xid/connection_adapters/mysql2_adapter_spec.rb
+- spec/xid/connection_adapters/mysql_adapter_spec.rb
+- spec/xid/connection_adapters/oracle_enhanced_adapter_spec.rb
 - spec/xid/connection_adapters/postgresql_adapter_spec.rb
 - xid.gemspec
-has_rdoc: true
 homepage: https://github.com/adzap/xid
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Adds ability to ActiveRecord to retrieve the current transaction ID
-test_files: 
+test_files:
 - spec/spec_helper.rb
+- spec/support/transaction_id_specs.rb
 - spec/xid/connection_adapters/abstract_adapter_spec.rb
+- spec/xid/connection_adapters/mysql2_adapter_spec.rb
+- spec/xid/connection_adapters/mysql_adapter_spec.rb
+- spec/xid/connection_adapters/oracle_enhanced_adapter_spec.rb
 - spec/xid/connection_adapters/postgresql_adapter_spec.rb