contentful 2.16.3 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4624711e7107b359d434d25cd80d630befeea1e102644a77e661d39a75bb11ab
-  data.tar.gz: 2c98524d5540abdf4631d919285b7fe0d892893d98cde8e53fbb2231639336f8
+  metadata.gz: 44bcfad09bdb03cc6460ebf0ac778f89e1b2820b9434f76bbbc297f63f84f7c7
+  data.tar.gz: a36e3d13ed3b67c501c34ceb7c777f60592188944905048839720d48490886d4
 SHA512:
-  metadata.gz: f173fb7196031ab788394a0cc657342cbbb07210a2ffd7dd6faf3f330ab52fe497d718686e04d868acbe88f4425459ae2a4858dcd66df5544bc8c33b766679ba
-  data.tar.gz: 527960b745300f48f8b5ceffd668bd086b01c266fbe5dccaeff4b91f5a6d973535ce2bc2160c1ce247fa1d2936c029514a8ccb39cff67916230a6bc00e85230b
+  metadata.gz: 171a6d3f675e9596a9353c40d43ab5ee81fabf755407e13933fdf04a7934d1db058d33480b25a305609b52a27e00d46f6790a1186608495815b93cc29c0648d9
+  data.tar.gz: 763fc3a03017b6c10a5fdee30d6bd71eca0f0015aacbf4e3f250186985d347a20363d817265c4e6aa777b06b73df0817c865d4d9ddba8b3e0cace9b177eb62fb

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 
-## Unreleased
+## 2.17.0
+
+### Updated
+* Updated `http` gem version
+
+### Changed
+* CI/CD vendor from travis to circleci
+* Refactored `includes` to be a model (`Contentful::Includes`) with a lookup table instead of a plain Ruby array, for improved performance when `include_level` is set. Two related methods from `Support` have been moved to this new class. Any code that uses the undocumented `includes_for_single` option to any method will need to be updated. [#235](https://github.com/contentful/contentful.rb/pull/235)
 
 ## 2.16.3
 ### Fixed

data/README.md

@@ -21,8 +21,8 @@
     <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License" />
   </a>
   &nbsp;
-  <a href="https://travis-ci.org/contentful/contentful.rb">
-    <img src="https://travis-ci.org/contentful/contentful.rb.svg?branch=master" alt="Build Status">
+  <a href="https://app.circleci.com/pipelines/github/contentful/contentful.rb?branch=master">
+    <img src="https://circleci.com/gh/contentful/contentful.rb/tree/master.svg?style=svg" alt="CircleCI">
   </a>
 </p>
 

data/lib/contentful/array.rb

@@ -1,5 +1,6 @@
 require_relative 'base_resource'
 require_relative 'array_like'
+require_relative 'includes'
 
 module Contentful
   # Resource Class for Arrays (e.g. search results)
@@ -47,7 +48,7 @@ module Contentful
         require_relative 'resource_builder'
         ResourceBuilder.new(
           item.raw,
-          raw_object[:configuration].merge(includes_for_single: Support.includes_from_response(raw, false)),
+          raw_object[:configuration].merge(includes_for_single: Includes.from_response(raw, false)),
           item.respond_to?(:localized) ? item.localized : false,
           0,
           raw_object[:configuration][:errors] || []

data/lib/contentful/base_resource.rb

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

data/lib/contentful/coercions.rb

@@ -155,10 +155,7 @@ module Contentful
 
       return nil if Support.unresolvable?(node['data']['target'], configuration[:errors])
 
-      resource = Support.resource_for_link(
-        node['data']['target'],
-        configuration[:includes_for_single]
-      )
+      resource = configuration[:includes_for_single].find_link(node['data']['target'])
 
       # Resource is valid but unreachable
       return Link.new(node['data']['target'], configuration) if resource.nil?

data/lib/contentful/entry.rb

@@ -2,6 +2,7 @@ require_relative 'error'
 require_relative 'fields_resource'
 require_relative 'content_type_cache'
 require_relative 'resource_references'
+require_relative 'includes'
 
 module Contentful
   # Resource class for Entry.
@@ -30,7 +31,7 @@ module Contentful
         content_type_field = content_type.field_for(field_id)
         coercion_configuration = @configuration.merge(
           includes_for_single:
-            @configuration.fetch(:includes_for_single, []) + includes,
+            @configuration.fetch(:includes_for_single, Includes.new) + includes,
           _entries_cache: entries,
           localized: localized,
           depth: @depth,
@@ -58,7 +59,7 @@ module Contentful
     # Any included object after the maximum include resolution depth will be just a Link
     def build_nested_resource(value, includes, entries, errors)
       if @depth < @configuration.fetch(:max_include_resolution_depth, 20)
-        resource = Support.resource_for_link(value, includes)
+        resource = includes.find_link(value)
         return resolve_include(resource, includes, entries, errors) unless resource.nil?
       end
 
@@ -72,7 +73,7 @@ module Contentful
         resource,
         @configuration.merge(
           includes_for_single:
-            @configuration.fetch(:includes_for_single, []) + includes,
+            @configuration.fetch(:includes_for_single, Includes.new) + includes,
           _entries_cache: entries
         ),
         localized,

data/lib/contentful/fields_resource.rb

@@ -2,6 +2,7 @@
 
 require_relative 'support'
 require_relative 'base_resource'
+require_relative 'includes'
 
 module Contentful
   # Base definition of a Contentful Resource containing Field properties
@@ -9,7 +10,7 @@ module Contentful
     attr_reader :localized
 
     # rubocop:disable Metrics/ParameterLists
-    def initialize(item, _configuration, localized = false, includes = [], entries = {}, depth = 0, errors = [])
+    def initialize(item, _configuration, localized = false, includes = Includes.new, entries = {}, depth = 0, errors = [])
       super
 
       @configuration[:errors] = errors
@@ -56,7 +57,7 @@ module Contentful
       super(raw_object)
       @localized = raw_object[:localized]
       @fields = hydrate_fields(
-        raw_object[:configuration].fetch(:includes_for_single, []),
+        raw_object[:configuration].fetch(:includes_for_single, Includes.new),
         {},
         raw_object[:configuration].fetch(:errors, [])
       )

data/lib/contentful/includes.rb

@@ -0,0 +1,74 @@
+require_relative 'array_like'
+
+module Contentful
+  # The includes hashes returned when include_level is specified
+  class Includes
+    include ArrayLike
+
+    attr_accessor :items, :lookup
+
+    def initialize(items = [], lookup = nil)
+      self.items = items
+      self.lookup = lookup || build_lookup
+    end
+
+    def self.from_response(json, raw = true)
+      includes = if raw
+                   json['items'].dup
+                 else
+                   json['items'].map(&:raw)
+                 end
+
+      %w[Entry Asset].each do |type|
+        includes.concat(json['includes'].fetch(type, [])) if json.fetch('includes', {}).key?(type)
+      end
+
+      new includes || []
+    end
+
+    def find_link(link)
+      key = "#{link['sys']['linkType']}:#{link['sys']['id']}"
+      lookup[key]
+    end
+
+    # Override some of the features of Array to take into account the lookup
+    # field in a performant way.
+
+    # If the lookups are the same then these two objects are effectively the same
+    def ==(other)
+      object_id == other.object_id || lookup == other.lookup
+    end
+
+    def +(other)
+      # If we're being asked to add to itself, just return without duplicating
+      return self if self == other
+
+      dup.tap do |copy|
+        copy.items += other.items
+        copy.lookup.merge!(other.lookup)
+      end
+    end
+
+    def dup
+      self.class.new(items.dup, lookup.dup)
+    end
+
+    def marshal_dump
+      items
+    end
+
+    def marshal_load(array)
+      self.items = array
+      self.lookup = build_lookup
+    end
+
+    private
+
+    def build_lookup
+      items.each_with_object({}) do |i, h|
+        key = "#{i['sys']['type']}:#{i['sys']['id']}"
+        h[key] = i
+      end
+    end
+  end
+end

data/lib/contentful/resource_builder.rb

@@ -8,6 +8,7 @@ require_relative 'link'
 require_relative 'deleted_entry'
 require_relative 'deleted_asset'
 require_relative 'locale'
+require_relative 'includes'
 
 module Contentful
   # Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error
@@ -39,7 +40,7 @@ module Contentful
       @default_locale = configuration.fetch(:default_locale, ::Contentful::Client::DEFAULT_CONFIGURATION[:default_locale])
       @resource_mapping = default_resource_mapping.merge(configuration.fetch(:resource_mapping, {}))
       @entry_mapping = default_entry_mapping.merge(configuration.fetch(:entry_mapping, {}))
-      @includes_for_single = configuration.fetch(:includes_for_single, [])
+      @includes_for_single = configuration.fetch(:includes_for_single, Includes.new)
       @localized = localized
       @depth = depth
       @endpoint = configuration.fetch(:endpoint, nil)
@@ -79,7 +80,7 @@ module Contentful
       build_item(json, includes, @errors)
     end
 
-    def build_item(item, includes = [], errors = [])
+    def build_item(item, includes = Includes.new, errors = [])
       item_type = BUILDABLES.detect { |b| b == item['sys']['type'] }
       fail UnparsableResource, 'Item type is not known, could not parse' if item_type.nil?
       item_class = resource_class(item)
@@ -98,7 +99,7 @@ module Contentful
     end
 
     def fetch_includes
-      Support.includes_from_response(json)
+      Includes.from_response(json)
     end
 
     def fetch_errors

data/lib/contentful/support.rb

@@ -47,41 +47,6 @@ module Contentful
 
         false
       end
-
-      # Returns the resource that matches the link
-      #
-      # @param [Hash] link
-      # @param [::Array] includes
-      #
-      # @return [Hash]
-      def resource_for_link(link, includes)
-        includes.detect do |i|
-          i['sys']['id'] == link['sys']['id'] &&
-            i['sys']['type'] == link['sys']['linkType']
-        end
-      end
-
-      # Returns combined include array from an API Response
-      #
-      # @param [Hash] json JSON Response
-      # @param [Bool] raw Response pre-proccessed?
-      #
-      # @return [Array]
-      def includes_from_response(json, raw = true)
-        includes = if raw
-                     json['items'].dup
-                   else
-                     json['items'].map(&:raw)
-                   end
-
-        %w[Entry Asset].each do |type|
-          if json.fetch('includes', {}).key?(type)
-            includes.concat(json['includes'].fetch(type, []))
-          end
-        end
-
-        includes
-      end
     end
   end
 end

data/lib/contentful/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.16.3
+  version: 2.17.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -21,7 +21,7 @@ dependencies:
         version: '0.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: '0.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +267,7 @@ files:
 - lib/contentful/field.rb
 - lib/contentful/fields_resource.rb
 - lib/contentful/file.rb
+- lib/contentful/includes.rb
 - lib/contentful/link.rb
 - lib/contentful/locale.rb
 - lib/contentful/location.rb
@@ -298,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: contentful