scrivito_sdk 0.65.2 → 0.66.0.rc1

data/lib/scrivito/editing_context_middleware.rb

@@ -28,10 +28,15 @@ class EditingContextMiddleware
         header_params['workspace_id'] ||
         cookie_params['workspace_id']
 
+    if cookie_params['workspace_id']
+      workspace_changed = workspace_id != cookie_params['workspace_id']
+    end
+
     env[ENVKEY] = EditingContext.new(
       display_mode: display_mode,
       editor: editor_proc(env),
-      selected_workspace_id: workspace_id
+      selected_workspace_id: workspace_id,
+      workspace_changed: workspace_changed
     )
 
     @app.call(env)

data/lib/scrivito/errors.rb

@@ -17,4 +17,22 @@ end
 class InternalError < ScrivitoError
 end
 
+# @api beta
+class TransformationError < ScrivitoError
+  attr_reader :code
+
+  def initialize(message, code)
+    @code = code
+    super(message)
+  end
+end
+
+# @api beta
+class TransformationSourceError < TransformationError
+end
+
+# @api beta
+class TransformationDefinitionError < TransformationError
+end
+
 end # module Scrivito

data/lib/scrivito/image_tag.rb

@@ -0,0 +1,55 @@
+module Scrivito
+
+class ImageTag < Struct.new(:view_context)
+  def options(obj, attribute_name, tag_options, editing_options)
+    tag_options.reverse_merge(
+      src: src(obj, attribute_name, editing_options),
+      alt: alt(obj, attribute_name)
+    )
+  end
+
+  private
+
+  def src(obj, attribute_name, editing_options)
+    path(obj, attribute_name, editing_options) ||
+      editing_options[:placeholder] ||
+      view_context.image_path('scrivito/image_placeholder.png')
+  end
+
+  def alt(obj, attribute_name)
+    case target = obj[attribute_name]
+    when Binary then obj.try(:alt_description)
+    when Enumerable then target.first.try(:alt_description)
+    else target.try(:alt_description)
+    end
+  end
+
+  def path(obj, attribute_name, editing_options)
+    if target = target(obj, attribute_name, editing_options)
+      image_options = editing_options.slice(:transform)
+      cms_routing = CmsRouting.new(request, main_app, scrivito_engine, image_options)
+      cms_routing.path_or_url(target, :path)
+    end
+  end
+
+  def target(obj, attribute_name, editing_options)
+    target = obj[attribute_name]
+    target = link_target(target) if target.is_a?(Link)
+    target = linklist_target(target) if target.is_a?(Enumerable)
+    target
+  end
+
+  def link_target(link)
+    link.internal? ? link.obj : link
+  end
+
+  def linklist_target(linklist)
+    if linklist.any?
+      link_target(linklist.first)
+    end
+  end
+
+  delegate :request, :main_app, :scrivito_engine, to: :view_context
+end
+
+end

data/lib/scrivito/link.rb

@@ -135,6 +135,18 @@ module Scrivito
       dt
     end
 
+    # The alt description of a +Link+ used for {ScrivitoHelper#scrivito_image_tag}.
+    #
+    # By default this method returns the +title+ of this +Link+.
+    # If +title+ is nil and this +Link+ references an {BasicObj Obj}
+    # +alt_description+ of that {BasicObj Obj} is used.
+    #
+    # @api public
+    def alt_description
+      return title if title
+      obj.alt_description if internal?
+    end
+
     # Returns true this Link links to a CMS Object.
     # @api public
     def internal?

data/lib/scrivito/membership_collection.rb

@@ -10,7 +10,7 @@ module Scrivito
 
     # @api public
     # @!method each
-    # Iterate over all {Membership Memberships} of a specfic {Workspace}. Allows
+    # Iterate over all {Membership Memberships} of a specific {Workspace}. Allows
     # you to use all methods defined by ruby's Enumerable module.
     #
     # @yield [Membership]
@@ -18,7 +18,7 @@ module Scrivito
     # @return [Enumerator] if no block is given an Enumerator is returned
     #
     # @example
-    #   # Optain all owners of a workspace
+    #   # Obtain all owners of a workspace
     #   my_workspace.memberships.select do |membership|
     #     membership.role == "owner"
     #   end
@@ -71,6 +71,7 @@ module Scrivito
     private
 
     def memberships
+      return [] if workspace.published?
       @memberships ||= begin
         workspace.data.memberships.map do |id, data|
           Membership.new(id, data)

data/lib/scrivito/migrations/cms_backend.rb

@@ -10,25 +10,18 @@ module Scrivito
       end
 
       def save(value)
-        if Workspace.current.uses_obj_classes
-          CmsRestApi.put(endpoint("objs/#{migration_store_obj.id}"), obj: {versions: value})
-        else
-          CmsRestApi.put(endpoint("objs/#{migration_store_obj.id}"),
-            obj: {versions: ['string', value]})
-        end
+        CmsRestApi.put(endpoint("objs/#{migration_store_obj.id}"),
+          obj: {versions: ['string', value]})
+
         Workspace.current.reload
       end
 
       private
 
       def create
-        if Workspace.current.uses_obj_classes
-          CmsRestApi.post(endpoint('objs'),
-            obj: {_path: path, _obj_class: 'MigrationStore', versions: ''})
-        else
-          CmsRestApi.post(endpoint('objs'),
-            obj: {_path: path, _obj_class: 'MigrationStore', versions: ['string', '']})
-        end
+        CmsRestApi.post(endpoint('objs'),
+          obj: {_path: path, _obj_class: 'MigrationStore', versions: ['string', '']})
+
         Workspace.current.reload
       end
 

data/lib/scrivito/migrations/migrator.rb

@@ -69,33 +69,12 @@ module Scrivito
       private
 
       def workspace
-        workspace = migration_workspace
-
-        if workspace
-          if workspace_lock.exists?
-            workspace_lock.validate(workspace)
-          end
-        else
-          workspace = Workspace.create(title: 'Migration Working Copy', id: 'rtc')
-          workspace_lock.write(workspace)
-        end
-
-        workspace
-      end
-
-      def migration_workspace
-        Workspace.find('rtc')
-      rescue ResourceNotFound
+        @workspace = workspace_lock.get
       end
 
       def remove_workspace_with(&block)
-        workspace = migration_workspace
-
-        if workspace
-          workspace_lock.validate(workspace)
-
+        if workspace_lock.exists?
           yield
-
           workspace_lock.remove
         else
           raise ScrivitoError.new('Migration workspace does not exist')

data/lib/scrivito/migrations/workspace_lock.rb

@@ -5,17 +5,15 @@ module Scrivito
     class WorkspaceLock
       include Singleton
 
-      def validate(workspace)
-        unless exists? && workspace.revision_id == File.read(filename)
-          raise ScrivitoError.new("There is a migration in progress right now. \
-            Please try again after the migration working copy '#{workspace.id}' has \
-            been published or removed.")
-        end
-      end
-
-      def write(workspace)
-        File.open(filename, 'w') do |file|
-          file.write(workspace.revision_id)
+      def get
+        if exists?
+          begin
+            Workspace.find(workspace_id)
+          rescue Scrivito::ResourceNotFound
+            create_workspace
+          end
+        else
+          create_workspace
         end
       end
 
@@ -31,6 +29,20 @@ module Scrivito
 
       private
 
+      def create_workspace
+        Workspace.create(title: 'Migration Working Copy').tap do |workspace|
+          write(workspace)
+        end
+      end
+
+      def write(workspace)
+        File.write(filename, workspace.id)
+      end
+
+      def workspace_id
+        File.read(filename)
+      end
+
       def filename
         File.join(Rails.root, 'tmp/migration_store.lock')
       end

data/lib/scrivito/named_link.rb

@@ -11,7 +11,7 @@ module Scrivito
 
     # This method will be called to retrieve the NamedLink {BasicObj Obj}.
     # By default it will look for the Obj at the path "_named_links".
-    # Overwrite this method only if you know what you are doing.
+    # Override this method only if you know what you are doing.
     # @api public
     def self.find_named_link_obj
       BasicObj.find_by_path("/_named_links")

data/lib/scrivito/obj_collection.rb

@@ -70,7 +70,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 find_all_by_obj_class(obj_class)

data/lib/scrivito/obj_data_from_service.rb

@@ -19,13 +19,6 @@ module Scrivito
     def convert_value(value, type)
       case type
       when 'html' then convert_text_links(value)
-      when 'widget'
-        if value.is_a?(Hash) && value.size == 1 && value.has_key?('list')
-          # Legacy data with obj classes.
-          value['list'].map { |item| item['widget'] }
-        else
-          value
-        end
       else value
       end
     end

data/lib/scrivito/obj_search_enumerator.rb

@@ -4,7 +4,7 @@ module Scrivito
   # This is done using the {http://ruby-doc.org/core-2.1.3/Enumerable.html <code>Enumerable</code> mixin},
   # which provides methods such as <code>map</code>, <code>select</code> or <code>take</code>.
   #
-  # This enumerator is lazy. If for example you are looking for {BasicObj Obj}s with the ObjClass "Publication",
+  # This enumerator is lazy. If for example you are looking for {BasicObj Obj}s with the obj class "Publication",
   # and there are 93 objs in total, than <code>enum.take(10)</code> will fetch the first 10 objs only,
   # ignoring the other 83 objs.
   # This also means, that iterating multiple times over this enumerator causes the search results and objs to be fetched again.
@@ -22,7 +22,7 @@ module Scrivito
   # [+:title+]          Title of an {BasicObj Obj}. This is a +string+ field.
   # [+:body+]           Body of an {BasicObj Obj}. This is an +html+ field. Thus, only the +contains+ and
   #                     +contains_prefix+ operators can be applied to this field.
-  # [+:_obj_class+]     ObjClass of an {BasicObj Obj}. This is a +string+ field.
+  # [+:_obj_class+]     obj class of an {BasicObj Obj}. This is a +string+ field.
   # [+:_permalink+]     Permalink of an {BasicObj Obj}. This is a +string+ field.
   # [+:_last_changed+]  Date of last change of an {BasicObj Obj}.
   # [every <em><code>:custom_attribute</code></em>] Custom attribute of an {BasicObj Obj}. Note that

data/lib/scrivito/parent_path.rb

@@ -0,0 +1,9 @@
+module Scrivito
+  class ParentPath
+    def self.of(path)
+      return if path.nil?
+      return if path == '/'
+      path.gsub(/\/[^\/]+$/, '').presence || '/'
+    end
+  end
+end

data/lib/scrivito/routing_helper.rb

@@ -20,7 +20,7 @@ module Scrivito
     # @return [String]
     #
     def scrivito_path(target, options = {})
-      CmsRouting.new(request, main_app).path_or_url(target, "path", options)
+      CmsRouting.new(request, main_app, scrivito_engine).path_or_url(target, "path", options)
     end
 
     #
@@ -36,7 +36,7 @@ module Scrivito
     # @return [String]
     #
     def scrivito_url(target, options = {})
-      CmsRouting.new(request, main_app).path_or_url(target, "url", options)
+      CmsRouting.new(request, main_app, scrivito_engine).path_or_url(target, "url", options)
     end
   end
 end

data/lib/scrivito/user.rb

@@ -52,8 +52,8 @@ module Scrivito
       #     user.can_never(:create, :workspace, 'You are not allowed to create workspaces.')
       #     user.can_always(:read, :workspace)
       #
-      #     user.restrict_obj_publish(using: :_obj_class) do |obj_class|
-      #       if obj_class.name == 'BlogPost'
+      #     user.restrict_obj_publish(using: :_obj_class_name) do |obj_class_name|
+      #       if obj_class_name == 'BlogPost'
       #         false
       #       else
       #         'You are not allowed to publish blog posts.'

data/lib/scrivito/user_definition.rb

@@ -184,8 +184,8 @@ module Scrivito
     #           end
     #         end
     #
-    #         user.restrict_obj_publish(using: :_obj_class) do |obj_class|
-    #           if obj_class.name == 'BlogPost'
+    #         user.restrict_obj_publish(using: :_obj_class_name) do |obj_class_name|
+    #           if obj_class_name == 'BlogPost'
     #             false
     #           else
     #             'You are only allowed to edit Blog Posts'

data/lib/scrivito/widget_garbage_collection.rb

@@ -80,8 +80,8 @@ class WidgetGarbageCollection
     else
       params.each do |key, value|
         if content.type_of_attribute(key) == 'widgetlist'
-          current = content[key]
-          new = value
+          current = content[key] || []
+          new = value || []
 
           dereferenced_ids += current - new
           newreferenced_ids += new - current

data/lib/scrivito/widget_tag.rb

@@ -1,16 +1,19 @@
 module Scrivito
 
-class WidgetTag < Struct.new(:view, :widget, :placement_modification, :template_name)
+class WidgetTag < Struct.new(:view, :widget, :placement_modification, :template_name, :inner_tag)
+  DEFAULT_TAG = "div"
+
   include TagRenderer
 
   def tag_name
-    :div
+    inner_tag || DEFAULT_TAG
   end
 
   def content
     view.render(template: template_path, locals: {widget: widget})
   rescue ActionView::MissingTemplate
-    %{Missing Ruby model class for "#{widget.obj_class_name}"} if view.scrivito_user
+    raise if Rails.env.development? || Rails.env.test?
+    "Missing show template for #{widget.description_for_editor}" if view.scrivito_user
   end
 
   def options

data/lib/scrivito/workspace.rb

@@ -5,8 +5,6 @@ module Scrivito
 # This class represents a CMS workspace
 # @api public
 class Workspace
-  PUBLISHED_ID = 'published'
-
   extend ActiveModel::Naming
 
   include ModelIdentity
@@ -31,7 +29,7 @@ class Workspace
     if @current.respond_to? :call
       @current = @current.call
     else
-      @current ||= default
+      @current ||= published
     end
   end
 
@@ -41,19 +39,13 @@ class Workspace
   def self.all
     result_json = CmsRestApi.get('/workspaces')
 
-    result_json['results'].map do |workspace_json|
-      Workspace.find(workspace_json['id'])
+    result_json['results'].map do |raw_data|
+      Workspace.new(WorkspaceData.new(raw_data))
     end
   end
 
-  def self.default
-    published
-  end
-
   def self.published
-    cache.fetch(PUBLISHED_ID) do
-      cache[PUBLISHED_ID] = find(PUBLISHED_ID)
-    end
+    find("published")
   end
 
   # Find a workspace by its id
@@ -62,10 +54,14 @@ class Workspace
   # @return [Scrivito::Workspace]
   # @raise [Scrivito::ResourceNotFound]
   def self.find(id)
-    if workspace_data = CmsBackend.instance.find_workspace_data_by_id(id)
-      Workspace.new workspace_data
-    else
-      raise ResourceNotFound, "Could not find #{self} with id #{id}"
+    cache.fetch(id) do
+      workspace_data = CmsBackend.instance.find_workspace_data_by_id(id)
+
+      unless workspace_data
+        raise ResourceNotFound, "Could not find #{self} with id #{id}"
+      end
+
+      cache[id] = Workspace.new(workspace_data)
     end
   end
 
@@ -79,8 +75,38 @@ class Workspace
     all.detect { |workspace| workspace.title == title }
   end
 
+  # Find a workspace by its id or title and set it as the currently used workspace.
+  # @example
+  #   Scrivito::Workspace.use('6a75fe694eeeb093')
+  #
+  #   Scrivito::Workspace.current.id
+  #   # => '6a75fe694eeeb093'
+  #
+  #   Scrivito::Workspace.use('my working copy')
+  #
+  #   Scrivito::Workspace.current.title
+  #   # => 'my working copy'
+  #
+  #   # raises Scrivito::ResourceNotFound:
+  #   Scrivito::Workspace.use('missing')
+  # @api public
+  # @param [String] id_or_title
+  # @return [void]
+  # @raise [Scrivito::ResourceNotFound]
+  def self.use(id_or_title)
+    workspace = begin
+      find(id_or_title)
+    rescue ResourceNotFound
+      find_by_title(id_or_title)
+    end
+    if workspace.blank?
+      raise(ResourceNotFound, "Could not find #{self} with id or title #{id_or_title}")
+    end
+    self.current = workspace
+  end
+
   delegate :content_state_id, :base_content_state_id, :content_state,
-    :base_revision_id, :base_content_state, :uses_obj_classes, to: :data
+    :base_revision_id, :base_content_state, to: :data
 
   # Create a new workspace
   # @api public
@@ -96,8 +122,7 @@ class Workspace
   # since it was loaded
   # @api public
   def self.reload
-    id = current.id
-    self.current_using_proc = proc { find(id) }
+    current.reload
   end
 
   def self.cache
@@ -135,6 +160,7 @@ class Workspace
   # @param [Hash] attributes
   # @return [Scrivito::Workspace]
   def update(attributes)
+    raise ScrivitoError, 'published workspace is not modifiable' if published?
     CmsRestApi.put(backend_url, workspace: attributes)
     reload
   end
@@ -151,6 +177,8 @@ class Workspace
   def publish
     CmsRestApi.put("#{backend_url}/publish", {})
 
+    Workspace.published.reload
+
     reset_workspace_if_current
   end
 
@@ -172,11 +200,12 @@ class Workspace
     @workspace_data.revision_id
   end
 
-  # Returns the title of the workspace
+  # Returns the title of the workspace or an empty +String+
   # @api public
   # @return [String]
   def title
-    @workspace_data.title
+    return '' if published?
+    @workspace_data.title || ''
   end
 
   # @api public
@@ -195,15 +224,18 @@ class Workspace
     self.id == 'published'
   end
 
-  def rtc?
-    self.id == 'rtc'
-  end
-
   def outdated?
     !published? && Workspace.published.revision.id != base_revision_id
   end
 
   def revision
+    unless data.content_state_id?
+      # reload data from changes feed in order to obtain content_state_id
+      reload
+
+      raise InternalError unless data.content_state_id?
+    end
+
     @revision ||= Revision.new(id: revision_id, workspace: self)
   end
 
@@ -231,7 +263,6 @@ class Workspace
 
   def assert_revertable
     raise ScrivitoError, 'published workspace is not modifiable' if published?
-    raise ScrivitoError, 'rtc workspace may contain attribute and class changes' if rtc?
   end
 
   # {ObjCollection} for this working copy
@@ -241,19 +272,6 @@ class Workspace
     @objs ||= ObjCollection.new(self)
   end
 
-  # Returns all obj classes of this working copy.
-  #
-  # @api public
-  # @deprecated
-  #
-  # @example Find the obj class named "Homepage" in the "rtc" {Workspace}.
-  #   Workspace.find('rtc').obj_classes['Homepage']
-  #
-  # @return {ObjClassCollection}
-  def obj_classes
-    @obj_classes ||= ObjClassCollection.new(self)
-  end
-
   def inspect
     "<#{self.class} id=\"#{id}\" title=\"#{title}\">"
   end
@@ -281,11 +299,12 @@ class Workspace
   end
 
   def reset_workspace_if_current
+    Workspace.cache.delete(id)
+
     if Workspace.current == self
-      Workspace.current = Workspace.default
+      Workspace.current = Workspace.published
     end
   end
-
 end
 
 end