scrivito_sdk 0.30.0 → 0.40.0.rc1

data/lib/scrivito/controller_actions.rb

@@ -42,15 +42,17 @@ module ControllerActions
   end
 
   def widget_details
+    assert_dialog_layout
     widget = load_widget
     template_path = "#{widget.obj_class_name.underscore}/details"
-    render template_path, layout: false, locals: {widget: widget}
+    render template_path, layout: 'scrivito_dialog', locals: {widget: widget}
   end
 
   def details_page
+    assert_dialog_layout
     @scrivito_resource = editing_context.selected_workspace.objs
         .find_including_deleted(params[:resource_id])
-    render text: '', layout: true
+    render text: '', layout: 'scrivito_dialog'
   end
 
   module ClassMethods
@@ -79,6 +81,8 @@ module ControllerActions
     request.env[EditingContextMiddleware::ENVKEY] || EditingContext.new
   end
 
+  delegate :comparison, to: :editing_context
+
   def load_object
     CmsEnv.new(request.env).load
     loaded_obj = request.env[CmsEnv::OBJ_ENV_KEY]
@@ -87,7 +91,12 @@ module ControllerActions
   end
 
   def load_widget
-    @obj.widget_from_pool(params[:widget_id])
+    if widget = @obj.widget_from_pool(params[:widget_id])
+      widget
+    elsif comparison.active? # The "diff" mode.
+      @obj.in_revision(editing_context.selected_workspace.base_revision)
+        .widget_from_pool(params[:widget_id])
+    end
   end
 
   #
@@ -103,6 +112,18 @@ module ControllerActions
       render text: 'Empty Blob', status: 404
     end
   end
+
+  def assert_dialog_layout
+    view_context.lookup_context.find('layouts/scrivito_dialog')
+  rescue ActionView::MissingTemplate
+    raise %{
+      Missing the Scrivito dialog layout!
+
+      Scrivito requires a special view layout in order to render the details dialog.
+      Normally the install generator places it in `app/views/layouts/scrivito_dialog.html.erb`.
+      If upgrading Scrivito, please re-run the install generator: `rails g scrivito:install`.
+    }
+  end
 end
 
 end

data/lib/scrivito/image_tag_helper.rb

@@ -13,24 +13,12 @@ class ImageTagHelper < Struct.new(:view_context)
   end
 
   def options(obj, field_name, tag_options, editing_options)
-    if field_name.nil?
-      field_name = determine_field_name(obj)
-    end
-
     tag_options.reverse_merge(src: scrivito_image_tag_src(obj, field_name, editing_options),
         alt: scrivito_image_tag_alt(obj, field_name))
   end
 
   private
 
-  def determine_field_name(obj)
-    if obj.binary?
-      :blob
-    else
-      raise ScrivitoError, "when omitting `field_name' you have to pass a binary obj"
-    end
-  end
-
   def scrivito_image_tag_src(obj, field_name, editing_options)
     scrivito_image_tag_path(obj, field_name) || editing_options[:placeholder] ||
         view_context.image_path('scrivito/image_placeholder.png')

data/lib/scrivito/layout_tags.rb

@@ -8,7 +8,7 @@ class LayoutTags < Struct.new(:view)
         resource: resource,
         return_to: view.params[:return_to]
       ).to_json
-      view.content_tag(:div, '', 'data-scrivito-private-config' => config, style: 'display:none')
+      view.content_tag(:div, '', 'data-scrivito-private-config' => config)
     end
   end
 
@@ -21,13 +21,6 @@ class LayoutTags < Struct.new(:view)
     content << "; Version #{GemInfo.version}" if view.scrivito_user
     view.tag(:meta, name: 'generator', content: content)
   end
-
-  def reset_stylesheet_tag
-    view.content_tag(:style, %{
-      *[data-scrivito-field-type="widget"],
-      *[data-scrivito-private-widget-id] { position: relative; }
-    }.squish, {type: 'text/css'}, false)
-  end
 end
 
 end

data/lib/scrivito/link_parser.rb

@@ -9,6 +9,11 @@ module Scrivito
 
     def parse(url)
       uri = Addressable::URI.parse(url)
+
+      if (params = route(uri.to_s)) && params[:controller] == 'scrivito/ui'
+        uri.path = params[:application_path]
+      end
+
       link_params = {}
 
       if obj = find_obj(uri)

data/lib/scrivito/{memberships_collection.rb → membership_collection.rb}

@@ -1,8 +1,8 @@
 module Scrivito
   # @api public
-  # The MembershipsCollection includes all members of a given {Workspace}.
+  # The MembershipCollection includes all members of a given {Workspace}.
   # You can access it using {Workspace#memberships} method.
-  class MembershipsCollection
+  class MembershipCollection
     extend Forwardable
     include Enumerable
 

data/lib/scrivito/obj_class.rb

@@ -8,16 +8,13 @@ module Scrivito
     include ModelIdentity
 
     class << self
-      # Returns all the obj classes.
       #
+      # Returns all obj classes.
       # @api public
+      # @return Scrivito::ObjClassCollection
       #
-      # @example Find all obj classes in the current {Scrivito::Workspace}.
-      #   ObjClass.all
-      #
-      # @return [Array<Scrivito::ObjClass>]
       def all
-        Workspace.current.obj_classes.to_a
+        Workspace.current.obj_classes
       end
 
       # Finds an obj class by its name.

data/lib/scrivito/{objs_collection.rb → obj_collection.rb}

@@ -2,7 +2,7 @@ module Scrivito
   # This class allows you to retrieve Objects from a specific working copy.
   # You can get an instance by accessing {Workspace#objs}.
   # @api public
-  class ObjsCollection
+  class ObjCollection
     attr_reader :workspace
 
     def initialize(workspace)

data/lib/scrivito/obj_create_params_parser.rb

@@ -0,0 +1,15 @@
+module Scrivito
+  class ObjCreateParamsParser < Struct.new(:host, :port)
+    include ObjParamsParser
+
+    private
+
+    def convert_params(params)
+      if obj_class_name = params['_obj_class']
+        convert_field_params(ObjClass.find(obj_class_name), params)
+      else
+        raise ArgumentError, 'Missing "_obj_class" param'
+      end
+    end
+  end
+end

data/lib/scrivito/obj_params_parser.rb

@@ -1,63 +1,55 @@
 module Scrivito
-  class ObjParamsParser
-    def initialize(host, port)
-      @host = host
-      @port = port
+  module ObjParamsParser
+    class UnknownWidgetAction < ScrivitoError
     end
 
-    def parse(obj, orig_params)
-      raise "Required parameter 'obj' is missing." unless orig_params.present?
-      raise "Parameter 'obj' is not a hash." unless orig_params.is_a?(Hash)
-
-      params = orig_params.dup
-
-      if obj
-        widget_field_params = WidgetFieldParams.new
-
-        convert_params(params, obj, widget_field_params)
-
-        if widget_pool_params = params['_widget_pool']
-          convert_widget_pool_params(widget_pool_params, obj, widget_field_params)
-        end
-
-        additional_widget_pool_params = widget_field_params.pool_params
-        if additional_widget_pool_params.any?
-          params['_widget_pool'] ||= {}
-          params['_widget_pool'].merge!(additional_widget_pool_params)
-        end
-      end
-
+    def parse(params)
+      params = params.deep_dup
+      convert_params(params)
       params
     end
 
     private
 
-    def convert_widget_pool_params(widget_pool_params, obj, widget_field_params_parser)
-      widget_pool_params.each_pair do |widget_id, widget_params|
-        widget = obj.widget_from_pool(widget_id)
-        if widget_params.present?
-          convert_params(widget_params, widget, widget_field_params_parser)
+    def convert_field_params(obj_class, params)
+      params.each_pair do |key, value|
+        if key.to_s == 'blob' && obj_class.legacy_type?
+          params[key] = parse_binary_field_params(value)
+          next
         end
+
+        params[key] = case type = obj_class.attributes[key].try(:type)
+          when 'html'     then ContentConversion.convert_html_links(value, host, port)
+          when 'linklist' then ContentConversion.convert_linklist_urls(value, host, port)
+          when 'link'     then ContentConversion.convert_link(value, host, port)
+          when 'widget'   then parse_widget_field_params(value)
+          when 'binary'   then parse_binary_field_params(value)
+          else value
+          end
       end
     end
 
-    def convert_params(params, obj, widget_field_params)
-      params.each do |key, value|
-        type = obj.type_of_attribute(key.to_s)
-
-        params[key] = case type
-        when 'html'
-          ContentConversion.convert_html_links(value, @host, @port)
-        when 'linklist'
-          ContentConversion.convert_linklist_urls(value, @host, @port)
-        when 'link'
-          ContentConversion.convert_link(value, @host, @port)
-        when 'widget'
-          widget_field_params.convert(value)
+    def parse_widget_field_params(params)
+      params.map do |widget_id_or_params|
+        if widget_id_or_params.is_a?(Hash)
+          action, widget_params = widget_id_or_params.flatten
+          case action
+          when 'create' then Widget.new(widget_params)
+          when 'copy'
+            widget_id = widget_params['src_widget_id']
+            widget = Obj.find(widget_params['src_obj_id']).widgets[widget_id]
+            raise ResourceNotFound, "Could not find Widget with id #{widget_id}" unless widget
+            widget.copy
+          else raise UnknownWidgetAction
+          end
         else
-          value
+          obj.widgets[widget_id_or_params]
         end
       end
     end
+
+    def parse_binary_field_params(params)
+      UploadedBinary.new(params) if params
+    end
   end
 end

data/lib/scrivito/obj_update_params_parser.rb

@@ -0,0 +1,25 @@
+module Scrivito
+  class ObjUpdateParamsParser < Struct.new(:obj, :host, :port)
+    include ObjParamsParser
+
+    private
+
+    def convert_params(params)
+      convert_field_params(obj.obj_class, params)
+      convert_widget_pool_params(params)
+    end
+
+    def convert_widget_pool_params(params)
+      return unless params['_widget_pool']
+
+      widget_pool = {}
+      params['_widget_pool'].each_pair do |widget_id, widget_params|
+        if widget_params.present?
+          widget = obj.widgets[widget_id]
+          widget_pool[widget] = convert_field_params(widget.obj_class, widget_params)
+        end
+      end
+      params['_widget_pool'] = widget_pool
+    end
+  end
+end

data/lib/scrivito/revision.rb

@@ -1,8 +1,12 @@
 module Scrivito
 
-class Revision < Struct.new(:id, :content_state, :workspace)
+class Revision < Struct.new(:id, :content_state, :workspace, :base)
   def initialize(options)
-    super(*options.values_at(:id, :content_state, :workspace))
+    super(*options.values_at(:id, :content_state, :workspace, :base))
+  end
+
+  def base?
+    !!base
   end
 end
 

data/lib/scrivito/sdk_engine.rb

@@ -36,7 +36,12 @@ module ::Scrivito
 
     initializer 'scrivito.add_sdk_assets' do |app|
       # Specify which file should be precompiled for packaging
-      app.config.assets.precompile += %w(scrivito_sdk.js scrivito_sdk.css)
+      app.config.assets.precompile += %w[
+        scrivito_sdk.css
+        scrivito_sdk.js
+        scrivito_ui.css
+        scrivito_ui.js
+      ]
       app.config.assets.precompile += %w(*.png *.jpg *.jpeg *.gif)
     end
 

data/lib/scrivito/test_request.rb

@@ -36,5 +36,9 @@ module Scrivito
         end
       end
     end
+
+    def for_cms_object(*args)
+      raise "The method `for_cms_object' was removed. Please use `for_scrivito_obj' instead"
+    end
   end
 end

data/lib/scrivito/uploaded_binary.rb

@@ -0,0 +1,4 @@
+module Scrivito
+  class UploadedBinary < Struct.new(:params)
+  end
+end

data/lib/scrivito/user.rb

@@ -144,6 +144,8 @@ module Scrivito
     # @param [BasicObj] obj the obj that should be published
     # @return [Array<String>] Hints why the user can't publish
     def restriction_messages_for(obj)
+      assert_restrictions_applicable(obj)
+
       return [] if can_always?(:publish, :workspace)
 
       if obj.modification == Modification::EDITED
@@ -185,6 +187,12 @@ module Scrivito
       raise ScrivitoError.new("Invalid verb '#{verb}'") unless VERBS.include?(verb)
     end
 
+    def assert_restrictions_applicable(obj)
+      if obj.revision.base?
+        raise ScrivitoError.new("The revision of #{obj.inspect} may not be a base revision")
+      end
+    end
+
     def sandbox_suggest_user_proc(input)
       suggest_users_proc.call(input)
     rescue Exception => e

data/lib/scrivito/widget_collection.rb

@@ -0,0 +1,22 @@
+module Scrivito
+  # @api public
+  # The +WidgetCollection+ represents all {Scrivito::BasicWidget Widgets} referenced by an
+  # {Scrivito::BasicObj Obj} or its subwidgets.
+  class WidgetCollection
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # @api public
+    # Access a {Scrivito::BasicWidget Widget} by its +id+
+    # @param [String] widget_id the id of the widget
+    # @return [Scrivito::BasicWidget, nil] the Widget with the given +widget_id+ or nil
+    def [](widget_id)
+      obj.widget_from_pool(widget_id)
+    end
+
+    private
+
+    attr_reader :obj
+  end
+end

data/lib/scrivito/workspace.rb

@@ -181,9 +181,9 @@ class Workspace
   # @api public
   # Returns the members of this workspace and their roles
   #
-  # @return [MembershipsCollection]
+  # @return [MembershipCollection]
   def memberships
-    @memberships ||= MembershipsCollection.new(self)
+    @memberships ||= MembershipCollection.new(self)
   end
 
   def data
@@ -208,7 +208,12 @@ class Workspace
 
   def base_revision
     if base_revision_id
-      @base_revision ||= Revision.new(id: base_revision_id, content_state: base_content_state)
+      @base_revision ||= Revision.new(
+        id: base_revision_id,
+        content_state: base_content_state,
+        workspace: self,
+        base: true
+      )
     end
   end
 
@@ -229,11 +234,11 @@ class Workspace
     raise ScrivitoError, 'rtc workspace may contain attribute and class changes' if rtc?
   end
 
-  # {ObjsCollection} for this working copy
+  # {ObjCollection} for this working copy
   # @api public
-  # @return {ObjsCollection}
+  # @return {ObjCollection}
   def objs
-    @objs ||= ObjsCollection.new(self)
+    @objs ||= ObjCollection.new(self)
   end
 
   # Returns all obj classes of this working copy.