sequel_paper_trail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61d2d99cb151f8ca3f3ce9e098d6bcc398da7a38
+  data.tar.gz: a94f1018b8b7dcdec22af0c026ac3c0cc9e1fa0b
+SHA512:
+  metadata.gz: b067af614882469a32b3f3d761e925bf9db906fcb9bfae2c421f9ba8a42096175fa2d4d7ded996f5bff0649d5921a4982b4b0d9cf2ee8d9adacd83afd857ad8d
+  data.tar.gz: fef0e1027d6b5188d9021397a9f98f5de1fc35bf9cdaaf90acef402e557551c071a63630382cb2709ea88bf90d675e257ae02a22bd1bf7ac5b162a48c1cfc030

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vadim Lazebny
+
+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,146 @@
+Sequel plugin for Paper Trail
+=============
+
+This is a simple Sequel plugin for PaperTrail (with limited functionality).
+
+Conributions are welcome!
+
+[![Gem Version](https://badge.fury.io/rb/sequel_paper_trail.svg)](http://badge.fury.io/rb/sequel_paper_trail)
+[![Travis badge](https://travis-ci.org/lazebny/sequel_paper_trail.svg?branch=master)](https://travis-ci.org/lazebny/sequel_paper_trail)
+[![Coverage Status](https://coveralls.io/repos/lazebny/sequel_paper_trail/badge.png)](https://coveralls.io/r/lazebny/sequel_paper_trail)
+[![Code Climate Badge](https://codeclimate.com/github/lazebny/sequel_paper_trail.svg)](https://codeclimate.com/github/lazebny/sequel_paper_trail)
+[![Inch CI](http://inch-ci.org/github/lazebny/sequel_paper_trail.svg)](http://inch-ci.org/github/lazebny/sequel_paper_trail)
+[![Dependency Status](https://gemnasium.com/lazebny/sequel_paper_trail.svg)](https://gemnasium.com/lazebny/sequel_paper_trail)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
+Features
+------------
+
+* model are able to subscribe on create, update, delete callback
+* can be specified whodunnit
+* can be specified info_for_paper_trail
+* versioning can be disabled or enabled globaly or in block context
+
+Limitations
+------------
+
+* this gem doesn't create a version table
+* versions table has a structure as Paper Trail v0.6.x. has
+* whodunnit is global
+* info_for_paper_trail is global
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel_paper_trail'
+```
+
+Documentation
+-------------
+
+
+Usage
+-------------
+
+Our usage model:
+
+* separate service uses [Sequel](https://github.com/jeremyevans/sequel) + this plugin
+* web uses [Paper Trail](https://github.com/airblade/paper_trail) + [Rails Admin](https://github.com/sferik/rails_admin).
+
+Be sure that you have a proper tables from [Paper Trail](https://github.com/airblade/paper_trail) v0.6.x.
+
+Than you can subscribe a model on create, update, destroy callbacks.
+
+Quick start:
+
+```ruby
+
+require 'sequel_paper_trail'
+require 'sequel'
+require 'sequel/plugins/has_paper_trail'
+
+Album.pligin :has_paper_trail,
+             class_name: 'VersionClassName'
+# or
+
+Album.pligin :has_paper_trail,
+             item_class_name: SomeAlbum,
+             class_name: 'VersionClassName'
+
+```
+
+Enable versioning globaly:
+
+```ruby
+
+SequelPaperTrail.enabled = true
+
+```
+
+Enable versioning for block of code:
+
+```ruby
+
+SequelPaperTrail.with_versioning { 'code' }
+
+```
+
+Disable versioning globaly:
+
+```ruby
+
+SequelPaperTrail.enabled = false
+
+```
+
+Disable versioning for block of code
+
+```ruby
+
+SequelPaperTrail.with_versioning(false) { 'code' }
+
+```
+
+Set whodunnit:
+
+```ruby
+
+SequelPaperTrail.whodunnit = 'Mr. Smith'
+
+```
+
+Set info_for_paper_trail - additional info (Hash) which will be attached to versions table.
+
+```ruby
+
+# If you have 'release' and 'instance' columns in a versions table you can populate them.
+
+SequelPaperTrail.info_for_paper_trail = { release: 'asdf131234', instance: `hostname` }
+
+```
+
+Development
+--------------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+Contributing
+--------------
+
+This gem has a very limited functionality so conributions are welcome!
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lazebny/sequel_paper_trail.
+
+
+License
+--------------
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/sequel/plugins/has_paper_trail.rb

@@ -0,0 +1,128 @@
+module Sequel
+  module Plugins
+    # Add Paper Trail versioning callbacks to model.
+    #
+    # Usage:
+    #
+    #   # Enable versioning for all models.
+    #   Sequel::Model.plugin :has_paper_trail
+    #
+    #   # Make the Album class be able to versioning.
+    #   Album.plugin :has_paper_trail, item_class_name: Album, class_name: 'Album::Version'
+    #
+    module HasPaperTrail
+      # rubocop:disable Metrics/MethodLength
+      def self.configure(model, opts = {})
+        paper_trail_item_class_name = opts.fetch(:item_class_name) { model.name }
+        paper_trail_version_class_name = opts.fetch(:class_name) { 'SequelPaperTrail::Version' }
+
+        model.plugin :dirty
+        model.one_to_many :versions,
+                          class: paper_trail_version_class_name,
+                          key: :item_id,
+                          conditions: { item_type: paper_trail_item_class_name }
+
+        model.instance_eval do
+          @paper_trail_item_class_name = paper_trail_item_class_name
+          @paper_trail_version_class_name = paper_trail_version_class_name
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Style/Documentation
+      module ClassMethods
+        Sequel::Plugins.inherited_instance_variables(
+          self,
+          :@paper_trail_item_class_name => :dup,
+          :@paper_trail_version_class_name => :dup
+        )
+
+        # The class name of item for versioning
+        attr_reader :paper_trail_item_class_name
+
+        # The version class name
+        attr_reader :paper_trail_version_class_name
+      end
+      # rubocop:enable Style/Documentation
+
+      # rubocop:disable Style/Documentation
+      module InstanceMethods
+        def after_create
+          super
+
+          return unless SequelPaperTrail.enabled?
+
+          attrs = {
+            item_id: id,
+            event: :create,
+            object_changes: values.to_json,
+            object: nil
+          }
+
+          PaperTrailHelpers.create_version(model, attrs)
+        end
+
+        def after_update
+          super
+
+          return unless SequelPaperTrail.enabled?
+          return if column_changes.empty?
+
+          attrs = {
+            item_id: id,
+            event: :update,
+            object_changes: column_changes.to_json,
+            object: values.merge(initial_values).to_json
+          }
+
+          PaperTrailHelpers.create_version(model, attrs)
+        end
+
+        def after_destroy
+          super
+
+          return unless SequelPaperTrail.enabled?
+
+          attrs = {
+            item_id: id,
+            event: :destroy,
+            object_changes: nil,
+            object: values.to_json
+          }
+
+          PaperTrailHelpers.create_version(model, attrs)
+        end
+      end
+      # rubocop:enable Style/Documentation
+
+      # rubocop:disable Style/Documentation
+      module PaperTrailHelpers
+        def self.create_version(model, attrs)
+          default_attrs = {
+            item_type: model.paper_trail_item_class_name.to_s,
+            whodunnit: SequelPaperTrail.whodunnit,
+            created_at: Time.now.utc.iso8601,
+            transaction_id: nil
+          }
+
+          create_attrs = default_attrs
+                         .merge(SequelPaperTrail.info_for_paper_trail)
+                         .merge(attrs)
+
+          version_class(model.paper_trail_version_class_name).create(create_attrs)
+        end
+
+        private_class_method
+
+        def self.version_class(class_name)
+          if class_name.is_a?(String)
+            Kernel.const_get(class_name)
+          else
+            class_name
+          end
+        end
+      end
+      # rubocop:enable Style/Documentation
+    end
+  end
+end

data/lib/sequel_paper_trail/config.rb

@@ -0,0 +1,21 @@
+require 'singleton'
+
+module SequelPaperTrail
+  # Config storage
+  class Config
+    include Singleton
+
+    def initialize
+      @mutex = Mutex.new
+      @enabled = true
+    end
+
+    def enabled
+      @mutex.synchronize { @enabled }
+    end
+
+    def enabled=(enable)
+      @mutex.synchronize { @enabled = enable }
+    end
+  end
+end

data/lib/sequel_paper_trail/version.rb

@@ -0,0 +1,3 @@
+module SequelPaperTrail
+  VERSION = '0.0.1'.freeze
+end

data/lib/sequel_paper_trail.rb

@@ -0,0 +1,43 @@
+require 'sequel_paper_trail/version'
+require 'sequel_paper_trail/config'
+
+# Paper Trail config interface
+module SequelPaperTrail
+  class << self
+    attr_accessor :whodunnit
+    attr_accessor :info_for_paper_trail
+
+    # Set versioning state.
+    #
+    # Boolean -> Boolean
+    #
+    def enabled=(enable)
+      Config.instance.enabled = enable
+    end
+
+    # Check if versioning enabled.
+    #
+    # Boolean
+    #
+    def enabled?
+      Config.instance.enabled
+    end
+
+    # Execute block with or without versioning.
+    #
+    # Boolean -> Proc -> Boolean
+    #
+    def with_versioning(enable = true)
+      was_enabled = enabled?
+      self.enabled = enable
+      yield
+    ensure
+      self.enabled = was_enabled
+    end
+  end
+end
+
+# Default Configuration
+SequelPaperTrail.enabled = true
+SequelPaperTrail.whodunnit = nil
+SequelPaperTrail.info_for_paper_trail = {}

data/spec/sequel/plugins/has_paper_trail_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Sequel::Plugins::HasPaperTrail do
+  def without_fields(records, *fields)
+    records.map do |record|
+      record.to_hash.tap { |r| fields.each { |field| r.delete(field) } }
+    end
+  end
+
+  let(:paper_db) { SpecPaperDb.new }
+  let(:item_class) { paper_db.test_model }
+  let(:version_class) { paper_db.version_model }
+
+  before do
+    paper_db.create_test_table
+    paper_db.create_versions_table
+
+    item_class.plugin :has_paper_trail,
+                      item_class_name: 'TetsClass',
+                      class_name: version_class
+
+    SequelPaperTrail.whodunnit = 'Admin'
+    SequelPaperTrail.info_for_paper_trail = {
+      info: {
+        'val' => 1
+      }.to_json,
+      other_info: '{}'
+    }
+  end
+
+  after do
+    paper_db.drop_all_tables
+  end
+
+  it 'creates versions on record create event' do
+    record = item_class.create(name: 'test', email: 'test@test.com')
+    expected = [
+      {
+        item_type: 'TetsClass',
+        item_id: 1,
+        event: 'create',
+        whodunnit: 'Admin',
+        created_at: Time.now.utc.iso8601,
+        transaction_id: nil,
+        object_changes: '{"name":"test","email":"test@test.com","id":1}',
+        object: nil,
+        info: '{"val":1}',
+        other_info: '{}'
+      }
+    ]
+    expect(without_fields(record.versions, :id)).to eql(expected)
+  end
+
+  it 'creates versions on record update event' do
+    record = item_class.create(name: 'test', email: 'test@test.com')
+    record.update(name: '2')
+    expected = {
+      item_type: 'TetsClass',
+      item_id: 1,
+      event: 'update',
+      whodunnit: 'Admin',
+      created_at: Time.now.utc.iso8601,
+      transaction_id: nil,
+      object_changes: '{"name":["test","2"]}',
+      object: '{"id":1,"name":"test","email":"test@test.com"}',
+      info: '{"val":1}',
+      other_info: '{}'
+    }
+    expect(without_fields(record.versions, :id)).to be_include(expected)
+  end
+
+  it 'creates versions on record destroy event' do
+    record = item_class.create(name: 'test', email: 'test@test.com')
+    record.destroy
+    expected = {
+      item_type: 'TetsClass',
+      item_id: 1,
+      event: 'destroy',
+      whodunnit: 'Admin',
+      created_at: Time.now.utc.iso8601,
+      transaction_id: nil,
+      object_changes: nil,
+      object: '{"id":1,"name":"test","email":"test@test.com"}',
+      info: '{"val":1}',
+      other_info: '{}'
+    }
+    expect(without_fields(record.versions, :id)).to be_include(expected)
+  end
+end

data/spec/sequel_paper_trail_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe SequelPaperTrail do
+  let(:paper_db) { SpecPaperDb.new }
+  let(:item_class) { paper_db.test_model }
+  let(:version_class) { paper_db.version_model }
+
+  before do
+    paper_db.create_test_table
+    paper_db.create_versions_table
+
+    item_class.plugin :has_paper_trail,
+                      item_class_name: 'TestClass',
+                      class_name: version_class
+  end
+
+  after do
+    paper_db.drop_all_tables
+  end
+
+  context '.with_versioning' do
+    it 'enabled' do
+      described_class.with_versioning(true) do
+        item = item_class.create(name: 'test')
+        expect(item.versions).not_to be_empty
+      end
+    end
+
+    it 'disabled' do
+      described_class.with_versioning(false) do
+        item = item_class.create(name: 'test')
+        expect(item.versions).to be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'sequel'
+# require 'jdbc-sqlite3'
+require 'pry'
+
+require 'sequel_paper_trail'
+require 'sequel/plugins/has_paper_trail'
+
+Dir['./spec/support/*'].each(&method(:require))
+
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.order = 'random'
+  # Enable flags like --only-failures and --next-failure
+  # config.example_status_persistence_file_path = '.rspec_status'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/spec_paper_db.rb

@@ -0,0 +1,49 @@
+class SpecPaperDb
+  def initialize
+    # https://gist.github.com/studiorailsway/1561497
+    @db = if RUBY_PLATFORM == 'java'
+            Sequel.connect('jdbc:sqlite:db.sqlite3')
+          else
+            Sequel.sqlite(':memory:')
+          end
+  end
+
+  def create_test_table
+    @db.create_table!(:test_table) do
+      primary_key :id
+      column :name,     :text
+      column :email,    :text
+    end
+  end
+
+  def test_model
+    Class.new(Sequel::Model(@db[:test_table]))
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def create_versions_table
+    @db.create_table!(:versions) do
+      primary_key :id
+      column 'item_type', :text
+      column 'item_id', :integer
+      column 'event', :text
+      column 'whodunnit', :text
+      column 'created_at', :text
+      column 'transaction_id', :integer
+      column 'object_changes', :text
+      column 'object', :text
+      column 'info', :text
+      column 'other_info', :text
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def version_model
+    Class.new(Sequel::Model(@db[:versions]))
+  end
+
+  def drop_all_tables
+    @db.drop_table(:test_table)
+    @db.drop_table(:versions)
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: sequel_paper_trail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vadim Lazebny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies: []
+description: Sequel plugin for PaperTrail.
+email:
+- vadim.lazebny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/sequel/plugins/has_paper_trail.rb
+- lib/sequel_paper_trail.rb
+- lib/sequel_paper_trail/config.rb
+- lib/sequel_paper_trail/version.rb
+- spec/sequel/plugins/has_paper_trail_spec.rb
+- spec/sequel_paper_trail_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_paper_db.rb
+homepage: https://github.com/lazebny/sequel_paper_trail
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Sequel plugin for PaperTrail.
+test_files:
+- spec/sequel/plugins/has_paper_trail_spec.rb
+- spec/support/spec_paper_db.rb
+- spec/spec_helper.rb
+- spec/sequel_paper_trail_spec.rb