sequel-audit_by_day 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/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-audit_by_day.gemspec
+gemspec
+
+gem "rake"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonathan Tron
+
+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,117 @@
+# Sequel::AuditByDay
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel-audit_by_day'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-audit_by_day
+
+## Usage
+
+Given following models:
+
+```ruby
+#
+# Sequel.migration do
+#   change do
+#     create_table :users do
+#       primary_key :id
+#       FalseClass  :admin, default: false, null: false
+#     end
+#   end
+# end
+#
+class User < Sequel::Model
+  def admin_in_audit?
+    admin
+  end
+end
+#
+# Sequel.migration do
+#   change do
+#     create_table :posts do
+#       primary_key :id
+#     end
+#     create_table :post_versions do
+#       primary_key :id
+#       foreign_key :master_id, :posts, on_delete: :cascade, deferrable: true
+#       Time        :created_at
+#       Time        :expired_at
+#       Date        :valid_from
+#       Date        :valid_to
+#       String      :title
+#       index [:master_id, :created_at, :valid_from, :valid_to]
+#     end
+#     create_table :post_audits do
+#       primary_key :id
+#       Date        :for
+#       foreign_key :post_id, :posts, on_delete: :cascade, deferrable: true
+#       index [:post_id, :for], unique: true
+#     end
+#     create_table :post_audit_versions do
+#       primary_key :id
+#       foreign_key :master_id, :post_audits, on_delete: :cascade, deferrable: true
+#       Time        :created_at
+#       Time        :expired_at
+#       Date        :valid_from
+#       Date        :valid_to
+#       foreign_key :title_updated_by_id, :users, on_delete: :set_null
+#       foreign_key :admin_user_id, :users, on_delete: :set_null
+#       index [:master_id, :created_at, :valid_from, :valid_to]
+#     end
+#   end
+# end
+#
+class Post < Sequel::Model
+  plugin :bitemporal, version_class: PostVersion,
+                      audit_class: PostAudit,
+                      audit_updated_by_method: :updated_by
+
+  one_to_many :audits, class: "PostAudit"
+  delegate :updated_by, to: :pending_or_current_version, allow_nil: true
+end
+class PostVersion < Sequel::Model
+  attr_accessor :updated_by
+end
+class PostAudit < Sequel::Model
+  plugin :bitemporal, version_class: PostAuditVersion
+  plugin :audit_by_day, foreign_key: :post_id
+end
+class PostAuditVersion < Sequel::Model
+end
+```
+
+Then you can record changes like this:
+
+```
+user = User.create
+admin = User.create admin: true
+
+post = Post.new.update_attributes({
+  title: "First post",
+  updated_by: admin,
+})
+
+post.update_attributes({
+  title: "First post updated",
+  updated_by: user
+})
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sequel/plugins/audit_by_day.rb

@@ -0,0 +1,51 @@
+module Sequel
+  module Plugins
+    module AuditByDay
+      require "set"
+
+      def self.configure(master, opts={})
+        audit_foreign_key = opts[:foreign_key]
+        default_valid_from = opts.fetch(:default_valid_from){ Time.utc(1000) }
+        raise Error, ":foreign_key options is required for audit" unless audit_foreign_key
+        raise Error, ":foreign_key column does not exists for audit" unless master.columns.include? audit_foreign_key
+        updated_by_suffix = "_updated_by_id"
+        version_columns = master.version_class.columns.collect do |column|
+          column_str = column.to_s
+          if column_str.end_with? updated_by_suffix
+            column_str = column_str.gsub(updated_by_suffix, "").to_sym
+          end
+        end.compact
+        master.instance_eval do
+          @audit_foreign_key = audit_foreign_key
+          @audit_checked_columns = Set.new version_columns
+        end
+      end
+
+      module ClassMethods
+        attr_reader :audit_foreign_key, :audit_checked_columns, :default_valid_from
+
+        def find_for(audited_id, at)
+          where(audit_foreign_key => audited_id, :for => at).with_current_version.first
+        end
+
+        def audit(master, previous_values, updated_values, update_time, updated_by)
+          changed_values = updated_values.select do |column, updated_value|
+            audit_checked_columns.include?(column) &&
+            previous_values[column]!=updated_value
+          end
+          audit_for_day = find_for master.id, update_time
+          audit_for_day ||= new({audit_foreign_key => master.id, :for => update_time})
+          if updated_by.respond_to?(:admin_in_audit?) && updated_by.admin_in_audit?
+            attrs = {admin_user_id: updated_by.id}
+          else
+            attrs = Hash[changed_values.collect{|column, _| ["#{column}_updated_by_id", updated_by]}]
+            attrs[:admin_user_id] = nil
+          end
+          audit_for_day.update_attributes attrs.merge({
+            partial_update: true, valid_from: self.class.default_valid_from
+          })
+        end
+      end
+    end
+  end
+end

data/lib/sequel-audit_by_day/version.rb

@@ -0,0 +1,5 @@
+module Sequel
+  module AuditByDay
+    VERSION = "0.0.1"
+  end
+end

data/lib/sequel-audit_by_day.rb

@@ -0,0 +1,3 @@
+require "sequel"
+require "sequel-audit_by_day/version"
+require "sequel/plugins/audit_by_day"

data/sequel-audit_by_day.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel-audit_by_day/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sequel-audit_by_day"
+  gem.version       = Sequel::AuditByDay::VERSION
+  gem.authors       = ["Jonathan Tron", "Joseph Halter"]
+  gem.email         = ["jonathan.tron@metrilio.com", "joseph.halter@metrilio.com"]
+  gem.description   = "Audit by day for sequel_bitemporal"
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/TalentBox/sequel-audit_by_day"
+
+  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.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "sequel_bitemporal", ">= 0.4.7"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: sequel-audit_by_day
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Tron
+- Joseph Halter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel_bitemporal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+description: Audit by day for sequel_bitemporal
+email:
+- jonathan.tron@metrilio.com
+- joseph.halter@metrilio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel-audit_by_day.rb
+- lib/sequel-audit_by_day/version.rb
+- lib/sequel/plugins/audit_by_day.rb
+- sequel-audit_by_day.gemspec
+homepage: https://github.com/TalentBox/sequel-audit_by_day
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3583529659193523704
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3583529659193523704
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Audit by day for sequel_bitemporal
+test_files: []