snapshotable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6e8b118f2e16f01a786078f2f595dc4758d68a9
-  data.tar.gz: ce248ffcc575d4958f117be3558551a311a82c3a
+  metadata.gz: acbed2ff58337c9ea062a66e6903534f8c438a38
+  data.tar.gz: b673bec953e6067fe9baacc1447be0fa07109fcf
 SHA512:
-  metadata.gz: 4734984d20167bc564e2314d4333947fb6b33e3639584d94c0c976b4714dbebf33ae4154f4da044941fd73414054a5ad931b277090611bd2333d4530a7f51d8e
-  data.tar.gz: a4fbbbb53540e83ccd1a19451286f00194ca69dbc669cb8e57994d3d5dae582538d8366c155ce4b127d79dcc1a0a21e089131578798f0b090eaffee5da5cb3cd
+  metadata.gz: 455c66dc663627512c89ec58a74e0c3be63b3a470e140a0ef3a32ca66f6fb952e2415eabae0a223c1378a70d232a0e06b963013e599a1f922fb84988ee8dda80
+  data.tar.gz: 4f7b81e9cb19139b243a62e7cb0ec8a1d27539f980ec3752b37ed6b8cac7b97493a8598a8643b646f230f2cc7a36b14fbe81d4f2c37ef45db0178385c475c9fd

data/README.md

@@ -41,8 +41,8 @@ class CreateContractSnapshots < ActiveRecord::Migration
       # model to be snapshoted
       t.references :user, index: true, null: false, foreign_key: true
 
-      # snapshoted_attributes
-      t.jsonb :attributes, null: false
+      # snapshoted_object
+      t.jsonb :object, null: false
       t.timestamps null: false
     end
   end
@@ -55,7 +55,7 @@ class UserSnapshot < ApplicationRecord
   belongs_to :user
 
   validates :user, presence: true
-  validates :attributes, presence: true
+  validates :object, presence: true
 end
 ```
 
@@ -77,13 +77,13 @@ class CreateContractSnapshots < ActiveRecord::Migration
       t.references :user, index: true, null: false, foreign_key: true
 
       # snapshoted_attributes
-      t.jsonb :attributes, null: false
+      t.jsonb :object, null: false
       
-      t.jsonb :profile_attributes, null: false
-      t.jsonb :photo_attributes, null: false
+      t.jsonb :profile_object, null: false
+      t.jsonb :photo_object, null: false
 
-      t.jsonb :groups_attributes, null: false, array: true, default: []
-      t.jsonb :friends_attributes, null: false, array: true, default: []
+      t.jsonb :groups_object, null: false, array: true, default: []
+      t.jsonb :friends_object, null: false, array: true, default: []
 
       t.timestamps null: false
     end
@@ -112,24 +112,24 @@ In the example above a `UserSnapshot` would be created like this:
 ```
 {
   user_id: user.id,
-  attributes: {
+  object: {
     id: user.id,
     name: user.name,
     age: user.age
   },
-  profile_attributes: {
+  profile_object: {
     description: user.profile.description
   },
-  photo_attributes: {
+  photo_object: {
     url: user.photo.url
   },
-  groups_attributes: [{
+  groups_object: [{
     name: user.groups.first.name
   },
   {
     name: user.groups.second.name
   }],
-  friends_attributes: [{
+  friends_object: [{
     name: user.friends.first.name,
     age: user.friends.first.age
   },

data/lib/generators/snapshotable/create_generator.rb

@@ -1,49 +1,49 @@
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
-require "rails/generators/active_record"
+# frozen_string_literal: true
+
+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__)
+      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"
+        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
+          [Time.now.utc.strftime('%Y%m%d%H%M%S'), format('%.14d', next_migration_number)].max
         else
-          "%.3d" % next_migration_number
+          format('%.3d', next_migration_number)
         end
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]" if ActiveRecord::VERSION::MAJOR >= 5
       end
 
       def active_record_class
         ActiveRecord::VERSION::MAJOR >= 5 ? 'ApplicationRecord' : 'ActiveRecord::Base'
       end
 
-      def has_one
+      def relations_has_one
         options['has_one']
       end
 
-      def has_many
+      def relations_has_many
         options['has_many']
       end
 
@@ -56,4 +56,4 @@ module Snapshotable
       end
     end
   end
-end
+end

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

@@ -6,9 +6,9 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
 
       # snapshoted_attributes
       t.jsonb :attributes, null: false
-<% has_one.each do |relation| %>
+<% relations_has_one.each do |relation| %>
       t.jsonb :<%= relation.underscore %>_attributes, null: false<% end %>
-<% has_many.each do |relation| %>
+<% relations_has_many.each do |relation| %>
       t.jsonb :<%= relation.underscore %>_attributes, null: false, array: true, default: []<% end %>
 
       t.timestamps null: false

data/lib/services/snapshot_creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Snapshotable
   class SnapshotCreator
     def initialize(record)
@@ -15,23 +17,31 @@ 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_deep_snapshot_objects(snapshot)
+
+      snapshot
+    end
+
+    def add_custom_attributes(snapshot)
       record.custom_snapshot_attributes.each do |key, attribute|
         snapshot[key] = record.send(attribute)
       end
+    end
 
-      snapshot[:attributes] = extract_attributes(record_snapshot_attrs, record) if record_snapshot_attrs.any?
-
+    def add_deep_snapshot_objects(snapshot)
       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
+        snapshot["#{association_name}_object"] = 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)
@@ -49,5 +59,9 @@ module Snapshotable
     def deep_snapshot_attrs
       @deep_snapshot_attrs ||= record.attributes_to_save_on_snapshot.select { |attr| attr.is_a? Hash }.first
     end
+
+    def custom_snapshot_attributes
+      @custom_snapshot_attributes ||= record.custom_snapshot_attributes
+    end
   end
 end

data/lib/snapshotable/version.rb

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

data/lib/snapshotable.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'services/snapshot_creator'
 
 module Snapshotable
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/BlockLength
   def self.included(base)
     base.class_eval do
       extend ClassMethods
@@ -41,6 +46,9 @@ module Snapshotable
       end
     end
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/BlockLength
 
   module ClassMethods
     def snapshot(*attributes)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapshotable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - João Batista Marinho
@@ -12,7 +12,7 @@ cert_chain: []
 date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -133,6 +133,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
 description: Caches a model in a time period
 email: engineering@qulture.rocks
 executables: []
@@ -160,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.7
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="