consyncful 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427a251dcb99af926beb09b1bd9c606319df5107c65954f152d007d5d3efc10c
-  data.tar.gz: d6774652c16586f99ed13a9683c5fa800fdd5e1535bb6c117d280f941d82a37f
+  metadata.gz: 10b3daa6395ab09a3eefac1c3d6e8795530b346b8ce5d4d1248527e98719a785
+  data.tar.gz: f2948c392596ff652ae67f4153b0e407f73b5424315de19df348842f1ee1d181
 SHA512:
-  metadata.gz: d7d2852b4f286dc1b19557f1e59411c3d4a4f354f1e4466ff14596a425fb7cb1f1cb858ab0fb61229004884442adb6aef44661be150bb10f10f18782cc79bc52
-  data.tar.gz: 8011d57e5ac51fe2a2c287e57d9adcd747de95858074734135ebe4b0e05ffd6b1c16bd2dca1840886978ce5ae0925d7d1a28d15e5c1bc0c2c53a606760c8899c
+  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.6.2)
+    consyncful (0.7.0)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
@@ -10,19 +10,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3.1)
-      activesupport (= 6.1.3.1)
-    activesupport (6.1.3.1)
+    activemodel (7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activesupport (7.0.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.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.12.0)
-    concurrent-ruby (1.1.8)
+    bson (4.15.0)
+    concurrent-ruby (1.1.10)
     contentful (2.16.0)
       http (> 0.8, < 5.0)
       multi_json (~> 1)
@@ -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.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.14.4)
-    mongo (2.14.0)
+    minitest (5.15.0)
+    mongo (2.17.1)
       bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.2.2)
-      activemodel (>= 5.1, < 6.2)
+    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,6 +83,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     uber (0.0.15)
@@ -90,7 +91,6 @@ GEM
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (1.6.1)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -104,4 +104,4 @@ DEPENDENCIES
   rubocop (= 0.79.0)
 
 BUNDLED WITH
-   2.1.4
+   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
 
@@ -165,6 +165,26 @@ 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.

data/lib/consyncful/item_mapper.rb

@@ -13,6 +13,13 @@ 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
       case @item.type
       when 'Entry' then @item.content_type.id
@@ -35,6 +42,12 @@ module Consyncful
 
     private
 
+    def item_tag_ids
+      return [] if @item.nil?
+
+      @item._metadata[:tags].map(&:id)
+    end
+
     def generic_fields
       { created_at: @item.created_at,
         updated_at: @item.updated_at,

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/sync.rb

@@ -102,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/version.rb

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

data/lib/consyncful.rb

@@ -13,8 +13,12 @@ require 'consyncful/railtie' if defined?(Rails)
 module Consyncful
   # Handles Rails configurations for Consynful
   class Configuration
-    attr_accessor :contentful_client_options, :locale,
-                  :mongo_client, :mongo_collection
+    attr_accessor :contentful_client_options,
+                  :locale,
+                  :mongo_client,
+                  :mongo_collection,
+                  :content_tags,
+                  :ignore_content_tags
 
     def initialize
       @contentful_client_options = {
@@ -23,6 +27,8 @@ module Consyncful
       @locale = 'en-NZ'
       @mongo_client = :default
       @mongo_collection = 'contentful_models'
+      @content_tags = []
+      @ignore_content_tags = []
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Contentful to local database synchronisation for Rails

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.4
-services:
-  - mongodb
-
-script:
-  - bundle exec rake spec
-  - bundle exec rubocop -P