syncify 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 732f3fd3c050a56656ad4eb272412d59528dd0ef
-  data.tar.gz: 6e400731043ff844d4edb694ec68f7c354a68909
+  metadata.gz: 7248fc338732c09e34209b7c01381195ae1f2af4
+  data.tar.gz: ab1f81a93c882e2055c47523c499de0a8f2620dc
 SHA512:
-  metadata.gz: d5c78f9f3b5306c79acbd67a37809166d6f296eb79dbff0183c7a6ecdeca3f0106602e1b003ebf67591208b476d727f2ccac40ae98f414568a5ccde73ba212cb
-  data.tar.gz: 1c54d9823b93cb12d74d4b249222182f2b090c87c7cb83044b816aed3adc6c86fcaaf94f0d9601026f581e9a4a4b276e36928da1babaef7f52049d381824fd6d
+  metadata.gz: 97cc971370901723a93e3241df248da0c57744403f9ef5582e8bb58b02da7e9b47fb450ba1e4c1bf208fa6c65284139707ba42e375feba00907875d7cf681c89
+  data.tar.gz: d87c63cbbda49f8f24312e19c68686e1327d3363df4eff2b4aabe30f4d0494df1a8ad9e9a7f4db2fd32bbc8b5400d76a507db5d354d211a6eccb918bcd9dd585

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syncify (0.1.0)
+    syncify (0.1.2)
       active_interaction (~> 3.0)
       activerecord (~> 4.2)
       activerecord-import (~> 0.17)
@@ -59,7 +59,7 @@ GEM
     method_source (0.9.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.10.3)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -76,7 +76,7 @@ GEM
       activesupport (>= 4.2.0, < 5.0)
       nokogiri (~> 1.6)
       rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.1.0)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
     railties (4.2.11.1)
       actionpack (= 4.2.11.1)

data/README.md

@@ -24,7 +24,6 @@ Or install it yourself as:
 
 ## Usage
 
-
 Syncify doesn't require Rails, just ActiveRecord, but it's a reasonable foundation for the following examples.
 
 Also, you can sync from any environment to whatever your current environment is. So, you could sync from your staging environment to your client test environment or from staging to development. Heck, you could go from staging to prod if you'd like.
@@ -181,6 +180,32 @@ Syncify::Sync.run!(klass: Customer,
 
 This will sync a customer, all of their invoices, all of those invoice's line items. It goes on to sync all of the line item's products, whether digital or physical, as well as the digital product's category and the physical product's distributor.
 
+### Callbacks
+
+Sometimes production databases contain sensitive data that you really don't want to have end up in other environments. Or, maybe you want to disassociate production data from third party production APIs. Or maybe you want to download images before you actually create image records locally. Syncify handles this by providing a callback mechanism.
+
+Syncify's workflow is basically this:
+
+1. Using the specified class and its associations, Syncify identifies all of the records we need to sync to the local environment. Effectively, all of the records are loaded from the remote environment into a set in memory.
+2. Syncify calls an optional `callback` proc you can pass into the `run!` method.
+3. Syncify actually bulk inserts all of the identified records into the local database.
+
+By providing a `callback` proc, you can take some sort of action after all of the remote data has been identified, but before you write it locally. This includes modifying the remote data (in memory, not actually in the remote database).
+
+Here's an example that masks personally identifiable information for users:
+
+```ruby
+Syncify::Sync.run!(klass: User,
+                   id: 40,
+                   remote_database: :production,
+                   callback:
+                     proc do |identified_records|
+                       user = identified_records.find { |record| record.class == User }
+                       user.first_name = "#{user.first_name.first}#{'*' * (user.first_name.size - 1)}"
+                       user.last_name = "#{user.last_name.first}#{'*' * (user.last_name.size - 1)}"
+                     end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/syncify/sync.rb

@@ -12,28 +12,29 @@ module Syncify
     attr_accessor :identified_records
 
     def execute
+      puts 'Identifying records to sync...'
       @identified_records = Set[]
 
       remote do
         identify_associated_records(klass.find(id), normalized_associations(association))
       end
 
+      puts "Identified #{identified_records.size} records to sync."
+
       callback.call(identified_records) if callback.present?
 
       sync_records
     end
 
     def identify_associated_records(root, associations)
+      print '.'
       identified_records << root
 
       standard_associations = associations.reject(&method(:includes_polymorphic_association))
       polymorphic_associations = associations.select(&method(:includes_polymorphic_association))
 
       standard_associations.each do |association|
-        traverse_associations(
-          root.class.eager_load(association).find(root.id),
-          association
-        )
+        traverse_associations(root.class.eager_load(association).find(root.id), association)
       end
 
       identify_polymorphic_associated_records(root, polymorphic_associations)
@@ -76,13 +77,14 @@ module Syncify
         classify_identified_instances.each do |class_name, new_instances|
           puts "Syncing #{new_instances.size} #{class_name} objects"
           clazz = Object.const_get(class_name)
-          clazz.import(new_instances, validate: false, on_duplicate_key_update: [:id])
+          clazz.where(id: [new_instances.map(&:id)]).delete_all
+          clazz.import(new_instances, validate: false)
         end
       end
     end
 
     def classify_identified_instances
-      puts "Classifying #{identified_records.size} records for bulk import."
+      puts "Classifying #{identified_records.size} records for bulk import..."
 
       identified_records.each_with_object({}) do |instance, memo|
         clazz = instance.class

data/lib/syncify/version.rb

@@ -1,3 +1,3 @@
 module Syncify
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syncify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Doug Hughes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler