wcc-contentful 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9026bfcc1e7745f7d8ecf3fb38928672f02d663d382fd1a3ca953ab33a78cb25
-  data.tar.gz: 36ec7c7f47fb6e49d565d7ca82c5021ac8f88b46eabfe41754ac5c123ac0004d
+  metadata.gz: 3cbb012e1545d674abc930f6513ea342611beb586b2afe5ad5ce703903e5a9cb
+  data.tar.gz: da23bc050241c0ae55e1952fc48d892d2b2d768f33d314aef34f4a5f159db585
 SHA512:
-  metadata.gz: 633116bd83752074876ccf76265eb64bc6a19a28b9a477bf2026925f0a84977cd651a234f5656b7a657a43e65b3320031e2385ca398bb2b846ab730693105799
-  data.tar.gz: 32f1f08bac98d42d89a136c0b49d2bb1ee1a72e057326edd50a17834b53b2da7fecbbe1db1aded355d2849bc1d222d4f16d3e721024a3c105f786349ab6548fc
+  metadata.gz: e53a8c32ea3687f8e5e8bfaac3a4a15d940e21873c7068c20b26cca92b5ed2876a8f680949f2bf169ebae258a00c0665f63c314888a1c3379b69b37da2be97d5
+  data.tar.gz: 24e358dc0f8ec03873ffb27ff6d79c5a64f0fda24b5f66336482ca38f0b4b654227907df96955005fcc4cf04ed811e78070c3688f3c3d0629406666734c8fd93

data/README.md

@@ -565,7 +565,10 @@ to multiple spaces within the same ruby process!  You just have to create and in
 The {WCC::Contentful::ModelAPI} concern makes this straightforward.  Start by creating your Namespace
 and including the concern:
 ```ruby
-# app/models/my_second_space.rb
+# lib/my_second_space.rb
+
+# Note: This class must be in the "lib" folder in :zeitwerk mode, otherwise Rails 6+ will unload all your constants
+# that were created in the initializer.  Your models which subclass this namespace may reside in the app/models directory.
 class MySecondSpace
   include WCC::Contentful::ModelAPI
 end
@@ -587,6 +590,11 @@ MySecondSpace.configure do |config|
   config.space = ENV['SECOND_CONTENTFUL_SPACE_ID']
   config.environment = ENV['CONTENTFUL_ENVIRONMENT']
 end
+
+# Ensure that models are reloaded in Rails development mode
+Rails.application.config.to_prepare do
+  MySecondSpace.reload!
+end
 ```
 
 Finally, use it:
@@ -614,6 +622,22 @@ sync_engine = MySecondSpace.services.sync_engine
 Note that the above services are not accessible on {WCC::Contentful::Services.instance}
 or via the {WCC::Contentful::ServiceAccessors}.
 
+#### Important Note when using Zeitwerk with Rails 6+
+When using Rails >= 6 with `config.autoloader = :zeitwerk`, Rails will remove any models defined in `app/models` after
+initialization and then load them again when they are referenced.  If you `include WCC::Contentful::ModelAPI` in a class
+defined inside the `app` directory, this will have the effect of deleting all configuration that was set in the initializer
+as well as the constants generated from your schema.
+This will result in one of two errors:
+
+* `NameError (uninitialized constant MySecondSpace::MyContentType)`  
+    if you try to reference a subclass such as `MyContentType < MySecondSpace::MyContentType`
+* `ArgumentError (Not yet configured!)`
+    if you try to `MySecondSpace.find('xxxx')` to load an Entry or Asset
+
+The solution is to have your secondary namespace in a folder which is not in the `autoload_paths`.
+We suggest using `lib`, which will work so long as you have not added the `lib` folder to the `autoload_paths` as some
+uninformed StackOverflow answers suggest you do.
+
 ### Using a sync store with a second space
 
 If you use something other than the CDNAdapter with your second space, you will

data/lib/wcc/contentful/active_record_shim.rb

@@ -33,7 +33,7 @@ module WCC::Contentful::ActiveRecordShim
 
   class_methods do
     def model_name
-      WCC::Contentful::Helpers.constant_from_content_type(content_type)
+      ActiveModel::Name.new(self, nil, WCC::Contentful::Helpers.constant_from_content_type(content_type))
     end
 
     def const_get(name)
@@ -46,7 +46,7 @@ module WCC::Contentful::ActiveRecordShim
     end
 
     def table_name
-      model_name.tableize
+      model_name.plural.tableize
     end
 
     def unscoped

data/lib/wcc/contentful/model_api.rb

@@ -96,7 +96,7 @@ module WCC::Contentful::ModelAPI
       loop do
         begin
           # The app may have defined a model and we haven't loaded it yet
-          const = parent.const_missing(const_name)
+          const = parent.const_get(const_name)
           return const if const && const < self
         rescue NameError => e
           raise e unless e.message =~ /uninitialized constant (.+::)*#{const_name}$/
@@ -156,7 +156,7 @@ module WCC::Contentful::ModelAPI
         const_name = klass.name
         begin
           # the const_name is fully qualified so search from root
-          const = Object.const_missing(const_name)
+          const = Object.const_get(const_name)
           register_for_content_type(content_type, klass: const) if const
         rescue NameError => e
           msg = "Error when reloading constant #{const_name} - #{e}"

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '1.3.0'
+    VERSION = '1.3.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Watermark Dev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -493,7 +493,7 @@ licenses:
 metadata:
   documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.3/wcc-contentful
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -508,8 +508,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://rubygems.org/gems/wcc-contentful)
   [![Build Status](https://circleci.com/gh/watermarkchurch/wcc-contentful.svg?style=svg)](https://circleci.com/gh/watermarkchurch/wcc-contentful)
@@ -766,14 +766,19 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   step.  However the gem is also capable of connecting to multiple spaces within the
   same ruby process!  You just have to create and initialize a namespace.  The {WCC::Contentful::ModelAPI}
   concern makes this straightforward.  Start by creating your Namespace and including
-  the concern: ```ruby # app/models/my_second_space.rb class MySecondSpace include
-  WCC::Contentful::ModelAPI end  # app/models/other_page.rb class OtherPage < MySecondSpace::Page
-  end ```  Then configure it in an initializer: ```ruby # config/initializers/my_second_space.rb
+  the concern: ```ruby # lib/my_second_space.rb  # Note: This class must be in the
+  "lib" folder in :zeitwerk mode, otherwise Rails 6+ will unload all your constants
+  # that were created in the initializer.  Your models which subclass this namespace
+  may reside in the app/models directory. class MySecondSpace include WCC::Contentful::ModelAPI
+  end  # app/models/other_page.rb class OtherPage < MySecondSpace::Page end ```  Then
+  configure it in an initializer: ```ruby # config/initializers/my_second_space.rb
   MySecondSpace.configure do |config| # Make sure to point to a different schema file
   from your first space! config.schema_file = Rails.root.join(''db/second-contentful-schema.json'')  config.access_token
   = ENV[''SECOND_CONTENTFUL_ACCESS_TOKEN''] config.preview_token = ENV[''SECOND_CONTENTFUL_PREVIEW_ACCESS_TOKEN'']
   config.space = ENV[''SECOND_CONTENTFUL_SPACE_ID''] config.environment = ENV[''CONTENTFUL_ENVIRONMENT'']
-  end ```  Finally, use it: ```ruby OtherPage.find(''1234'') # GET https://cdn.contentful.com/spaces/other-space/environments/other-env/entries/1234
+  end  # Ensure that models are reloaded in Rails development mode Rails.application.config.to_prepare
+  do MySecondSpace.reload! end ```  Finally, use it: ```ruby OtherPage.find(''1234'')
+  # GET https://cdn.contentful.com/spaces/other-space/environments/other-env/entries/1234
   # => #<OtherPage:0x0000000005c71a78 @created_at=2018-04-16 18:41:17 UTC...>  Page.find(''1234'')
   # GET https://cdn.contentful.com/spaces/first-space/environments/first-env/entries/1234
   # => #<Page:0x0000000001271b70 @created_at=2018-04-15 12:02:14 UTC...> ```  The
@@ -783,14 +788,27 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   preview_client = MySecondSpace.services.preview_client # => #<WCC::Contentful::SimpleClient::Preview:0x00007f888ccafa00
   sync_engine = MySecondSpace.services.sync_engine # => #<WCC::Contentful::SyncEngine:0x00007f88960b6b40
   ``` Note that the above services are not accessible on {WCC::Contentful::Services.instance}
-  or via the {WCC::Contentful::ServiceAccessors}.  ### Using a sync store with a second
-  space  If you use something other than the CDNAdapter with your second space, you
-  will need to find a way to trigger `MySecondSpace.services.sync_engine.next` to
-  keep it up-to-date.  The {WCC::Contentful::Engine} will only manage the global SyncEngine
-  configured by the global {WCC::Contentful.configure}.  The easiest way to do this
-  is to set up your own Rails route to respond to Contentful webhooks and then configure
-  the second Contentful space to send webhooks to this route. You could also do this
-  by triggering it periodically in a background job using Sidekiq and [sidekiq-scheduler](https://github.com/Moove-it/sidekiq-scheduler).  ##
+  or via the {WCC::Contentful::ServiceAccessors}.  #### Important Note when using
+  Zeitwerk with Rails 6+ When using Rails >= 6 with `config.autoloader = :zeitwerk`,
+  Rails will remove any models defined in `app/models` after initialization and then
+  load them again when they are referenced.  If you `include WCC::Contentful::ModelAPI`
+  in a class defined inside the `app` directory, this will have the effect of deleting
+  all configuration that was set in the initializer as well as the constants generated
+  from your schema. This will result in one of two errors:  * `NameError (uninitialized
+  constant MySecondSpace::MyContentType)`   if you try to reference a subclass such
+  as `MyContentType < MySecondSpace::MyContentType` * `ArgumentError (Not yet configured!)`
+  if you try to `MySecondSpace.find(''xxxx'')` to load an Entry or Asset  The solution
+  is to have your secondary namespace in a folder which is not in the `autoload_paths`.
+  We suggest using `lib`, which will work so long as you have not added the `lib`
+  folder to the `autoload_paths` as some uninformed StackOverflow answers suggest
+  you do.  ### Using a sync store with a second space  If you use something other
+  than the CDNAdapter with your second space, you will need to find a way to trigger
+  `MySecondSpace.services.sync_engine.next` to keep it up-to-date.  The {WCC::Contentful::Engine}
+  will only manage the global SyncEngine configured by the global {WCC::Contentful.configure}.  The
+  easiest way to do this is to set up your own Rails route to respond to Contentful
+  webhooks and then configure the second Contentful space to send webhooks to this
+  route. You could also do this by triggering it periodically in a background job
+  using Sidekiq and [sidekiq-scheduler](https://github.com/Moove-it/sidekiq-scheduler).  ##
   Development  After checking out the repo, run `bin/setup` to install dependencies.
   Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for
   an interactive prompt that will allow you to experiment.  ## Contributing  Bug reports