wcc-contentful 1.3.0 → 1.4.0.rc1

data/lib/wcc/contentful/store/rspec_examples/locale_queries.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'supports locales in queries' do |feature_set|
+  describe 'supports query options: { locale: ... }' do
+    before { skip('querying alternate locales not supported') } if feature_set == false
+
+    generator = proc { "test#{rand(1..10_000)}" }
+
+    let(:desired_value) {
+      generator.call
+    }
+
+    let(:data) {
+      1.upto(3).map do |i|
+        {
+          'sys' => { 'id' => "k#{i}", 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+          'fields' => {
+            'slug' => {
+              'en-US' => generator.call,
+              'es-ES' => generator.call
+            }
+          }
+        }
+      end
+    }
+
+    let(:desired) {
+      {
+        'sys' => { 'id' => "k#{rand}", 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+        'fields' => {
+          'slug' => {
+            'en-US' => generator.call,
+            'es-ES' => desired_value
+          }
+        }
+      }
+    }
+
+    context 'when localized value exists' do
+      it 'find_by can apply filter object' do
+        [*data, desired].shuffle.each { |d| subject.set(d.dig('sys', 'id'), d) }
+
+        # act
+        found = subject.find_by(content_type: 'test1',
+          filter: { 'slug' => desired_value },
+          options: { locale: 'es-ES' })
+
+        # assert
+        expect(found).to_not be_nil
+        expect(found).to eq(desired)
+      end
+
+      it 'find_by can find value in array' do
+        data =
+          1.upto(3).map do |i|
+            {
+              'sys' => {
+                'id' => "k#{i}",
+                'contentType' => { 'sys' => { 'id' => 'test1' } }
+              },
+              'fields' => {
+                'slug' => {
+                  'en-US' => [generator.call, generator.call],
+                  'es-ES' => [generator.call, generator.call]
+                }
+              }
+            }
+          end
+
+        desired_value = generator.call
+        desired = {
+          'sys' => { 'id' => "k#{rand}", 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+          'fields' => {
+            'slug' => {
+              'en-US' => [generator.call, generator.call],
+              'es-ES' => [generator.call, desired_value]
+            }
+          }
+        }
+
+        data << desired
+        data.shuffle.each { |d| subject.set(d.dig('sys', 'id'), d) }
+
+        # act
+        found = subject.find_by(content_type: 'test1',
+          filter: { 'slug' => { eq: desired_value } },
+          options: { locale: 'es-ES' })
+
+        # assert
+        expect(found).to_not be_nil
+        expect(found).to eq(desired)
+      end
+
+      it 'find_all can apply operator' do
+        desired =
+          4.upto(5).map do |i|
+            {
+              'sys' => { 'id' => "d#{i}", 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+              'fields' => {
+                'slug' => {
+                  'en-US' => generator.call,
+                  'es-ES' => desired_value
+                }
+              }
+            }
+          end
+
+        [*data, *desired].shuffle.each { |d| subject.set(d.dig('sys', 'id'), d) }
+
+        # act
+        found = subject.find_all(content_type: 'test1', options: { locale: 'es-ES' })
+          .eq('slug', desired_value)
+
+        # assert
+        expect(found.count).to eq(2)
+        sorted = found.to_a.sort_by { |item| item.dig('sys', 'id') }
+        expect(sorted).to eq(desired)
+      end
+    end
+
+    context 'using fallback locales' do
+      before { pending('querying alternate locales not yet implemented') } if feature_set&.to_s == 'pending'
+
+      before do
+        allow(configuration).to receive(:locale_fallbacks)
+          .and_return({
+            'es-MX' => 'es-ES',
+            'es-ES' => 'en-US'
+          })
+      end
+
+      it 'find_by can apply filter object' do
+        [*data, desired].shuffle.each { |d| subject.set(d.dig('sys', 'id'), d) }
+
+        # act
+        found = subject.find_by(content_type: 'test1',
+          filter: { 'slug' => desired_value },
+          options: { locale: 'es-MX' })
+
+        # assert
+        expect(found).to_not be_nil
+        expect(found).to eq(desired)
+      end
+
+      it 'find_by can find value in array' do
+        data =
+          1.upto(3).map do |i|
+            {
+              'sys' => {
+                'id' => "k#{i}",
+                'contentType' => { 'sys' => { 'id' => 'test1' } }
+              },
+              'fields' => {
+                'slug' => {
+                  'en-US' => [generator.call, generator.call],
+                  'es-ES' => [generator.call, generator.call]
+                }
+              }
+            }
+          end
+
+        desired_value = generator.call
+        desired = {
+          'sys' => { 'id' => "k#{rand}", 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+          'fields' => {
+            'slug' => {
+              'en-US' => [generator.call, generator.call],
+              'es-ES' => [generator.call, desired_value]
+            }
+          }
+        }
+
+        data << desired
+        data.shuffle.each { |d| subject.set(d.dig('sys', 'id'), d) }
+
+        # act
+        found = subject.find_by(content_type: 'test1',
+          filter: { 'slug' => { eq: desired_value } },
+          options: { locale: 'es-MX' })
+
+        # assert
+        expect(found).to_not be_nil
+        expect(found).to eq(desired)
+      end
+
+      it 'find_all can apply operator' do
+        desired = [
+          {
+            'sys' => { 'id' => 'd1', 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+            'fields' => {
+              'slug' => {
+                'en-US' => generator.call,
+                'es-ES' => desired_value
+              }
+            }
+          },
+          {
+            'sys' => { 'id' => 'd2', 'contentType' => { 'sys' => { 'id' => 'test1' } } },
+            'fields' => {
+              'slug' => {
+                'en-US' => desired_value
+              }
+            }
+          }
+        ]
+
+        [*data, *desired].shuffle.each { |d| subject.set(d.dig('sys', 'id'), d) }
+
+        # act
+        found = subject.find_all(content_type: 'test1', options: { locale: 'es-MX' })
+          .eq('slug', desired_value)
+
+        # assert
+        expect(found.count).to eq(2)
+        sorted = found.to_a.sort_by { |item| item.dig('sys', 'id') }
+        expect(sorted).to eq(desired)
+      end
+    end
+  end
+end

data/lib/wcc/contentful/store/rspec_examples/operators/eq.rb

@@ -46,7 +46,7 @@ RSpec.shared_examples 'supports :eq operator' do
                 'id' => "k#{i}",
                 'contentType' => { 'sys' => { 'id' => 'test1' } }
               },
-              'fields' => { 'name' => { 'en-US' => [generator.call, generator.call] } }
+              'fields' => { type.to_s => { 'en-US' => [generator.call, generator.call] } }
             }
           end
 

data/lib/wcc/contentful/store/rspec_examples.rb

@@ -4,6 +4,7 @@ require_relative './rspec_examples/basic_store'
 require_relative './rspec_examples/operators'
 require_relative './rspec_examples/nested_queries'
 require_relative './rspec_examples/include_param'
+require_relative './rspec_examples/locale_queries'
 
 # rubocop:disable Style/BlockDelimiters
 
@@ -24,6 +25,11 @@ require_relative './rspec_examples/include_param'
 #    all linked entries of an object in a single query.
 #    If your store does not respect the include parameter, then the Model layer
 #    will be calling #find a lot in order to resolve linked entries.
+# [:locale_queries] - This feature defines how the store respects the `locale: x`
+#    key in the Options hash.  If this option is set, then the store needs to
+#    compare the query to the appropriate localized value.
+#    If the store does not support this, then either the application should not
+#    use multiple locales OR should always query using the default locale.
 #
 # @example
 #   require 'wcc/contentful/store/rspec_examples'
@@ -38,13 +44,19 @@ require_relative './rspec_examples/include_param'
 RSpec.shared_examples 'contentful store' do |feature_set|
   feature_set = {
     nested_queries: 'pending',
-    include_param: 'pending'
+    include_param: 'pending',
+    locale_queries: 'pending'
   }.merge(feature_set&.symbolize_keys || {})
 
+  let(:configuration) {
+    WCC::Contentful::Configuration.new
+  }
+
   include_examples 'basic store'
   include_examples 'operators', feature_set[:operators]
   include_examples 'supports nested queries', feature_set[:nested_queries]
   include_examples 'supports include param', feature_set[:include_param]
+  include_examples 'supports locales in queries', feature_set[:locale_queries]
 end
 
 # rubocop:enable Style/BlockDelimiters

data/lib/wcc/contentful/sync_engine.rb

@@ -138,7 +138,7 @@ module WCC::Contentful
       # This job uses the Contentful Sync API to update the configured store with
       # the latest data from Contentful.
       class Job < ActiveJob::Base
-        self.queue_adapter = :async
+        self.queue_adapter ||= :async
         queue_as :default
 
         def configuration

data/lib/wcc/contentful/test/double.rb

@@ -60,7 +60,7 @@ module WCC::Contentful::Test::Double
         revision: rand(100),
         locale: 'en-US'
       },
-      fields: attrs.transform_values { |v| { 'en-US' => v } }
+      fields: attrs
     }
 
     double(attrs)

data/lib/wcc/contentful/test/factory.rb

@@ -24,7 +24,7 @@ module WCC::Contentful::Test::Factory
 
       raw_value = v
       raw_value = to_raw(v, field.type) if %i[Asset Link].include?(field.type)
-      raw['fields'][field.name][raw.dig('sys', 'locale')] = raw_value
+      raw['fields'][field.name] = raw_value
     end
 
     instance = const.new(raw, context)
@@ -84,9 +84,7 @@ module WCC::Contentful::Test::Factory
   end
 
   def contentful_fields(model)
-    WCC::Contentful::Test::Attributes.defaults(model).transform_values do |v|
-      { 'en-US' => v }
-    end
+    WCC::Contentful::Test::Attributes.defaults(model)
   end
 
   def to_raw(val, field_type)

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '1.3.0'
+    VERSION = '1.4.0.rc1'
   end
 end

data/lib/wcc/contentful.rb

@@ -10,6 +10,7 @@ require 'wcc/contentful/configuration'
 require 'wcc/contentful/downloads_schema'
 require 'wcc/contentful/exceptions'
 require 'wcc/contentful/helpers'
+require 'wcc/contentful/entry_locale_transformer'
 require 'wcc/contentful/link_visitor'
 require 'wcc/contentful/services'
 require 'wcc/contentful/simple_client'
@@ -40,9 +41,8 @@ module WCC::Contentful
     end
 
     # Gets all queryable locales.
-    # Reserved for future use.
     def locales
-      @locales ||= { 'en-US' => {} }.freeze
+      configuration&.locale_fallbacks
     end
 
     def logger
@@ -93,15 +93,18 @@ module WCC::Contentful
       end
     end
 
-    content_types =
+    schema =
       begin
-        JSON.parse(File.read(configuration.schema_file))['contentTypes'] if File.exist?(configuration.schema_file)
+        JSON.parse(File.read(configuration.schema_file)) if File.exist?(configuration.schema_file)
       rescue JSON::ParserError
         Services.instance.warn("Schema file invalid, ignoring it: #{configuration.schema_file}")
         nil
       end
 
-    if !content_types && %i[if_possible never].include?(configuration.update_schema_file)
+    content_types = schema['contentTypes'] if schema
+    locales = schema['locales'] if schema
+
+    if !schema && %i[if_possible never].include?(configuration.update_schema_file)
       # Final fallback - try to grab content types from CDN.  We can't update the file
       # because the CDN doesn't have all the field validation info, but we can at least
       # build the WCC::Contentful::Model instances.
@@ -127,7 +130,15 @@ module WCC::Contentful
       services: WCC::Contentful::Services.instance
     )
 
-    # Drop an initial sync
+    # Update the locale fallbacks from the schema file, unless they have already
+    # been configured.
+    locales&.each do |locale_hash|
+      next if @configuration.locale_fallbacks[locale_hash['code']]
+
+      @configuration.locale_fallbacks[locale_hash['code']] = locale_hash['fallbackCode']
+    end
+
+    # Enqueue an initial sync
     WCC::Contentful::SyncEngine::Job.perform_later if defined?(WCC::Contentful::SyncEngine::Job)
 
     @configuration = @configuration.freeze