scrivito_sdk 0.65.2 → 0.66.0.rc1

data/lib/scrivito/backend/index.rb

@@ -23,6 +23,26 @@ module Index
     abstract_base_method
   end
 
+  def update(key, cached_result, change_index)
+    updated = Set.new(cached_result)
+
+    change_index.each do |id, data|
+      value = extract_update_value_from_data(data)
+
+      if value == key
+        updated.add(id)
+      else
+        updated.delete(id)
+      end
+    end
+
+    updated.to_a
+  end
+
+  def extract_update_value_from_data(data)
+    abstract_base_method
+  end
+
   def group_by(keys, obj_datas)
     return [obj_datas] if keys.length == 1
 

data/lib/scrivito/backend/obj_data_cache.rb

@@ -1,63 +1,189 @@
 module Scrivito
 module Backend
 
-class ObjDataCache < Struct.new(:workspace_id, :base)
+module ObjDataCache
+
+  # in the cache, missing objs (no obj exists with the given id) are
+  # represented as an empty hash to distinguish them from cache misses.
+  # nil => cache miss for given id
+  # {} => cache hit for given id, no obj with this id exists
+  NONEXISTENT_OBJ = {}
+
+  def self.convert_from_backend(obj_data)
+    if obj_data.blank? || obj_data["_deleted"]
+      ObjDataCache::NONEXISTENT_OBJ
+    else
+      obj_data
+    end
+  end
 
   def self.view_for_revision(revision)
-    cache = new(revision.workspace.id, revision.base)
-
-    cache.view_from(revision.content_state_node)
+    if revision.base
+      SimpleCacheView.new(revision.id)
+    else
+      view_for_workspace(revision.workspace.id, revision.content_state_node)
+    end
   end
 
-  def view_from(content_state_node)
-    CacheView.new(cache_id, content_state_node)
+  def self.view_for_workspace(workspace_id, content_state_node)
+      IncrementalCacheView.new(workspace_id, content_state_node)
   end
 
-  private
+  # builds a "change index", i.e. a hash mapping from `_id` to
+  # CmsDataCache-Tags that reference the data of the Obj
+  def self.changes_index_from(objs)
+    obj_ids = objs.map { |obj| obj["_id"] || obj["_deleted"] }
 
-  def cache_id
-    suffix = base ? "-B" : ""
-    "#{workspace_id}#{suffix}"
+    tags = objs.
+      map(&method(:convert_from_backend)).
+      map(&CmsDataCache.method(:write_data_to_tag))
+
+    Hash[obj_ids.zip(tags)]
   end
 
-  class CacheView < Struct.new(:cache_id, :viewed_state)
+
+  class SimpleCacheView < Struct.new(:cache_id)
+
+    def read_obj(id)
+      if tag = CmsDataCache.read_obj_data_rest(cache_id, "id", id)
+        CmsDataCache.read_data_from_tag(tag)
+      end
+    end
+
+    def write_obj(id, data)
+      write_cache("id", id, CmsDataCache.write_data_to_tag(data))
+    end
 
     def read_index(index, key)
+      index_access
+    end
+
+    def write_index(index, key, data)
+      index_access
+    end
+
+    private
+
+    def index_access
+      # SimpleCacheView is currently only used for base revision that do not
+      # support index queries.
+      raise InternalError
+    end
+
+    def write_cache(index, key, data)
+      raise InternalError unless data
+
+      CmsDataCache.write_obj_data_rest(cache_id, index, key, data)
+    end
+
+  end
+
+  class IncrementalCacheView < Struct.new(:cache_id, :viewed_state)
+
+    def read_index(index, key, &update_function)
       if hit = CmsDataCache.read_obj_data_rest(cache_id, index, key)
-        stored_at = hit.first
 
-        hit.second if viewed_state.content_state_id == stored_at
+        cached_at = hit.first
+        cached_result = hit.second
+
+        # if no update needed, just return
+        return cached_result if cached_at == viewed_state.content_state_id
+
+        updated_result = update_result(
+            key, cached_result, cached_at, &update_function)
+
+        return nil unless updated_result
+
+        if cached_at != csid_to_write_to
+          write_cache(index, key, updated_result)
+        end
+
+        updated_result
       end
     end
 
     def write_index(index, key, data)
-      CmsDataCache.write_obj_data_rest(
-          cache_id, index, key, [viewed_state.content_state_id, data])
+      write_cache(index, key, data)
     end
 
     def read_obj(id)
       if hit = CmsDataCache.read_obj_data_rest(cache_id, "id", id)
-        stored_at, data = hit
-
-        obj_in_changes = viewed_state.obj_from_changes(id, stored_at)
-
-        case obj_in_changes
-        when ContentStateNode::CACHE_MISS
-          # could not reconstruct all changes since `stored_at`
-          # so we don't know if data is still valid.
-          nil
-        when ContentStateNode::NOT_FOUND
-          # there were no relevant changes, so the data is still valid
-          data
-        else
-          # the changes revealed a newer version, return it instead
-          obj_in_changes
+        cached_at, cached_tag = hit
+
+        tag_in_changes = viewed_state.obj_from_changes(id, cached_at)
+
+        updated_tag =
+          case tag_in_changes
+          when ContentStateNode::CACHE_MISS
+            # could not reconstruct all changes since `cached_at`
+            # so we don't know if data is still valid.
+            nil
+          when ContentStateNode::NOT_FOUND
+            # there were no relevant changes, so the data is still valid
+            cached_tag
+          else
+            # the changes revealed a newer version, return it instead
+            tag_in_changes
+          end
+
+        return nil unless updated_tag
+
+        if cached_at != csid_to_write_to
+          write_cache("id", id, updated_tag)
         end
+
+        CmsDataCache.read_data_from_tag(updated_tag)
       end
     end
 
     def write_obj(id, data)
-      write_index("id", id, data)
+      write_obj_tag(id, CmsDataCache.write_data_to_tag(data))
+    end
+
+    def write_obj_tag(id, tag)
+      write_cache("id", id, tag)
+    end
+
+    private
+
+    def write_cache(index, key, data)
+      raise InternalError unless data
+
+      CmsDataCache.write_obj_data_rest(
+          cache_id, index, key, [csid_to_write_to, data])
+    end
+
+    # tries to update an outdated cache result using the changes recorded in the
+    # ContentStateNode history.
+    # returns `nil` (= cache-miss) if update is not possible.
+    def update_result(key, cached_result, cached_at, &update_function)
+      # if index does not support update, treat as cache-miss
+      return nil unless update_function
+
+      change_index = viewed_state.change_index_for(cached_at)
+
+      return nil if change_index == ContentStateNode::CACHE_MISS
+
+      expanded_index = expand_index(change_index)
+
+      # if the data of changed objs was evicted, treat as cache-miss
+      return nil if !expanded_index
+
+      update_function.call(key, cached_result, expanded_index)
+    end
+
+    # accepts a "change index" (id --> tag), looks up each
+    # tag in the cache and return an "expanded index" (id --> data).
+    # return `nil` if any tag cannot be found in the cache.
+    def expand_index(change_index)
+      # using "merge(self)" to map over a hash
+      change_index.merge(change_index) do |id, tag|
+        CmsDataCache.read_data_from_tag(tag) or return nil
+      end
+    end
+
+    def csid_to_write_to
+      viewed_state.next_stable_node.content_state_id
     end
 
   end

data/lib/scrivito/backend/obj_data_from_rest.rb

@@ -3,6 +3,7 @@ module Backend
 
 class ObjDataFromRest < ObjData
   def initialize(data)
+    raise InternalError unless Hash === data
     @data = data
   end
 

data/lib/scrivito/backend/obj_load.rb

@@ -20,12 +20,14 @@ class << self
       if missing_ids.blank?
         results_from_cache
       else
-        results_from_backend = revision.obj_mget_request(missing_ids)
+        raw_results = revision.obj_mget_request(missing_ids)
 
-        results_from_backend.each do |result|
-          if result
-            cache.write_obj(result["_id"], result)
-          end
+        results_from_backend = raw_results.map do |result|
+          ObjDataCache.convert_from_backend(result)
+        end
+
+        results_from_backend.each_with_index do |result, index|
+          cache.write_obj(missing_ids[index], result)
         end
 
         results_from_cache.map do |result|
@@ -34,7 +36,9 @@ class << self
       end
 
     overall_results.map do |raw_data|
-      Backend::ObjDataFromRest.new(raw_data) if raw_data
+      if raw_data != ObjDataCache::NONEXISTENT_OBJ
+        Backend::ObjDataFromRest.new(raw_data)
+      end
     end
   end
 

data/lib/scrivito/backend/obj_query.rb

@@ -8,8 +8,9 @@ class << self
     cache = Backend::ObjDataCache.view_for_revision(revision)
 
     missing_keys = []
+
     ids_from_cache = keys.map do |key|
-      result = cache.read_index(index.id, key)
+      result = cache.read_index(index.id, key, &index.method(:update))
 
       missing_keys << key unless result
 

data/lib/scrivito/backend/parent_path_index.rb

@@ -11,7 +11,11 @@ class << self
   end
 
   def query(keys)
-    [{:field => "_parent_path", :operator => :equals, :value => keys}]
+    [{ field: "_parent_path", operator: :equals, value: keys }]
+  end
+
+  def extract_update_value_from_data(data)
+    ParentPath.of(data["_path"])
   end
 
 end

data/lib/scrivito/backend/path_index.rb

@@ -11,7 +11,11 @@ class << self
   end
 
   def query(keys)
-    [{:field => "_path", :operator => :equals, :value => keys}]
+    [{ field: '_path', operator: :equals, value: keys }]
+  end
+
+  def extract_update_value_from_data(data)
+    data["_path"]
   end
 
   def group_by_multiple(paths, obj_datas)

data/lib/scrivito/backend/permalink_index.rb

@@ -1,17 +1,25 @@
 module Scrivito
 module Backend
-  class PermalinkIndex
-    class << self
-      include Backend::Index
 
-      def id
-        "permalink"
-      end
+module PermalinkIndex
+class << self
 
-      def query(keys)
-        [{ field: '_permalink', operator: :equals, value: keys }]
-      end
-    end
+  include Backend::Index
+
+  def id
+    "permalink"
+  end
+
+  def query(keys)
+    [{ field: '_permalink', operator: :equals, value: keys }]
+  end
+
+  def extract_update_value_from_data(data)
+    data["_permalink"]
   end
+
+end
+end
+
 end
 end

data/lib/scrivito/basic_obj.rb

@@ -97,7 +97,7 @@ module Scrivito
     #   Obj.create(:date => Time.new)
     #   Obj.create(:date => Date.now)
     #
-    # @example String, text, html and enum can be set by passing a {String} value
+    # @example String, html and enum can be set by passing a {String} value
     #   Obj.create(:title => "My Title")
     #
     # @example Arrays of {String Strings} allow you to set multi enum fields
@@ -185,13 +185,12 @@ module Scrivito
     # {ObjSearchEnumerator}s can be chained using one of the chainable methods
     # (e.g. {ObjSearchEnumerator#and} and {ObjSearchEnumerator#and_not}).
     #
-    # @example Look for the first 10 Objs whose ObjClass is "Pressrelease" and whose title contains "quarterly":
+    # @example Look for the first 10 Objs whose obj class is "Pressrelease" and whose title contains "quarterly":
     #   Obj.where(:_obj_class, :equals, 'Pressrelease').and(:title, :contains, 'quarterly').take(10)
     # @param [Symbol, String, Array<Symbol, String>] field See {ObjSearchEnumerator#and} for details
     # @param [Symbol, String] operator See {ObjSearchEnumerator#and} for details
     # @param [String, Array<String>] value See {ObjSearchEnumerator#and} for details
     # @param [Hash] boost See {ObjSearchEnumerator#and} for details
-    # @raise [ScrivitoError] if called on a subclass of +Obj+ with no corresponding {ObjClass}
     # @raise [ScrivitoError] if called directly on +BasicObj+. Use +Obj.where+ instead.
     # @return [ObjSearchEnumerator]
     # @api public
@@ -208,7 +207,6 @@ module Scrivito
     # Returns a {ObjSearchEnumerator} of all {Scrivito::BasicObj Obj}s.
     # If invoked on a subclass of Obj, the result will be restricted to instances of that subclass.
     # @return [ObjSearchEnumerator]
-    # @raise [ScrivitoError] if called on a subclass of +Obj+ with no corresponding {ObjClass}
     # @raise [ScrivitoError] if called directly on +BasicObj+. Use +Obj.all+ instead.
     # @api public
     def self.all
@@ -221,7 +219,7 @@ module Scrivito
     end
 
     # Returns a {ObjSearchEnumerator} of all Objs with the given +obj_class+.
-    # @param [String] obj_class Name of the ObjClass.
+    # @param [String] obj_class name of the obj class.
     # @return [ObjSearchEnumerator]
     # @api public
     def self.find_all_by_obj_class(obj_class)
@@ -280,30 +278,23 @@ module Scrivito
     #
     # Be aware that the given argument is a parent path.
     # E.g. when creating a page with path +/products/shoes+ then the argument will be +/products+.
+    # The given parent path can also be +NilClass+.
     #
     # If +NilClass+ is returned, then all possible classes will be available.
     # By default +NilClass+ is returned.
     #
-    # If +Array+ is returned, then it should include desired class names.
-    # Each class name must be either a +String+ or a +Symbol+.
-    # Only this class names will be available. Order of the class names will be preserved.
+    # If +Array+ is returned, then it should include the desired classes.
+    # Only this classes will be available. Order of the classes will be preserved.
     #
-    # @param [String] parent_path Path of the parent obj
-    # @return [NilClass, Array<Symbol, String>]
+    # @param [String, NilClass] parent_path Path of the parent obj
+    # @return [NilClass, Array<Class>]
     # @api public
     def self.valid_page_classes_beneath(parent_path)
     end
 
     def self.valid_page_ruby_classes_beneath(parent_path)
-      computed_classes = valid_page_classes_beneath(parent_path)
-
-      return Scrivito.models.pages.to_a unless computed_classes
-
-      convert_to_obj_classes(computed_classes, Obj.type_computer) do |class_name|
-        Rails.logger.warn(
-          "Invalid page class #{class_name} returned by #valid_page_classes_beneath."
-        )
-      end
+      assert_classes(valid_page_classes_beneath(parent_path), '.valid_page_classes_beneath') ||
+          Scrivito.models.pages.to_a
     end
 
     # Update the {Scrivito::BasicObj Obj} with the attributes provided.
@@ -432,7 +423,7 @@ module Scrivito
           'Try "bundle exec rake scrivito:migrate scrivito:migrate:publish".'
     end
 
-    # Returns the homepage obj. This can be overwritten in your application's +Obj+.
+    # Returns the homepage obj. This can be overridden in your application's +Obj+.
     # Use {#homepage?} to check if an obj is the homepage.
     # @return [Obj]
     # @api public
@@ -453,7 +444,7 @@ module Scrivito
     # This method determines the controller that should be invoked when the +Obj+ is requested.
     # By default a controller matching the Obj's obj_class will be used.
     # If the controller does not exist, the CmsController will be used as a fallback.
-    # Overwrite this method to force a different controller to be used.
+    # Override this method to force a different controller to be used.
     # @return [String]
     # @api public
     def controller_name
@@ -462,7 +453,7 @@ module Scrivito
 
     # This method determines the action that should be invoked when the +Obj+ is requested.
     # The default action is 'index'.
-    # Overwrite this method to force a different action to be used.
+    # Override this method to force a different action to be used.
     # @return [String]
     # @api public
     def controller_action_name
@@ -482,7 +473,7 @@ module Scrivito
     # The default is {http://apidock.com/rails/ActiveSupport/Inflector/parameterize parameterize}
     # on +obj.title+.
     #
-    # You can customize this part by overwriting {#slug}.
+    # You can customize this part by overriding {#slug}.
     # @return [String]
     # @api public
     def slug
@@ -491,7 +482,7 @@ module Scrivito
 
     #
     # This method determines the description that is shown in the UI
-    # and defaults to {Scrivito::BasicObj#display_title}. It can be overriden by a custom value.
+    # and defaults to {Scrivito::BasicObj#display_title}. It can be overridden by a custom value.
     #
     # @api public
     #
@@ -512,6 +503,18 @@ module Scrivito
       (binary_title || title).presence || self.class.description_for_editor
     end
 
+    # The alt description of an +Obj+ used for {ScrivitoHelper#scrivito_image_tag}.
+    #
+    # By default this method returns the +title+ of this +Obj+.
+    #
+    # You can customize this part by overriding {#alt_description}.
+    #
+    # @return [String]
+    # @api public
+    def alt_description
+      title
+    end
+
     # @api public
     def title
       read_attribute('title')
@@ -531,6 +534,23 @@ module Scrivito
       blob_attribute_definition.present? && blob_attribute_definition.type == 'binary'
     end
 
+    #
+    # When delivering binary Objs, this method decides whether the image transformations should be
+    # applied by default.
+    #
+    # @api beta
+    #
+    # By default this method returns +false+.
+    # Override in subclasses to fit your needs.
+    #
+    # @note Only relevant for binary Objs
+    # @see Scrivito::Configuration.default_image_transformation=
+    # @see Scrivito::Binary#transform
+    #
+    def apply_image_transformation?
+      false
+    end
+
     # Returns true if this object is the root object.
     # @api public
     def root?
@@ -802,7 +822,6 @@ module Scrivito
     #   Please use {Scrivito::BasicObj.restore Obj.restore} to restore them.
     #
     # @raise [ScrivitoError] If the current workspace is +published+.
-    # @raise [ScrivitoError] If the current workspace is the +rtc+ workspace.
     # @raise [ScrivitoError] If the +Obj+ is +new+.
     # @raise [ScrivitoError] If the +Obj+ is +deleted+.
     #
@@ -894,15 +913,25 @@ module Scrivito
     end
 
     def parent_path
-      unless root? || path.nil?
-        path.gsub(/\/[^\/]+$/, '').presence || '/'
-      end
+      ParentPath.of(path) unless root?
     end
 
     def as_client_json
       data_from_cms.to_h.except(*GENERATED_ATTRIBUTES)
     end
 
+    def outdated?
+      return false if workspace.published?
+
+      base_revision = workspace.base_revision
+      published_revision = Workspace.published.revision
+
+      return false if base_revision == published_revision
+      return true if has_conflict?
+
+      cms_data_for_revision(base_revision) != cms_data_for_revision(published_revision)
+    end
+
     private
 
     def cms_data_for_revision(revision)
@@ -1003,8 +1032,6 @@ module Scrivito
       # @api public
       #
       # @raise [ScrivitoError] If the current workspace is +published+.
-      # @raise [ScrivitoError] If the current workspace is the +rtc+ workspace.
-      #
       def restore(obj_id)
         Workspace.current.assert_revertable
         base_revision_path = "revisions/#{Workspace.current.base_revision_id}/objs/#{obj_id}"
@@ -1028,18 +1055,11 @@ module Scrivito
       end
 
       def serialize_attributes(obj_attributes, widget_pool_attributes, workspace)
-        if workspace.uses_obj_classes
-          serialized_attributes = CmsRestApi::LegacyAttributeSerializer.convert(obj_attributes)
-          serialized_attributes['_widget_pool'] = CmsRestApi::LegacyAttributeSerializer
-            .generate_widget_pool_changes(widget_pool_attributes)
-          serialized_attributes
-        else
-          serializer = AttributeSerializer.new(obj_attributes['_obj_class'] || name)
-          serialized_attributes = serialize_obj_attributes(serializer, obj_attributes)
-          serialized_attributes['_widget_pool'] =
-            serialize_widget_pool_attributes(serializer, widget_pool_attributes)
-          serialized_attributes
-        end
+        serializer = AttributeSerializer.new(obj_attributes['_obj_class'] || name)
+        serialized_attributes = serialize_obj_attributes(serializer, obj_attributes)
+        serialized_attributes['_widget_pool'] =
+          serialize_widget_pool_attributes(serializer, widget_pool_attributes)
+        serialized_attributes
       end
 
       def serialize_obj_attributes(serializer, obj_attributes)