snapshotable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6e8b118f2e16f01a786078f2f595dc4758d68a9
+  data.tar.gz: ce248ffcc575d4958f117be3558551a311a82c3a
+SHA512:
+  metadata.gz: 4734984d20167bc564e2314d4333947fb6b33e3639584d94c0c976b4714dbebf33ae4154f4da044941fd73414054a5ad931b277090611bd2333d4530a7f51d8e
+  data.tar.gz: a4fbbbb53540e83ccd1a19451286f00194ca69dbc669cb8e57994d3d5dae582538d8366c155ce4b127d79dcc1a0a21e089131578798f0b090eaffee5da5cb3cd

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Manuel Puyol
+
+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,145 @@
+
+
+# Snapshotable
+
+This gem is intended to work as a model history, saving important information about it (and its relations) over time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snapshotable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snapshotable
+
+## Setup
+
+### Creating the model and migration
+We provide a helpful generator to create migrations and models easily. Simply run:
+```
+rails generate snapshotable:create <model_to_be_snapshoted>
+```
+
+Example:
+```
+rails generate snapshotable:create user
+```
+
+This would create a `create_user_snapshot` migration
+```
+class CreateContractSnapshots < ActiveRecord::Migration
+  def change
+    create_table :user_snapshots do |t|
+      # model to be snapshoted
+      t.references :user, index: true, null: false, foreign_key: true
+
+      # snapshoted_attributes
+      t.jsonb :attributes, null: false
+      t.timestamps null: false
+    end
+  end
+end
+```
+
+and a `UserSnapshot` model
+```
+class UserSnapshot < ApplicationRecord
+  belongs_to :user
+
+  validates :user, presence: true
+  validates :attributes, presence: true
+end
+```
+
+### Saving relation information
+
+It's possible to add `--has_one` or `--has_many` options to the generator, which creates the needed attributes
+
+Example:
+```
+rails generate snapshotable:create user --has_one profile photo --has_many groups friends 
+```
+
+This would create a `create_user_snapshot` migration
+```
+class CreateContractSnapshots < ActiveRecord::Migration
+  def change
+    create_table :user_snapshots do |t|
+      # model to be snapshoted
+      t.references :user, index: true, null: false, foreign_key: true
+
+      # snapshoted_attributes
+      t.jsonb :attributes, null: false
+      
+      t.jsonb :profile_attributes, null: false
+      t.jsonb :photo_attributes, null: false
+
+      t.jsonb :groups_attributes, null: false, array: true, default: []
+      t.jsonb :friends_attributes, null: false, array: true, default: []
+
+      t.timestamps null: false
+    end
+  end
+end
+```
+
+In this case, the model won't change, but you could modify it manually if you wish.
+
+### Setting the base model
+
+After creating the Snapshot model, add a `has_many` relation to the base model
+```
+has_many user_snapshots, dependent: :destroy
+```
+Then, set which attributes should be saved on the Snapshot using `snapshot` on the model
+```
+snapshot :id, :name, :age, profile: [:description], photo: [:url], groups: [:name], friends: [:name, :age]
+```
+
+### Creating a Snapshot
+
+Run `take_snapshot!` to save a new snapshot from a model instance. This will only save a new snapshot if any of the saved fields have changed.
+
+In the example above a `UserSnapshot` would be created like this:
+```
+{
+  user_id: user.id,
+  attributes: {
+    id: user.id,
+    name: user.name,
+    age: user.age
+  },
+  profile_attributes: {
+    description: user.profile.description
+  },
+  photo_attributes: {
+    url: user.photo.url
+  },
+  groups_attributes: [{
+    name: user.groups.first.name
+  },
+  {
+    name: user.groups.second.name
+  }],
+  friends_attributes: [{
+    name: user.friends.first.name,
+    age: user.friends.first.age
+  },
+  {
+    name: user.friends.second.name,
+    age: user.friends.second.age
+  }]
+}
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/snapshotable/create_generator.rb

@@ -0,0 +1,59 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Snapshotable
+  module Generators
+    class CreateGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      argument :snapshotable_model, type: :string
+      class_option :has_one, type: :array, default: [], desc: 'has_one relations to add to the snapshot'
+      class_option :has_many, type: :array, default: [], desc: 'has_many relations to add to the snapshot'
+
+      def generate_migration_and_model
+        migration_template "migration.rb", "db/migrate/create_#{snapshotable_model}_snapshots.rb", migration_version: migration_version
+        template "model.rb", "app/models/#{model_underscored}_snapshot.rb"
+      end
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def migration_version
+        if ActiveRecord::VERSION::MAJOR >= 5
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+
+      def active_record_class
+        ActiveRecord::VERSION::MAJOR >= 5 ? 'ApplicationRecord' : 'ActiveRecord::Base'
+      end
+
+      def has_one
+        options['has_one']
+      end
+
+      def has_many
+        options['has_many']
+      end
+
+      def model_underscored
+        snapshotable_model.underscore
+      end
+
+      def model_camelcased
+        snapshotable_model.camelcase
+      end
+    end
+  end
+end

data/lib/generators/snapshotable/templates/migration.rb

@@ -0,0 +1,17 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= model_underscored %>_snapshots do |t|
+      # model to be snapshoted
+      t.references :<%= model_underscored %>, index: true, null: false, foreign_key: true
+
+      # snapshoted_attributes
+      t.jsonb :attributes, null: false
+<% has_one.each do |relation| %>
+      t.jsonb :<%= relation.underscore %>_attributes, null: false<% end %>
+<% has_many.each do |relation| %>
+      t.jsonb :<%= relation.underscore %>_attributes, null: false, array: true, default: []<% end %>
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/snapshotable/templates/model.rb

@@ -0,0 +1,6 @@
+class <%= model_camelcased %>Snapshot < <%= active_record_class %>
+  belongs_to :<%= model_underscored %>
+
+  validates :<%= model_underscored %>, presence: true
+  validates :attributes, presence: true
+end

data/lib/services/snapshot_creator.rb

@@ -0,0 +1,53 @@
+module Snapshotable
+  class SnapshotCreator
+    def initialize(record)
+      @record = record
+    end
+
+    def call
+      snapshot_attrs
+    end
+
+    private
+
+    attr_reader :record
+
+    def snapshot_attrs
+      snapshot = {}
+
+      record.custom_snapshot_attributes.each do |key, attribute|
+        snapshot[key] = record.send(attribute)
+      end
+
+      snapshot[:attributes] = extract_attributes(record_snapshot_attrs, record) if record_snapshot_attrs.any?
+
+      deep_snapshot_attrs&.each do |association_name, attributes|
+        association = record.send(association_name)
+
+        snapshot["#{association_name}_attributes"] = if association.class.name == 'ActiveRecord::Associations::CollectionProxy'
+                                                           association.map { |model| extract_attributes(attributes, model) }
+                                                         else
+                                                           extract_attributes(attributes, association)
+                                                         end
+      end
+
+      snapshot
+    end
+
+    def extract_attributes(attributes, model)
+      return {} if model.blank?
+
+      attributes.inject({}) do |collected_attrs, attr|
+        collected_attrs.merge(attr => model.send(attr))
+      end
+    end
+
+    def record_snapshot_attrs
+      @record_snapshot_attrs ||= record.attributes_to_save_on_snapshot.select { |attr| attr.is_a? Symbol }
+    end
+
+    def deep_snapshot_attrs
+      @deep_snapshot_attrs ||= record.attributes_to_save_on_snapshot.select { |attr| attr.is_a? Hash }.first
+    end
+  end
+end

data/lib/snapshotable/version.rb

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

data/lib/snapshotable.rb

@@ -0,0 +1,62 @@
+require 'services/snapshot_creator'
+
+module Snapshotable
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      class_attribute :attributes_to_save_on_snapshot, instance_writer: false
+      class_attribute :attributes_to_ignore_on_diff, instance_writer: false
+      class_attribute :custom_snapshot_attributes, instance_writer: false
+
+      self.attributes_to_save_on_snapshot = []
+      self.attributes_to_ignore_on_diff = %w[id created_at updated_at]
+      self.custom_snapshot_attributes = {}
+
+      unless instance_methods.include?(:take_snapshot!)
+        def take_snapshot!
+          snapshot = SnapshotCreator.new(self).call
+          snapshot_model = Object.const_get("#{self.class.name}Snapshot")
+
+          snapshot_model.create!(snapshot) if should_create_new_snapshot?(snapshot)
+        end
+      end
+
+      unless instance_methods.include?(:last_snapshot)
+        def last_snapshot
+          send("#{self.class.name.downcase}_snapshots").last
+        end
+      end
+
+      unless instance_methods.include?(:should_create_cache?)
+        def should_create_new_snapshot?(snapshot)
+          return true if last_snapshot.nil?
+
+          snapshot_to_compare = last_snapshot
+                                .attributes
+                                .except(*attributes_to_ignore_on_diff)
+                                .with_indifferent_access
+
+          HashDiff.diff(snapshot_to_compare, snapshot.with_indifferent_access).any?
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+    def snapshot(*attributes)
+      self.attributes_to_save_on_snapshot = attributes
+    end
+
+    def snapshot_ignore_diff(*attributes)
+      self.attributes_to_ignore_on_diff = attributes.map(&:to_s)
+    end
+
+    def custom_snapshot(*attributes)
+      self.custom_snapshot_attributes = attributes.first
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  include Snapshotable
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: snapshotable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- João Batista Marinho
+- Manuel Puyol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Caches a model in a time period
+email: engineering@qulture.rocks
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/snapshotable/create_generator.rb
+- lib/generators/snapshotable/templates/migration.rb
+- lib/generators/snapshotable/templates/model.rb
+- lib/services/snapshot_creator.rb
+- lib/snapshotable.rb
+- lib/snapshotable/version.rb
+- lib/tasks/cacheable_models.rake
+homepage: https://github.com/QultureRocks/snapshotable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Caches a model in a time period.
+test_files: []