consyncful 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14eda0769dbcdc516d59a9a4252fafb23eb6380ce0224a276e101f81d649c950
-  data.tar.gz: aa4aaf421824043dbea600c1cfabca2633a8d3470ed2a14aba5685b8bf8acd90
+  metadata.gz: 6a8f36ac50a10800cbce6e6b9d086e346b1e7362e422080d532a87bb981d8135
+  data.tar.gz: 6df1ea6cf1cb05f405938d83e09436927e21b7828424f33c79a105e4c11da127
 SHA512:
-  metadata.gz: 9ac1a66dda08d88396d83c736308516a798503afa519cd673e76f668d771dc933b6068a2e03c1f75926ec8980ad273c0936af6e2058d84d5919a250a498ebbd7
-  data.tar.gz: 260c353fe5eb6c646473830ecdec0a094016bf0f0e518ef357ceb7cc03862f38e76e4cccbcf656a4c368fad72641ef60788d13a5c76e768a5b8fc9652b375c96
+  metadata.gz: bdebe27350c747d4d3d02e290c5971d2b295815741e887ad658a09248f0d7d0a798a4060d5500c99d2f18e4b7f920d98e32bc0f0d49bbdea488ded106bda53d7
+  data.tar.gz: 034ec0cbec2265225f48bbd52d6412fe238ee026b78827bfacec54e8a31c42f9786495709c7dcea1e4ecf261761897f99a8417e4bea09149296c6cc51c9f789b

data/.travis.yml

@@ -5,10 +5,10 @@ cache: bundler
 rvm:
   - 2.5.1
   - 2.6.5
-before_install: gem install bundler -v 2.1.0
+before_install: gem install bundler -v 2.1.4
 services:
   - mongodb
 
-script: 
+script:
   - bundle exec rake spec
   - bundle exec rubocop -P

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consyncful (0.5.0)
+    consyncful (0.6.1)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
@@ -10,27 +10,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activesupport (6.0.3.4)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    bson (4.11.1)
+    bson (4.12.0)
     concurrent-ruby (1.1.8)
-    contentful (2.15.4)
+    contentful (2.16.0)
       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.14.2)
+    ffi (1.15.0)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -46,14 +46,14 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.14.3)
+    minitest (5.14.4)
     mongo (2.14.0)
       bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.2.0)
-      activemodel (>= 5.1, < 6.1)
+    mongoid (7.2.2)
+      activemodel (>= 5.1, < 6.2)
       mongo (>= 2.10.5, < 3.0.0)
     multi_json (1.15.0)
     parallel (1.19.1)
@@ -83,9 +83,8 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     uber (0.0.15)
     unf (0.1.4)
       unf_ext
@@ -105,4 +104,4 @@ DEPENDENCIES
   rubocop (= 0.79.0)
 
 BUNDLED WITH
-   2.1.0
+   2.1.4

data/README.md

@@ -8,10 +8,21 @@ Once the content is available locally, finding and interact with contentful data
 
 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. :)
-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](#installation)
+- [Usage](#usage)
+  - [Creating contentful models in your Rails app](#creating-contentful-models-in-your-rails-app)
+  - [Synchronizing contentful data](#synchronizing-contentful-data)
+  - [Finding and interacting with models](#finding-and-interacting-with-models)
+    - [Querying](#querying)
+    - [References](#references)
+    - [Finding entries from different content types](#finding-entries-from-different-content-types)
+  - [Sync callbacks](#sync-callbacks)
+  - [Using Locales for specific fields](#using-locales-for-specific-fields)
+  - [Configuring what Mongo database Consyncful uses](#configuring-what-mongo-database-consyncful-uses)
+  - [Why do I have to use MongoDB?](#why-do-i-have-to-use-mongodb)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -32,17 +43,17 @@ If you don't already use Mongoid, generate a mongoid.yml by running:
 Add an initializer:
 
 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'
-    config.contentful_client_options = {
-      api_url: 'cdn.contentful.com',
-      space: 'space_id',
-      access_token: 'ACCESS TOKEN',
-      environment: 'master',        # optional
-      logger: Logger.new(STDOUT)    # optional for debugging
-    }
-  end
+```rb
+Consyncful.configure do |config|
+  config.locale = 'en-NZ'
+  config.contentful_client_options = {
+    api_url: 'cdn.contentful.com',
+    space: 'space_id',
+    access_token: 'ACCESS TOKEN',
+    environment: 'master',        # optional
+    logger: Logger.new(STDOUT)    # optional for debugging
+  }
+end
 ```
 
 ## Usage
@@ -129,7 +140,7 @@ instance.other_things.in_order # ordered the same as in Contentful
 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> ]
+Consyncful::Base.where(title: 'a title') # [ #<ModelName>, #<OtherModelName> ]
 ```
 
 ### Sync callbacks
@@ -154,6 +165,21 @@ end
 
 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)
 
+### Configuring what Mongo database Consyncful uses
+
+You can also configure what Mongoid client Consyncful uses and the name of the collection the entries are stored under. This is useful if you want to have your consyncful data hosted in a different mongo database than your application-specific mongo database.
+
+```rb
+Consyncful.configure do |config|
+  config.mongo_client = :consyncful # defaults to :default (referencing the clients in mongoid.yml)
+  config.mongo_collection = 'contentful_models' # this is the default
+end
+```
+
+### 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. 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.
+
 ## 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/consyncful.rb

@@ -11,23 +11,18 @@ require 'consyncful/sync'
 require 'consyncful/railtie' if defined?(Rails)
 
 module Consyncful
-  class << self
-    attr_accessor :configuration
-  end
-
-  def self.configure
-    self.configuration ||= Configuration.new
-    yield(configuration)
-  end
-
+  # Handles Rails configurations for Consynful
   class Configuration
-    attr_accessor :contentful_client_options, :locale
+    attr_accessor :contentful_client_options, :locale,
+                  :mongo_client, :mongo_collection
 
     def initialize
       @contentful_client_options = {
         api_url: 'cdn.contentful.com'
       }
       @locale = 'en-NZ'
+      @mongo_client = :default
+      @mongo_collection = 'contentful_models'
     end
   end
 
@@ -36,11 +31,21 @@ module Consyncful
     api_url: 'cdn.contentful.com'
   }.freeze
 
-  def self.client
-    @client ||= begin
-      options = Consyncful.configuration.contentful_client_options
-      options.reverse_merge!(DEFAULT_CLIENT_OPTIONS)
-      Contentful::Client.new(options)
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def client
+      @client ||= begin
+        options = Consyncful.configuration.contentful_client_options
+        options.reverse_merge!(DEFAULT_CLIENT_OPTIONS)
+        Contentful::Client.new(options)
+      end
     end
   end
 end

data/lib/consyncful/base.rb

@@ -8,10 +8,11 @@ module Consyncful
     include Mongoid::Document
     include Mongoid::Attributes::Dynamic
 
-    store_in collection: 'contentful_models'
-
     cattr_accessor :model_map
 
+    store_in collection: -> { Consyncful.configuration.mongo_collection },
+             client: -> { Consyncful.configuration.mongo_client }
+
     def self.contentful_model_name(name)
       self.model_map ||= {}
 
@@ -22,7 +23,9 @@ module Consyncful
     def self.references_many(name)
       has_and_belongs_to_many name.to_sym, class_name: 'Consyncful::Base', inverse_of: nil do
         def in_order
-          _target.to_a.sort_by { |a| _base[foreign_key].index(a.id) }
+          _target.to_a.sort_by do |reference|
+            _base[foreign_key].index(reference.id)
+          end
         end
       end
     end

data/lib/consyncful/item_mapper.rb

@@ -14,10 +14,9 @@ module Consyncful
     end
 
     def type
-      if @item.type == 'Entry'
-        @item.content_type.id
-      elsif @item.type == 'Asset'
-        'asset'
+      case @item.type
+      when 'Entry' then @item.content_type.id
+      when 'Asset' then 'asset'
       end
     end
 
@@ -37,13 +36,11 @@ module Consyncful
     private
 
     def generic_fields
-      fields = {}
-      fields[:created_at] = @item.created_at
-      fields[:updated_at] = @item.updated_at
-      fields[:revision] = @item.revision
-      fields[:contentful_type] = type
-      fields[:synced_at] = Time.current
-      fields
+      { created_at: @item.created_at,
+        updated_at: @item.updated_at,
+        revision: @item.revision,
+        contentful_type: type,
+        synced_at: Time.current }
     end
 
     def localized_fields(default_locale)
@@ -52,9 +49,10 @@ module Consyncful
       @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)
+
+          field_name = localized_field_name(field, locale_code, default_locale)
+          field_name, value = mapped_field_entry_for(field_name, value)
+          fields[field_name] = value
         end
       end
 
@@ -66,13 +64,20 @@ module Consyncful
       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
+        field_name = localized_field_name('file', locale_code, default_locale)
+        fields[field_name.to_sym] = details
       end
 
       fields
     end
 
+    # Suffixes the field with the locale unless it's the default locale.
+    def localized_field_name(field, locale_code, default_locale)
+      return field if locale_code.to_s == default_locale.to_s
+
+      "#{field}_#{locale_code.to_s.underscore}".to_sym
+    end
+
     def reference_value?(value)
       single_reference?(value) || many_reference?(value)
     end
@@ -85,14 +90,14 @@ module Consyncful
       value.is_a?(Array) && single_reference?(value.first)
     end
 
-    def assign_field(hash, field, value)
+    def mapped_field_entry_for(field, value)
       if single_reference?(value)
-        hash[ActiveSupport::Inflector.foreign_key(field).to_sym] = value.id
+        [ActiveSupport::Inflector.foreign_key(field).to_sym, value.id]
       elsif many_reference?(value)
         ids_field_name = field.to_s.singularize + '_ids' # fk field name
-        hash[ids_field_name.to_sym] = value.map(&:id)
+        [ids_field_name.to_sym, value.map(&:id)]
       else
-        hash[field] = value
+        [field, value]
       end
     end
   end

data/lib/consyncful/railtie.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Adds Consyncful task to Rails
 class Consyncful::Railtie < Rails::Railtie
   rake_tasks do
     load 'consyncful/tasks/consyncful.rake'

data/lib/consyncful/sync.rb

@@ -19,6 +19,8 @@ module Consyncful
     include Mongoid::Document
     include Hooks
 
+    store_in client: -> { Consyncful.configuration.mongo_client }
+
     define_hook :before_run
     define_hook :after_run
 

data/lib/consyncful/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler