scrivito_sdk 0.50.1 → 0.60.0.rc1

data/lib/scrivito/basic_widget.rb

@@ -3,6 +3,8 @@ module Scrivito
 # The CMS widget class
 # @api public
 class BasicWidget
+  # @!parse extend Scrivito::AttributeContent::ClassMethods
+
   include AttributeContent
 
   def self.type_computer
@@ -13,11 +15,43 @@ class BasicWidget
     @_type_computer = nil
   end
 
-  def self.hide_from_widget_class_selection?
-    false
+  #
+  # @api public
+  # This method can be overridden in subclasses to control to which pages or
+  # widgets the given widget class can be added. This method can be used
+  # to ensure that only a special type of widget can be added to a specific
+  # container. An example for this is a +TabGroupWidget+ that should
+  # contain widgets of the +TabWidget+ type only, and, vice versa, a +TabWidget+
+  # should only be contained in a +TabGroupWidget+. A value of +nil+ means that
+  # no additional restrictions are applied.
+  #
+  # This method only further restricts the list of valid classes defined
+  # by means of {AttributeContent#valid_widget_classes_for}.
+  #
+  # @return [Array<String, Symbol, Class>, nil]
+  #
+  # @example
+  #   class TabGroupWidget < Widget
+  #     def valid_widget_classes_for(field_name)
+  #       [TabWidget]
+  #     end
+  #   end
+  #
+  #   class TabWidget < Widget
+  #     def self.valid_container_classes
+  #       [TabGroupWidget]
+  #     end
+  #   end
+  #
+  def self.valid_container_classes
   end
 
-  attr_accessor :container, :container_field_name
+  def self.valid_inside_container?(container_class)
+    valid_container_classes.nil? ||
+      valid_container_classes.map(&:to_s).include?(container_class.name)
+  end
+
+  attr_accessor :container, :container_attribute_name
 
   attr_writer :obj, :id
 
@@ -46,7 +80,16 @@ class BasicWidget
   #   my_obj(my_widget_field: [new_widget])
   #
   def initialize(attributes = {})
-    @attributes_to_be_saved = self.class.with_default_obj_class(attributes)
+    @attributes_to_be_saved = self.class.prepare_attributes_for_instantiation(attributes)
+    @attribute_cache = {}
+  end
+
+  def self.new(attributes = {})
+    if obj_class = extract_obj_class_from_attributes(attributes)
+      obj_class.new(attributes)
+    else
+      super
+    end
   end
 
   def revision
@@ -66,8 +109,8 @@ class BasicWidget
   # Destroys the {Scrivito::BasicWidget Widget} in the current {Workspace}
   # @api public
   def destroy
-    new_widget_list = container[container_field_name] - [self]
-    container.update(container_field_name => new_widget_list)
+    new_widget_list = container[container_attribute_name] - [self]
+    container.update(container_attribute_name => new_widget_list)
   end
 
   #
@@ -83,25 +126,30 @@ class BasicWidget
   #   obj.update(my_widgets: obj.my_widgets.push(obj.my_widgets.first.copy))
   #
   def copy
-    attrs = {}
-    each_custom_attribute do |attr_name, attr_value, attr_type|
-      attrs[attr_name] = attr_type == 'widget' ? attr_value.map(&:copy) : attr_value
+    attributes = {}
+    attribute_definitions.each do |attribute_definition|
+      attribute_name = attribute_definition.name
+      attribute_value = read_attribute(attribute_name)
+      attribute_value = attribute_value.map(&:copy) if attribute_definition.widgetlist?
+      attributes[attribute_name] = attribute_value
     end
-    self.class.new(attrs)
+    self.class.new(attributes)
   end
 
   def copy_for_restore(referenced_ids)
-    attrs = {}
-    each_custom_attribute do |attr_name, attr_value, attr_type|
-      attrs[attr_name] = if attr_type == 'widget'
-        attr_value.reject { |widget| referenced_ids.include?(widget.id) }
+    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) }
-      else
-        attr_value
       end
+      attributes[attribute_name] = attribute_value
     end
-    attrs['_id'] = id
-    self.class.new(attrs)
+    attributes['_id'] = id
+    self.class.new(attributes)
   end
 
   def clone
@@ -154,7 +202,7 @@ class BasicWidget
           CmsRestApi.get("revisions/#{workspace.base_revision_id}/objs/#{obj.id}")
       previous_widget_content = previous_obj_content["_widget_pool"]["#{id}"]
       previous_widget_content.delete_if do |attribute_name, _|
-        type_of_attribute(attribute_name) == "widget"
+        type_of_attribute(attribute_name) == 'widgetlist'
       end
       CmsRestApi.put("workspaces/#{workspace.id}/objs/#{obj.id}",
           { obj: {_widget_pool: {id => previous_widget_content}} })
@@ -205,17 +253,27 @@ class BasicWidget
   # returns the entity ({Scrivito::BasicObj} or {Scrivito::BasicWidget}) that references this widget
   # @api public
   def container
-    @container || cache_container_and_field_name_for_widget.first
+    @container || container_and_attribute_name.first
+  end
+
+  # returns the name of the widget attribute that references this widget
+  # @api public
+  def container_attribute_name
+    @container_attribute_name || container_and_attribute_name.second
   end
 
   # returns the name of the widget field that references this widget
   # @api public
+  # @deprecated
   def container_field_name
-    @container_field_name || cache_container_and_field_name_for_widget.second
+    Scrivito::Deprecation.warn('Scrivito::BasicWidget#container_field_name is deprecated'\
+      ' and will be removed in a future version.'\
+      ' Please use Scrivito::BasicWidget#container_attribute_name instead.')
+    container_attribute_name
   end
 
-  def container_field_index
-    container[container_field_name].index(self)
+  def container_attribute_index
+    container[container_attribute_name].index(self)
   end
 
   def has_attribute?(key)
@@ -261,6 +319,14 @@ class BasicWidget
     obj_class_name
   end
 
+  def data_from_cms
+    if persisted?
+      super
+    else
+      raise_not_persisted_error
+    end
+  end
+
   private
 
   def workspace
@@ -271,14 +337,6 @@ class BasicWidget
     end
   end
 
-  def data_from_cms
-    if persisted?
-      super
-    else
-      raise_not_persisted_error
-    end
-  end
-
   def raise_not_persisted_error
     raise ScrivitoError.new('Can not access a new widget before it has been saved')
   end
@@ -287,14 +345,22 @@ class BasicWidget
     obj.widget_data_for_revision(id, revision)
   end
 
-  def cache_container_and_field_name_for_widget
-    @cache_container_and_field_name_for_widget ||= obj.container_and_field_name_for_widget(id)
+  def container_and_attribute_name
+    @container_and_attribute_name ||= obj.find_container_and_attribute_name_for_widget(id)
   end
 
-  def each_custom_attribute
-    data_from_cms.all_custom_attributes.each do |attr_name|
-      yield attr_name, read_attribute(attr_name), type_of_attribute(attr_name)
-    end
+  def has_system_attribute?(attribute_name)
+    attribute_name == '_obj_class'
+  end
+
+  alias_method :has_public_system_attribute?, :has_system_attribute?
+
+  def type_of_system_attribute(attribute_name)
+    'string' if attribute_name == 'obj_class'
+  end
+
+  def value_of_system_attribute(attribute_name)
+    data_from_cms.value_of(attribute_name)
   end
 end
 

data/lib/scrivito/binary.rb

@@ -4,6 +4,8 @@ module Scrivito
 # The Binary class represents the data stored in a binary attribute of an Obj
 # or Widget
 class Binary
+  attr_reader :id
+
   def initialize(id, public_content)
     @id = id
     @public_content = public_content
@@ -11,7 +13,7 @@ class Binary
 
   # @api public
   # Some Scrivito data is considered private, i.e. it is not currently intended
-  # for the general public, for example content in a workspace that has not 
+  # for the general public, for example content in a workspace that has not
   # been published yet.
   # @return [Boolean]
   def private?
@@ -53,8 +55,6 @@ class Binary
 
   private
 
-  attr_reader :id
-
   def public_content?
     !!@public_content
   end

data/lib/scrivito/cache/chainable.rb

@@ -11,10 +11,12 @@ module Scrivito
         value
       end
 
-      def write(key, value, options = {})
+      def write(key, value, expires_in = nil)
         transformed_key = transform_key(key)
-        next_store.write(transformed_key, value, options) if next_store
-        internal_write(transformed_key, value, options)
+        if forward_write?(key, value, expires_in)
+          next_store.write(transformed_key, value, expires_in)
+        end
+        internal_write(transformed_key, value, expires_in)
       end
 
       def fetch(key, &block)
@@ -40,13 +42,17 @@ module Scrivito
         raise NotImplementedError
       end
 
-      def internal_write(key, value, options = {})
+      def internal_write(key, value, expires_in = nil)
         raise NotImplementedError
       end
 
       def transform_key(key)
         key
       end
+
+      def forward_write?(key, value, expires_in)
+        next_store.present?
+      end
     end
   end
 end

data/lib/scrivito/cache/file_store.rb

@@ -15,11 +15,14 @@ module Cache
 
     private
 
-    delegate :read, :write, to: :internal_store, prefix: :internal
+    delegate :read, to: :internal_store, prefix: :internal
 
-    def transform_key(key)
-      # Workaround for rails/rails#15616. Will be fixed in Rails 4.2.
-      Digest::SHA1.hexdigest(key)
+    def internal_write(key, value, expires_in = nil)
+      internal_store.write(key, value, expires_in: expires_in)
+    end
+
+    def forward_write?(key, value, expires_in)
+      super && !expires_in
     end
   end
 end

data/lib/scrivito/cache/ram_store.rb

@@ -19,7 +19,7 @@ module Cache
       internal_store[key]
     end
 
-    def internal_write(key, value, options = {})
+    def internal_write(key, value, expires_in = nil)
       internal_store[key] = value
     end
 

data/lib/scrivito/class_collection.rb

@@ -1,7 +1,7 @@
 module Scrivito
 
 #
-# @api private
+# @api public
 #
 class ClassCollection
   include Enumerable
@@ -13,7 +13,7 @@ class ClassCollection
   #
   # @!method each
   #   Iterates over the classes.
-  #   @api private
+  #   @api public
   #   @yieldparam [Class] class if a block is given.
   #   @return [Enumerator] enumerator if no block is given.
   #

data/lib/scrivito/client_config.rb

@@ -7,12 +7,13 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
 
   def to_json
     config = {}
-    config[:current_page]     = current_page_config
-    config[:editing_context]  = editing_context_config
-    config[:i18n]             = i18n_config
-    config[:resource_dialog]  = resource_dialog_config
-    config[:user]             = user_config
-    config[:user_permissions] = user_permissions_config
+    config[:current_page]        = current_page_config
+    config[:editing_context]     = editing_context_config
+    config[:i18n]                = i18n_config
+    config[:resource_dialog]     = resource_dialog_config
+    config[:user]                = user_config
+    config[:user_permissions]    = user_permissions_config
+    config[:is_development_mode] = Rails.env.development?
     config.to_json
   end
 

data/lib/scrivito/cms_backend.rb

@@ -205,7 +205,7 @@ module Scrivito
         %w[get head].each do |verb|
           blob_data = blob_datas[access][verb]
           CmsDataCache.cache.write(blob_data_cache_key(id, access, verb),
-            blob_data, expires_in: blob_data['maxage'])
+            blob_data, blob_data['maxage'])
         end
       end
     end
@@ -242,7 +242,7 @@ module Scrivito
     def store_blob_metadata_in_cache(id, blob_metadata)
       max_age = blob_metadata.delete(:cache_control) =~ /max-age=(.*),/ && $1
       max_age = max_age.to_i if max_age
-      CmsDataCache.cache.write(blob_metadata_cache_key(id), blob_metadata, expires_in: max_age)
+      CmsDataCache.cache.write(blob_metadata_cache_key(id), blob_metadata, max_age)
     end
 
     def blob_metadata_cache_key(id)

data/lib/scrivito/cms_field_tag.rb

@@ -1,14 +1,24 @@
 module Scrivito
 
 # this class is the server-side equivalent of the JavaScript class `cms_field_element`
-class CmsFieldTag < Struct.new(
-    :view, :tag_name, :obj_or_widget, :field_name)
+class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :field_name)
+  FIELD_TYPES_WITH_ORIGINAL_CONTENT = %w[
+    binary
+    date
+    enum
+    html
+    multienum
+    reference
+    referencelist
+    string
+    text
+  ]
 
   include TagRenderer
 
   def content(&block)
-    if field_type == 'widget'
-      raise ArgumentError, 'No block allowed for widget fields' if block_given?
+    if field_type == 'widgetlist'
+      raise ArgumentError, 'No block allowed for widgetlist fields' if block_given?
       modifications = modification_info || []
       rendered_widgets = default_content.each_with_index.map do |widget, index|
         WidgetTag.new(view, widget, modifications[index]).render
@@ -30,7 +40,7 @@ class CmsFieldTag < Struct.new(
     }
 
     modification = comparison.modification_for_attribute(obj_or_widget, field_name)
-    if modification == Modification::EDITED && field_type != 'widget'
+    if modification == Modification::EDITED && field_type != 'widgetlist'
       options['field-modification'] = modification
     end
 
@@ -48,11 +58,8 @@ class CmsFieldTag < Struct.new(
       options['private-field-original-content'] = encoded_content
     end
 
-    if field_type == 'widget'
-      valid_widget_classes = obj_or_widget.valid_widget_classes_for(field_name.to_s)
-      if valid_widget_classes
-        options['private-field-widget-allowed-classes'] = valid_widget_classes.to_json
-      end
+    if field_type == 'widgetlist'
+      options['private-field-widget-allowed-classes'] = build_valid_widget_classes.to_json
     end
 
     options
@@ -65,10 +72,23 @@ class CmsFieldTag < Struct.new(
 
   private
 
+  def build_valid_widget_classes
+    obj_or_widget.valid_widget_class_names_for(field_name).map do |widget_class|
+      {
+        name: widget_class,
+        description: description_for_widget_class(widget_class),
+      }
+    end
+  end
+
   def field_type
     @field_type ||= obj_or_widget.type_of_attribute(field_name)
   end
 
+  def description_for_widget_class(class_name)
+    class_name.constantize.description_for_editor
+  end
+
   def default_content
     calculate_content_and_modification
     @content_and_modification.first
@@ -91,18 +111,6 @@ class CmsFieldTag < Struct.new(
     Workspace.current.id
   end
 
-  FIELD_TYPES_WITH_ORIGINAL_CONTENT = %w[
-    enum
-    html
-    multienum
-    reference
-    referencelist
-    string
-    text
-    binary
-    date
-  ]
-
   def authenticated_editor?
     editing_context.authenticated_editor?
   end
@@ -113,10 +121,10 @@ class CmsFieldTag < Struct.new(
 
   def original_content(field_type, field_value, raw_value)
     case field_type
-    when 'reference' then field_value.try(:id)
+    when 'binary'        then field_value && {}
+    when 'date'          then raw_value.try(:utc).try(:iso8601)
+    when 'reference'     then field_value.try(:id)
     when 'referencelist' then field_value.map(&:id)
-    when 'binary' then field_value && {}
-    when 'date' then raw_value.try(:utc).try(:iso8601)
     else field_value
     end
   end