paper_trail-background 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 429ba548db6a5017655f122d0eb90807ff62d6a3c8c0cb500bc60dc104a49e10
+  data.tar.gz: d200d4f26668cbaf3c19fd66f88a1c1ab47e8adf9decd89d5e4c76ce391ad507
+SHA512:
+  metadata.gz: 41c19e1a64c9f99610390ecddca4e7a8669590112310df538cebbf75567e6f92d85dd91202cad5a6227edd04e3013842372956097baacf0315b91422cd427087
+  data.tar.gz: 91348f10376acbadc06f425bab1307e89f21f7e46172709cc5e14902d7ff856f227eee56fb5eecfdcbc1d36a89fcaa9189505bc6412128ef0c237b404d72d451

data/README.md

@@ -0,0 +1,34 @@
+# paper_trail-background
+
+  - [![Build](http://img.shields.io/travis-ci/krainboltgreene/paper_trail-background.svg?style=flat-square)](https://travis-ci.org/krainboltgreene/paper_trail-background)
+  - [![Downloads](http://img.shields.io/gem/dtv/paper_trail-background.svg?style=flat-square)](https://rubygems.org/gems/paper_trail-background)
+  - [![Version](http://img.shields.io/gem/v/paper_trail-background.svg?style=flat-square)](https://rubygems.org/gems/paper_trail-background)
+
+
+TODO: Write a gem description
+
+
+## Using
+
+TODO: Write usage instructions here
+
+
+## Installing
+
+Run this command in your project:
+
+    $ bundle add paper_trail-background
+
+Or install it yourself with:
+
+    $ gem install paper_trail-background
+
+
+## Contributing
+
+  1. Read the [Code of Conduct](/CONDUCT.md)
+  2. Fork it
+  3. Create your feature branch (`git checkout -b my-new-feature`)
+  4. Commit your changes (`git commit -am 'Add some feature'`)
+  5. Push to the branch (`git push origin my-new-feature`)
+  6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all the tests in spec"
+RSpec::Core::RakeTask.new(:spec) do |let|
+  let.pattern = "lib/**{,/*/**}/*_spec.rb"
+end
+
+desc "Default: run tests"
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paper_trail-background"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/paper_trail-background.rb

@@ -0,0 +1,5 @@
+require "paper_trail"
+
+module PaperTrail
+  require_relative "paper_trail/background"
+end

data/lib/paper_trail/background.rb

@@ -0,0 +1,92 @@
+module PaperTrail
+  require_relative "background/version"
+  require_relative "background/sidekiq"
+
+  module Background
+    # @api private
+    # @return - The created version object, so that plugins can use it, e.g.
+    # paper_trail-association_tracking
+    def record_create
+      return unless enabled?
+
+      event = PaperTrail::Events::Create.new(@record, true)
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_create` but PT-AT still does.
+      data = event.data.merge(data_for_create)
+
+      trigger_write(@record, data, :create)
+    end
+
+    # `recording_order` is "after" or "before". See ModelConfig#on_destroy.
+    #
+    # @api private
+    # @return - The created version object, so that plugins can use it, e.g.
+    # paper_trail-association_tracking
+    def record_destroy(recording_order)
+      return unless enabled?
+      return if @record.new_record?
+
+      in_after_callback = recording_order == "after"
+
+      event = PaperTrail::Events::Destroy.new(@record, in_after_callback)
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_destroy` but PT-AT still does.
+      data = event.data.merge(data_for_destroy)
+
+      trigger_write(@record, data, :destroy)
+    end
+
+    # @api private
+    # @return - The created version object, so that plugins can use it, e.g.
+    # paper_trail-association_tracking
+    def record_update(force:, in_after_callback:, is_touch:)
+      return unless enabled?
+
+      event = PaperTrail::Events::Update.new(@record, in_after_callback, is_touch, nil)
+
+      return unless force || event.changed_notably?
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_update_columns` but PT-AT still does.
+      data = event.data.merge(data_for_update_columns)
+
+      trigger_write(@record, data, :update)
+    end
+
+    # @api private
+    # @return - The created version object, so that plugins can use it, e.g.
+    # paper_trail-association_tracking
+    def record_update_columns(changes)
+      return unless enabled?
+
+      event = Events::Update.new(@record, false, false, changes)
+
+      return unless force || event.changed_notably?
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_update_columns` but PT-AT still does.
+      data = event.data.merge(data_for_update_columns)
+
+      trigger_write(@record, data, :update)
+    end
+
+    private def trigger_write(record, data, event)
+      version_class = record.class.paper_trail.version_class
+
+      version_class.after_transaction do
+        VersionJob.perform_async(
+          version_class,
+          data.merge(
+            :item_id => record.id,
+            :item_type => record.class.name
+          ),
+          event
+        )
+      end
+    end
+  end
+end
+
+PaperTrail::RecordTrail.prepend(PaperTrail::Background)

data/lib/paper_trail/background/sidekiq.rb

@@ -0,0 +1,9 @@
+module PaperTrail
+  module Background
+    module Sidekiq
+      def perform(version_class, attributes, event)
+        version = version_class.constantize.create!(attributes)
+      end
+    end
+  end
+end

data/lib/paper_trail/background/version.rb

@@ -0,0 +1,5 @@
+module PaperTrail
+  module Background
+    VERSION = "1.0.0"
+  end
+end

data/lib/paper_trail/background/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe PaperTrail::Background::VERSION do
+  it "should be a string" do
+    expect(PaperTrail::Background::VERSION).to be_kind_of(String)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: paper_trail-background
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.0.1
+description: A library for making paper_trail a background process
+email:
+- kurtis@rainbolt-greene.online
+executables:
+- setup
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paper_trail-background.rb
+- lib/paper_trail/background.rb
+- lib/paper_trail/background/sidekiq.rb
+- lib/paper_trail/background/version.rb
+- lib/paper_trail/background/version_spec.rb
+homepage: http://krainboltgreene.github.io/paper_trail-background.rb
+licenses:
+- ISC
+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.7.7
+signing_key: 
+specification_version: 4
+summary: A library for making paper_trail a background process
+test_files: []