consyncful 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5798e871965ab5ca699b12f71a397ef37025d75547786ea804e1c38a9b0091ac
-  data.tar.gz: abfc466d422b44adc07abdc2d1b6bc36ff6e3dde8b57006d856bd809aaae86d5
+  metadata.gz: 14eda0769dbcdc516d59a9a4252fafb23eb6380ce0224a276e101f81d649c950
+  data.tar.gz: aa4aaf421824043dbea600c1cfabca2633a8d3470ed2a14aba5685b8bf8acd90
 SHA512:
-  metadata.gz: 8dbb9580e3aaa1aee124608323d877ab21f89da591976394bedd69c400682f88714b83598a14bacf32c18987089bfd84225273d2c868a4c17a033bb366c0ff3d
-  data.tar.gz: e3dc1aaf34278f60014f30c7f6487ba4558a7a0c9810ece3b44ee61e387a2036e52bb4eeb8955a94297a800f87ee2f6a5dedc85e26fc24d3e1bc91e256a6fbe7
+  metadata.gz: 9ac1a66dda08d88396d83c736308516a798503afa519cd673e76f668d771dc933b6068a2e03c1f75926ec8980ad273c0936af6e2058d84d5919a250a498ebbd7
+  data.tar.gz: 260c353fe5eb6c646473830ecdec0a094016bf0f0e518ef357ceb7cc03862f38e76e4cccbcf656a4c368fad72641ef60788d13a5c76e768a5b8fc9652b375c96

data/.rubocop_todo.yml

@@ -1,22 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-01-24 14:47:44 +1300 using RuboCop version 0.79.0.
+# on 2021-03-01 10:54:42 +1300 using RuboCop version 0.79.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/consyncful/item_mapper.rb'
+
 # Offense count: 1
 Metrics/AbcSize:
   Max: 19
 
-# Offense count: 7
+# Offense count: 10
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 153
+  Max: 175
 
-# Offense count: 4
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, EnforcedStyle.
 # SupportedStyles: nested, compact
@@ -24,21 +31,16 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/consyncful/railtie.rb'
     - 'spec/consyncful/base_spec.rb'
-    - 'spec/consyncful/sync_spec.rb'
 
-# Offense count: 7
+# Offense count: 3
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/consyncful.rb'
-    - 'lib/consyncful/base.rb'
-    - 'lib/consyncful/item_mapper.rb'
     - 'lib/consyncful/railtie.rb'
-    - 'lib/consyncful/stats.rb'
-    - 'lib/consyncful/sync.rb'
 
-# Offense count: 42
+# Offense count: 56
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/.ruby-version

@@ -1 +1 @@
-2.5.5
+2.7.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consyncful (0.4.0)
+    consyncful (0.5.0)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)

data/README.md

@@ -2,18 +2,15 @@
 
 Contentful -> local database synchronisation for Rails
 
-Requesting complicated models from the Contentful Delivery API in Rails applications is often
-too slow, and makes testing applications painful. Consyncful uses Contentful's syncronisation API 
-to keep a local copy of the entire content in a Mongo database up to date.
+Requesting complicated models from the Contentful Delivery API in Rails applications is often too slow, and makes testing applications painful. Consyncful uses Contentful's synchronisation API to keep a local, up-to-date copy of the entire content in a Mongo database.
 
-Once the content is availble locally, finding and interact with contentful data is as easy as 
-using [Mongoid](https://docs.mongodb.com/mongoid/current/tutorials/mongoid-documents/) ODM. 
+Once the content is available locally, finding and interact with contentful data is as easy as using [Mongoid](https://docs.mongodb.com/mongoid/current/tutorials/mongoid-documents/) ODM.
 
-This gem doesn't provide any intergration with the management api or any way to update contentful models from the local store. It is strictly read only.
+This gem doesn't provide any integration with the management API, or any way to update Contentful models from the local store. It is strictly read only.
 
 ## Why do I have to use MongoDB?
 
-Consyncful currently only supports Mongoid ODM because models have dynamic schemas. And that's all we've had a chance to work out so far. :) 
+Consyncful currently only supports Mongoid ODM because models have dynamic schemas. And that's all we've had a chance to work out so far. :)
 The same pattern might be able to be extended to work with ActiveRecord, but having to migrate the local database as well as your contentful content type's seems tedious.
 
 ## Installation
@@ -28,12 +25,13 @@ And then execute:
 
     $ bundle
 
-If you don't already use mongoid, generate a mongoid.yml by running:
+If you don't already use Mongoid, generate a mongoid.yml by running:
 
     $ rake g mongoid:config
 
 Add an initializer:
-Consyncful uses [contentful.rb](https://github.com/contentful/contentful.rb) so client options are as documented there.
+
+Consyncful uses [contentful.rb](https://github.com/contentful/contentful.rb); client options are as documented there.
 ```ruby
   Consyncful.configure do |config|
     config.locale = 'en-NZ'
@@ -49,7 +47,7 @@ Consyncful uses [contentful.rb](https://github.com/contentful/contentful.rb) so
 
 ## Usage
 
-### Creating contentful models in your rails app
+### Creating contentful models in your Rails app
 
 Create models by inheriting from `Consyncful::Base`
 
@@ -59,9 +57,9 @@ class ModelName < Consyncful::Base
 end
 ```
 
-Model fields will be dynamicly assigned, but mongoid dynamic fields are not accessible if the entry has an empty field. If you want the accessor methods to be reliably available for fields it is recommended to define the fields in the model:
+Model fields will be dynamically assigned, but Mongoid dynamic fields are not accessible if the entry has an empty field. If you want the accessor methods to be reliably available for fields it is recommended to define the fields in the model:
 
-```ruby 
+```ruby
 class ModelName < Consyncful::Base
   contentful_model_name 'contentfulTypeName'
 
@@ -70,9 +68,9 @@ class ModelName < Consyncful::Base
 end
 ```
 
-Contentful reference fields are a bit special compared with standard mongoid associations, Consyncful provides the following helpers to set up the correct relationships:
+Contentful reference fields are a bit special compared with standard Mongoid associations. Consyncful provides the following helpers to set up the correct relationships:
 
-```ruby 
+```ruby
 class ModelWithReferences < Consyncful::Base
   contentful_model_name 'contentfulTypeName'
 
@@ -81,26 +79,26 @@ class ModelWithReferences < Consyncful::Base
 end
 ```
 
-### Syncronizing contentful data
+### Synchronizing contentful data
 
-To run a syncronization process run:
+To run a synchronization process run:
 
     $ rake consyncful:sync
 
-The first time you run this it will download all the contentful content, it will then check every 15 seconds for changes to the content and update/delete records in the database when changes are made in contentful.
+The first time you run this it will download all the Contentful content. It will then check every 15 seconds for changes to the content and update/delete records in the database when changes are made in Contentful.
 
-If you want to syncronise from scratch run:
+If you want to synchronise from scratch, run:
 
     $ rake consyncful:refresh
 
 It is recommended to refresh your data if you change model names.
 
-Now you've synced your data, it is all available via your rails models
+Now you've synced your data, it is all available via your Rails models.
 
 ### Finding and interacting with models
 
 #### Querying
-Models are available using standard mongoid [queries](https://docs.mongodb.com/mongoid/current/tutorials/mongoid-queries/).
+Models are available using standard Mongoid [queries](https://docs.mongodb.com/mongoid/current/tutorials/mongoid-queries/).
 
 ```ruby
 instance = ModelName.find_by(instance: 'foo')
@@ -109,7 +107,7 @@ instance.is_awesome # true
 ```
 
 #### References
-References work like you woule expect:
+References work like you would expect:
 
 ```ruby
 
@@ -120,23 +118,23 @@ instance.other_things # all the referenced things, polymorphic, so might be diff
 ```
 
 **Except**:
-`references_many` associations return objects in a different order from how they are ordered in contentful. If you want them in the order they appare in contentful, use the `.in_order` helper:
+`references_many` associations return objects in a different order from how they are ordered in Contentful. If you want them in the order they appear in Contentful, use the `.in_order` helper:
 
 ```ruby
-instance.other_things.in_order # ordered the same as in contentful
+instance.other_things.in_order # ordered the same as in Contentful
 ```
 
-#### Finding entrys from different content types
+#### Finding entries from different content types
 
-Because all contentful models are stored as polymorphic subtypes of Consyncful::Base, you can query all entries without knowing what type you are looking for:
+Because all Contentful models are stored as polymorphic subtypes of `Consyncful::Base`, you can query all entries without knowing what type you are looking for:
 
 ```ruby
   Consyncful::Base.where(title: 'a title') # [ #<ModelName>, #<OtherModelName> ]
 ```
 
-### Sync callbacks 
+### 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. 
+You may want to attach some application logic to happen before or after a sync run, for example to update caches.
 
 Callbacks can be registered using:
 
@@ -152,11 +150,9 @@ Consyncful::Sync.after_run do |updated_ids|
 end
 ```
 
-## Limitations
-
-### Locales
+### Using Locales for specific fields
 
-Current Consyncful only uses one globally configured locale to map the data to the database.
+If fields have multiple locales then the default locale will be mapped to the field name. Additional locales will have a suffix (lower snake case) on the field name. e.g title (default), title_mi_nz (New Zealand Maori mi-NZ)
 
 ## Development
 

data/consyncful.gemspec

@@ -7,8 +7,8 @@ require 'consyncful/version'
 Gem::Specification.new do |spec|
   spec.name          = 'consyncful'
   spec.version       = Consyncful::VERSION
-  spec.authors       = ['Andy Anastasiadis-Gray', 'Montgomery Anderson']
-  spec.email         = ['andy@boost.co.nz', 'montgomery@boost.co.nz']
+  spec.authors       = ['Andy Anastasiadis-Gray', 'Montgomery Anderson', 'Greg Rogan']
+  spec.email         = ['andy@boost.co.nz', 'montgomery@boost.co.nz', 'greg@boost.co.nz']
 
   spec.summary       = 'Contentful to local database synchronisation for Rails'
   spec.homepage      = 'https://github.com/boost/consyncful'

data/lib/consyncful.rb

@@ -27,7 +27,7 @@ module Consyncful
       @contentful_client_options = {
         api_url: 'cdn.contentful.com'
       }
-      @locale = 'en-US'
+      @locale = 'en-NZ'
     end
   end
 

data/lib/consyncful/base.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Consyncful
+  ##
+  # Provides common functionality of Mongoid models created from contentful
+  # entries
   class Base
     include Mongoid::Document
     include Mongoid::Attributes::Dynamic

data/lib/consyncful/item_mapper.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Consyncful
+  ##
+  # Responsible for mapping an update received from Contentful's syncronisation API
+  # into useful fields for Consyncful::PersistedItem to store in the database.
   class ItemMapper
     def initialize(item)
       @item = item
@@ -22,17 +25,11 @@ module Consyncful
       @item.id
     end
 
-    def mapped_fields(locale)
+    def mapped_fields(default_locale)
       fields = generic_fields
 
-      @item.fields_with_locales.each do |field, value_with_locales|
-        value = value_with_locales[locale.to_sym]
-        next if value.is_a? Contentful::File # it is special
-
-        assign_field(fields, field, value)
-      end
-
-      fields[:file] = raw_file(locale) if type == 'asset'
+      fields.merge!(localized_fields(default_locale))
+      fields.merge!(localized_asset_fields(default_locale)) if type == 'asset'
 
       fields
     end
@@ -49,9 +46,31 @@ module Consyncful
       fields
     end
 
-    def raw_file(locale)
-      file_json = @item.raw.fetch('fields', {}).fetch('file', nil)
-      file_json[locale] unless file_json.nil?
+    def localized_fields(default_locale)
+      fields = {}
+
+      @item.fields_with_locales.each do |field, value_with_locales|
+        value_with_locales.each do |locale_code, value|
+          next if value.is_a? Contentful::File # assets are handeled below
+    
+          fieldname = locale_code == default_locale.to_sym ? field : "#{field}_#{locale_code.to_s.underscore}".to_sym
+          assign_field(fields, fieldname, value)
+        end
+      end
+
+      fields
+    end
+
+    def localized_asset_fields(default_locale)
+      fields = {}
+      files_by_locale = @item.raw.dig('fields', 'file') || {}
+
+      files_by_locale.each do |locale_code, details|
+        fieldname = locale_code == default_locale ? 'file' : "file_#{locale_code.to_s.underscore}"
+        fields[fieldname.to_sym] = details
+      end
+
+      fields
     end
 
     def reference_value?(value)

data/lib/consyncful/persisted_item.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Consyncful
-  # Takes a mapped item from contentful and applies it to the local storage.
+  ##
+  # Takes a mapped item from Contentful and creates/updates/deletes
+  # the relevant model in the local database.
   class PersistedItem
     DEFAULT_LOCALE = 'en-NZ'
 

data/lib/consyncful/stats.rb

@@ -3,6 +3,8 @@
 require 'rainbow'
 
 module Consyncful
+  ##
+  # Responsible for recording changes during a sync for outputting in logs
   class Stats
     def initialize
       @stats = {

data/lib/consyncful/sync.rb

@@ -7,6 +7,14 @@ require 'consyncful/stats'
 require 'hooks'
 
 module Consyncful
+  ##
+  # A mongoid model that stores the state of a syncronisation feed. Stores the
+  # next URL provided by Contentfuls Sync API.
+  #
+  # Sync's are affectivly singletons,
+  # there should only ever be one in the database
+  #
+  # Is also the entrypoint of a Syncronization run
   class Sync
     include Mongoid::Document
     include Hooks
@@ -14,8 +22,6 @@ module Consyncful
     define_hook :before_run
     define_hook :after_run
 
-    DEFAULT_LOCALE = 'en-NZ'
-
     field :next_url
     field :last_run_at, type: DateTime
 
@@ -23,17 +29,25 @@ module Consyncful
       last || new
     end
 
+    ##
+    # Delete the previous sync chains from database and create a fresh one.
+    # Used to completely resync all items from Contentful.
     def self.fresh
       destroy_all
       latest
     end
 
+    ##
+    # Makes sure that the database contains only records that have been provided
+    # during this chain of syncronisation.
     def drop_stale
       stale = Base.where(:sync_id.ne => id, :sync_id.exists => true)
       puts Rainbow("Dropping #{stale.count} records that haven't been touched in this sync").red
       stale.destroy
     end
 
+    ##
+    # Entry point to a syncronization run. Is responsible for updating Sync state
     def run
       run_hook :before_run
 

data/lib/consyncful/version.rb

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

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
 - Montgomery Anderson
-autorequire:
+- Greg Rogan
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,10 +150,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - andy@boost.co.nz
 - montgomery@boost.co.nz
+- greg@boost.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -186,7 +188,7 @@ homepage: https://github.com/boost/consyncful
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -201,9 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Contentful to local database synchronisation for Rails
 test_files: []