consyncful 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10b3daa6395ab09a3eefac1c3d6e8795530b346b8ce5d4d1248527e98719a785
-  data.tar.gz: f2948c392596ff652ae67f4153b0e407f73b5424315de19df348842f1ee1d181
+  metadata.gz: c882690a75c66e0d0045caf2c574e04c6eb1c86160f767db1d5d1ef309cffc22
+  data.tar.gz: 8223e7a016e55b6ee64b80bb0979eaa4f646d84dbcfb157fdd3fffe2ff30822e
 SHA512:
-  metadata.gz: 4b136cbf030b12667c3a590bb6361ec8b6aa6ac45fcb452af7401c116f926afb227ba02c31293ec3f55e084e96aaa428551358b39b6ec5d63d4f094d533a1e78
-  data.tar.gz: 3419eba7818aadf3f472fde9013a12043ac22227cd36562ae3c29e392bf73e65cb4525b9711aade7c1bd25460b8543b1b99d73517bd466ef04a2860340f5922e
+  metadata.gz: 1883a3eba634425d4579d734046e2f44e2bd1798ee4c0ff7e0b4d911df3afb40760aa29bfb78cf1ba770fcf7f1b84a76833e1925a31c50c1e3c108462731f5dc
+  data.tar.gz: da8df93ab4487b5ffb8d626781338a623a988d568b3d0445b357e44adeb5021c8bcbe3c7a14daec9e0c0f37cd5626ee172986d420f7ea28b5ef4d872deb07722

data/.github/workflows/ci.yml

@@ -37,6 +37,9 @@ jobs:
         with:
           mongodb-version: ${{ matrix.mongodb }}
 
+      - name: Run rubocop
+        run: |
+          bundle exec rubocop
       - name: Run tests
         run: |
           bundle exec rspec

data/.rubocop.yml

@@ -1 +1,5 @@
 inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable

data/.rubocop_todo.yml

@@ -1,24 +1,33 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-05-03 14:45:03 +1200 using RuboCop version 0.79.0.
+# on 2022-05-03 22:33:33 UTC using RuboCop version 1.28.2.
 # 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: 2
+# Offense count: 3
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/consyncful/base_spec.rb'
+    - 'spec/consyncful/persisted_item_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 19
 
 # Offense count: 12
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 211
+  Max: 220
 
 # Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle.
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
@@ -26,15 +35,16 @@ Style/ClassAndModuleChildren:
     - 'spec/consyncful/base_spec.rb'
 
 # Offense count: 1
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/consyncful.rb'
 
-# Offense count: 57
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 9
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
   Max: 226

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consyncful (0.7.0)
+    consyncful (0.7.1)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
@@ -10,26 +10,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.2.4)
-      activesupport (= 7.0.2.4)
-    activesupport (7.0.2.4)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.2)
     bson (4.15.0)
     concurrent-ruby (1.1.10)
-    contentful (2.16.0)
+    contentful (2.16.3)
       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.15.0)
+    ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -40,15 +40,14 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    minitest (5.15.0)
+    minitest (5.16.2)
     mongo (2.17.1)
       bson (>= 4.8.2, < 5.0.0)
     mongoid (7.4.0)
@@ -56,12 +55,14 @@ GEM
       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)
-      ast (~> 2.4.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (13.0.1)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -75,22 +76,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.28.2)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     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)
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -101,7 +110,9 @@ DEPENDENCIES
   database_cleaner
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (= 0.79.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -165,6 +165,19 @@ 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)
 
+### Preserving Contentful timestamps
+
+If you need to access the timestamps from Contentful, you can enable it by setting `preserve_contentful_timestamps` to `true`.
+
+```rb
+Consyncful.configure do |config|
+  # Consyncful models will have two extra fields that contains the value of timestamps in Contentful.
+  # contentful_created_at
+  # contentful_updated_at
+  config.preserve_contentful_timestamps = true # defaults to false
+end
+```
+
 ### 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.
 

data/consyncful.gemspec

@@ -5,14 +5,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'consyncful/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'consyncful'
-  spec.version       = Consyncful::VERSION
-  spec.authors       = ['Andy Anastasiadis-Gray', 'Montgomery Anderson', 'Greg Rogan']
-  spec.email         = ['andy@boost.co.nz', 'montgomery@boost.co.nz', 'greg@boost.co.nz']
+  spec.name                  = 'consyncful'
+  spec.version               = Consyncful::VERSION
+  spec.required_ruby_version = '>= 2.7'
+  spec.authors               = ['Andy Anastasiadis-Gray']
+  spec.email                 = ['andy@boost.co.nz']
 
-  spec.summary       = 'Contentful to local database synchronisation for Rails'
-  spec.homepage      = 'https://github.com/boost/consyncful'
-  spec.license       = 'MIT'
+  spec.summary  = 'Contentful to local database synchronisation for Rails'
+  spec.homepage = 'https://github.com/boost/consyncful'
+  spec.license  = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -23,7 +24,7 @@ Gem::Specification.new do |spec|
   #     "public gem pushes."
   # end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = 'exe'
@@ -34,10 +35,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.79.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
 
   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'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/consyncful/item_mapper.rb

@@ -36,6 +36,7 @@ module Consyncful
 
       fields.merge!(localized_fields(default_locale))
       fields.merge!(localized_asset_fields(default_locale)) if type == 'asset'
+      fields.merge!(contentful_timestamps) if Consyncful.configuration.preserve_contentful_timestamps
 
       fields
     end
@@ -49,11 +50,13 @@ module Consyncful
     end
 
     def generic_fields
-      { created_at: @item.created_at,
+      {
+        created_at: @item.created_at,
         updated_at: @item.updated_at,
         revision: @item.revision,
         contentful_type: type,
-        synced_at: Time.current }
+        synced_at: Time.current
+      }
     end
 
     def localized_fields(default_locale)
@@ -107,11 +110,18 @@ module Consyncful
       if single_reference?(value)
         [ActiveSupport::Inflector.foreign_key(field).to_sym, value.id]
       elsif many_reference?(value)
-        ids_field_name = field.to_s.singularize + '_ids' # fk field name
+        ids_field_name = "#{field.to_s.singularize}_ids" # fk field name
         [ids_field_name.to_sym, value.map(&:id)]
       else
         [field, value]
       end
     end
+
+    def contentful_timestamps
+      {
+        contentful_created_at: @item.created_at,
+        contentful_updated_at: @item.updated_at
+      }
+    end
   end
 end

data/lib/consyncful/version.rb

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

data/lib/consyncful.rb

@@ -18,7 +18,8 @@ module Consyncful
                   :mongo_client,
                   :mongo_collection,
                   :content_tags,
-                  :ignore_content_tags
+                  :ignore_content_tags,
+                  :preserve_contentful_timestamps
 
     def initialize
       @contentful_client_options = {
@@ -29,6 +30,7 @@ module Consyncful
       @mongo_collection = 'contentful_models'
       @content_tags = []
       @ignore_content_tags = []
+      @preserve_contentful_timestamps = false
     end
   end
 

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
-- Montgomery Anderson
-- Greg Rogan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,16 +70,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: contentful
   requirement: !ruby/object:Gem::Requirement
@@ -153,8 +179,6 @@ dependencies:
 description:
 email:
 - andy@boost.co.nz
-- montgomery@boost.co.nz
-- greg@boost.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -187,7 +211,8 @@ files:
 homepage: https://github.com/boost/consyncful
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -196,7 +221,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="