snapshotable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acbed2ff58337c9ea062a66e6903534f8c438a38
-  data.tar.gz: b673bec953e6067fe9baacc1447be0fa07109fcf
+  metadata.gz: 295739bcb71078e20aa642a39b554663b3eba3ed
+  data.tar.gz: 1aa27734ea1eceb4f18ef96e251cde73cc2b87a4
 SHA512:
-  metadata.gz: 455c66dc663627512c89ec58a74e0c3be63b3a470e140a0ef3a32ca66f6fb952e2415eabae0a223c1378a70d232a0e06b963013e599a1f922fb84988ee8dda80
-  data.tar.gz: 4f7b81e9cb19139b243a62e7cb0ec8a1d27539f980ec3752b37ed6b8cac7b97493a8598a8643b646f230f2cc7a36b14fbe81d4f2c37ef45db0178385c475c9fd
+  metadata.gz: e26506fecd06d327690dcda5a88a9a1ef557b3153e47bf4ca93ffd2b1fc95bb61dd3e657f2ef2c36325dcd9adda7c793975832ec8067a9a7ef1a49a45c1cfd4a
+  data.tar.gz: 5b6084efc5ff846800c97689f2cc8d3f28e05cf21cf86ea5a9bf53ce42572198763928bf7137cddef87c22b8cfd9e74b9bcfed4363397a9765833bdeb00ac612

data/README.md

@@ -95,11 +95,7 @@ In this case, the model won't change, but you could modify it manually if you wi
 
 ### 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
+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]
 ```

data/lib/services/snapshot_creator.rb

@@ -17,7 +17,7 @@ module Snapshotable
     def snapshot_attrs
       snapshot = {}
 
-      add_custom_attributes(snapshot) if custom_snapshot_attributes.any?
+      add_custom_attributes(snapshot) if custom_snapshot_attributes&.any?
 
       snapshot[:object] = extract_attributes(record_snapshot_attrs, record) if record_snapshot_attrs.any?
 
@@ -27,7 +27,7 @@ module Snapshotable
     end
 
     def add_custom_attributes(snapshot)
-      record.custom_snapshot_attributes.each do |key, attribute|
+      custom_snapshot_attributes.each do |key, attribute|
         snapshot[key] = record.send(attribute)
       end
     end
@@ -53,15 +53,15 @@ module Snapshotable
     end
 
     def record_snapshot_attrs
-      @record_snapshot_attrs ||= record.attributes_to_save_on_snapshot.select { |attr| attr.is_a? Symbol }
+      @record_snapshot_attrs ||= record.class.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
+      @deep_snapshot_attrs ||= record.class.attributes_to_save_on_snapshot.select { |attr| attr.is_a? Hash }.first
     end
 
     def custom_snapshot_attributes
-      @custom_snapshot_attributes ||= record.custom_snapshot_attributes
+      @custom_snapshot_attributes ||= record.class.custom_snapshot_attributes.first
     end
   end
 end

data/lib/snapshotable.rb

@@ -1,70 +1,21 @@
 # frozen_string_literal: true
 
-require 'services/snapshot_creator'
+require 'snapshotable/snapshots'
 
 module Snapshotable
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/BlockLength
-  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
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/BlockLength
-
-  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)
+  class << self
+    # Switches Snapshotable on or off
+    def enabled=(value)
+      Snapshotable.config.enabled = value
     end
 
-    def custom_snapshot(*attributes)
-      self.custom_snapshot_attributes = attributes.first
+    # Returns if Snapshotable is turned on
+    def enabled?
+      Snapshotable.config.enabled.present?
     end
   end
 end
 
 ActiveSupport.on_load :active_record do
-  include Snapshotable
+  include Snapshotable::Model
 end

data/lib/snapshotable/model_config.rb

@@ -0,0 +1,84 @@
+module Snapshotable
+  class ModelConfig
+    DEFAULT_ATTRIBUTES = [].freeze
+    DEFAULT_IGNORE_ATTRIBUTES = %w[id created_at updated_at].freeze
+    DEFAULT_CUSTOM_ATTRIBUTES = {}.freeze
+
+    def initialize(model)
+      @model = model
+    end
+
+    def setup_snapshot
+      setup_snapshot_names
+      setup_variables
+      setup_association(@model)
+
+      @model.send :include, ::Snapshotable::Model::InstanceMethods
+    end
+
+    def setup_snapshot_attributes(attributes)
+      setup_snapshot unless snapshot_configured?
+      @model.attributes_to_save_on_snapshot = attributes || DEFAULT_ATTRIBUTES
+    end
+
+    def setup_snapshot_ignore(attributes)
+      setup_snapshot unless snapshot_configured?
+      @model.attributes_to_ignore_on_diff = attributes || DEFAULT_IGNORE_ATTRIBUTES
+    end
+
+    def setup_snapshot_custom(attributes)
+      setup_snapshot unless snapshot_configured?
+      @model.custom_snapshot_attributes = attributes || DEFAULT_CUSTOM_ATTRIBUTES
+    end
+
+    def snapshot_configured?
+      @model.respond_to?(:snapshot_configured) && @model.snapshot_configured
+    end
+
+    def setup_variables
+      @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
+
+      @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
+
+      @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
+      @model.class_attribute :snapshot_association_name
+      @model.snapshot_association_name = snapshot_association_name
+
+      @model.class_attribute :snapshot_class_name
+      @model.snapshot_class_name = snapshot_class_name
+    end
+
+    def setup_association(klass)
+      klass.has_many(
+        klass.snapshot_association_name,
+        class_name: klass.snapshot_class_name,
+        dependent: :destroy
+      )
+    end
+
+    def snapshot_class_name
+      "#{@model.name}Snapshot"
+    end
+
+    def snapshot_association_name
+      snapshot_class_name.pluralize.underscore.to_sym
+    end
+
+    def snapshot_foreign_key
+      "#{@model.name.downcase}_id"
+    end
+  end
+end

data/lib/snapshotable/snapshots.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'services/snapshot_creator'
+require 'snapshotable/model_config'
+
+module Snapshotable
+  module Model
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def snapshot(*attributes)
+        snapshotable_config.setup_snapshot_attributes(attributes)
+      end
+
+      def snapshot_ignore_diff(*attributes)
+        snapshotable_config.setup_snapshot_ignore(attributes)
+      end
+
+      def custom_snapshot(*attributes)
+        snapshotable_config.setup_snapshot_custom(attributes)
+      end
+
+      def snapshotable_config
+        ::Snapshotable::ModelConfig.new(self)
+      end
+    end
+
+    module InstanceMethods
+      def take_snapshot!
+        snapshot = SnapshotCreator.new(self).call
+        snapshot_class.create!(snapshot) if should_create_new_snapshot?(snapshot)
+      end
+
+      def snapshots
+        send(snapshot_association_name)
+      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
+                              .attributes
+                              .except(*self.class.attributes_to_ignore_on_diff)
+                              .with_indifferent_access
+
+        HashDiff.diff(snapshot_to_compare, snapshot.with_indifferent_access).any?
+      end
+    end
+  end
+end

data/lib/snapshotable/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapshotable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - João Batista Marinho
@@ -166,6 +166,8 @@ files:
 - lib/generators/snapshotable/templates/model.rb
 - lib/services/snapshot_creator.rb
 - lib/snapshotable.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