snapshotable 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 295739bcb71078e20aa642a39b554663b3eba3ed
-  data.tar.gz: 1aa27734ea1eceb4f18ef96e251cde73cc2b87a4
+  metadata.gz: 7040b8e2dbf8340101b338b1ba076e33a73137d4
+  data.tar.gz: 8545fcb80172d4062b0f8d7926da4e4088d0ff1b
 SHA512:
-  metadata.gz: e26506fecd06d327690dcda5a88a9a1ef557b3153e47bf4ca93ffd2b1fc95bb61dd3e657f2ef2c36325dcd9adda7c793975832ec8067a9a7ef1a49a45c1cfd4a
-  data.tar.gz: 5b6084efc5ff846800c97689f2cc8d3f28e05cf21cf86ea5a9bf53ce42572198763928bf7137cddef87c22b8cfd9e74b9bcfed4363397a9765833bdeb00ac612
+  metadata.gz: d454e050918822be5e32ea4656ed06252b0444b8765cde2f8f2e317dde9c6d6cc37e16fcb8343ef88a7f228368359bd7d7b1e1bfecf8f29dca87b6ee2dfdf7f6
+  data.tar.gz: 9b313144a07ff5690ee5ebefb4a33bf7e4d6a4ba9aa794df493c8d7b69704291960f0a52ebbcefb45fe27144ded265a0d578d7cfac80641415fb004b4ff4dab8

data/README.md

@@ -1,4 +1,4 @@
-
+[![Build Status](https://travis-ci.com/QultureRocks/snapshotable.svg?branch=master)](https://travis-ci.com/QultureRocks/snapshotable)
 
 # Snapshotable
 

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

@@ -4,12 +4,12 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       # model to be snapshoted
       t.references :<%= model_underscored %>, index: true, null: false, foreign_key: true
 
-      # snapshoted_attributes
-      t.jsonb :attributes, null: false
+      # snapshoted attributes
+      t.jsonb :object, null: false
 <% relations_has_one.each do |relation| %>
-      t.jsonb :<%= relation.underscore %>_attributes, null: false<% end %>
+      t.jsonb :<%= relation.underscore %>_object<% end %>
 <% relations_has_many.each do |relation| %>
-      t.jsonb :<%= relation.underscore %>_attributes, null: false, array: true, default: []<% end %>
+      t.jsonb :<%= relation.underscore %>_object, array: true, default: []<% end %>
 
       t.timestamps null: false
     end

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

@@ -2,5 +2,5 @@ class <%= model_camelcased %>Snapshot < <%= active_record_class %>
   belongs_to :<%= model_underscored %>
 
   validates :<%= model_underscored %>, presence: true
-  validates :attributes, presence: true
+  validates :object, presence: true
 end

data/lib/services/snapshot_creator.rb

@@ -17,16 +17,23 @@ module Snapshotable
     def snapshot_attrs
       snapshot = {}
 
-      add_custom_attributes(snapshot) if custom_snapshot_attributes&.any?
-
       snapshot[:object] = extract_attributes(record_snapshot_attrs, record) if record_snapshot_attrs.any?
 
+      add_foreign_key(snapshot)
+      add_custom_attributes(snapshot)
       add_deep_snapshot_objects(snapshot)
 
       snapshot
     end
 
+    def add_foreign_key(snapshot)
+      return false if record.snapshot_foreign_key.nil?
+      snapshot[record.snapshot_foreign_key.to_s] = record.id
+    end
+
     def add_custom_attributes(snapshot)
+      return false unless custom_snapshot_attributes&.any?
+
       custom_snapshot_attributes.each do |key, attribute|
         snapshot[key] = record.send(attribute)
       end

data/lib/snapshotable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'snapshotable/snapshots'
+require 'snapshotable/model'
 
 module Snapshotable
   class << self

data/lib/snapshotable/{snapshots.rb → model.rb}

@@ -2,6 +2,7 @@
 
 require 'services/snapshot_creator'
 require 'snapshotable/model_config'
+require 'hashdiff'
 
 module Snapshotable
   module Model
@@ -37,12 +38,19 @@ module Snapshotable
         send(snapshot_association_name)
       end
 
+      def last_snapshot_before(time = Time.now)
+        snapshots.order(created_at: :desc).where('created_at < ?', time).first
+      end
+
+      def last_snapshot
+        snapshots.order(created_at: :desc).first
+      end
+
       def snapshot_class
         Object.const_get(snapshot_class_name)
       end
 
       def should_create_new_snapshot?(snapshot)
-        last_snapshot = snapshots.last
         return true if last_snapshot.nil?
 
         snapshot_to_compare = last_snapshot
@@ -54,4 +62,4 @@ module Snapshotable
       end
     end
   end
-end
+end

data/lib/snapshotable/model_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Snapshotable
   class ModelConfig
     DEFAULT_ATTRIBUTES = [].freeze
@@ -12,6 +14,7 @@ module Snapshotable
       setup_snapshot_names
       setup_variables
       setup_association(@model)
+      setup_callback(@model)
 
       @model.send :include, ::Snapshotable::Model::InstanceMethods
     end
@@ -36,21 +39,31 @@ module Snapshotable
     end
 
     def setup_variables
+      setup_attributes_to_save_on_snapshot
+      setup_attributes_to_ignore_on_diff
+      setup_custom_snapshot_attributes
+
+      @model.class_attribute :snapshot_configured
+      @model.snapshot_configured = true
+      @model.send :attr_accessor, :snapshot_configured
+    end
+
+    def setup_attributes_to_save_on_snapshot
       @model.class_attribute :attributes_to_save_on_snapshot, instance_writer: false
       @model.attributes_to_save_on_snapshot = DEFAULT_ATTRIBUTES
       @model.send :attr_accessor, :attributes_to_save_on_snapshot
+    end
 
+    def setup_attributes_to_ignore_on_diff
       @model.class_attribute :attributes_to_ignore_on_diff, instance_writer: false
       @model.attributes_to_ignore_on_diff = DEFAULT_IGNORE_ATTRIBUTES
       @model.send :attr_accessor, :attributes_to_ignore_on_diff
+    end
 
+    def setup_custom_snapshot_attributes
       @model.class_attribute :custom_snapshot_attributes, instance_writer: false
       @model.custom_snapshot_attributes = DEFAULT_CUSTOM_ATTRIBUTES
       @model.send :attr_accessor, :custom_snapshot_attributes
-
-      @model.class_attribute :snapshot_configured
-      @model.snapshot_configured = true
-      @model.send :attr_accessor, :snapshot_configured
     end
 
     def setup_snapshot_names
@@ -59,6 +72,9 @@ module Snapshotable
 
       @model.class_attribute :snapshot_class_name
       @model.snapshot_class_name = snapshot_class_name
+
+      @model.class_attribute :snapshot_foreign_key
+      @model.snapshot_foreign_key = snapshot_foreign_key
     end
 
     def setup_association(klass)
@@ -69,6 +85,12 @@ module Snapshotable
       )
     end
 
+    def setup_callback(klass)
+      klass.after_create(
+        :take_snapshot!
+      )
+    end
+
     def snapshot_class_name
       "#{@model.name}Snapshot"
     end
@@ -81,4 +103,4 @@ module Snapshotable
       "#{@model.name.downcase}_id"
     end
   end
-end
+end

data/lib/snapshotable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snapshotable
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapshotable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - João Batista Marinho
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -85,6 +85,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +161,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +195,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
-description: Caches a model in a time period
+description: Stores a model attributes in a time period
 email: engineering@qulture.rocks
 executables: []
 extensions: []
@@ -166,10 +208,9 @@ files:
 - lib/generators/snapshotable/templates/model.rb
 - lib/services/snapshot_creator.rb
 - lib/snapshotable.rb
+- lib/snapshotable/model.rb
 - lib/snapshotable/model_config.rb
-- lib/snapshotable/snapshots.rb
 - lib/snapshotable/version.rb
-- lib/tasks/cacheable_models.rake
 homepage: https://github.com/QultureRocks/snapshotable
 licenses:
 - MIT
@@ -193,5 +234,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Caches a model in a time period.
+summary: Stores a model attributes in a time period.
 test_files: []