synced 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b57fd9809319aece800d98be7cb7d595af42183
-  data.tar.gz: ceb98bf9015b4877d597f4d89a73c63627ad8353
+  metadata.gz: a79202a122c1ac89d94317b7a04ddcc4cbd2f826
+  data.tar.gz: 9a24cb9fa5f708ead2375829a1a615588d1dc9e9
 SHA512:
-  metadata.gz: 498ac45444e90dac7dba56d8c79bb644c61a89fd5da85c1225612a86dc0d5fae59cb6570d744d2c5c7b4d3176dd0936c36d304f7aadfa97d672bd4b2a4b38125
-  data.tar.gz: 43493baddef335a7c0602949071ba5602cc0e9519e746fc7f737f86a9fc327a8c6d5dda260bc2ec68249d060e3293dc67a5aac0100cde3527dd4300b49fd0988
+  metadata.gz: 9be1f7c897d14a222d99dd2ba3392fa637af8b56432b82078aa26ef59c5914ec412e2b3fb29e3582d03c2881f8a6383d7f0dccdc1d5369b9b044c3aac54f2728
+  data.tar.gz: 970a8062422cd80b92d69d7f2d82f82c14ccbabefad4aa8ce9659aace797ae4be06cae49a58458649d1499ff6f08b2ea982d127a732f822afc8dbe043df2d113

data/README.md

@@ -462,6 +462,22 @@ keys are delegated attributes' names and values are keys on synced data Hash. Th
 version of `delegate :name, to: :synced_data` which works with Hash reserved attributes names, like
 `:zip`, `:map`.
 
+## Persisting fetched objects
+
+By default all fetched objects are persisted inside one big transaction. You can customize this behaviour by providing `transaction_per_page` option either in model configuration:
+
+```ruby
+class Photo < ActiveRecord::Base
+  synced transaction_per_page: true
+end
+```
+
+Or as a param in `synchronize` method:
+
+```
+Photo.synchronize(transaction_per_page: true)
+```
+
 ## Synced configuration options
 
 Option name          | Default value    | Description                                                                       | synced | synchronize |
@@ -477,6 +493,7 @@ Option name          | Default value    | Description
 `:remote`            | `nil`            | [Remote objects to be synchronized with local ones](#synchronization-of-given-remote-objects) | NO | YES |
 `:delegate_attributes`| `[]`            | [Define delegators to synced data Hash attributes](#delegate-attributes)          | YES    | NO |
 `:auto_paginate`     | `true`           | [Whether data should be fetched in batches or as one response](#fetching-methods)                 | YES    | YES |
+`:transaction_per_page` | `false`       | [Whether transaction should be per page of fetched objects or for all the pages - note that setting this value to `true` will mean always fetching data in batches, even when specifying `auto_paginate` as true](#persisting-fetched-objects)                 | YES    | YES |
 `:handle_processed_objects_proc` | `nil` | [Custom proc taking persisted remote objects, called after persisting batch of data](#persisted-objects)   | YES    | NO |
 
 ## Documentation

data/lib/synced/model.rb

@@ -37,17 +37,20 @@ module Synced
     #   which will be passed to api client to perform search
     # @option options [Boolean] auto_paginate: If true (default) will fetch and save all
     #   records at once. If false will fetch and save records in batches.
+    # @option options transaction_per_page [Boolean]: If false (default) all fetched records
+    #   will be persisted within single transaction. If true the transaction will be per page
+    #   of fetched records
     # @option options [Proc] handle_processed_objects_proc: Proc taking one argument (persisted remote objects).
     #   Called after persisting remote objects (once in case of auto_paginate, after each batch
     #   when paginating with block).
     def synced(strategy: :updated_since, **options)
       options.assert_valid_keys(:associations, :data_key, :fields,
         :globalized_attributes, :id_key, :include, :initial_sync_since,
-        :local_attributes, :mapper, :only_updated, :remove, :auto_paginate,
+        :local_attributes, :mapper, :only_updated, :remove, :auto_paginate, :transaction_per_page,
         :delegate_attributes, :query_params, :timestamp_strategy, :handle_processed_objects_proc)
       class_attribute :synced_id_key, :synced_data_key,
         :synced_local_attributes, :synced_associations, :synced_only_updated,
-        :synced_mapper, :synced_remove, :synced_include, :synced_fields, :synced_auto_paginate,
+        :synced_mapper, :synced_remove, :synced_include, :synced_fields, :synced_auto_paginate, :synced_transaction_per_page,
         :synced_globalized_attributes, :synced_initial_sync_since, :synced_delegate_attributes,
         :synced_query_params, :synced_timestamp_strategy, :synced_strategy, :synced_handle_processed_objects_proc
       self.synced_strategy              = strategy
@@ -69,6 +72,7 @@ module Synced
       self.synced_query_params          = options.fetch(:query_params, {})
       self.synced_timestamp_strategy    = options.fetch(:timestamp_strategy, nil)
       self.synced_auto_paginate         = options.fetch(:auto_paginate, true)
+      self.synced_transaction_per_page  = options.fetch(:transaction_per_page, false)
       self.synced_handle_processed_objects_proc  = options.fetch(:handle_processed_objects_proc, nil)
       include Synced::DelegateAttributes
       include Synced::HasSyncedData
@@ -93,6 +97,9 @@ module Synced
     #   and then overwritten in the synchronize method.
     # @param auto_paginate [Boolean] - If true (default) will fetch and save all
     #   records at once. If false will fetch and save records in batches.
+    # @param transaction_per_page [Boolean] - If false (default) all fetched records
+    #   will be persisted within single transaction. If true the transaction will be per page
+    #   of fetched records
     # @param api [BookingSync::API::Client] - API client to be used for fetching
     #   remote objects
     # @example Synchronizing amenities
@@ -106,12 +113,13 @@ module Synced
     #  website.rentals.synchronize(remote: remote_rentals)
     #
     def synchronize(scope: scope_from_relation, strategy: synced_strategy, **options)
-      options.assert_valid_keys(:api, :fields, :include, :remote, :remove, :query_params, :association_sync, :auto_paginate)
+      options.assert_valid_keys(:api, :fields, :include, :remote, :remove, :query_params, :association_sync, :auto_paginate, :transaction_per_page)
       options[:remove]  = synced_remove unless options.has_key?(:remove)
       options[:include] = Array.wrap(synced_include) unless options.has_key?(:include)
       options[:fields]  = Array.wrap(synced_fields) unless options.has_key?(:fields)
       options[:query_params] = synced_query_params unless options.has_key?(:query_params)
       options[:auto_paginate] = synced_auto_paginate unless options.has_key?(:auto_paginate)
+      options[:transaction_per_page] = synced_transaction_per_page unless options.has_key?(:transaction_per_page)
       options.merge!({
         scope:                 scope,
         strategy:              strategy,

data/lib/synced/strategies/full.rb

@@ -44,6 +44,9 @@ module Synced
       #   which will be mapped with their translations.
       # @option options [Boolean] auto_paginate: If true (default) will fetch and save all
       #   records at once. If false will fetch and save records in batches.
+      # @options options [Boolean] transaction_per_page: if false (default) all fetched records
+      #   will be persisted within single transaction. If true the transaction will be per page
+      #   of fetched records
       def initialize(model_class, options = {})
         @model_class           = model_class
         @scope                 = options[:scope]
@@ -64,21 +67,22 @@ module Synced
         @globalized_attributes = synced_attributes_as_hash(options[:globalized_attributes])
         @query_params         = options[:query_params]
         @auto_paginate         = options[:auto_paginate]
+        @transaction_per_page  = options[:transaction_per_page]
         @handle_processed_objects_proc = options[:handle_processed_objects_proc]
         @remote_objects_ids = []
       end
 
       def perform
         instrument("perform.synced", model: @model_class) do
+          processed_objects = instrument("sync_perform.synced", model: @model_class) do
+            process_remote_objects(remote_objects_persistor)
+          end
           relation_scope.transaction do
-            processed_objects = instrument("sync_perform.synced", model: @model_class) do
-              process_remote_objects(remote_objects_persistor)
-            end
             instrument("remove_perform.synced", model: @model_class) do
               remove_relation.send(remove_strategy) if @remove
             end
-            processed_objects
           end
+          processed_objects
         end
       end
 
@@ -193,11 +197,21 @@ module Synced
 
       def fetch_and_save_remote_objects(processor)
         instrument("fetch_remote_objects.synced", model: @model_class) do
-          if @auto_paginate
-            processor.call(api.paginate(resource_name, api_request_options))
-          else
+          if @transaction_per_page
             api.paginate(resource_name, api_request_options) do |batch|
-              processor.call(batch)
+              relation_scope.transaction do
+                processor.call(batch)
+              end
+            end
+          elsif @auto_paginate
+            relation_scope.transaction do
+              processor.call(api.paginate(resource_name, api_request_options))
+            end
+          else
+            relation_scope.transaction do
+              api.paginate(resource_name, api_request_options) do |batch|
+                processor.call(batch)
+              end
             end
           end
         end

data/lib/synced/version.rb

@@ -1,3 +1,3 @@
 module Synced
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synced
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Sebastien Grosjean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -238,8 +238,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Keep your BookingSync Application synced with BookingSync.
 test_files: []
+has_rdoc: