xid 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transaction_id.gemspec
+gemspec
+
+gem 'pg'
+gem 'activerecord', '~> 3.0'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam Meehan
+
+MIT License
+
+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,40 @@
+# XID
+
+Adds ability to ActiveRecord to retrieve the current transaction ID. This can be used to as metadata
+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:
+
+- PostgreSQL
+
+Please fork and add functionality for other databases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xid 
+
+## Usage
+
+Simply call this to get the current ID:
+
+    ActiveRecord::Base.connection.transaction_id
+
+
+## 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

data/Rakefile

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

data/lib/xid/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,19 @@
+module XID
+  module ConnectionAdapters
+    module AbstractAdapter
+
+      def supports_transaction_id?
+        false
+      end
+
+      def transaction_id
+        nil
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+  include XID::ConnectionAdapters::AbstractAdapter
+end

data/lib/xid/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,26 @@
+module XID
+  module ConnectionAdapters
+    module PostgreSQLAdapter
+
+      def supports_transaction_id?
+        true
+      end
+
+      # 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
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
+  include XID::ConnectionAdapters::PostgreSQLAdapter
+end

data/lib/xid/railtie.rb

@@ -0,0 +1,9 @@
+module XID
+  class Railtie < Rails::Railtie
+
+    initializer 'xid.load_adapter', :after => 'active_record.initialize_database' do
+      ActiveSupport.on_load(:active_record) { XID.load }
+    end
+
+  end
+end

data/lib/xid/version.rb

@@ -0,0 +1,3 @@
+module XID
+  VERSION = "0.0.1"
+end

data/lib/xid.rb

@@ -0,0 +1,12 @@
+require "xid/version"
+
+module XID
+  def self.load
+    adapter_name = ActiveRecord::Base.connection_pool.spec.config[:adapter]
+    require "xid/connection_adapters/#{adapter_name}_adapter"
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  require "xid/connection_adapters/abstract_adapter"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+
+require 'active_record'
+require 'xid'
+
+module SpecHelpers
+  def connect_with_adapter(adapter_name)
+    before(:all) do
+      ActiveRecord::Base.establish_connection({:adapter => adapter_name, :database => 'activerecord_unittest'}) 
+      require "xid/connection_adapters/#{adapter_name}_adapter"
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.extend SpecHelpers
+end

data/spec/xid/connection_adapters/abstract_adapter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+require "xid/connection_adapters/abstract_adapter"
+
+describe 'XID::ConnectionAdapters::AbstractAdapter' do
+  let(:adapter) { ActiveRecord::ConnectionAdapters::AbstractAdapter.new(stub.as_null_object) }
+
+  describe "#supports_transaction_id?" do
+    it "should respond false to supports_transaction_id?" do
+      adapter.supports_transaction_id?.should be_false
+    end
+  end
+
+  describe "#transaction_id" do
+    it "should return nil" do
+      adapter.transaction_id.should be_nil
+    end
+  end
+end

data/spec/xid/connection_adapters/postgresql_adapter_spec.rb

@@ -0,0 +1,33 @@
+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
+end

data/xid.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/xid/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Adam Meehan"]
+  gem.email         = ["adam.meehan@gmail.com"]
+  gem.description   = %q{Adds ability to ActiveRecord to retrieve the current transaction ID}
+  gem.summary       = %q{Adds ability to ActiveRecord to retrieve the current transaction ID}
+  gem.homepage      = "https://github.com/adzap/xid"
+
+  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.name          = "xid"
+  gem.require_paths = ["lib"]
+  gem.version       = XID::VERSION
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: xid
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Meehan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-05 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Adds ability to ActiveRecord to retrieve the current transaction ID
+email: 
+- adam.meehan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/xid.rb
+- lib/xid/connection_adapters/abstract_adapter.rb
+- lib/xid/connection_adapters/postgresql_adapter.rb
+- lib/xid/railtie.rb
+- lib/xid/version.rb
+- spec/spec_helper.rb
+- spec/xid/connection_adapters/abstract_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: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Adds ability to ActiveRecord to retrieve the current transaction ID
+test_files: 
+- spec/spec_helper.rb
+- spec/xid/connection_adapters/abstract_adapter_spec.rb
+- spec/xid/connection_adapters/postgresql_adapter_spec.rb