scrivito_sdk 0.50.1 → 0.60.0.rc1

data/lib/scrivito/obj_class_collection.rb

@@ -4,6 +4,7 @@ module Scrivito
   # instance by accessing {Workspace#obj_classes}.
   #
   # @api public
+  # @deprecated
   class ObjClassCollection
     include Enumerable
 
@@ -18,6 +19,7 @@ module Scrivito
     # Finds an obj class by its name in the working copy of the collection.
     #
     # @api public
+    # @deprecated
     #
     # @example Find the obj class named "Homepage" in the "rtc" {Workspace}.
     #   Workspace.find('rtc').obj_classes['Homepage']
@@ -30,21 +32,37 @@ module Scrivito
       end
     end
 
+    #
     # @!method each
+    #
     # Yields successive obj classes of the collection. Implements the +Enumerable+ interface.
+    #
     # @api public
-    # @yield [ObjClass] Successive obj classes of the collection.
+    # @deprecated
+    # @see Scrivito::ObjClass.remove
+    #
+    # @yield [ObjClass] successive obj classes of the collection if the corresponding workspace
+    #   still uses {Scrivito::ObjClass}.
+    # @yield [Array] an empty array if the corresponding workspace does not use {Scrivito::ObjClass}
+    #   anymore.
+    #
     # @example Find all obj classes in the "rtc" {Workspace} and print their name.
     #   Workspace.find('rtc').obj_classes.each do |obj_class|
     #     puts obj_class.name
     #   end
+    #
     delegate :each, to: :obj_classes
 
     private
 
     def obj_classes
-      CmsBackend.instance.find_all_obj_class_data(workspace.revision).map do |obj_class_data|
-        ObjClass.new(obj_class_data, workspace)
+      if workspace.uses_obj_classes
+        CmsBackend.instance.find_all_obj_class_data(workspace.revision).map do |obj_class_data|
+          ObjClass.new(obj_class_data, workspace)
+        end
+      else
+        Scrivito.print_obj_class_deprecated_warning
+        []
       end
     end
 

data/lib/scrivito/obj_create_params_parser.rb

@@ -6,7 +6,8 @@ module Scrivito
 
     def convert_params(params)
       if obj_class_name = params['_obj_class']
-        convert_field_params(ObjClass.find(obj_class_name), params)
+        model_class = Obj.type_computer.compute_type(obj_class_name)
+        convert_field_params(params, model_class.attribute_definitions)
       else
         raise ArgumentError, 'Missing "_obj_class" param'
       end

data/lib/scrivito/obj_data.rb

@@ -1,39 +1,5 @@
 module Scrivito
-
   class ObjData
-    internal_key_list = %w[
-      last_changed
-      modification
-      permalink
-      text_links
-      conflicts
-    ]
-
-    INTERNAL_KEYS = Set.new(internal_key_list.map { |name| "_#{name}" } )
-
-    internal_comparison_key_list = %w[
-      path
-      permalink
-      widget_pool
-    ]
-
-    INTERNAL_COMPARISON_KEYS = Set.new(internal_comparison_key_list.map { |name| "_#{name}" })
-
-    ATTRIBUTE_DEFAULT_VALUES = {
-      "string"        => "",
-      "text"          => "",
-      "html"          => "",
-      "multienum"     => [],
-      "linklist"      => [],
-      "referencelist" => [],
-      "widget"        => [],
-      "enum"          => nil,
-      "binary"        => nil,
-      "date"          => nil,
-      "reference"     => nil,
-      "link"          => nil,
-    }.freeze
-
     def value_of(attribute_name)
       value_and_type_of(attribute_name).first
     end
@@ -42,32 +8,14 @@ module Scrivito
       value_and_type_of(attribute_name).second
     end
 
-    def value_without_default_of(attribute_name)
-      value_and_type_without_default_of(attribute_name).first
-    end
-
     def value_and_type_of(attribute_name)
-      if internal_attribute?(attribute_name)
-        internal_value_and_type(attribute_name)
-      else
-        custom_value_and_type_with_default(attribute_name)
-      end
-    end
-
-    def value_and_type_without_default_of(attribute_name)
-      if internal_attribute?(attribute_name)
-        internal_value_and_type(attribute_name)
+      if attribute_name.starts_with?('_')
+        [raw_value_and_type_of(attribute_name).first, nil]
       else
         raw_value_and_type_of(attribute_name)
       end
     end
 
-    def all_custom_attributes
-      @all_custom_attributes ||= all_attributes.select do |attribute|
-        has_custom_attribute?(attribute)
-      end
-    end
-
     def to_h
       raise NotImplementedError, 'implement in subclass'
     end
@@ -76,62 +24,20 @@ module Scrivito
       raise NotImplementedError, "implement in subclass"
     end
 
-    def has_custom_attribute?(name)
-      raise NotImplementedError, "implement in subclass"
-    end
-
-    def all_attributes
+    def attribute_names_for_comparison
       raise NotImplementedError, "implement in subclass"
     end
 
     def ==(other)
-      if other.kind_of?(ObjData)
-        (all_attributes | other.all_attributes).each do |attr|
-          attr = attr.to_s
-
-          next if attr.start_with?('_') && !INTERNAL_COMPARISON_KEYS.include?(attr)
-
-          if value_without_default_of(attr) != other.value_without_default_of(attr)
-            return false
-          end
-        end
-
-        return true
-      end
-
-      false
-    end
+      return false unless other.is_a?(ObjData)
 
-    private
+      attribute_names = attribute_names_for_comparison | other.attribute_names_for_comparison
+      attribute_names.reject! { |attribute_name| attribute_name.starts_with?('_') }
+      attribute_names += %w[_path _permalink _widget_pool]
 
-    def custom_value_and_type_with_default(attribute_name)
-      value, type = raw_value_and_type_of(attribute_name)
-      value = ATTRIBUTE_DEFAULT_VALUES[type] if value.nil?
-      [value, type]
-    end
-
-    def internal_value_and_type(attribute_name)
-      value, type = raw_value_and_type_of(attribute_name)
-      type = type_of_internal(attribute_name)
-      [value, type]
-    end
-
-    def internal_attribute?(attribute_name)
-      attribute_name.starts_with?('_')
-    end
-
-    def type_of_internal(key)
-      case key
-      when "_permalink"
-        "string"
-      when "_text_links"
-        "linklist"
-      when "_last_changed"
-        "date"
-      else
-        nil
+      attribute_names.all? do |attribute_name|
+        value_of(attribute_name) == other.value_of(attribute_name)
       end
     end
   end
-
 end

data/lib/scrivito/obj_data_from_hash.rb

@@ -1,31 +1,29 @@
 module Scrivito
 
-  class ObjDataFromHash < ObjData
-    def initialize(hash, type_hash = {})
-      @hash = hash.stringify_keys
-      @type_hash = type_hash.stringify_keys
-    end
-
-    def raw_value_and_type_of(attribute_name)
-      [@hash[attribute_name], @type_hash[attribute_name]]
-    end
-
-    def has_custom_attribute?(name)
-      @hash.has_key?(name) || name == '_id'
-    end
+class ObjDataFromHash < ObjData
+  def initialize(attributes)
+    @attributes = attributes.stringify_keys
+  end
 
-    def all_attributes
-      @all_attributes ||= begin
-        @hash.keys |
-          INTERNAL_KEYS.to_a |
-           %w[_id]
+  def raw_value_and_type_of(attribute_name)
+    if attribute_data = @attributes[attribute_name]
+      if attribute_name.starts_with?('_')
+        [attribute_data, nil]
+      else
+        attribute_data.reverse
       end
+    else
+      [nil, nil]
     end
+  end
 
-    def to_h
-      @hash
-    end
+  def attribute_names_for_comparison
+    @attributes.keys
+  end
 
+  def to_h
+    @attributes
   end
+end
 
 end

data/lib/scrivito/obj_data_from_service.rb

@@ -6,54 +6,42 @@ module Scrivito
     end
 
     def raw_value_and_type_of(attribute_name)
-      if attribute_name == '_widget_pool'
-        [value_of_widget_pool, nil]
+      return [value_of_widget_pool, nil] if attribute_name == '_widget_pool'
+      if value_and_type = @data[attribute_name]
+        value, type = value_and_type
+        value = convert_value(value, type)
+        [value, type]
       else
-        type_and_value = @data.fetch(attribute_name, [nil, nil])
-
-        if type_and_value.present?
-          type = if type_and_value.length == 1
-            type_of_internal(attribute_name)
-          else
-            type_and_value.last
-          end
-
-          [convert_value(type_and_value.first, type), type]
-        end
+        [nil, nil]
       end
     end
 
-    def has_custom_attribute?(attribute_name)
-      is_custom_attribute?(attribute_name) && !!@data[attribute_name]
+    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
 
-    def all_attributes
-      @all_attributes ||= (@data.keys | INTERNAL_KEYS.to_a)
+    def attribute_names_for_comparison
+      @data.keys
     end
 
     def to_h
-      @data.dup.tap do |h|
-        h.each_pair { |k, v| h[k] = v.first }
-      end
+      @data.to_h
     end
 
     private
 
-    def convert_value(value, type)
-      case type
-      when "html"
-        text_links_conversion.convert(value)
-      when "widget"
-        if !value
-          []
-        else
-          (value['list'] || []).map do |list_item|
-            list_item['widget']
-          end
-        end
-      else
-        value
-      end
+    def convert_text_links(value)
+      text_links_conversion.convert(value)
     end
 
     def text_links_conversion
@@ -70,21 +58,13 @@ module Scrivito
     end
 
     def value_of_widget_pool
-      raw_value_of_widget_pool.dup.tap do |hash|
-        hash.each_pair do |widget_id, raw_widget_data|
-          hash[widget_id] = self.class.new(raw_widget_data)
+      if widget_pool = @data['_widget_pool']
+        widget_pool.first.dup.tap do |hash|
+          hash.each_pair do |widget_id, raw_widget_data|
+            hash[widget_id] = self.class.new(raw_widget_data)
+          end
         end
       end
     end
-
-    def raw_value_of_widget_pool
-      @data['_widget_pool'].first
-    end
-
-    def is_custom_attribute?(attribute_name)
-      !internal_attribute?(attribute_name)
-    end
-
   end
-
 end

data/lib/scrivito/obj_params_parser.rb

@@ -11,25 +11,21 @@ module Scrivito
 
     private
 
-    def convert_field_params(obj_class, params)
+    def convert_field_params(params, attribute_definitions)
       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)
+        params[key] = case type = attribute_definitions[key.to_s].try(:type)
+          when 'binary'     then parse_binary_params(value)
+          when 'html'       then ContentConversion.convert_html_links(value, host, port)
+          when 'link'       then ContentConversion.convert_link(value, host, port)
+          when 'linklist'   then ContentConversion.convert_linklist_urls(value, host, port)
+          when 'widgetlist' then parse_widgetlist_params(value)
+          when 'date'       then parse_date_params(value)
           else value
           end
       end
     end
 
-    def parse_widget_field_params(params)
+    def parse_widgetlist_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
@@ -50,8 +46,12 @@ module Scrivito
       end
     end
 
-    def parse_binary_field_params(params)
+    def parse_binary_params(params)
       UploadedBinary.new(params) if params
     end
+
+    def parse_date_params(params)
+      DateAttribute.parse(params)
+    end
   end
 end

data/lib/scrivito/obj_search_enumerator.rb

@@ -303,7 +303,7 @@ module Scrivito
 
     def convert_single_value(value)
       if value.is_a?(Time) || value.is_a?(Date)
-        CmsRestApi::AttributeSerializer.convert_time(value)
+        DateAttribute.serialize(value)
       else
         value
       end

data/lib/scrivito/obj_update_params_parser.rb

@@ -5,7 +5,7 @@ module Scrivito
     private
 
     def convert_params(params)
-      convert_field_params(obj.obj_class, params)
+      convert_field_params(params, obj.attribute_definitions)
       convert_widget_pool_params(params)
     end
 
@@ -16,7 +16,7 @@ module Scrivito
       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)
+          widget_pool[widget] = convert_field_params(widget_params, widget.attribute_definitions)
         end
       end
       params['_widget_pool'] = widget_pool

data/lib/scrivito/restriction_set.rb

@@ -14,7 +14,7 @@ module Scrivito
       private
 
       def skip?(obj)
-        !obj.has_attribute?(attribute) || obj.type_of_attribute(attribute) == 'widget'
+        !obj.has_attribute?(attribute) || obj.type_of_attribute(attribute) == 'widgetlist'
       end
     end