sequel_paper_trail_safehub 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa412934301fcc0f02d260c7ef473dc69bb5ca8eb3202a5b5b35de1617aa0c6d
+  data.tar.gz: b54c187e26c4aa92fb2c7b272de7b51b3d7029375864d680a80ff950995301bd
+SHA512:
+  metadata.gz: f541d6bfb5fc433f732b192b128b9e54e801d201659e54fe5c8979b182eed702bf2b83218aa51f56e668e76ffc433a0402a045234e3969d27657b653541d95c4
+  data.tar.gz: d53503b9f9e2f922c14d123cfd135bdabe110db766e004e586ebebfc4f42ed2949e5f2bdb49765cab126fb008fc3cb53a90fb91cb3e1f756b65a8a546a78fd3e

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,132 @@
+Sequel plugin for Paper Trail
+=============
+
+This is a simple Sequel plugin for PaperTrail (with limited functionality).
+
+Contributions are welcome!
+
+[![Travis badge](https://github.com/lambwaves/sequel_paper_trail/actions/workflows/ruby.yml/badge.svg)](https://github.com/lambwaves/sequel_paper_trail/actions/workflows/ruby.yml)
+[![Coverage Status](https://coveralls.io/repos/github/lambwaves/sequel_paper_trail/badge.svg)](https://coveralls.io/github/lambwaves/sequel_paper_trail)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
+Features
+------------
+
+* Track when models are created, updated, or deleted
+* specify current_user as whodunnit
+* can be specified info_for_paper_trail
+* versioning can be disabled or enabled globally or in a block context
+
+Limitations
+------------
+
+* this gem doesn't create a version table
+* this is forked from 7 year old code, and I may not accept PRs.
+* info_for_paper_trail is global
+* does not reify
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel_paper_trail', github: 'lambwaves/sequel_paper_trail'
+```
+
+Documentation
+-------------
+
+
+Usage
+-------------
+
+Quick start:
+
+```ruby
+
+require 'sequel_paper_trail'
+require 'sequel'
+require 'sequel/plugins/has_paper_trail'
+
+Album.plugin :has_paper_trail, class_name: 'VersionClassName'
+
+class AlbumsController < BaseController
+  before_action :set_user_for_papertrail
+
+  def set_user_for_papertrail
+    SequelPaperTrail.whodunnit = current_user.id
+  end
+end
+```
+
+Enable versioning globally:
+
+```ruby
+
+SequelPaperTrail.enabled = true
+
+```
+
+Enable versioning for a block of code:
+
+```ruby
+
+SequelPaperTrail.with_versioning { 'code' }
+
+```
+
+Disable versioning globally:
+
+```ruby
+
+SequelPaperTrail.enabled = false
+
+```
+
+Disable versioning for a 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 the 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.
+
+I specify the location of this gem in my application's Gemfile.
+
+
+Contributing
+--------------
+
+I have minimal functionality, so contributions might not be received applicably. 
+
+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,160 @@
+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) do
+          model.name
+        end
+        paper_trail_version_class_name = opts.fetch(:class_name) do
+          'SequelPaperTrail::Version'
+        end
+        paper_trail_ignore_attributes = opts.fetch(:ignore) { [] }
+        paper_trail_whodunnit = opts.fetch(:whodunnit) { proc { '' } }
+
+        model.plugin :dirty
+        binding.pry
+        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
+          @paper_trail_ignore_attributes = paper_trail_ignore_attributes
+          @paper_trail_whodunnit = paper_trail_whodunnit
+        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,
+          :@paper_trail_ignore_attributes => :dup,
+          :@paper_trail_whodunnit => :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
+
+        # Attributes to ignore in version table
+        attr_reader :paper_trail_ignore_attributes
+
+        # Attributes to set whodunnit
+        attr_reader :paper_trail_whodunnit
+      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: nil
+          }
+
+          PaperTrailHelpers.create_version(model, attrs)
+        end
+
+        def after_update
+          super
+
+          return unless SequelPaperTrail.enabled?
+          return if column_changes.empty?
+          return if (column_changes.keys - model.paper_trail_ignore_attributes)
+            .empty?
+
+          attrs = {
+            item_id: id,
+            event: :update,
+            object: PaperTrailHelpers.serializer(values.merge(initial_values))
+          }
+
+          PaperTrailHelpers.create_version(model, attrs)
+        end
+
+        def after_destroy
+          super
+
+          return unless SequelPaperTrail.enabled?
+
+          attrs = {
+            item_id: id,
+            event: :destroy,
+            object: PaperTrailHelpers.serializer(values)
+          }
+
+          PaperTrailHelpers.create_version(model, attrs)
+        end
+
+        def current_version_id
+          versions.any? ? versions.first.id : nil
+        end
+      end
+      # rubocop:enable Style/Documentation
+
+      # rubocop:disable Style/Documentation
+      module PaperTrailHelpers
+        def self.create_version(model, attrs)
+          whodunnit = SequelPaperTrail.whodunnit.respond_to?(:call) ? SequelPaperTrail.whodunnit.call : SequelPaperTrail.whodunnit
+          default_attrs = {
+            item_type: model.paper_trail_item_class_name.to_s,
+            whodunnit: whodunnit,
+            created_at: Time.now.utc.iso8601
+          }
+
+          extra_params = if SequelPaperTrail.info_for_paper_trail.nil?
+              {}
+            elsif SequelPaperTrail.info_for_paper_trail.respond_to?(:call)
+              SequelPaperTrail.info_for_paper_trail.call
+            else
+              SequelPaperTrail.info_for_paper_trail
+            end
+
+          create_attrs = default_attrs
+                         .merge(extra_params)
+                         .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
+
+        def self.serializer(hash)
+          JSON.dump(hash)
+        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.4'.freeze
+end

data/lib/sequel_paper_trail/whodunnit.rb

@@ -0,0 +1,3 @@
+module SequelPaperTrail
+  # Config storage
+end

data/lib/sequel_paper_trail.rb

@@ -0,0 +1,42 @@
+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.info_for_paper_trail = {}

data/spec/sequel/plugins/has_paper_trail_spec.rb

@@ -0,0 +1,126 @@
+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,
+                      ignore: [:ignore]
+
+    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: nil,
+        info: '{"val":1}',
+        other_info: '{}'
+      }
+    ]
+    expect(without_fields(record.versions, :id)).to eq(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: '{"id":1,"name":"test","email":"test@test.com","ignore":null}',
+      info: '{"val":1}',
+      other_info: '{}'
+    }
+    binding.pry
+    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: '{"id":1,"name":"test","email":"test@test.com","ignore":null}',
+      info: '{"val":1}',
+      other_info: '{}'
+    }
+    expect(without_fields(record.versions, :id)).to be_include(expected)
+  end
+
+  it 'creates versions on record update event without ignored attrs' do
+    record = item_class.create(name: 'test',
+                               email: 'test@test.com',
+                               ignore: 'secret')
+    record.update(ignore: '2')
+    expected = {
+      item_type: 'TetsClass',
+      item_id: 1,
+      event: 'update',
+      whodunnit: 'Admin',
+      created_at: Time.now.utc.iso8601,
+      transaction_id: nil,
+      object: '{"id":1,"name":"test","email":"test@test.com","ignore":null}',
+      info: '{"val":1}',
+      other_info: '{}'
+    }
+    expect{ record.update(ignore: '2') }.to_not change { record.versions.count }
+  end
+
+  it 'current_version_id returns the latest version id' do
+    record = item_class.create(name: 'test', email: 'test@test.com')
+    record.update(name: '1')
+    record.update(name: '2')
+    expect(record.current_version_id).to eq(record.versions.first.id)
+  end
+
+  it 'saves join table rows' do
+    paper_db.create_test_join_table
+    test_join_model = paper_db.test_join_model
+    # class AlbumArtist;end;
+      test_join_model.plugin :has_paper_trail,
+                      item_class_name: 'AlbumArtist',
+                      class_name: version_class
+
+    joiner = test_join_model.create(artist_id: 1, album_id: 1)
+    expect(joiner.versions.count).to eq(1)
+  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/generic_sinatra_app.rb

@@ -0,0 +1,9 @@
+# require 'sinatra'
+
+# class GenericSinatraApp < Sinatra::Base
+# 	get '/' do
+# 		binding.pry
+# 		db = SpecPaperDb.new
+# 		db.test_model.all[-1].update_email('fresh@example.com')
+# 	end
+# end

data/spec/support/spec_paper_db.rb

@@ -0,0 +1,60 @@
+class SpecPaperDb
+  def initialize
+    # https://gist.github.com/studiorailsway/1561497
+    @db = if RUBY_PLATFORM == 'java'
+            Sequel.connect('jdbc:sqlite:db.sqlite3')
+          else
+            Sequel.extension(:sqlite_json_ops)
+            Sequel.sqlite(':memory:')
+          end
+  end
+
+  def create_test_join_table
+    @db.create_table!(:albums_artists) do
+      column :artist_id,     :integer
+      column :album_id,    :integer
+    end
+  end
+
+  def create_test_table
+    @db.create_table!(:test_table) do
+      primary_key :id
+      column :name,     :text
+      column :email,    :text
+      column :ignore,    :text
+    end
+  end
+
+  def test_model
+    Class.new(Sequel::Model(@db[:test_table]))
+  end
+
+  def test_join_model
+    Class.new(Sequel::Model(@db[:albums_artists]))
+  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', :json
+      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,66 @@
+--- !ruby/object:Gem::Specification
+name: sequel_paper_trail_safehub
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Vadim Lazebny
+- Evan Richards
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-17 00:00:00.000000000 Z
+dependencies: []
+description: Sequel plugin for PaperTrail.
+email:
+- vadim.lazebny@gmail.com
+- evan.richards@safehub.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- 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
+- lib/sequel_paper_trail/whodunnit.rb
+- spec/sequel/plugins/has_paper_trail_spec.rb
+- spec/sequel/plugins/whodunnit_spec.rb
+- spec/sequel_paper_trail_spec.rb
+- spec/spec_helper.rb
+- spec/support/generic_sinatra_app.rb
+- spec/support/spec_paper_db.rb
+homepage: https://github.com/lambwaves/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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Sequel plugin for PaperTrail.
+test_files:
+- spec/spec_helper.rb
+- spec/sequel/plugins/whodunnit_spec.rb
+- spec/sequel/plugins/has_paper_trail_spec.rb
+- spec/sequel_paper_trail_spec.rb
+- spec/support/generic_sinatra_app.rb
+- spec/support/spec_paper_db.rb