sequel_timelined 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f84dadb8e4cd0f30d69de8086dfa22122b78c7e
+  data.tar.gz: edf27b253671bc6f3d92cfd191b083c7125cc5ed
+SHA512:
+  metadata.gz: 1a6466b268a9220ed1d46845974dabf20325ecaf4b41bb4de225f5e35c5d3f795fa8fe3c8780dfd7fae08a5fd86887f1a0de9819939f8fb127c4908a5aaaa3b2
+  data.tar.gz: e046a7d97fcd69c6d9f0888c90327c41d47ef3bb9b738e2170001a266b87498d395345a7a44637d5ceb375b8dbbb753b27a872ad0a1c25741da7e15f39fd50ee

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    sequel_timelined (0.1.0)
+      registry-rails (~> 0.0)
+      sequel (~> 4.10)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.18)
+      actionpack (= 3.2.18)
+      mail (~> 2.5.4)
+    actionpack (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+    activerecord (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    journey (1.0.4)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    multi_json (1.10.0)
+    polyglot (0.3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.18)
+      actionmailer (= 3.2.18)
+      actionpack (= 3.2.18)
+      activerecord (= 3.2.18)
+      activeresource (= 3.2.18)
+      activesupport (= 3.2.18)
+      bundler (~> 1.0)
+      railties (= 3.2.18)
+    railties (3.2.18)
+      actionpack (= 3.2.18)
+      activesupport (= 3.2.18)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.3.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    registry-rails (0.0.3)
+      rails (~> 3.1)
+    sequel (4.10.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.19.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.3)
+  sequel_timelined!

data/README.md

@@ -0,0 +1,25 @@
+dm-is-timelined
+===============
+
+This [sequel][1] plugin adds parallel copy-on-write to all models, copying all properties, changing the 'id' field
+to 'timeline_id' and adding the properties 'timeline_action', 'timeline_timestamp'.
+
+On create, delete and update, the model will be automatically copied to '''model_name_timeline''' to provide full
+history and auditing capabilities without having to fall back to complex UNION statements.
+
+Warning
+-------
+
+sequel-timelined will NOT provide helpers for creating views (yet). 
+
+sequel-timelined will ONLY work for models using an artificial key called 'id'.
+
+TODO
+----
+
+   - Add helpers for views.
+   - Handle composite keys gracefully.
+
+
+
+[1]: http://http://sequel.rubyforge.org/

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'rake'
+
+
+FileList['tasks/**/*.rake'].each { |task| import task }

data/lib/sequel_timelined.rb

@@ -0,0 +1,7 @@
+require 'sequel'
+require 'registry-rails'
+
+require 'sequel_timelined/plugin'
+require 'sequel_timelined/transaction_manager'
+require 'sequel_timelined/transaction_middleware'
+require 'sequel_timelined/utilities'

data/lib/sequel_timelined/plugin.rb

@@ -0,0 +1,55 @@
+module Sequel
+  module Plugins
+    module Timelined
+
+      def self.apply(model)
+        self.add_timeline(model)
+      end
+
+      def self.add_timeline(model)
+        timeline_table_name = "#{model.name}Timelines".underscore.to_sym
+        timeline_model = Class.new(Sequel::Model(timeline_table_name))
+        timeline_model.class_eval do
+          def self.at_timestamp(timestamp)
+            self.timestamp_partition(timestamp).from_self.where(t1__row_number: 1)
+          end
+
+          def self.timestamp_partition(timestamp)
+            self.select_all(self.table_name).select_append do
+              row_number(:over, partition: :timeline_id, order: Sequel.desc(:timeline_timestamp)) {}
+            end.where {timeline_timestamp <= timestamp}
+          end
+
+          def self.join_at(timestamp, model, conditions={})
+            conditions[:row_number] = 1
+            self.at_timestamp(timestamp).join(model.timestamp_partition(timestamp), conditions)
+          end
+        end
+        model.const_set(:Timeline, timeline_model)
+      end
+
+      module InstanceMethods
+        def transaction_manager
+          register = Registry::Rails::Register.instance
+          register.get(:timeline_transaction_manager, TransactionManager.new)
+        end
+
+        def write_timeline_object(additional_data = {})
+          values = self.values.dup.extract!(*self.columns)
+          values.merge!(additional_data)
+          self.transaction_manager.append(self.class, self.id, values)
+        end
+
+        def after_save
+          super
+          write_timeline_object
+        end
+
+        def after_destroy
+          super
+          write_timeline_object(timeline_action: 'deleted')
+        end
+      end
+    end
+  end
+end

data/lib/sequel_timelined/transaction_manager.rb

@@ -0,0 +1,57 @@
+module Sequel
+  module Plugins
+    module Timelined
+
+      class TransactionManager
+        attr_accessor :timeline_changes, :timestamp_generator
+
+
+        def initialize
+          self.timeline_changes = {}
+          self.timestamp_generator = Utilities::TimestampGenerator.new.method(:timestamp)
+        end
+
+        def timeline_timestamp
+          self.timestamp_generator.()
+        end
+
+        def append(model, id, data)
+          self.timeline_changes[model] ||= {}
+          self.timeline_changes[model][id] = data
+        end
+
+        def write_timelined_objects
+          timestamp = self.timeline_timestamp
+          self.timeline_changes.each do |model, objects|
+            data = objects.values.map do |values|
+              values[:timeline_id] = values.delete(:id)
+              values[:timeline_timestamp] = timestamp
+              values
+            end
+            model::Timeline.multi_insert(data)
+          end
+        end
+
+        def self.db
+          Sequel::Model.db
+        end
+
+        def self.timelined_transaction
+          if block_given?
+            self.db.transaction do
+              register = Registry::Rails::Register.instance
+              ttm = self.new
+              register.set(:timeline_transaction_manager, ttm)
+              result = yield(ttm)
+              ttm.write_timelined_objects
+              result
+            end
+          else
+            raise "No block given"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/sequel_timelined/transaction_middleware.rb

@@ -0,0 +1,36 @@
+require 'sequel'
+
+
+module Sequel::Plugins::Timelined
+
+  class TransactionMiddleware
+
+    def initialize(application)
+      @app = application
+    end
+
+    def call(env)
+      method = env['REQUEST_METHOD']
+      if %w[PUT POST].include?(method)
+        self.call_with_transaction(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    def call_with_transaction(env)
+      status, headers, body = [nil, nil, nil]
+      TransactionManager.timelined_transaction do
+        status, headers, body = @app.call(env)
+        unless (200...400).include?(status)
+          # rollback database changes on any status that is not success (2xx)
+          # or redirect (3xx)
+          raise Sequel::Rollback
+        end
+      end
+      [status, headers, body]
+    end
+
+  end
+
+end

data/lib/sequel_timelined/utilities.rb

@@ -0,0 +1,64 @@
+module Sequel
+  module Plugins
+    module Timelined
+
+      class Utilities
+
+        class TimestampGenerator
+
+          def timestamp
+            @timestamp ||= DateTime.now
+          end
+
+        end
+
+        class SchemaGenerator < Sequel::Schema::CreateTableGenerator
+
+          def column(name, type, opts = {})
+            super(name, type)
+          end
+
+          def foreign_key(name, table=nil, options={})
+            self.column(name, :integer)
+          end
+
+          def constraint(name, *args, &block)
+            nil
+          end
+        end
+
+        def self.db
+          Sequel::Model.db
+        end
+
+        def self.create_table(name, options={}, &block)
+          generator, timeline_generator = self.create_table_generator(&block)
+          timelined_name = "#{name.to_s.singularize}_timelines"
+          self.db.transaction do
+            self.db.create_table(name, generator)
+            self.db.create_table(timelined_name, timeline_generator)
+          end
+        end
+
+        def self.create_table_generator(&block)
+          generator = Sequel::Schema::CreateTableGenerator.new(self.db, &block)
+          timeline_generator = self::SchemaGenerator.new(self.db, &block)
+          self.timeline_fields.each do |field_desc|
+            timeline_generator.columns << field_desc
+          end
+
+          [generator, timeline_generator]
+        end
+
+        def self.timeline_fields
+          [
+            { name: :timeline_timestamp, type: 'timestamp with time zone' },
+            { name: :timeline_id, type: :integer },
+            { name: :timeline_action, type: 'character varying(255)' }
+          ]
+        end
+      end
+
+    end
+  end
+end

data/lib/sequel_timelined/version.rb

@@ -0,0 +1,9 @@
+module Sequel
+  module Plugins
+    module Timelined
+
+      VERSION = '0.1.0'
+
+    end
+  end
+end

data/sequel_timelined.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'lib', 'sequel_timelined', 'version')
+
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = "sequel_timelined"
+  s.version = Sequel::Plugins::Timelined::VERSION
+
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andreas Kopecky <andreas.kopecky@radarservices.com>", "Martin Natano <martin.natano@radarservices.com"]
+  s.date = Date.today.strftime
+  s.description = "Sequel plugin enabling extended timeline storage as parallel copy-on-write of models"
+  s.email = "gems [a] radarservices [d] com"
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.extra_rdoc_files = %w[LICENSE README.md]
+
+  s.homepage = "http://github.com/rs-dev/sequel_timelined"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Sequel plugin enabling extended timeline storage as parallel copy-on-write of models"
+
+
+  s.add_runtime_dependency(%q<sequel>, ["~> 4.10"])
+  s.add_runtime_dependency(%q<registry-rails>, ["~> 0.0"])
+  s.add_development_dependency(%q<rake>, ["~> 10.3"])
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: sequel_timelined
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Kopecky <andreas.kopecky@radarservices.com>
+- Martin Natano <martin.natano@radarservices.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+- !ruby/object:Gem::Dependency
+  name: registry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: Sequel plugin enabling extended timeline storage as parallel copy-on-write
+  of models
+email: gems [a] radarservices [d] com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sequel_timelined.rb
+- lib/sequel_timelined/plugin.rb
+- lib/sequel_timelined/transaction_manager.rb
+- lib/sequel_timelined/transaction_middleware.rb
+- lib/sequel_timelined/utilities.rb
+- lib/sequel_timelined/version.rb
+- sequel_timelined.gemspec
+homepage: http://github.com/rs-dev/sequel_timelined
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sequel plugin enabling extended timeline storage as parallel copy-on-write
+  of models
+test_files: []