scrivito_sdk 1.16.0.rc1 → 1.17.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76243f40035c3d7c864fe322c0f35f55d4ed1c1c38a158b492b1a5403af08352
-  data.tar.gz: 27765ae148888b8d98a439c036cfdff78b942014d9f1977c5a0cee45f78fe84f
+  metadata.gz: 24bd5086592408534913facabf378aca4cee04e9d749b33bc9b22e2fd253849f
+  data.tar.gz: c840807dab6c5ec6c0f9f4cfa97b900a27ef739f415c06a18fb91c70609f2833
 SHA512:
-  metadata.gz: 4b6b7548be93614eeebdc6573ca2a89b3f5a86a68f1fc7e6a058e0b7dcc4e47456ff48d2f9fb84e59ec24dca71c2dd98bb248b9dfb884690fe09fc6f571ae538
-  data.tar.gz: 487530d43384f921eb2b75cec781ad69961e15d970354a3a25883bcd591ffb2f6bbc69eb0f63b61612a4fc6c2f64df84b03c756f625b16fa9bbbe364a7656d10
+  metadata.gz: ae653310b1e55e892d45e37c1a1748a01231b5d34b8e1180cae0000ef6e2dddde3694415cdc609e065cf530f929587c5cb1e1d431d20f296a201b8a6f4286da9
+  data.tar.gz: 7ad67012b3de012bada117385977b1438d6791bb2a5750da7e27dbadff818af5d0e84da79921929277b6e5f228f57b50f4c499af86a3a4ed40616252c6363533

data/README.md

@@ -12,7 +12,7 @@ of concepts and APIs, tutorials, and release notes.
 
 ## License
 
-Copyright (c) 2009 - 2019 Infopark AG (http://www.infopark.com)
+Copyright (c) 2009 - 2020 Infopark Group GmbH (http://www.infopark.com)
 
 This software can be used and modified under the LGPL-3.0. Please refer to
 http://www.gnu.org/licenses/lgpl-3.0.html for the license text.

data/app/cms/scrivito/attribute_serializer.rb

@@ -29,6 +29,8 @@ class AttributeSerializer < Struct.new(:obj_class, :obj_id)
       _permalink
     ].include?(attribute_name)
       [attribute_name, attribute_value.to_s]
+    elsif attribute_name == '_restriction'
+      [attribute_name, attribute_value]
     else
       raise_unknown_attribute(attribute_name)
     end

data/app/cms/scrivito/basic_obj.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'ostruct'
 require 'active_model/naming'
 
@@ -25,15 +24,18 @@ module Scrivito
     PublicSystemAttributeDefinition = Class.new(AttributeDefinition)
 
     SYSTEM_ATTRIBUTES = AttributeDefinitionCollection.new(
-      '_id'           => PublicSystemAttributeDefinition.new(:_id, :string),
-      '_last_changed' => PublicSystemAttributeDefinition.new(:_last_changed, :date),
-      '_obj_class'    => PublicSystemAttributeDefinition.new(:_obj_class, :string),
-      '_path'         => PublicSystemAttributeDefinition.new(:_path, :string),
-      '_permalink'    => PublicSystemAttributeDefinition.new(:_permalink, :string),
-
-      '_conflicts'    => AttributeDefinition.new(:_conflicts, nil),
-      '_modification' => AttributeDefinition.new(:_modification, nil),
-      '_widget_pool'  => AttributeDefinition.new(:_widget_pool, nil),
+      '_id'                 => PublicSystemAttributeDefinition.new(:_id, :string),
+      '_created_at'         => PublicSystemAttributeDefinition.new(:_created_at, :date),
+      '_last_changed'       => PublicSystemAttributeDefinition.new(:_last_changed, :date),
+      '_first_published_at' => PublicSystemAttributeDefinition.new(:_first_published_at, :date),
+      '_published_at'       => PublicSystemAttributeDefinition.new(:_published_at, :date),
+      '_obj_class'          => PublicSystemAttributeDefinition.new(:_obj_class, :string),
+      '_path'               => PublicSystemAttributeDefinition.new(:_path, :string),
+      '_permalink'          => PublicSystemAttributeDefinition.new(:_permalink, :string),
+
+      '_conflicts'          => AttributeDefinition.new(:_conflicts, nil),
+      '_modification'       => AttributeDefinition.new(:_modification, nil),
+      '_widget_pool'        => AttributeDefinition.new(:_widget_pool, nil),
     )
 
     UNIQ_ATTRIBUTES = %w[
@@ -44,7 +46,10 @@ module Scrivito
 
     GENERATED_ATTRIBUTES = %w[
       _conflicts
+      _created_at
       _last_changed
+      _first_published_at
+      _published_at
       _modification
       _obj_type
       _text_links
@@ -138,14 +143,14 @@ module Scrivito
       else
         attributes = build_attributes_with_defaults(attributes, context)
         attributes = prepare_attributes_for_instantiation(attributes)
-        api_attributes, widget_properties = prepare_attributes_for_rest_api(attributes)
+        extraction, api_attributes = prepare_attributes_for_rest_api(attributes)
 
         workspace = Workspace.current
         obj_data = workspace.create_obj(obj: api_attributes)
         obj = BasicObj.instantiate(obj_data)
         obj.revision = workspace.revision
 
-        CmsRestApi::WidgetExtractor.notify_persisted_widgets(obj, widget_properties)
+        extraction.notify_persisted(obj)
         obj
       end
     end
@@ -301,7 +306,7 @@ module Scrivito
     # @api public
     def self.find_by_path(path)
       Workspace.current.objs.find_one_by(:path, path,
-          obj_class_name: type_computer.obj_class_name_for_type(self))
+          type_computer.obj_class_name_for_type(self))
     end
 
     # Find an {Scrivito::BasicObj Obj} with the given name.
@@ -329,7 +334,7 @@ module Scrivito
     # @api public
     def self.find_by_permalink(permalink)
       Workspace.current.objs.find_one_by(:permalink, permalink,
-          obj_class_name: type_computer.obj_class_name_for_type(self))
+          type_computer.obj_class_name_for_type(self))
     end
 
     # Returns the {Scrivito::BasicObj Obj} with the given permalink, or raises
@@ -414,9 +419,9 @@ module Scrivito
     #     }
     #   )
     def update(attributes)
-      api_attributes, widget_properties = prepare_attributes_for_rest_api(attributes)
+      extraction, api_attributes = prepare_attributes_for_rest_api(attributes)
       update_data(workspace.update_obj(id, obj: api_attributes))
-      CmsRestApi::WidgetExtractor.notify_persisted_widgets(self, widget_properties)
+      extraction.notify_persisted(self)
       self
     end
 
@@ -633,7 +638,7 @@ module Scrivito
       return [] if binary?
       toclist = children
       toclist = toclist.reject { |toc| toc.binary? } unless args.include?(:all)
-      toclist
+      toclist.sort_by(&:id)
     end
 
     # @api public
@@ -659,13 +664,23 @@ module Scrivito
     SYSTEM_KEYS = Set.new(%w[
       body
       _id
+      _created_at
       _last_changed
+      _first_published_at
+      _published_at
       _path
       _permalink
       _obj_class
       title
     ])
 
+    DATE_KEYS = Set.new(%w[
+      _created_at
+      _last_changed
+      _first_published_at
+      _published_at
+    ])
+
     # Returns the value of a system or custom attribute specified by its name.
     # Passing an invalid key will not raise an error but return +nil+.
     # @api public
@@ -704,11 +719,39 @@ module Scrivito
       }
     end
 
+    # @note If the custom attribute +created_at+ is defined, this value will be returned
+    #   instead of the system attribute +_created_at+. To access the system attribute
+    #   regardless of a custom attribute, call {#[] <code>obj[:_created_at]</code>}.
+    # @return [nil, ActiveSupport::TimeWithZone]
+    # @api public
+    def created_at
+      read_custom_or_system_attribute('created_at')
+    end
+
+    # @return [ActiveSupport::TimeWithZone]
     # @api public
     def last_changed
       read_attribute('_last_changed')
     end
 
+    # @note If the custom attribute +first_published_at+ is defined, this value will be returned
+    #   instead of the system attribute +_first_published_at+. To access the system attribute
+    #   regardless of a custom attribute, call {#[] <code>obj[:_first_published_at]</code>}.
+    # @return [nil, ActiveSupport::TimeWithZone]
+    # @api public
+    def first_published_at
+      read_custom_or_system_attribute('first_published_at')
+    end
+
+    # @note If the custom attribute +published_at+ is defined, this value will be returned
+    #   instead of the system attribute +_published_at+. To access the system attribute
+    #   regardless of a custom attribute, call {#[] <code>obj[:_published_at]</code>}.
+    # @return [nil, ActiveSupport::TimeWithZone]
+    # @api public
+    def published_at
+      read_custom_or_system_attribute('published_at')
+    end
+
     def new?(revision=workspace.base_revision)
       quick_modification(revision) == "new"
     end
@@ -991,15 +1034,16 @@ module Scrivito
     end
 
     def self.prepare_attributes_for_rest_api(attributes, obj = nil)
-      widget_pool_attributes, obj_attributes = CmsRestApi::WidgetExtractor.call(attributes, obj)
+      extraction = CmsRestApi::WidgetExtractor.call(attributes, obj)
+      obj_attributes = extraction.attributes
       obj_id = obj ? obj.id : obj_attributes.fetch(:_id)
       workspace = obj ? obj.revision.workspace : Workspace.current
 
       api_attributes = serialize_attributes(
-        obj_attributes, widget_pool_attributes, workspace, obj_id
+        obj_attributes, extraction.widget_pool_attributes, workspace, obj_id
       )
 
-      [api_attributes, widget_pool_attributes]
+      [extraction, api_attributes]
     end
 
     def self.find_attribute_definitions(obj_class, basic_class = self)
@@ -1025,7 +1069,7 @@ module Scrivito
 
     private_class_method def self.serialize_widget_pool_attributes(serializer, widget_pool_attributes)
       {}.tap do |serialized_attributes|
-        widget_pool_attributes.each_pair do |widget, widget_attributes|
+        widget_pool_attributes.each_value do |(widget, widget_attributes)|
           obj_class = widget_attributes['_obj_class']
           widget_serializer = AttributeSerializer.new(obj_class, serializer.obj_id)
 
@@ -1037,6 +1081,12 @@ module Scrivito
 
     private
 
+    def read_custom_or_system_attribute(attribute_name)
+      return read_attribute(attribute_name) if has_custom_attribute?(attribute_name)
+
+      read_attribute("_#{attribute_name}")
+    end
+
     def children_including_deleted
       workspace.objs.find_by_parent_path_including_deleted(path)
     end
@@ -1066,8 +1116,7 @@ module Scrivito
 
     def instantiate_widget(widget_id, widget_data)
       BasicWidget.instantiate(widget_data).tap do |widget|
-        widget.id = widget_id
-        widget.obj = self
+        widget.attach_to_obj(self, widget_id)
       end
     end
 
@@ -1151,7 +1200,7 @@ module Scrivito
 
     def value_of_system_attribute(attribute_name)
       attribute_value = data_from_cms.value_of(attribute_name)
-      if attribute_name == '_last_changed'
+      if DATE_KEYS.include?(attribute_name)
         DateConversion.deserialize_from_backend(attribute_value)
       else
         attribute_value

data/app/cms/scrivito/basic_widget.rb

@@ -95,8 +95,6 @@ class BasicWidget
 
   attr_accessor :container, :container_attribute_name
 
-  attr_writer :obj, :id
-
   attr_reader :attributes_to_be_saved
 
   delegate :widget_from_pool, to: :obj
@@ -221,12 +219,29 @@ class BasicWidget
     @attributes_to_be_saved.nil?
   end
 
+  def attach_to_obj(an_obj, widget_id = compute_widget_id(an_obj))
+    @obj = an_obj
+    @id = widget_id
+
+    attributes_to_be_saved
+  end
+
   def ==(other)
-    other.respond_to?(:obj) && obj == other.obj && other.respond_to?(:id) && id == other.id
+    eql?(other)
   end
 
   def eql?(other)
-    self == other
+    other.respond_to?(:equality_identifier, true) &&
+      equality_identifier.eql?(other.equality_identifier)
+  end
+
+  def hash
+    unless persisted?
+      # An unbound widget will likely be attached soon, which mutates its #hash value. Evil.
+      raise ScrivitoError, 'a new widget is not allowed to be used as a hash key'
+    end
+
+    equality_identifier.hash
   end
 
   #
@@ -262,7 +277,7 @@ class BasicWidget
           { obj: {_widget_pool: {id => previous_widget_content}} })
       reload
     else
-      raise ScrivitoError, "cannot revert changes, since widget is #{modification}."
+      raise ScrivitoError, "cannot revert changes, since widget is #{modification}"
     end
   end
 
@@ -297,14 +312,6 @@ class BasicWidget
     end
   end
 
-  def hash
-    if @obj && @id
-      (id + obj.id).hash
-    else
-      super
-    end
-  end
-
   # Returns the entity ({Scrivito::BasicObj} or {Scrivito::BasicWidget})
   # that references this widget.
   # @api public
@@ -360,7 +367,8 @@ class BasicWidget
     end
   end
 
-  def forget_unsaved_attributes
+  def notify_persisted(obj)
+    @obj = obj
     @attributes_to_be_saved = nil
     reload_data
   end
@@ -398,6 +406,12 @@ class BasicWidget
     referenced + referenced.map { |widget| widget.contained_widgets }.flatten
   end
 
+  protected
+
+  def equality_identifier
+    [id, obj.id]
+  end
+
   private
 
   def workspace
@@ -433,6 +447,14 @@ class BasicWidget
   def value_of_system_attribute(attribute_name)
     data_from_cms.value_of(attribute_name)
   end
+
+  def compute_widget_id(obj)
+    @attributes_to_be_saved.delete('_id') || generate_widget_id(obj)
+  end
+
+  def generate_widget_id(obj)
+    obj.present? ? obj.generate_widget_pool_id : BasicObj.generate_widget_pool_id
+  end
 end
 
 end

data/app/cms/scrivito/cms_backend.rb

@@ -206,7 +206,7 @@ module Scrivito
     private_class_method :blob_data_cache_key
 
     def self.search_params_cache_key(params)
-      MultiJson.encode(normalize_search_param(params))
+      JSON.generate(normalize_search_param(params))
     end
     private_class_method :search_params_cache_key
 

data/app/cms/scrivito/cms_field_tag.rb

@@ -67,7 +67,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
     if FIELD_TYPES_WITH_ORIGINAL_CONTENT.include?(field_type)
       original_value = view.scrivito_value(current_value)
       original_content = original_content(field_type, original_value, current_value)
-      encoded_content = Base64.strict_encode64(MultiJson.encode(original_content))
+      encoded_content = Base64.strict_encode64(JSON.generate(original_content))
       options['private-field-original-content'] = encoded_content
     end
 
@@ -161,7 +161,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
   end
 
   def valid_values
-    MultiJson.encode(obj_or_widget.attribute_definitions[field_name].try(:values) || [])
+    JSON.generate(obj_or_widget.attribute_definitions[field_name].try(:values) || [])
   end
 
   def assert_valid_attribute

data/app/cms/scrivito/cms_rest_api.rb

@@ -123,7 +123,7 @@ module Scrivito
       timer)
       request = method_to_net_http_class(method).new(path(resource_path))
       set_headers(request)
-      request.body = MultiJson.encode(payload) if payload.present?
+      request.body = JSON.generate(payload) if payload.present?
 
       response = retry_once_on_network_error(method, timer) do
         CmsRestApi::RateLimit.retry_on_rate_limit(timer) do
@@ -138,12 +138,12 @@ module Scrivito
     private_class_method def self.handle_response(resource_path, response)
       http_code = response.code.to_i
       if response.code.start_with?('2')
-        MultiJson.load(response.body)
+        JSON.parse(response.body)
       elsif response.code == '403'
         raise AccessDenied.new(response.body)
       else
         begin
-          error_body = MultiJson.decode(response.body)
+          error_body = JSON.parse(response.body)
           specific_output = error_body['error']
 
           if response.code.start_with?('4')
@@ -155,7 +155,7 @@ module Scrivito
           else # 3xx and >500 are treated as NetworkErrors
             raise NetworkError.new(response.body, http_code)
           end
-        rescue MultiJson::DecodeError
+        rescue JSON::ParserError, TypeError
           raise NetworkError.new(response.body, http_code)
         end
       end
@@ -170,6 +170,9 @@ module Scrivito
         message = task_data["message"] ||
           "Missing error message in task response #{task_data}"
 
+        if task_data['status'] == 'exception'
+          raise BackendError.new(message, 500)
+        end
         backend_code = task_data['code']
         raise ClientError.new(message, backend_code: backend_code)
       end

data/app/cms/scrivito/cms_rest_api/widget_extractor.rb

@@ -1,53 +1,68 @@
 module Scrivito
   class CmsRestApi
     class WidgetExtractor
-
       # Extract widgets from a given attribute tree
       # first return param: a flat hash of widget_like => updated widget attributes
       # second return param: the updated attributes
       def self.call(attributes, obj=nil)
+        new(obj).extract_widgets(attributes)
+      end
+
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def extract_widgets(attributes)
+        @extracted_widgets = {}
         updated_attributes = attributes.dup
-        extracted_widgets = {}
+        widget_pool = updated_attributes.delete(:_widget_pool)
+        extract_widgets_from_pool(widget_pool) if widget_pool
+        extract_widgets_from_attributes(updated_attributes)
 
-        (updated_attributes.delete(:_widget_pool) || {}).each do |widget, widget_properties|
-          unless widget.persisted?
-            raise ScrivitoError, 'new top-level widgets are not allowed in the _widget_pool'
-          end
-          extracted_widgets[widget] = widget_properties
-          extracted_widgets.merge!(call(widget_properties, obj).first)
+        Extraction.new(extracted_widgets, updated_attributes)
+      end
+
+      private
+
+      attr_reader :obj
+      attr_reader :extracted_widgets
+
+      def extract_widgets_from_pool(widget_pool)
+        widget_pool.each do |widget, widget_properties|
+          extracted_widgets[widget.id] = [widget, widget_properties]
+          extract_widgets_from_attributes(widget_properties)
         end
+      end
 
-        updated_attributes.each do |attribute_name, value|
+      def extract_widgets_from_attributes(attributes)
+        attributes.each do |attribute_name, value|
           if value.is_a?(Array) && value.all? { |w| w.is_a?(BasicWidget) }
             value.each do |widget|
               unless widget.persisted?
-                attach_widget_to_obj(widget, obj)
-                extracted_widgets[widget] = widget.attributes_to_be_saved
-                extracted_widgets.merge!(call(widget.attributes_to_be_saved, obj).first)
+                widget_attributes = widget.attach_to_obj(obj)
+                extracted_widgets[widget.id] = [widget, widget_attributes]
+                extract_widgets_from_attributes(widget_attributes)
               end
             end
           end
         end
-
-        return extracted_widgets, updated_attributes
       end
 
-      def self.attach_widget_to_obj(widget, obj)
-        widget.id = widget.attributes_to_be_saved.delete('_id') || generate_widget_pool_id(obj)
-        widget.obj = obj
-      end
+      class Extraction
+        attr_reader :widget_pool_attributes, :attributes
 
-      def self.notify_persisted_widgets(obj, widget_hash)
-        widget_hash.each do |widget, attributes|
-          if attributes.present?
-            widget.obj = obj
-            widget.forget_unsaved_attributes
-          end
+        def initialize(widget_pool_attributes, attributes)
+          @widget_pool_attributes = widget_pool_attributes
+          @attributes = attributes
         end
-      end
 
-      def self.generate_widget_pool_id(obj)
-        obj.presence ? obj.generate_widget_pool_id : BasicObj.generate_widget_pool_id
+        def notify_persisted(obj)
+          widget_pool_attributes.each_value do |(widget, attributes)|
+            if attributes.present?
+              widget.notify_persisted(obj)
+            end
+          end
+        end
       end
     end
   end