scrivito_sdk 1.8.1 → 1.9.0.rc1

data/lib/generators/scrivito/install/templates/app/models/image.rb

@@ -1,9 +1,4 @@
 class Image < Obj
   attribute :blob, :binary
   attribute :tags, :stringlist
-
-  # activate image resizing and optimization
-  def apply_image_transformation?
-    true
-  end
 end

data/lib/scrivito/attribute_content.rb

@@ -4,7 +4,7 @@ module Scrivito
 # default values, restricting the types of widgets that may be added to a +widgetlist+
 # attribute, plus a couple of convenience methods.
 # @api public
-# @see http://scrivito.com/attribute-types Attributes and their type
+# @see https://scrivito.com/attribute-types Attributes and their type
 #
 module AttributeContent
   ATTRIBUTE_TYPES = %w[
@@ -128,7 +128,8 @@ module AttributeContent
   # @api public
   # @param [String] field_name Name of the widget attribute.
   # @return [nil, Array<Class>]
-  # @see http://scrivito.com/limiting-widget-and-page-types Limiting available widget and page types
+  # @see
+  #   https://scrivito.com/limiting-widget-and-page-types Limiting available widget and page types
   #
   def valid_widget_classes_for(field_name)
   end
@@ -451,7 +452,7 @@ module AttributeContent
     #   ImageWidget.attribute_definitions[:my_reference2].valid_classes
     #   #=> [Image, Video]
     #
-    # @see http://scrivito.com/default-attribute-values Specifying default attribute values
+    # @see https://scrivito.com/default-attribute-values Specifying default attribute values
     #
     def attribute(name, type, options = {})
       name, type, options = name.to_s, type.to_s, options
@@ -562,7 +563,7 @@ module AttributeContent
     #   my_page = MyPage.create({_path: '/en/test'}, bob)
     #   my_page.title # => 'Hier den Titel eingeben'
     #
-    # @see http://scrivito.com/default-attribute-values Specifying default attribute values
+    # @see https://scrivito.com/default-attribute-values Specifying default attribute values
     #
     def default_for(attribute_name, &block)
       attribute_name = attribute_name.to_s

data/lib/scrivito/base_widget_tag.rb

@@ -23,6 +23,7 @@ class BaseWidgetTag < Struct.new(
     options = {}
 
     if inplace_editing_allowed?
+      options['private-widget'] = true
       options['private-widget-id'] = widget.id
       options['widget-obj-class'] = widget.obj_class
       options['private-widget-description-for-editor'] = description_for_editor

data/lib/scrivito/basic_obj.rb

@@ -16,7 +16,7 @@ module Scrivito
   # @note Please do not use {Scrivito::BasicObj} directly
   #   as it is intended as an abstract class.
   #   Always use {Obj} or a subclass of {Obj}.
-  # @see http://scrivito.com/objects-widgets-classes CMS objects, widgets, and classes
+  # @see https://scrivito.com/objects-widgets-classes CMS objects, widgets, and classes
   # @api public
   #
   class BasicObj
@@ -581,21 +581,13 @@ module Scrivito
       blob_attribute_definition.present? && blob_attribute_definition.type == 'binary'
     end
 
-    #
-    # When delivering binary objects, this method decides whether the image transformations should
-    # be applied by default.
     #
     # @api public
-    #
-    # By default, this method returns +false+.
-    # Override it in subclasses to fit your needs.
-    #
-    # @note Only relevant for binary objects
-    # @see Scrivito::Configuration.default_image_transformation=
-    # @see Scrivito::Binary#transform
+    # @deprecated Has no effect anymore: Image transformation will be applied if possible.
     #
     def apply_image_transformation?
-      false
+      Scrivito::Deprecation.warn(
+        'Scrivito::BasicObj#apply_image_transformation? is deprecated and has no effect anymore.')
     end
 
     # Returns true if this Obj is the root Obj.
@@ -623,11 +615,11 @@ module Scrivito
     #
     # @return [Array<Obj>]
     def sorted_toclist
-      if sortable_toclist?
-        (child_order & toclist) + (toclist - child_order).sort_by(&:id)
-      else
-        toclist
-      end
+      sort_toclist(toclist)
+    end
+
+    def sorted_toclist_including_deleted
+      sort_toclist(children_including_deleted.reject(&:binary?))
     end
 
     def sortable_toclist?
@@ -908,30 +900,6 @@ module Scrivito
       end
     end
 
-    def restore_widget(widget_id)
-      Workspace.current.assert_revertable
-
-      return if modification == Modification::UNMODIFIED
-      if modification == Modification::DELETED
-        raise ScrivitoError, 'Can not restore a widget inside a deleted obj'
-      end
-
-      unless widget = in_revision(Workspace.current.base_revision).widgets[widget_id]
-        raise ResourceNotFound, "Could not find widget with id #{widget_id}"
-      end
-
-      container = widget.container
-      if container.kind_of?(BasicWidget) && !widgets[container.id]
-        raise ScrivitoError, 'Can not restore a widget inside a deleted widget'
-      end
-
-      widget_copy = widget.copy_for_restore(read_widget_pool.keys)
-      attribute_name = widget.container_attribute_name
-      current_container = widgets[container.id] || self
-      current_container.update(attribute_name =>
-        current_container[attribute_name].insert(widget.container_attribute_index, widget_copy))
-    end
-
     def mark_resolved
       workspace.api_request(:put, "/objs/#{id}", obj: {_conflicts: nil})
       reload
@@ -995,6 +963,18 @@ module Scrivito
 
     private
 
+    def children_including_deleted
+      workspace.objs.find_by_parent_path_including_deleted(path)
+    end
+
+    def sort_toclist(unsorted_toclist)
+      if sortable_toclist?
+        (child_order & unsorted_toclist) + (unsorted_toclist - child_order).sort_by(&:id)
+      else
+        unsorted_toclist
+      end
+    end
+
     def cms_data_for_revision(revision)
       return nil unless revision
 

data/lib/scrivito/basic_widget.rb

@@ -4,7 +4,7 @@ module Scrivito
 # of content editors want to place on pages or into widgets. All widget classes are based on
 # subclasses of {Scrivito::BasicWidget Widget}. As with CMS objects, the content of a widget
 # is stored in its attributes.
-# @see http://scrivito.com/page-with-widgets Creating a page type with widgets
+# @see https://scrivito.com/page-with-widgets Creating a page type with widgets
 # @api public
 class BasicWidget
   extend AttributeContent::ClassMethods
@@ -204,22 +204,6 @@ class BasicWidget
     self.class.new(attributes)
   end
 
-  def copy_for_restore(referenced_ids)
-    attributes = {}
-    attribute_definitions.each do |attribute_definition|
-      attribute_name = attribute_definition.name
-      attribute_value = read_attribute(attribute_name)
-      if attribute_definition.widgetlist?
-        attribute_value = attribute_value
-          .reject { |widget| referenced_ids.include?(widget.id) }
-          .map { |widget| widget.copy_for_restore(referenced_ids) }
-      end
-      attributes[attribute_name] = attribute_value
-    end
-    attributes['_id'] = id
-    self.class.new(attributes)
-  end
-
   def clone
     raise "The method `clone' was removed. Please use `copy' instead"
   end
@@ -347,10 +331,6 @@ class BasicWidget
     container_attribute_name
   end
 
-  def container_attribute_index
-    container[container_attribute_name].index(self)
-  end
-
   def has_attribute?(key)
     key.to_s == '_obj_class' || super
   end

data/lib/scrivito/binary.rb

@@ -283,13 +283,6 @@ class Binary
   # Otherwise +self+.
   #
   # @return [Scrivito::Binary] original binary
-  #
-  # @example
-  #   @obj.blob.id # => "abc123"
-  #   @obj.blob.original.id # => "abc123"
-  #   @obj.blob.transform(width: 50).original.id # => "abc123"
-  #   @obj.blob.transform(width: 50).transform(height: 50).original.id # => "abc123"
-  #
   def original
     @original || self
   end

data/lib/scrivito/binary_routing.rb

@@ -9,13 +9,13 @@ class BinaryRouting < Struct.new(:request, :scrivito_engine)
     binary = if image_options.key?(:transform)
       apply_custom_transformation(binary, image_options[:transform])
     else
-      apply_default_transformation(binary, obj)
+      apply_default_transformation(binary)
     end
     binary_url(binary)
   end
 
   def resolved_binary_obj_url(obj, binary)
-    apply_default_transformation(binary, obj).url
+    BinaryRewrite.call(request, apply_default_transformation(binary).url)
   end
 
   private
@@ -39,10 +39,9 @@ class BinaryRouting < Struct.new(:request, :scrivito_engine)
     end
   end
 
-  def apply_default_transformation(binary, obj)
-    if (transformation_definition = Scrivito::Configuration.default_image_transformation) &&
-        obj.apply_image_transformation?
-      binary.transform(transformation_definition)
+  def apply_default_transformation(binary)
+    if Scrivito::Configuration.default_image_transformation
+      binary.transform(Scrivito::Configuration.default_image_transformation)
     else
       binary
     end

data/lib/scrivito/child_list_tag.rb

@@ -37,8 +37,15 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
   def content(&block)
     return unless block_given?
 
+    toclist =
+      if EditingContextMiddleware.from_request(view.request).include_deleted_objs?
+        obj.sorted_toclist_including_deleted
+      else
+        obj.sorted_toclist
+      end
+
     is_sortable = obj.sortable_toclist? && user_present?
-    rendered_children = obj.sorted_toclist.map do |child|
+    rendered_children = toclist.map do |child|
       obj_tag = ObjTag.new(child, is_sortable, comparison.modification(child), view)
       yield obj_tag, child
       obj_tag.rendered

data/lib/scrivito/cms_env.rb

@@ -28,8 +28,12 @@ module Scrivito
 
     def find_obj
       found_obj =
-        if params[:id]
-          Obj.find(params[:id])
+        if id = params[:id]
+          if EditingContextMiddleware.from_env(env).include_deleted_objs?
+            Obj.find_including_deleted(id)
+          else
+            Obj.find(id)
+          end
         elsif params[:permalink].present?
           permalink =  Array(params[:permalink]).join("/")
           Obj.find_by_permalink!(permalink)

data/lib/scrivito/cms_field_tag.rb

@@ -149,6 +149,8 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
     if %w[
       binary
       date
+      enum
+      multienum
       reference
       referencelist
     ].include?(field_type)

data/lib/scrivito/cms_routing.rb

@@ -76,21 +76,33 @@ class CmsRouting < Struct.new(:request, :context, :scrivito_engine, :image_optio
   end
 
   def path_or_url_for_objs(obj, path_or_url, options)
-    permalink = obj.permalink
-    if permalink && (route = find_route(:permalink)) && permalink.split('/').first != 'scrivito'
-      route.generate(path_or_url, options.merge(:permalink => permalink))
-    elsif homepage?(obj) && route = find_route(:homepage)
-      route.generate(path_or_url, options)
-    elsif obj.binary?
-      binary_obj_url(obj) || LINK_TO_EMPTY_BLOB
-    elsif route = find_route(:slug_id)
+    if permalink_route_applicable?(obj) && route = find_route(:permalink)
+      return route.generate(path_or_url, options.merge(permalink: obj.permalink))
+    end
+
+    if homepage?(obj) && route = find_route(:homepage)
+      return route.generate(path_or_url, options)
+    end
+
+    if obj.binary?
+      return binary_obj_url(obj) || LINK_TO_EMPTY_BLOB
+    end
+
+    if route = find_route(:slug_id)
       slug = obj.slug.present? ? obj.slug.sub(/^\//, '') : nil
-      route.generate(path_or_url, options.merge(id: obj.id, slug: slug))
-    else
-      raise ScrivitoError, "The required scrivito route 'slug_id' is not defined. "\
-        "Please add a 'slug_id' definition to your routes.rb. See the documentation"\
-        " of 'scrivito_route' for further details."
+
+      return route.generate(path_or_url, options.merge(id: obj.id, slug: slug))
     end
+
+    raise ScrivitoError, "The required scrivito route 'slug_id' is not defined. "\
+      "Please add a 'slug_id' definition to your routes.rb. See the documentation"\
+      " of 'scrivito_route' for further details."
+  end
+
+  def permalink_route_applicable?(obj)
+    permalink = obj.permalink
+
+    permalink && permalink.split('/').first != 'scrivito' && !obj.deleted?
   end
 
   def find_route(name)

data/lib/scrivito/configuration.rb

@@ -323,9 +323,7 @@ Please use the new scrivito_route api to replicate the legacy routes:
       #
       # @api public
       #
-      # When delivering binary Objs, the default image transformation will be applied if
-      # {Scrivito::BasicObj#apply_image_transformation? Obj#apply_image_transformation?} returns
-      # +true+.
+      # When delivering binary Objs, the default image transformation will be applied.
       #
       # If not changed the default image transformation is an empty transformation (an empty
       # +Hash+). Set it to +false+ to disabled the default image transformation completely.
@@ -333,7 +331,6 @@ Please use the new scrivito_route api to replicate the legacy routes:
       # @param [Hash] value the {Scrivito::Binary#transform transformation definition}
       #
       # @see Scrivito::Binary#transform
-      # @see Scrivito::BasicObj#apply_image_transformation?
       #
       attr_writer :default_image_transformation
 

data/lib/scrivito/disable_browser_cache_for_ui_middleware.rb

@@ -0,0 +1,19 @@
+module Scrivito
+class DisableBrowserCacheForUiMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    status, headers, response = @app.call(env)
+
+    editing_context = EditingContextMiddleware.from_env(env)
+
+    if editing_context.authenticated_editor?
+      headers['Cache-Control'] = 'no-store, must-revalidate'
+    end
+
+    [status, headers, response]
+  end
+end
+end

data/lib/scrivito/editing_context.rb

@@ -80,6 +80,10 @@ class EditingContext
     display_mode == 'editing'
   end
 
+  def include_deleted_objs?
+    display_mode == 'diff'
+  end
+
   def to_params
     {
       _scrivito_display_mode: display_mode,

data/lib/scrivito/editing_context_middleware.rb

@@ -6,7 +6,11 @@ class EditingContextMiddleware
   ENVKEY = 'SCRIVITO_EDITING_CONTEXT'
 
   def self.from_request(request)
-    request.env[ENVKEY] || EditingContext.new
+    from_env(request.env)
+  end
+
+  def self.from_env(env)
+    env[ENVKEY] || EditingContext.new
   end
 
   def initialize(app)

data/lib/scrivito/obj_collection.rb

@@ -102,6 +102,10 @@ module Scrivito
       find_by(:ppath, [path]).first
     end
 
+    def find_by_parent_path_including_deleted(path)
+      find_by_including_deleted(:ppath, [path]).first
+    end
+
     def find_by_id(id)
       find_by(:id, [id]).first.first
     end

data/lib/scrivito/page_config.rb

@@ -41,7 +41,7 @@ class PageConfig < Struct.new(:obj, :editing_context, :lookup_context)
       has_details_view: obj_has_details_view?,
       modification: modification(obj),
       parent_path: obj.parent_path,
-      restriction_messages: editor.restriction_messages_for(obj),
+      is_restricted: editor.restriction_messages_for(obj).any?,
     }
   end
 

data/lib/scrivito/preset_routes.rb

@@ -13,7 +13,7 @@ module Scrivito
             scrivito_route '(/)(*slug-):id', using: "slug_id", via: :all
 
             match ':id(/*slug)', to: 'scrivito/legacy_redirect#index', via: :all, constraints: {
-              id: /[a-z0-9]{16}/
+              id: /[a-f0-9]{16}/
             }
           end
 

data/lib/scrivito/revision.rb

@@ -40,7 +40,7 @@ class Revision < Struct.new(:id, :workspace, :base)
   def internal_obj_search(query, result, continuation=nil, tentative=false)
     response = workspace.api_request(:get, "/objs/search",
       query: query,
-      include_deleted: true,
+      options: {include_deleted: true},
       size: 100,
       continuation: continuation,
       consistent_with: content_state_id

data/lib/scrivito/sdk_engine.rb

@@ -69,6 +69,7 @@ module ::Scrivito
     config.app_middleware.use Scrivito::EditingContextMiddleware
     config.app_middleware.use Scrivito::CacheMiddleware
     config.app_middleware.use Scrivito::WorkspaceSelectionMiddleware
+    config.app_middleware.use Scrivito::DisableBrowserCacheForUiMiddleware
   end
 end
 

data/lib/scrivito/ui_config.rb

@@ -9,59 +9,33 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
   def to_json
     {
       app_extension_tags:  app_extension_tags,
-      editing_context:     editing_context_config,
       backend_endpoint:    Configuration.endpoint,
       tenant:              Configuration.tenant,
       i18n:                i18n_config,
       is_development_mode: Rails.env.development?,
       resource_dialog:     resource_dialog_config,
-      revision:            revision_config,
       user:                user_config,
       user_permissions:    user_permissions_config,
-      obj_class:           obj_class_config,
-      widget_class:        widget_class_config,
+      class_datas:         obj_class_config + widget_class_config,
+      useRailsEngine:      true,
     }.to_json
   end
 
   private
 
-  def editing_context_config
-    {
-      display_mode:       editing_context.display_mode,
-      selected_workspace: workspace_config(selected_workspace),
-      visible_workspace:  workspace_config(visible_workspace),
-    }
-  end
-
-  def workspace_config(workspace)
-    {
-      id: workspace.id,
-      memberships: workspace.memberships.map do |membership|
-        {
-          user_id: membership.user_id,
-          role: membership.role,
-          description: membership.user.description
-        }
-      end,
-      outdated: workspace.outdated?,
-      auto_update: workspace.auto_update?,
-      title: workspace.title,
-    }
-  end
-
   def i18n_config
     {locale: Scrivito::Configuration.ui_locale || I18n.locale}
   end
 
   def obj_class_config
     obj_models.map do |obj_class|
-      obj_class.as_json.merge(hasDetailsView: details_view?(obj_class.name))
+      obj_class_formatter.format(obj_class)
     end
   end
 
   def widget_class_config
     widget_models.map do |widget_class|
-      widget_class.as_json.merge(hasDetailsView: details_view?(widget_class.name))
+      obj_class_formatter.format(widget_class)
     end
   end
 
@@ -90,10 +64,6 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     }
   end
 
-  def revision_config
-    {published_revision_id: Workspace.published.revision_id}
-  end
-
   def editor
     editing_context.editor
   end
@@ -102,14 +72,8 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     editing_context.selected_workspace
   end
 
-  def visible_workspace
-    editing_context.visible_workspace
-  end
-
-  def details_view?(obj_class_name)
-    lookup_context.find("#{obj_class_name.underscore}/details").present?
-  rescue ActionView::MissingTemplate
-    false
+  def obj_class_formatter
+    @obj_class_formatter ||= UiObjClassesJsonFormatter.new(lookup_context)
   end
 end
 

data/lib/scrivito/ui_obj_classes_json_formatter.rb

@@ -0,0 +1,48 @@
+module Scrivito
+  class UiObjClassesJsonFormatter < Struct.new(:lookup_context)
+    def format(obj_class)
+      data = base_obj_class_data(obj_class)
+      if obj_class.ancestors.include?(Scrivito::BasicWidget)
+        data[:embeds] = obj_class.embeds?
+        data[:embeddingAttribute] =
+          obj_class.embeds? ? obj_class.embedding_attribute.name.camelcase(:lower) : nil
+
+        data[:validContainerClasses] = convert_classes_array(obj_class.valid_container_classes)
+      end
+
+      data[:hasServerDetailsTemplate] = details_view?(obj_class.name)
+      data
+    end
+
+    private
+
+    def base_obj_class_data(obj_class)
+      {
+        name: obj_class.name,
+        type: obj_class.ancestors.include?(Scrivito::BasicWidget) ? 'Widget' : 'Obj',
+        title: obj_class.description_for_editor,
+        attributes: obj_class.attribute_definitions.map { |attr| convert_attribute(attr) },
+        usesServerCallbacks: true,
+        hideFromEditor: obj_class.hide_from_editor?,
+      }
+    end
+
+    def convert_attribute(attribute)
+      attribute_json = attribute.as_json
+      attribute_json[:name] = attribute_json[:name].camelcase(:lower)
+      attribute_json
+    end
+
+    def details_view?(obj_class_name)
+      lookup_context.find("#{obj_class_name.underscore}/details").present?
+    rescue ActionView::MissingTemplate
+      false
+    end
+
+    def convert_classes_array(arr)
+      if arr
+        arr.map(&:name)
+      end
+    end
+  end
+end

data/lib/scrivito/user.rb

@@ -26,6 +26,9 @@ module Scrivito
 
       # Permits the user to publish the working copy.
       :publish,
+
+      # Permits the user to access the publishing history
+      :read_history,
     ].freeze
 
     class << self

data/lib/scrivito/user_definition.rb

@@ -18,7 +18,7 @@ module Scrivito
     #   perform a specific action. This method lets you add an exception to this logic and thus
     #   should be used carefully.
     # @note By default, all users are allowed to create a new workspace.
-    # @see http://scrivito.com/user-permissions Defining users and their permissions
+    # @see https://scrivito.com/user-permissions Defining users and their permissions
     #
     # @param [Symbol] verb the verb of the action (see {Scrivito::User::VERBS}).
     # @param [Symbol] subject the subject of the action. Currently, only +:workspace+ is supported.

data/lib/scrivito/workspace.rb

@@ -6,7 +6,7 @@ module Scrivito
 # This class represents a CMS workspace, called "working copy" in the UI. A working copy lets
 # editors create and modify content independently of the published content or other working copies.
 # On creation, a working copy is based on the currently published content.
-# @see http://scrivito.com/about-working-copies About working copies
+# @see https://scrivito.com/about-working-copies About working copies
 
 class Workspace
   extend ActiveModel::Naming