fast_versioning 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec16ba1c62cf76eb3f01b223c8b567084a799353
+  data.tar.gz: 6608e3c92443c1839aa47ad671da34e72a0aab40
+SHA512:
+  metadata.gz: 15f23487376caa1e310b64ab6397dc5a2ad348c9332a87a7e0303a9bf3477fc57c11fdebad1464ed7f0e0008cffdc9a25969833de10204e7d82bea48023fdb17
+  data.tar.gz: 6e7cd07ad4f9e4054b2287deb6e9dc7c42bbc842a4ae1261ce412ebf1477cb7e73fbc9f3b20c6fd28852f23f9f06e785106bad1b0f1ca1d82d309fefdedae815

data/README.md

@@ -0,0 +1,64 @@
+Fast Versioning
+===========
+A [PaperTrail](https://github.com/airblade/paper_trail) extension for seamless fast key/value versioning of individual object attributes, which can be queried.
+
+### Why?
+
+PaperTrail stores version changes in one serialized column, which is great for keeping backups, undoing, etc. For querying and searching this is a real pain to use, and sometimes you need to track single column changes that you can query, use for statistics, quickly check last changes. You can also use Fast Versioning to track more complex object state changes!
+
+### How?
+We hook up to PaperTrail version creation, check if an object's tracked attribute changed and store any changes individually.
+
+Installation
+------------
+1. Add to the Gemfile and bundle
+```ruby
+gem 'fast_versioning'
+```
+2. Install migrations
+```shell
+rake fast_versioning:install:migrations
+```
+
+Configuration
+-------------
+1. Include the concern in your model
+
+```ruby
+include FastVersioning::FastVersioned
+has_paper_trail
+
+    ...
+# define what you want to track
+has_fast_versions(
+  :plan_id,
+  :plan_type,
+  status: {
+    billed_statements: Proc.new { |account| account.utility_statements.count },
+    static_value: 'text'
+  }
+)
+
+# plan_id - is a attribute
+# plan_type - is a custom method
+# status - defines an additional serialized meta apart from storing property change
+```
+
+Usage
+-----
+
+### samples
+```ruby
+    your_model.fast_versions # get all fast versions
+    your_model.fast_versions_for(:plan_type) # get fast versions for given property - chain
+    your_model.fast_versions.last.version # get parent paper_trail version object
+    your_model.fast_versions.last.item # get changed item
+    your_model.fast_versions.last.name # property name
+    your_model.fast_versions.last.value # get value
+    your_model.fast_versions.last.prev_value # get value before the change
+
+    # query
+    your_model.fast_versions_for(:status).where(value: 'active').where(prev_value: 'incomplete')
+```
+
+An [Arcadia Power](http://www.arcadiapower.com) Project

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FastVersioning'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/models/fast_versioning/fast_version.rb

@@ -0,0 +1,11 @@
+module FastVersioning
+  class FastVersion < ActiveRecord::Base
+    belongs_to :item, polymorphic: true
+    belongs_to :whodunnit, polymorphic: true
+    belongs_to :version, class_name: 'PaperTrail::Version'
+
+    validates :version_id, uniqueness: { scope: :name }
+
+    serialize :meta, JSON
+  end
+end

data/db/migrate/20160914161314_create_fast_versioning_fast_versions.rb

@@ -0,0 +1,14 @@
+class CreateFastVersioningFastVersions < ActiveRecord::Migration
+  def change
+    create_table :fast_versioning_fast_versions do |t|
+      t.references :item, polymorphic: true, index: { name: 'fast_version_item_index' }
+      t.references :whodunnit, polymorphic: true, index: { name: 'fast_version_whodunnit_index' }
+      t.integer :version_id, index: { name: 'fast_version_version_id_index' }
+      t.string :name, index: { name: 'fast_version_name_index' }
+      t.string :prev_value, index: { name: 'fast_version_prev_value_index' }
+      t.string :value, index: { name: 'fast_version_value_index' }
+      t.text :meta
+      t.datetime :created_at, index: { name: 'fast_version_created_at_index' }
+    end
+  end
+end

data/lib/fast_versioning.rb

@@ -0,0 +1,10 @@
+require 'paper_trail'
+require 'fast_versioning/tracked_attribute'
+require 'fast_versioning/fast_versioned'
+require 'fast_versioning/value_change'
+require 'fast_versioning/paper_trail_extensions'
+require 'fast_versioning/railtie'
+require 'fast_versioning/engine'
+
+module FastVersioning
+end

data/lib/fast_versioning/engine.rb

@@ -0,0 +1,5 @@
+module FastVersioning
+  class Engine < ::Rails::Engine
+    isolate_namespace FastVersioning
+  end
+end

data/lib/fast_versioning/fast_versioned.rb

@@ -0,0 +1,29 @@
+module FastVersioning
+  module FastVersioned
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :fast_versions, class_name: 'FastVersioning::FastVersion', as: :item
+    end
+
+    module ClassMethods
+      def has_fast_versions(*attributes, **meta)
+        define_method :fast_version_for do
+          processed_meta = *meta.deep_dup.tap do |item|
+            item.values.each do |v|
+              v.each { |i,j| v[i] = j.call(self) if j.respond_to?(:call) }
+            end
+          end
+
+          (attributes + processed_meta).map do |tracked|
+            FastVersioning::TrackedAttribute.new(*tracked)
+          end
+        end
+      end
+    end
+
+    def fast_versions_for(name)
+      fast_versions.where(name: name)
+    end
+  end
+end

data/lib/fast_versioning/paper_trail_extensions.rb

@@ -0,0 +1,38 @@
+module FastVersioning
+  module PaperTrailExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      after_create :create_fast_versions
+      has_many :fast_versions, class_name: 'FastVersioning::FastVersion'
+    end
+
+    def create_fast_versions
+      if item.respond_to?(:fast_version_for, true)
+        value_change = FastVersioning::ValueChange.new(version: self)
+
+        item.send(:fast_version_for).each do |tracked_attribute|
+          if value_change.value_was(tracked_attribute.name) != value_change.value_became(tracked_attribute.name)
+            fast_versions.create(
+              item_id: item_id,
+              item_type: item_type,
+              whodunnit_id: whodunnit.to_i,
+              whodunnit_type: whodunnit_type,
+              name: tracked_attribute.name,
+              value: value_change.value_became(tracked_attribute.name),
+              prev_value: value_change.value_was(tracked_attribute.name),
+              meta: tracked_attribute.meta,
+              created_at: created_at
+            )
+          end
+        end
+      end
+      true
+    end
+
+    def recreate_fast_versions!
+      fast_versions.destroy_all
+      create_fast_versions
+    end
+  end
+end

data/lib/fast_versioning/railtie.rb

@@ -0,0 +1,9 @@
+class FastVersioning::Railtie < Rails::Railtie
+  config.to_prepare do
+    require 'paper_trail'
+
+    PaperTrail::Version.module_eval do
+      include FastVersioning::PaperTrailExtensions
+    end
+  end
+end

data/lib/fast_versioning/tracked_attribute.rb

@@ -0,0 +1,10 @@
+module FastVersioning
+  class TrackedAttribute
+    attr_reader :name, :meta
+
+    def initialize(name, meta = nil)
+      @name = name
+      @meta = meta
+    end
+  end
+end

data/lib/fast_versioning/value_change.rb

@@ -0,0 +1,40 @@
+module FastVersioning
+  class ValueChange
+    def initialize(version:)
+      @version = version
+      @item = version.item
+    end
+
+    def value_was(name)
+      if can_use_changeset?(name)
+        @version.changeset[name][0]
+      else
+        item_was.send(name)
+      end
+    end
+
+    def value_became(name)
+      if can_use_changeset?(name)
+        @version.changeset[name][1]
+      else
+        item_became.send(name)
+      end
+    end
+
+    private
+
+    def can_use_changeset?(name)
+      @version.respond_to?(:changeset) && @version.changeset[name].present?
+    end
+
+    # TODO: support different paper_trail versions
+    def item_was
+      @item_was ||= @version.reify(dup: true) || @item.class.new
+    end
+
+    # TODO: support different paper_trail versions
+    def item_became
+      @item_became ||= @version.next.present? ? @version.next.reify(dup: true) : @item
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fast_versioning
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Arcadia Power
+- Iwo Dziechciarow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fast versioning extension for paper_trail
+email:
+- engineering@arcadiapower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/models/fast_versioning/fast_version.rb
+- db/migrate/20160914161314_create_fast_versioning_fast_versions.rb
+- lib/fast_versioning.rb
+- lib/fast_versioning/engine.rb
+- lib/fast_versioning/fast_versioned.rb
+- lib/fast_versioning/paper_trail_extensions.rb
+- lib/fast_versioning/railtie.rb
+- lib/fast_versioning/tracked_attribute.rb
+- lib/fast_versioning/value_change.rb
+homepage: https://github.com/ArcadiaPower/fast-versioning
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fast versioning extension for paper_trail
+test_files: []