scrivito_sdk 1.1.1 → 1.2.0.rc1

data/lib/generators/scrivito/install/install_generator.rb

@@ -41,18 +41,12 @@ module Scrivito
 
       def copy_image_files
         copy_file 'app/models/image.rb'
-        #
-        # FIXME content-widget
-        #
-        # copy_file 'app/views/image/embed.html.erb'
+        copy_file 'app/views/image/details.html.erb'
       end
 
       def copy_download_files
         copy_file 'app/models/download.rb'
-        #
-        # FIXME content-widget
-        #
-        # copy_file 'app/views/download/embed.html.erb'
+        copy_file 'app/views/download/details.html.erb'
       end
 
       def copy_headline_widget_files

data/lib/generators/scrivito/install/templates/app/views/download/details.html.erb

@@ -0,0 +1,11 @@
+<%= scrivito_medium_dialog do %>
+  <%= scrivito_details_for do %>
+    <%= scrivito_tag :div, @obj, :blob do %>
+      <%= link_to @obj.description_for_editor, scrivito_path(@obj), :target => :blank %>
+    <% end %>
+  <% end %>
+
+  <%= scrivito_details_for do %>
+    <%= number_to_human_size @obj.meta_data[:content_length] %>
+  <% end %>
+<% end %>

data/lib/generators/scrivito/install/templates/app/views/headline_widget/thumbnail.html.erb

@@ -1,3 +1,3 @@
-<%= scrivito_thumbnail 'Headline Widget', :headline do %>
+<%= scrivito_thumbnail HeadlineWidget.description_for_editor, :headline do %>
   A headline widget.
 <% end %>

data/lib/generators/scrivito/install/templates/app/views/image/details.html.erb

@@ -0,0 +1,17 @@
+<%= scrivito_medium_dialog do %>
+  <%= scrivito_details_for do %>
+    <%= scrivito_image_tag @obj %>
+  <% end %>
+
+  <%= scrivito_details_for do %>
+    <% if @obj.meta_data[:width] && @obj.meta_data[:height]%>
+      <div>
+        <%= @obj.meta_data[:width] %> × <%= @obj.meta_data[:height] %> px
+      </div>
+    <% end %>
+
+    <div>
+      <%= number_to_human_size @obj.meta_data[:content_length] %>
+    </div>
+  <% end %>
+<% end %>

data/lib/generators/scrivito/install/templates/app/views/image_widget/thumbnail.html.erb

@@ -1,3 +1,3 @@
-<%= scrivito_thumbnail 'Image Widget', :image do %>
+<%= scrivito_thumbnail ImageWidget.description_for_editor, :image do %>
   A widget with an image.
 <% end %>

data/lib/generators/scrivito/install/templates/app/views/page/details.html.erb

@@ -1,3 +1,5 @@
-<%= scrivito_details_for 'Title' do %>
-  <%= scrivito_tag :div, @obj, :title %>
+<%= scrivito_medium_dialog do %>
+  <%= scrivito_details_for "Title" do %>
+    <%= scrivito_tag :div, @obj, :title %>
+  <% end %>
 <% end %>

data/lib/generators/scrivito/install/templates/app/views/page/thumbnail.html.erb

@@ -1,3 +1 @@
-<%= scrivito_thumbnail 'Page', :content do %>
-  A simple content page with a headline and content consisting of widgets.
-<% end %>
+<%= scrivito_thumbnail Page.description_for_editor, :content %>

data/lib/generators/scrivito/install/templates/app/views/text_widget/thumbnail.html.erb

@@ -1,3 +1,3 @@
-<%= scrivito_thumbnail 'Text Widget', :text do %>
-  A widget for text and HTML content.
+<%= scrivito_thumbnail TextWidget.description_for_editor, :text do %>
+  A widget for HTML content.
 <% end %>

data/lib/generators/scrivito/page/page_generator.rb

@@ -19,6 +19,14 @@ module Scrivito
         copy_file 'details.html.erb', "app/views/#{file_name}/details.html.erb"
         template 'thumbnail.html.erb', "app/views/#{file_name}/thumbnail.html.erb"
       end
+
+      def file_name
+        super.ends_with?('page') ? super : "#{super}_page"
+      end
+
+      def class_name
+        super.ends_with?('page') || super.ends_with?('Page') ? super : "#{super}Page"
+      end
     end
   end
 end

data/lib/generators/scrivito/page/templates/details.html.erb

@@ -1,3 +1,5 @@
-<%= scrivito_details_for 'Title' do %>
-  <%= scrivito_tag :div, @obj, :title %>
+<%= scrivito_medium_dialog do %>
+  <%= scrivito_details_for "Title" do %>
+    <%= scrivito_tag :div, @obj, :title %>
+  <% end %>
 <% end %>

data/lib/generators/scrivito/page/templates/thumbnail.html.erb

@@ -1,3 +1 @@
-<%%= scrivito_thumbnail '<%= class_name %>', :content do %>
-  <%= class_name %>
-<%% end %>
+<%%= scrivito_thumbnail <%= class_name %>.description_for_editor, :content %>

data/lib/generators/scrivito/widget/templates/details.html.erb

@@ -1,2 +1,4 @@
-This is the details view of the <%= human_name %>.
-Edit "app/views/<%= file_name %>/details.html.erb" to change its appearance.
+<%%= scrivito_medium_dialog do %>
+  <%%= scrivito_details_for <%= class_name %>.description_for_editor do %>
+  <%% end %>
+<%% end %>

data/lib/generators/scrivito/widget/templates/show.html.erb

@@ -1,2 +1 @@
-This is the show view of the <%= human_name %>.
-Edit "app/views/<%= file_name %>/show.html.erb" to change its appearance.
+This is the show view of the <%%= <%= class_name %>.description_for_editor %>.

data/lib/generators/scrivito/widget/templates/thumbnail.html.erb

@@ -1,3 +1 @@
-<%%= scrivito_thumbnail '<%= human_name %>' do %>
-  <!-- Add the detailed description of the widget here. -->
-<%% end %>
+<%%= scrivito_thumbnail <%= class_name %>.description_for_editor %>

data/lib/generators/scrivito/widget/widget_generator.rb

@@ -23,10 +23,6 @@ module Scrivito
       def class_name
         super.ends_with?('Widget') ? super : "#{super}Widget"
       end
-
-      def human_name
-        class_name.underscore.humanize
-      end
     end
   end
 end

data/lib/scrivito/attribute_content.rb

@@ -200,11 +200,6 @@ module AttributeContent
     widgets
   end
 
-  def contained_widgets
-    referenced = referenced_widgets
-    referenced + referenced.map { |widget| widget.contained_widgets }.flatten
-  end
-
   def update_data(data)
     self.data_from_cms = data
     @attribute_cache = {}
@@ -342,15 +337,24 @@ module AttributeContent
     # @option options [Symbol, String] :default custom default value.
     #   See {Scrivito::AttributeContent::DEFAULT_ATTRIBUTE_VALUES} for factory defaults.
     #   See {Scrivito::AttributeContent::ClassMethods#default_for} for more advanced defaults.
+    # @option options [Class, Array<Class>] :only specifies (for use in the UI) the valid classes
+    #   _of_ _the_ _values_ in a +reference+ or a +referencelist+ attribute, e.g. +Image+ or +Video+.
+    #   Raises an error if the attribute type is neither +reference+ nor +referencelist+. If not
+    #   specified, the UI assumes that any class is valid.
     #
     # @return nil
+    #
     # @raise [Scrivito::ScrivitoError] if the +type+ is unknown
     # @raise [Scrivito::ScrivitoError] if the +values+ include an empty string
+    # @raise [Scrivito::ScrivitoError] if the +only+ option is specified, but the +type+ is neither
+    #   +reference+ nor +referencelist+
+    # @raise [Scrivito::ScrivitoError] if the +only+ option includes invalid value(s)
+    #
     # @see Scrivito::AttributeContent::DEFAULT_ATTRIBUTE_VALUES
     # @see Scrivito::AttributeContent::ClassMethods#default_for
     #
     # @example Defining attributes:
-    #   class Page < ::Obj
+    #   class Page < Obj
     #     attribute :my_string, :string
     #     attribute 'my_html', 'my_html'
     #     attribute :my_enum, :enum, values: %w[a b c], default: 'a'
@@ -380,7 +384,7 @@ module AttributeContent
     #   #=> []
     #
     # @example Inheriting attributes:
-    #   class Page < ::Obj
+    #   class Page < Obj
     #     attribute :title, :string
     #   end
     #
@@ -391,7 +395,7 @@ module AttributeContent
     #   #=> "string"
     #
     # @example Overriding inherited attributes:
-    #   class Page < ::Obj
+    #   class Page < Obj
     #     attribute :title, :string
     #   end
     #
@@ -405,6 +409,18 @@ module AttributeContent
     #   SpecialPage.attribute_definitions[:title].type
     #   #=> "html"
     #
+    # @example Specifying valid classes for +reference+ attributes:
+    #   class Page < Obj
+    #     attribute :my_reference1, :reference, only: Image
+    #     attribute :my_reference2, :reference, only: [Image, Video]
+    #   end
+    #
+    #   ImageWidget.attribute_definitions[:my_reference1].valid_classes
+    #   #=> [Image]
+    #
+    #   ImageWidget.attribute_definitions[:my_reference2].valid_classes
+    #   #=> [Image, Video]
+    #
     # @see http://scrivito.com/default-attribute-values Specifying default attribute values
     #
     def attribute(name, type, options = {})
@@ -421,7 +437,8 @@ module AttributeContent
     end
 
     #
-    # Sets the default value of an attribute.
+    # Sets the default value of an attribute defined by
+    # {Scrivito::AttributeContent::ClassMethods#attribute}.
     #
     # @api public
     #
@@ -524,18 +541,22 @@ module AttributeContent
       nil
     end
 
+    #
+    # Short description of a CMS object or widget type for the UI.
+    #
     # @api public
     #
-    # Short description of a CMS object or widget type for the UI. The description is displayed
-    # when adding new pages or widgets, for example. As a general rule, it is used whenever no
-    # widget or object instance is available. If there is, the {Scrivito::BasicObj#description_for_editor}
-    # and, respectively, {Scrivito::BasicWidget#description_for_editor} instance methods are used instead.
+    # The description is displayed when adding new pages or widgets, for example. As a general rule,
+    # it is used whenever no widget or object instance is available. If there is, the
+    # {Scrivito::BasicObj#description_for_editor} and, respectively,
+    # {Scrivito::BasicWidget#description_for_editor} instance methods are used instead.
     #
     # This method can be overridden to customize the description displayed to editors.
     #
-    # @return [String] the +Class+ name
+    # @return [String] short description of a CMS object or widget type for the UI
+    #
     def description_for_editor
-      name
+      name.titleize
     end
 
     #
@@ -622,6 +643,14 @@ module AttributeContent
       attributes
     end
 
+    def as_json
+      {
+        name: name,
+        descriptionForEditor: description_for_editor,
+        attributes: attribute_definitions.map(&:as_json),
+      }
+    end
+
     protected
 
     def assert_valid_attribute_name(name)

data/lib/scrivito/attribute_definition.rb

@@ -37,17 +37,59 @@ class AttributeDefinition
     end
   end
 
-  def widgetlist?
-    type == 'widgetlist'
+  #
+  # Valid classes of a +reference+ or a +referencelist+ attribute.
+  #
+  # @api beta
+  #
+  # @raise [Scrivito::ScrivitoError] if +type+ is neither +reference+, nor +referencelist+.
+  # @return [Array<Class>] valid classes specified using the
+  #   {Scrivito::AttributeContent::ClassMethods#attribute only} option.
+  # @return +nil+ if no valid classes has been specified.
+  #
+  def valid_classes
+    assert_restrictable
+    @valid_classes
+  end
+
+  AttributeContent::ATTRIBUTE_TYPES.each do |attribute_type|
+    define_method "#{attribute_type}?" do
+      type == attribute_type
+    end
+  end
+
+  def as_json
+    hash = {
+      name: name,
+      type: type,
+    }
+
+    if enum? || multienum?
+      hash[:validValues] = values
+    end
+
+
+    if (reference? || referencelist?) && valid_classes
+      hash[:validClasses] = valid_classes.map(&:name)
+    end
+
+    hash
   end
 
   private
 
   def assert_valid_options
-    @options.assert_valid_keys(:values, 'values')
+    @options.assert_valid_keys(:values, 'values', :only, 'only')
+
     if values = @options[:values]
       values.each(&method(:assert_valid_value))
     end
+
+    if only = @options[:only]
+      assert_restrictable
+      @valid_classes = [@options[:only]].flatten
+      @valid_classes.each(&method(:assert_valid_restriction_class))
+    end
   end
 
   def assert_valid_value(value)
@@ -60,6 +102,20 @@ class AttributeDefinition
       raise ScrivitoError, %{Empty string is not allowed as value for #{type} attribute "#{name}".}
     end
   end
+
+  def assert_restrictable
+    unless %w[reference referencelist].include?(type)
+      raise ScrivitoError, "#{type} attribute \"#{name}\" has no restrictions: "\
+        'only reference and referencelist attributes can be restricted with the "only" option.'
+    end
+  end
+
+  def assert_valid_restriction_class(obj_class)
+    unless obj_class.is_a?(Class) && BasicObj > obj_class
+      raise ScrivitoError, "Cannot restrict attribute \"#{name}\" to #{obj_class.inspect}: "\
+        "#{obj_class} is not a valid model class."
+    end
+  end
 end
 
 end

data/lib/scrivito/basic_obj.rb

@@ -664,7 +664,7 @@ module Scrivito
     def reload_data
       id = self.id.to_s
       update_data -> {
-        CmsBackend.instance.find_obj_data_by(workspace.revision, :id, [id]).first.first
+        CmsBackend.find_obj_data_by(workspace.revision, :id, [id]).first.first
       }
     end
 
@@ -927,7 +927,7 @@ module Scrivito
         return [self, attribute_name]
       end
 
-      all_widgets_from_pool.each do |container_widget|
+      contained_widgets.each do |container_widget|
         if attribute_name = container_widget.find_attribute_containing_widget(widget_id)
           return [container_widget, attribute_name]
         end
@@ -948,12 +948,6 @@ module Scrivito
       !has_conflict?
     end
 
-    def all_widgets_from_pool
-      read_widget_pool.keys.map do |widget_id|
-        widget_from_pool(widget_id)
-      end
-    end
-
     def generate_widget_pool_id
       10.times do
         id = self.class.generate_widget_pool_id
@@ -964,6 +958,10 @@ module Scrivito
       raise ScrivitoError.new('Could not generate a new unused widget id')
     end
 
+    def contained_widgets
+      read_widget_pool.keys.map(&method(:widget_from_pool))
+    end
+
     def parent_path
       ParentPath.of(path) unless root?
     end
@@ -1027,7 +1025,7 @@ module Scrivito
 
     def reset_modifications
       case
-      when new? then destroy
+      when new? then workspace.api_request(:delete, "/objs/#{id}")
       when deleted? then self.class.restore(id)
       else revert
       end
@@ -1036,7 +1034,7 @@ module Scrivito
     def cms_data_for_revision(revision)
       return nil unless revision
 
-      result = CmsBackend.instance.find_obj_data_by(revision, "id", [id])
+      result = CmsBackend.find_obj_data_by(revision, "id", [id])
       obj_data = result.first.first
 
       if obj_data && obj_data.value_of("_modification") != "deleted"
@@ -1183,13 +1181,6 @@ module Scrivito
           obj_attributes, widget_pool_attributes, workspace, obj_id
         )
 
-        if obj
-          widget_pool = api_attributes['_widget_pool']
-          widget_gc = WidgetGarbageCollection.new(obj,
-            {obj => obj_attributes}.merge(widget_pool_attributes))
-          widget_gc.widgets_to_delete.each { |widget| widget_pool[widget.id] = nil }
-        end
-
         [api_attributes, widget_pool_attributes]
       end
 
@@ -1210,7 +1201,9 @@ module Scrivito
         {}.tap do |serialized_attributes|
           widget_pool_attributes.each_pair do |widget, widget_attributes|
             obj_class = widget_attributes['_obj_class']
-            serialized_attributes[widget.id] = serializer.serialize(widget_attributes,
+            widget_serializer = AttributeSerializer.new(obj_class, serializer.obj_id)
+
+            serialized_attributes[widget.id] = widget_serializer.serialize(widget_attributes,
               find_attribute_definitions(obj_class, BasicWidget) || widget.attribute_definitions)
           end
         end

data/lib/scrivito/basic_widget.rb

@@ -55,6 +55,43 @@ class BasicWidget
     computed_classes.nil? || computed_classes.include?(container_class)
   end
 
+  # @api beta
+  def self.embeds(attribute_name)
+    @embedding_attribute = attribute_name
+    nil
+  end
+
+  # @api beta
+  def self.embeds?
+    !!@embedding_attribute || !!superclass.try(:embeds?)
+  end
+
+  # @api beta
+  def self.embedding_attribute
+    raise ScrivitoError, "#{self} has no embedding attribute" unless embeds?
+
+    if @embedding_attribute
+      unless attribute_definition = attribute_definitions[@embedding_attribute]
+        raise ScrivitoError, %{Unknown attribute: "#{@embedding_attribute}"}
+      end
+
+      unless attribute_definition.reference?
+        raise ScrivitoError, %{Embedding attribute "#{@embedding_attribute}" must be a reference}
+      end
+
+      attribute_definition
+    else
+      superclass.embedding_attribute
+    end
+  end
+
+  def self.as_json
+    super.merge(
+      embeds: embeds?,
+      embeddingAttribute: @embedding_attribute,
+    )
+  end
+
   attr_accessor :container, :container_attribute_name
 
   attr_writer :obj, :id
@@ -363,6 +400,11 @@ class BasicWidget
     end
   end
 
+  def contained_widgets
+    referenced = referenced_widgets
+    referenced + referenced.map { |widget| widget.contained_widgets }.flatten
+  end
+
   private
 
   def workspace

data/lib/scrivito/binary.rb

@@ -112,12 +112,12 @@ class Binary
 
   def no_cache_url
     if private?
-      CmsBackend.instance.find_blob_data(id, 'private_access', 'get', no_cache: true)['url']
+      CmsBackend.find_blob_data(id, 'private_access', 'get', no_cache: true)['url']
     end
   end
 
   def url_from_cache
-    blob_data = CmsBackend.instance.find_blob_data_from_cache(id, access_type, 'get',
+    blob_data = CmsBackend.find_blob_data_from_cache(id, access_type, 'get',
       transformation_definition: transformation_definition)
     if blob_data
       blob_data['url']
@@ -290,7 +290,7 @@ class Binary
     raise_field_not_available('Meta data') if transformed?
 
     @meta_data ||= begin
-      deserialized_meta_data = deserialize_meta_data(CmsBackend.instance.find_binary_meta_data(id))
+      deserialized_meta_data = deserialize_meta_data(CmsBackend.find_binary_meta_data(id))
       MetaDataCollection.new(deserialized_meta_data)
     end
   end
@@ -306,11 +306,11 @@ class Binary
   end
 
   def headers
-    CmsBackend.instance.find_blob_metadata(id, find_url('head'))
+    CmsBackend.find_blob_metadata(id, find_url('head'))
   end
 
   def find_url(verb)
-    blob_data = CmsBackend.instance.find_blob_data(id, access_type, verb,
+    blob_data = CmsBackend.find_blob_data(id, access_type, verb,
       transformation_definition: transformation_definition)
     blob_data['url']
   rescue ClientError => e

data/lib/scrivito/cache_middleware.rb

@@ -1,23 +1,19 @@
 module Scrivito
+  class CacheMiddleware
+    def initialize(app)
+      @app = app
+    end
 
-class CacheMiddleware
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    clear_caches
-
-    @app.call(env)
-  end
-
+    def call(env)
+      clear_cache
+      @app.call(env)
+    end
 
-  private
+    private
 
-  def clear_caches
-    Workspace.cache.clear
-    CmsBackend.instance.clear_cache
+    def clear_cache
+      Workspace.cache.clear
+      CmsDataCache.clear_request_cache
+    end
   end
 end
-
-end # module Scrivito

data/lib/scrivito/class_collection.rb

@@ -7,7 +7,7 @@ class ClassCollection
   include Enumerable
 
   def initialize(classes)
-    @classes = classes
+    @classes = classes.compact.uniq
   end
 
   #

data/lib/scrivito/client_attribute_serializer.rb

@@ -67,7 +67,11 @@ module ClientAttributeSerializer
   end
 
   def self.serialize_binary_value(value)
-    {'url' => value.url, 'filename' => value.filename}
+    {
+      'filename' => value.filename,
+      'id'       => value.id,
+      'url'      => value.url,
+    }
   end
 
   def self.serialize_date_value(value)