consyncful 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35970feb7c2d47cbe63b05842f6942f5cf5d8f6a4e55d2802b09672b5e83174d
-  data.tar.gz: 49ffee729075860cf9ce4d3bf07fefad84a4fa6d62283c6c49418fb39749ea48
+  metadata.gz: 5798e871965ab5ca699b12f71a397ef37025d75547786ea804e1c38a9b0091ac
+  data.tar.gz: abfc466d422b44adc07abdc2d1b6bc36ff6e3dde8b57006d856bd809aaae86d5
 SHA512:
-  metadata.gz: aafcfc21b21ae872d3ff94e8540ea9d544785eb5fc989a2097fd97289bc46b80c4c965eac1c05d9b80a9e073e58dfa252363c5d5bf0377d3668a4a991b397de7
-  data.tar.gz: b872d49812bdad638f320a67f85d7809b6c17ab4421149247155b0c8961befb8394d4fc973b5a6c99166b928672867ddcf219e723d0833867980a284efac051f
+  metadata.gz: 8dbb9580e3aaa1aee124608323d877ab21f89da591976394bedd69c400682f88714b83598a14bacf32c18987089bfd84225273d2c868a4c17a033bb366c0ff3d
+  data.tar.gz: e3dc1aaf34278f60014f30c7f6487ba4558a7a0c9810ece3b44ee61e387a2036e52bb4eeb8955a94297a800f87ee2f6a5dedc85e26fc24d3e1bc91e256a6fbe7

data/Gemfile.lock

@@ -1,39 +1,42 @@
 PATH
   remote: .
   specs:
-    consyncful (0.3.3)
+    consyncful (0.4.0)
       contentful (>= 2.11.1, < 3.0.0)
+      hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
       rainbow
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    bson (4.8.2)
-    concurrent-ruby (1.1.6)
-    contentful (2.15.2)
+    bson (4.11.1)
+    concurrent-ruby (1.1.8)
+    contentful (2.15.4)
       http (> 0.8, < 5.0)
       multi_json (~> 1)
     database_cleaner (1.8.3)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.12.2)
+    ffi (1.14.2)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (4.3.0)
+    hooks (0.4.1)
+      uber (~> 0.0.14)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
@@ -41,22 +44,22 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http-parser (1.2.1)
+    http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.8.2)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    mongo (2.11.4)
-      bson (>= 4.4.2, < 5.0.0)
-    mongoid (7.1.0)
+    minitest (5.14.3)
+    mongo (2.14.0)
+      bson (>= 4.8.2, < 5.0.0)
+    mongoid (7.2.0)
       activemodel (>= 5.1, < 6.1)
-      mongo (>= 2.7.0, < 3.0.0)
-    multi_json (1.14.1)
+      mongo (>= 2.10.5, < 3.0.0)
+    multi_json (1.15.0)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
-    public_suffix (4.0.3)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
     rspec (3.9.0)
@@ -81,13 +84,14 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
+    uber (0.0.15)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -134,6 +134,24 @@ Because all contentful models are stored as polymorphic subtypes of Consyncful::
   Consyncful::Base.where(title: 'a title') # [ #<ModelName>, #<OtherModelName> ]
 ```
 
+### Sync callbacks 
+
+You may want to attach some application logic to happen before or after a sync run, for example to update caches or something. 
+
+Callbacks can be registered using:
+
+```ruby
+Consyncful::Sync.before_run do
+  # do something before the run
+end
+```
+
+```ruby
+Consyncful::Sync.after_run do |updated_ids|
+  # invalidate cache for updated_ids, or something
+end
+```
+
 ## Limitations
 
 ### Locales

data/consyncful.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '0.79.0'
 
   spec.add_dependency 'contentful', ['>=2.11.1', '<3.0.0']
+  spec.add_dependency 'hooks', '>=0.4.1'
   spec.add_dependency 'mongoid', ['>=7.0.2', '<8.0.0']
   spec.add_dependency 'rainbow'
 end

data/lib/consyncful/persisted_item.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Consyncful
+  # Takes a mapped item from contentful and applies it to the local storage.
+  class PersistedItem
+    DEFAULT_LOCALE = 'en-NZ'
+
+    def initialize(item, sync_id, stats)
+      @item = item
+      @sync_id = sync_id
+      @stats = stats
+    end
+
+    def persist
+      puts Rainbow("syncing: #{@item.id}").yellow
+      if @item.deletion?
+        delete_model(@item.id, @stats)
+      else
+        create_or_update_model(@item, @sync_id, @stats)
+      end
+    end
+
+    private
+
+    def delete_model(id, stats)
+      Base.find_by(id: id).destroy
+      stats.record_deleted
+    rescue Mongoid::Errors::DocumentNotFound
+      puts Rainbow("Deleted record not found: #{id}").yellow
+      nil
+    end
+
+    def create_or_update_model(item, sync_id, stats)
+      return if item.type.nil?
+
+      instance = find_or_initialize_item(item)
+      update_stats(instance, stats)
+
+      reset_fields(instance)
+
+      item.mapped_fields(DEFAULT_LOCALE).each do |field, value|
+        instance[field] = value
+      end
+
+      instance[:sync_id] = sync_id
+
+      instance.save
+    end
+
+    def find_or_initialize_item(item)
+      model_class(item.type).find_or_initialize_by(id: item.id)
+    end
+
+    def update_stats(instance, stats)
+      if instance.persisted?
+        stats.record_updated
+      else
+        stats.record_added
+      end
+    end
+
+    def model_class(type)
+      Base.model_map[type] || Base
+    end
+
+    def reset_fields(instance)
+      instance.attributes.each do |field_name, _value|
+        next if field_name.in? %w[_id _type]
+
+        instance[field_name] = nil
+      end
+    end
+  end
+end

data/lib/consyncful/sync.rb

@@ -2,11 +2,17 @@
 
 require 'rainbow'
 require 'consyncful/item_mapper'
+require 'consyncful/persisted_item'
 require 'consyncful/stats'
+require 'hooks'
 
 module Consyncful
   class Sync
     include Mongoid::Document
+    include Hooks
+
+    define_hook :before_run
+    define_hook :after_run
 
     DEFAULT_LOCALE = 'en-NZ'
 
@@ -29,19 +35,21 @@ module Consyncful
     end
 
     def run
+      run_hook :before_run
+
       stats = Consyncful::Stats.new
       load_all_models
 
       sync = start_sync
 
-      sync_items(sync, stats)
+      changed_ids = sync_items(sync, stats)
 
       drop_stale
 
-      self.next_url = sync.next_sync_url
-      self.last_run_at = Time.current
-      save
+      update_run(sync.next_sync_url)
       stats.print_stats
+
+      run_hook :after_run, changed_ids
     end
 
     private
@@ -52,6 +60,12 @@ module Consyncful
       Rails.application.eager_load!
     end
 
+    def update_run(next_url)
+      self.next_url = next_url
+      self.last_run_at = Time.current
+      save
+    end
+
     def start_sync
       if next_url.present?
         puts Rainbow("Starting update, last update: #{last_run_at} (#{(Time.current - last_run_at).round(3)}s ago)").blue
@@ -63,69 +77,19 @@ module Consyncful
     end
 
     def sync_items(sync, stats)
+      ids = []
       sync.each_page do |page|
         page.items.each do |item|
-          sync_item(ItemMapper.new(item), stats)
+          ids << sync_item(ItemMapper.new(item), stats)
         end
       end
+      ids
     end
 
     def sync_item(item, stats)
       puts Rainbow("syncing: #{item.id}").yellow
-      if item.deletion?
-        delete_model(item.id, stats)
-      else
-        create_or_update_model(item, stats)
-      end
-    end
-
-    def delete_model(id, stats)
-      Base.find_by(id: id).destroy
-      stats.record_deleted
-    rescue Mongoid::Errors::DocumentNotFound
-      puts Rainbow("Deleted record not found: #{id}").yellow
-      nil
-    end
-
-    def create_or_update_model(item, stats)
-      return if item.type.nil?
-
-      instance = find_or_initialize_item(item)
-      update_stats(instance, stats)
-
-      reset_fields(instance)
-
-      item.mapped_fields(DEFAULT_LOCALE).each do |field, value|
-        instance[field] = value
-      end
-
-      instance[:sync_id] = id
-
-      instance.save
-    end
-
-    def find_or_initialize_item(item)
-      model_class(item.type).find_or_initialize_by(id: item.id)
-    end
-
-    def update_stats(instance, stats)
-      if instance.persisted?
-        stats.record_updated
-      else
-        stats.record_added
-      end
-    end
-
-    def model_class(type)
-      Base.model_map[type] || Base
-    end
-
-    def reset_fields(instance)
-      instance.attributes.each do |field_name, _value|
-        next if field_name.in? %w[_id _type]
-
-        instance[field_name] = nil
-      end
+      PersistedItem.new(item, id, stats).persist
+      item.id
     end
   end
 end

data/lib/consyncful/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consyncful
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
 - Montgomery Anderson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -135,7 +149,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - andy@boost.co.nz
 - montgomery@boost.co.nz
@@ -162,6 +176,7 @@ files:
 - lib/consyncful.rb
 - lib/consyncful/base.rb
 - lib/consyncful/item_mapper.rb
+- lib/consyncful/persisted_item.rb
 - lib/consyncful/railtie.rb
 - lib/consyncful/stats.rb
 - lib/consyncful/sync.rb
@@ -171,7 +186,7 @@ homepage: https://github.com/boost/consyncful
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,9 +201,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Contentful to local database synchronisation for Rails
 test_files: []