contentful 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e169a58eaeb582e61a250dc95e7bf980c632d906
-  data.tar.gz: 615244247ac26f6f3be2afa7e430f12aa225687d
+  metadata.gz: 033f5efe6223ef9a1e09d693c298977d21235209
+  data.tar.gz: bbe60ca4295d8c60bebfeed1e9362d5f60e937dd
 SHA512:
-  metadata.gz: f074a6327c040944e729763b8003899c452ff7b31fe2a52998ab2364d55cb426b3e00b10fa4eaeb925293656afb2f85c3c9385c343c22a5563cbbe97d004bf36
-  data.tar.gz: 721607153d1085113cd632081be420a17f2c835521116f15f3cc450f4c710f88a580d44b05541c5dc2df777afadde5faa6ed63467dfe331306cb4ecc59802616
+  metadata.gz: 59e84824fe37fd0410211e2a8ad6eaa52316d2ecefa53c8d75c2b0e2f4aec93cbb1222e0ebcda1e3ed9bba0b6af1311fbc3cb6eddf2c44a0d9c27e75532c3041
+  data.tar.gz: 562af572939b7615e4de51483eac5718b820815ac757e0dd9821320f846a73be056eaae7eccc9807f869f9cc69dca052321db263e2d34a67b508eca879a9ee62

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 2.4.0
+### Added
+* Added `reuse_entries` option to client configuration. This is a performance improvement, which is disabled by default due to backwards compatibility. All users are highly encouraged to enable it and test it in their applications. [#164](https://github.com/contentful/contentful.rb/pull/164)
+
 ## 2.3.0
 ### Added
 * Support for the new query parameters to find incoming links [to a specific entry](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/links-to-entry) or [to a specific asset](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/links-to-asset) in a space.

data/README.md

@@ -242,12 +242,18 @@ Maximum time to wait for next available request (in seconds). Default value is 6
 can have up to 60 minutes of blocked requests. It is set to a default of 60 seconds in order to avoid blocking processes for too long, as rate limit retry behaviour
 is blocking per execution thread.
 
+### :reuse_entries
+
+When true, reuse hydrated Entry and Asset objects within the same request when possible. Can result in a large speed increase and better handles cyclical object graphs. 
+This can be a good alternative to `max_include_resolution_depth` if your content model contains (or can contain) circular references.
+
 ### :max_include_resolution_depth
 
 Maximum amount of levels to resolve includes for SDK entities (this is independent of API-level includes - it represents the maximum depth the include resolution
 tree is allowed to resolved before falling back to `Link` objects). This include resolution strategy is in place in order to avoid having infinite circular recursion
 on resources with circular dependencies. Defaults to 20. _Note_: If you're using something like `Rails::cache` it's advisable to considerably lower this value
 (around 5 has proven to be a good compromise - but keep it higher or equal than your maximum API-level include parameter if you need the entire tree resolution).
+Note that when `reuse_entries` is enabled, the max include resolution depth only affects deep chains of unique objects (ie, not simple circular references).
 
 ### :use_camel_case
 

data/lib/contentful/base_resource.rb

@@ -5,7 +5,9 @@ module Contentful
   class BaseResource
     attr_reader :raw, :default_locale, :sys
 
-    def initialize(item, configuration = {}, _localized = false, _includes = [], depth = 0)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(item, configuration = {}, _localized = false, _includes = [], entries = {}, depth = 0)
+      entries["#{item['sys']['type']}:#{item['sys']['id']}"] = self if entries && item.key?('sys')
       @raw = item
       @default_locale = configuration[:default_locale]
       @depth = depth

data/lib/contentful/entry.rb

@@ -15,9 +15,9 @@ module Contentful
 
     private
 
-    def coerce(field_id, value, includes)
-      return build_nested_resource(value, includes) if Support.link?(value)
-      return coerce_link_array(value, includes) if Support.link_array?(value)
+    def coerce(field_id, value, includes, entries = {})
+      return build_nested_resource(value, includes, entries) if Support.link?(value)
+      return coerce_link_array(value, includes, entries) if Support.link_array?(value)
 
       content_type_key = Support.snakify('contentType', @configuration[:use_camel_case])
       content_type = ContentTypeCache.cache_get(sys[:space].id, sys[content_type_key.to_sym].id)
@@ -27,13 +27,13 @@ module Contentful
         return content_type_field.coerce(value) unless content_type_field.nil?
       end
 
-      super(field_id, value, includes)
+      super(field_id, value, includes, entries)
     end
 
-    def coerce_link_array(value, includes)
+    def coerce_link_array(value, includes, entries)
       items = []
       value.each do |link|
-        items << build_nested_resource(link, includes)
+        items << build_nested_resource(link, includes, entries)
       end
 
       items
@@ -43,23 +43,24 @@ module Contentful
     # in case one of the included items has a reference in an upper level,
     # so we can keep the include chain for that object as well
     # Any included object after the maximum include resolution depth will be just a Link
-    def build_nested_resource(value, includes)
+    def build_nested_resource(value, includes, entries)
       if @depth < @configuration.fetch(:max_include_resolution_depth, 20)
         resource = Support.resource_for_link(value, includes)
-        return resolve_include(resource, includes) unless resource.nil?
+        return resolve_include(resource, includes, entries) unless resource.nil?
       end
 
       build_link(value)
     end
 
-    def resolve_include(resource, includes)
+    def resolve_include(resource, includes, entries)
       require_relative 'resource_builder'
 
       ResourceBuilder.new(
         resource,
         @configuration.merge(
           includes_for_single:
-            @configuration.fetch(:includes_for_single, []) + includes
+            @configuration.fetch(:includes_for_single, []) + includes,
+          _entries_cache: entries
         ),
         localized,
         @depth + 1,

data/lib/contentful/fields_resource.rb

@@ -6,12 +6,12 @@ module Contentful
   class FieldsResource < BaseResource
     attr_reader :localized
 
-    def initialize(item, _configuration, localized = false, includes = [], *)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(item, _configuration, localized = false, includes = [], entries = {}, *)
       super
 
       @localized = localized
-      @fields = hydrate_fields(includes)
-
+      @fields = hydrate_fields(includes, entries)
       define_fields_methods!
     end
 
@@ -56,7 +56,7 @@ module Contentful
     def marshal_load(raw_object)
       super(raw_object)
       @localized = raw_object[:localized]
-      @fields = hydrate_fields(raw_object[:configuration].fetch(:includes_for_single, []))
+      @fields = hydrate_fields(raw_object[:configuration].fetch(:includes_for_single, []), {})
       define_fields_methods!
     end
 
@@ -82,31 +82,18 @@ module Contentful
       end
     end
 
-    def hydrate_fields(includes)
-      return {} unless raw.key?('fields')
-
+    def hydrate_localized_fields(includes, entries)
       locale = internal_resource_locale
       result = { locale => {} }
-
-      if localized
-        raw['fields'].each do |name, locales|
-          locales.each do |loc, value|
-            result[loc] ||= {}
-            name = Support.snakify(name, @configuration[:use_camel_case])
-            result[loc][name.to_sym] = coerce(
-              name,
-              value,
-              includes
-            )
-          end
-        end
-      else
-        raw['fields'].each do |name, value|
+      raw['fields'].each do |name, locales|
+        locales.each do |loc, value|
+          result[loc] ||= {}
           name = Support.snakify(name, @configuration[:use_camel_case])
-          result[locale][name.to_sym] = coerce(
+          result[loc][name.to_sym] = coerce(
             name,
             value,
-            includes
+            includes,
+            entries
           )
         end
       end
@@ -114,9 +101,35 @@ module Contentful
       result
     end
 
+    def hydrate_nonlocalized_fields(includes, entries)
+      result = { locale => {} }
+      locale = internal_resource_locale
+      raw['fields'].each do |name, value|
+        name = Support.snakify(name, @configuration[:use_camel_case])
+        result[locale][name.to_sym] = coerce(
+          name,
+          value,
+          includes,
+          entries
+        )
+      end
+
+      result
+    end
+
+    def hydrate_fields(includes, entries)
+      return {} unless raw.key?('fields')
+
+      if localized
+        hydrate_localized_fields(includes, entries)
+      else
+        hydrate_nonlocalized_fields(includes, entries)
+      end
+    end
+
     protected
 
-    def coerce(_field_id, value, _includes)
+    def coerce(_field_id, value, _includes, _entries)
       value
     end
   end

data/lib/contentful/resource_builder.rb

@@ -40,6 +40,7 @@ module Contentful
       @depth = depth
       @endpoint = endpoint
       @configuration = configuration
+      @entries = configuration[:_entries_cache] || {}
     end
 
     # Starts the parsing process.
@@ -74,7 +75,17 @@ module Contentful
       fail UnparsableResource, 'Item type is not known, could not parse' if item_type.nil?
       item_class = resource_class(item)
 
-      item_class.new(item, @configuration, localized?, includes, depth)
+      reuse_entries = @configuration.fetch(:reuse_entries, false)
+      entries = @entries ? @entries : {}
+
+      id = "#{item['sys']['type']}:#{item['sys']['id']}"
+      entry = if reuse_entries && entries.key?(id)
+                entries[id]
+              else
+                item_class.new(item, @configuration, localized?, includes, entries, depth)
+              end
+
+      entry
     end
 
     def fetch_includes

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/spec/entry_spec.rb

@@ -283,7 +283,73 @@ describe Contentful::Entry do
     end
   end
 
+  describe 'reuse objects' do
+    it 'should handle recursion as well as not reusing' do
+      vcr('entry/include_resolution') {
+        entry = create_client(reuse_objects: true).entry('nyancat', include: 2)
+
+        expect(entry.best_friend.name).to eq 'Happy Cat'
+        expect(entry
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend
+              .best_friend.best_friend.name).to eq 'Nyan Cat'
+      }
+    end
+    it 'should use the same object for the same entry' do
+      vcr('entry/include_resolution') {
+        entry = create_client(reuse_entries: true).entry('nyancat', include: 2)
+
+        expect(entry.best_friend.name).to eq 'Happy Cat'
+        expect(entry.best_friend.best_friend).to be(entry)
+      }
+    end
+    it 'works on nested structures with unique objects' do
+      vcr('entry/include_resolution_uniques') {
+        entry = create_client(
+          space: 'v7cxgyxt0w5x',
+          access_token: '96e5d256e9a5349ce30e84356597e409f8f1bb485cb4719285b555e0f78aa27e',
+          reuse_entries: true
+        ).entry('1nLXjjWvk4MEeWeQCWmymc', include: 10)
+
+        expect(entry.title).to eq '1'
+        expect(entry
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.title).to eq '10'
+        expect(entry
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.child.title).to eq '1'
+        expect(entry
+                 .child.child.child.child
+                 .child.child.child.child
+                 .child.child.child.child
+                 .child.child.child.child
+                 .child.child.child.child.title).to eq '1'
+      }
+    end
+  end
+
   describe 'include resolution' do
+    it 'should not reuse objects by default' do
+      vcr('entry/include_resolution') {
+        entry = create_client.entry('nyancat', include: 2)
+
+        expect(entry.best_friend.name).to eq 'Happy Cat'
+        expect(entry.best_friend.best_friend).not_to be(entry)
+      }
+    end
     it 'defaults to 20 depth' do
       vcr('entry/include_resolution') {
         entry = create_client.entry('nyancat', include: 2)
@@ -329,6 +395,34 @@ describe Contentful::Entry do
                .best_friend.best_friend).to be_a ::Contentful::Link
       }
     end
+    it 'works on nested structures with unique objects' do
+      vcr('entry/include_resolution_uniques') {
+        entry = create_client(
+          space: 'v7cxgyxt0w5x',
+          access_token: '96e5d256e9a5349ce30e84356597e409f8f1bb485cb4719285b555e0f78aa27e',
+        ).entry('1nLXjjWvk4MEeWeQCWmymc', include: 10)
+
+        expect(entry.title).to eq '1'
+        expect(entry
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.title).to eq '10'
+        expect(entry
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.child
+                 .child.child.title).to eq '1'
+        expect(entry
+                 .child.child.child.child
+                 .child.child.child.child
+                 .child.child.child.child
+                 .child.child.child.child
+                 .child.child.child.child.title).to eq '1'
+      }
+    end
   end
 
   describe 'issues' do

data/spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml

@@ -0,0 +1,81 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/v7cxgyxt0w5x/entries?include=10&sys.id=1nLXjjWvk4MEeWeQCWmymc
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.3.0; platform ruby/2.4.1; os macOS/16;
+      Authorization:
+      - Bearer 96e5d256e9a5349ce30e84356597e409f8f1bb485cb4719285b555e0f78aa27e
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/2.2.2
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation,X-Contentful-User-Agent,X-Contentful-Enable-Alpha-Feature
+      Access-Control-Allow-Methods:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Etag:
+      - W/"61dce3f065024b11b5dce76f1e0b6c4d"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Request-Id:
+      - d4bd8c6410d7abd46c1d4669c38f6357
+      Content-Length:
+      - '878'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Wed, 14 Feb 2018 10:17:53 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-hhn1548-HHN
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1518603473.158289,VS0,VE398
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA+2ZS4+bMBCA7/srVpy7yLwhN5SlyWo3jSI2omy1B0po6hBICORBV/nvNQ8TkpqsqDggBQ4oNh6PZ+xvxnY+7u7vqTAOqd79B/qJClG8dlCJUjcbK6ZQ3fFL0iZaRdYS1TNpKXThGhVAWlhCD0bJJ5CVYeR4SYc/0g6zbi+0pJrCtWUnqnCLrLI0lqQircRjeoG+SyU6Tw/S7ruv+Zj1tMeLBnCWmLOT7MM8PkRgLxwSq/BzLH6ndmYPlckw/sv3xcLYufxIcwxn0je82LNL/RcD0/xoE5c/2BvHipyZmviFYgEjPwD2geFfGdBjhB6QaEaR3soC2/WsnsDG2cEQrnw8J/nI7ZUfOX6Ue6Q51/ZL/RIdHDlh9LljlyvbWqbry/EfpjoWKHxP/YLOcnZajolVVASjTIY5c/FvuEymtjkbL2cxVZ4tBS4+DIP9ePHmae5ozsoAgq2rVdibr6NsaSXv95QT6NvL7cwpsZYpxKScWCHQUsELsWXmtJwJAjNI6DNqCsOruEFxoUxReUlgelbKgJMfuT99bS+6q+0YPO9Z9YzOSn6Q+msE8T1BoRlBKBOERK4xVCFCpihRX8lREy6vpqlw/CVP1xxeQVUeu/PIQCALKSvY4s9nxibQ1YTlJMYKm324CL2nTTxUtbk3Z0dePx6JZcgunHCK3Rg5vA5PQeEsu+WuIGWeJowj5Z/CuP8niR0eBo7R/8oZtjsyNTZkbSDrjZCEchFDS4CtQVKFSEcSzlJcC0hiyMG3FLJvE6WKPH6WvvBu899QdTUpIS54WuSUeiiRRDqUMEpsC1CqiL43j5IgqlAJdGfwZNpxIKsGUCc8bCQr8T1epnlBroFShUiHEkZJbgFKQfAszR7h7pvKW9vpNLQCGXb7O0pQTOHnUDCkLeuG7ACo4/lorDVEksDRMsfUIoko0pGESRJbQJL+bMbuU8zMBxaiaDJyJroudyclwexvZ/owXE9FMQByoJnQXJkNkcQpNKi1veN7RJGOpOI+D7QApYpb3pvf35FDTBMnJXQXx9BArLe9I4p0KGGUpBaQVHEiuHmSyNeaDZEk0rwk1tvekUQ6kjBJQhtIIp8Ibp4k8gGyGZJ4npZBvb+UiCIdSZgkpQ0kkU8EdUhK276j9/HuePcXnaKW8jEhAAA=
+    http_version: 
+  recorded_at: Wed, 14 Feb 2018 10:17:52 GMT
+recorded_with: VCR 3.0.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -455,6 +455,7 @@ files:
 - spec/fixtures/vcr_cassettes/entry.yml
 - spec/fixtures/vcr_cassettes/entry/custom_resource.yml
 - spec/fixtures/vcr_cassettes/entry/include_resolution.yml
+- spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml
 - spec/fixtures/vcr_cassettes/entry/json_objects.yml
 - spec/fixtures/vcr_cassettes/entry/json_objects_client.yml
 - spec/fixtures/vcr_cassettes/entry/marshal_138.yml
@@ -591,6 +592,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/entry.yml
 - spec/fixtures/vcr_cassettes/entry/custom_resource.yml
 - spec/fixtures/vcr_cassettes/entry/include_resolution.yml
+- spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml
 - spec/fixtures/vcr_cassettes/entry/json_objects.yml
 - spec/fixtures/vcr_cassettes/entry/json_objects_client.yml
 - spec/fixtures/vcr_cassettes/entry/marshal_138.yml