transaction_timestamps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4a2761cfc95474cdb9dabc2a55e898083089229
+  data.tar.gz: 00d2179d119e1a9062e5a452bde77a27cbcdb522
+SHA512:
+  metadata.gz: 8e86ecbb39ac5b6bef6cf35a5cb8d42abc22ff5967617b46a36033ca96bdb82b929ddf01dcbb55e034fafdb1257e76fde87614dbb99abc6ca64126074f60e5d8
+  data.tar.gz: 9196bc25e8519a4c761169659659ef191ebf2213b2c989670e66110f01c0456a5c09d179f4eaa691f2a6b278c5c8c92e1fe0d901a7d1419732ce1e90d2898aeb

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+transaction_timestamps

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Coupa Software Inc
+
+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,43 @@
+# TransactionTimestamps
+
+Transaction timestamps sets a Rails model's `created_at` and `updated_at` timestamps to the database transaction time, 
+rather than the current time. This is useful for aligning the timestamps of different models saved within a single
+transaction to be exactly the same.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transaction_timestamps'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install transaction_timestamps
+
+## Usage
+
+In an initializer (eg. `config/initializers/transaction_timestamps.rb`), flag on transaction timestamps:
+    
+    TransactionTimestamps.enabled = true
+
+Any models created or updated within a transaction will then get the transaction timestamp.
+
+Note: For postgresql databases, the timestamp is generated from a SQL query for the actual transaction time. For other
+databases (where querying the transaction time is not supported), the current system time as of the first timestamping
+event in the transaction is used.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coupa/transaction_timestamps.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/transaction_timestamps.rb

@@ -0,0 +1,6 @@
+require "transaction_timestamps/version"
+require "transaction_timestamps/timestamp"
+require "transaction_timestamps/railtie"
+
+module TransactionTimestamps
+end

data/lib/transaction_timestamps/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module TransactionTimestamps
+  class Railtie < Rails::Railtie
+    initializer 'transaction_timestamps.initialize' do
+      ActiveSupport.on_load(:active_record) do
+        include TransactionTimestamps::Timestamp
+      end
+    end
+  end
+end

data/lib/transaction_timestamps/timestamp.rb

@@ -0,0 +1,71 @@
+module TransactionTimestamps
+  mattr_accessor :enabled
+
+  module Timestamp
+    def self.included(base)
+      base.class_eval do
+        # override the original timestamp with one our own that returns transaction-based timestamps
+        alias_method :original_current_time_from_proper_timezone, :current_time_from_proper_timezone
+        def current_time_from_proper_timezone
+          if use_transaction_timestamps?
+            current_transaction_time
+          else
+            original_current_time_from_proper_timezone
+          end
+        end
+      end
+    end
+
+    def current_transaction_time
+      if new_transaction?
+        @@cached_timestamp = adjust_time_to_timezone(db_transaction_time)
+      else
+        @@cached_timestamp
+      end
+    end
+
+    private
+    def use_transaction_timestamps?
+      # Timecop doesn't play well transaction timestamps, so don't enable them when using Timecop
+      # and the time is frozen
+      TransactionTimestamps.enabled &&
+        !(defined?(Timecop) && Timecop.frozen?)
+    end
+
+    def new_transaction?
+      # check whether the transaction object id has changed since the last time we checked
+      current_transaction_id = transaction_id
+      is_new = !defined?(@@prev_transaction_id) || (current_transaction_id != @@prev_transaction_id)
+      @@prev_transaction_id = current_transaction_id
+
+      is_new
+    end
+
+    def transaction_id
+      # use the transaction object id as a unique identifier for whether the transaction has changed
+      manager = ActiveRecord::Base.connection.instance_variable_get(:@transaction_manager)
+      manager.current_transaction.object_id
+    end
+
+    def db_transaction_time
+      if postgresql?
+        time_str = ActiveRecord::Base.connection.select_one("SELECT transaction_timestamp();")['transaction_timestamp']
+        Time.parse(time_str)
+      else
+        # other databases (MySQL, sqlite) don't support retrieval of the actual transaction time, so the best we can
+        # do is to use the current system time (and cache this until the transaction changes)
+        Time.now
+      end
+    end
+
+    def postgresql?
+      defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) &&
+        ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+    end
+
+    def adjust_time_to_timezone(time)
+      # do exactly the same time adjustment as performed in ActiveRecord::Timestamp
+      self.class.default_timezone == :utc ? time.utc : time.getlocal
+    end
+  end
+end

data/lib/transaction_timestamps/version.rb

@@ -0,0 +1,3 @@
+module TransactionTimestamps
+  VERSION = "0.1.0"
+end

data/transaction_timestamps.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transaction_timestamps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transaction_timestamps"
+  spec.version       = TransactionTimestamps::VERSION
+  spec.authors       = ["Kent Mewhort @ Coupa"]
+  spec.email         = ["kent.mewhort@coupa.com"]
+
+  spec.summary       = %q{Timestamp created_at and updated_at with the database transaction time}
+  spec.description   = %q{Keeps the timestamps for all models created or updated in at transaction the same}
+  spec.homepage      = "https://github.com/coupa/transaction_timestamps"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.0"
+  spec.add_development_dependency "combustion", "~> 0.5.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: transaction_timestamps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kent Mewhort @ Coupa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Keeps the timestamps for all models created or updated in at transaction
+  the same
+email:
+- kent.mewhort@coupa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transaction_timestamps.rb
+- lib/transaction_timestamps/railtie.rb
+- lib/transaction_timestamps/timestamp.rb
+- lib/transaction_timestamps/version.rb
+- transaction_timestamps.gemspec
+homepage: https://github.com/coupa/transaction_timestamps
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Timestamp created_at and updated_at with the database transaction time
+test_files: []