consyncful 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14eda0769dbcdc516d59a9a4252fafb23eb6380ce0224a276e101f81d649c950
-  data.tar.gz: aa4aaf421824043dbea600c1cfabca2633a8d3470ed2a14aba5685b8bf8acd90
+  metadata.gz: 10b3daa6395ab09a3eefac1c3d6e8795530b346b8ce5d4d1248527e98719a785
+  data.tar.gz: f2948c392596ff652ae67f4153b0e407f73b5424315de19df348842f1ee1d181
 SHA512:
-  metadata.gz: 9ac1a66dda08d88396d83c736308516a798503afa519cd673e76f668d771dc933b6068a2e03c1f75926ec8980ad273c0936af6e2058d84d5919a250a498ebbd7
-  data.tar.gz: 260c353fe5eb6c646473830ecdec0a094016bf0f0e518ef357ceb7cc03862f38e76e4cccbcf656a4c368fad72641ef60788d13a5c76e768a5b8fc9652b375c96
+  metadata.gz: 4b136cbf030b12667c3a590bb6361ec8b6aa6ac45fcb452af7401c116f926afb227ba02c31293ec3f55e084e96aaa428551358b39b6ec5d63d4f094d533a1e78
+  data.tar.gz: 3419eba7818aadf3f472fde9013a12043ac22227cd36562ae3c29e392bf73e65cb4525b9711aade7c1bd25460b8543b1b99d73517bd466ef04a2860340f5922e

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  ci_checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.7.5
+          - 3.0.3
+          - 3.1.1
+        mongodb:
+          - 4.2
+          - 4.4
+          - 5.0
+
+    name: Ruby ${{ matrix.ruby }} sample
+
+    steps:
+      - name: Checkout this repo
+        uses: actions/checkout@v2
+
+      - name: Install Ruby and Bundler
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.7.0
+        with:
+          mongodb-version: ${{ matrix.mongodb }}
+
+      - name: Run tests
+        run: |
+          bundle exec rspec

data/.rubocop_todo.yml

@@ -1,27 +1,20 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-01 10:54:42 +1300 using RuboCop version 0.79.0.
+# on 2022-05-03 14:45:03 +1200 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
+# Offense count: 2
 Metrics/AbcSize:
   Max: 19
 
-# Offense count: 10
+# Offense count: 12
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 175
+  Max: 211
 
 # Offense count: 3
 # Cop supports --auto-correct.
@@ -32,15 +25,14 @@ Style/ClassAndModuleChildren:
     - 'lib/consyncful/railtie.rb'
     - 'spec/consyncful/base_spec.rb'
 
-# Offense count: 3
+# Offense count: 1
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/consyncful.rb'
-    - 'lib/consyncful/railtie.rb'
 
-# Offense count: 56
+# Offense count: 57
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consyncful (0.5.0)
+    consyncful (0.7.0)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
@@ -10,27 +10,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activesupport (6.0.3.4)
+    activemodel (7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activesupport (7.0.2.4)
       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)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    bson (4.11.1)
-    concurrent-ruby (1.1.8)
-    contentful (2.15.4)
+    bson (4.15.0)
+    concurrent-ruby (1.1.10)
+    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,15 +45,16 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.8.7)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.14.3)
-    mongo (2.14.0)
+    minitest (5.15.0)
+    mongo (2.17.1)
       bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.2.0)
-      activemodel (>= 5.1, < 6.1)
+    mongoid (7.4.0)
+      activemodel (>= 5.1, < 7.1, != 7.0.0)
       mongo (>= 2.10.5, < 3.0.0)
+      ruby2_keywords (~> 0.0.5)
     multi_json (1.15.0)
     parallel (1.19.1)
     parser (2.7.0.2)
@@ -83,15 +83,14 @@ 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)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     uber (0.0.15)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (1.6.1)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -105,4 +104,4 @@ DEPENDENCIES
   rubocop (= 0.79.0)
 
 BUNDLED WITH
-   2.1.0
+   2.3.7

data/README.md

@@ -1,4 +1,4 @@
-# Consyncful [![Build Status](https://travis-ci.org/boost/consyncful.svg?branch=master)](https://travis-ci.org/boost/consyncful)
+# Consyncful
 
 Contentful -> local database synchronisation for Rails
 
@@ -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,41 @@ 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)
 
+### Sync specific contents using [Contentful Tag](https://www.contentful.com/help/tags/).
+You can configure Consyncful to sync or ignore specific contents using Contentful Tag.
+
+```rb
+Consyncful.configure do |config|
+  # Any contents tagged with 'myTag' will be stored in the database. 
+  # Other contents without 'myTag' would be ignored.
+  config.content_tags = ['myTag'] # defaults to []
+end
+```
+
+Also, you can ignore contents with specific Tags.
+
+```rb
+Consyncful.configure do |config|
+  # Any contents tagged with 'ignoreTag' won't be stored in the database.
+  config.ignore_content_tags = ['ignoreTag'] # defaults to []
+end
+```
+
+### 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/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

@@ -13,11 +13,17 @@ module Consyncful
       @item.is_a?(Contentful::DeletedEntry) || @item.is_a?(Contentful::DeletedAsset)
     end
 
+    def excluded_by_tag?
+      return (Consyncful.configuration.content_tags & item_tag_ids).empty?      if Consyncful.configuration.content_tags.any?
+      return (Consyncful.configuration.ignore_content_tags & item_tag_ids).any? if Consyncful.configuration.ignore_content_tags.any?
+
+      false
+    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
 
@@ -36,14 +42,18 @@ module Consyncful
 
     private
 
+    def item_tag_ids
+      return [] if @item.nil?
+
+      @item._metadata[:tags].map(&:id)
+    end
+
     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 +62,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 +77,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 +103,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/persisted_item.rb

@@ -15,7 +15,8 @@ module Consyncful
 
     def persist
       puts Rainbow("syncing: #{@item.id}").yellow
-      if @item.deletion?
+
+      if @item.deletion? || @item.excluded_by_tag?
         delete_model(@item.id, @stats)
       else
         create_or_update_model(@item, @sync_id, @stats)

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
 
@@ -100,10 +102,11 @@ module Consyncful
       ids
     end
 
-    def sync_item(item, stats)
-      puts Rainbow("syncing: #{item.id}").yellow
-      PersistedItem.new(item, id, stats).persist
-      item.id
+    def sync_item(item_mapper, stats)
+      puts Rainbow("syncing: #{item_mapper.id}").yellow
+      PersistedItem.new(item_mapper, id, stats).persist
+
+      item_mapper.id
     end
   end
 end

data/lib/consyncful/tasks/consyncful.rake

@@ -19,7 +19,7 @@ namespace :consyncful do
   end
 
   task update_model_names: [:environment] do
-    if Object.const_defined?('Zeitwerk::Loader') && Rails.application.config.autoloader.to_s == 'zeitwerk'
+    if Rails.autoloaders.zeitwerk_enabled?
       Zeitwerk::Loader.eager_load_all
     else
       Rails.application.eager_load!

data/lib/consyncful/version.rb

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

data/lib/consyncful.rb

@@ -11,23 +11,24 @@ 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,
+                  :content_tags,
+                  :ignore_content_tags
 
     def initialize
       @contentful_client_options = {
         api_url: 'cdn.contentful.com'
       }
       @locale = 'en-NZ'
+      @mongo_client = :default
+      @mongo_collection = 'contentful_models'
+      @content_tags = []
+      @ignore_content_tags = []
     end
   end
 
@@ -36,11 +37,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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
 - Montgomery Anderson
 - Greg Rogan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - andy@boost.co.nz
 - montgomery@boost.co.nz
@@ -159,12 +159,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -188,7 +188,7 @@ homepage: https://github.com/boost/consyncful
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Contentful to local database synchronisation for Rails
 test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-  - 2.6.5
-before_install: gem install bundler -v 2.1.0
-services:
-  - mongodb
-
-script: 
-  - bundle exec rake spec
-  - bundle exec rubocop -P