scrivito_sdk 1.2.0 → 1.3.0.rc1

data/lib/scrivito/{date_attribute.rb → date_conversion.rb}

@@ -1,7 +1,7 @@
 module Scrivito
 
   # Adds support for string columns which contain ISO dates
-  module DateAttribute
+  module DateConversion
     def self.deserialize_from_backend(iso_date_time)
       return nil unless iso_date_time
 
@@ -18,9 +18,7 @@ module Scrivito
       DateTime.iso8601(iso8601_date_time).in_time_zone
     rescue ArgumentError
       raise Scrivito::ClientError.new(
-        "The value is not a valid ISO 8601 date time: #{iso8601_date_time.inspect}",
-        400
-      )
+          "The value is not a valid ISO 8601 date time: #{iso8601_date_time.inspect}")
     end
 
     def self.serialize_for_backend(attribute_value)

data/lib/scrivito/float_conversion.rb

@@ -0,0 +1,29 @@
+module Scrivito
+  module FloatConversion
+    FLOAT_STRING_REGEX = /\A-?\d+(\.\d+)?\z/.freeze
+    DEFAULT_VALUE = 0.0
+
+    def self.deserialize_from_backend(backend_value)
+      case backend_value
+      when Integer, Float, FLOAT_STRING_REGEX
+        value = backend_value.to_f
+        value.finite? ? value : DEFAULT_VALUE
+      when nil, String
+        DEFAULT_VALUE
+      else
+        raise Scrivito::InternalError,
+            "invalid value #{backend_value} (class: #{backend_value.class})"
+      end
+    end
+
+    def self.serialize_for_backend(value, attr_name)
+      serialized_value = value.to_f
+      unless serialized_value.finite?
+        raise ClientError.new(
+            "Value #{value} for attribute #{attr_name} is not supported.")
+      end
+
+      value
+    end
+  end
+end

data/lib/scrivito/image_tag.rb

@@ -13,7 +13,7 @@ class ImageTag < Struct.new(:view_context)
   def src(obj_or_widget, attribute_name, editing_options)
     path(obj_or_widget, attribute_name, editing_options) ||
       editing_options[:placeholder] ||
-      view_context.image_path('scrivito/image_placeholder.png')
+      view_context.image_path('scrivito/image_placeholder.gif')
   end
 
   def alt(obj_or_widget, attribute_name)

data/lib/scrivito/integer_conversion.rb

@@ -0,0 +1,29 @@
+module Scrivito
+  module IntegerConversion
+    INTEGER_STRING_REGEX = /\A-?\d+\z/.freeze
+    DEFAULT_VALUE = 0
+    RANGE = Range.new(-(2**53 - 1), (2**53 - 1)).freeze
+
+    def self.deserialize_from_backend(backend_value)
+      case backend_value
+      when Integer, Float, INTEGER_STRING_REGEX
+        value = backend_value.to_i
+        RANGE.include?(value) ? value : DEFAULT_VALUE
+      when nil, String
+        DEFAULT_VALUE
+      else
+        raise Scrivito::InternalError,
+            "invalid value #{backend_value} (class: #{backend_value.class})"
+      end
+    end
+
+    def self.serialize_for_backend(value, attr_name)
+      unless RANGE.include?(value)
+        raise ClientError.new(
+            "Value #{value} for attribute #{attr_name} is out of range: #{RANGE}")
+      end
+
+      value
+    end
+  end
+end

data/lib/scrivito/obj_params_parser.rb

@@ -19,7 +19,7 @@ module Scrivito
           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 DateAttribute.deserialize_from_client(value)
+          when 'date'       then DateConversion.deserialize_from_client(value)
           else value
           end
       end

data/lib/scrivito/obj_search_builder.rb

@@ -54,7 +54,7 @@ class ObjSearchBuilder < Struct.new(:query)
   def deserialize_values(values)
     values.map do |(type, value)|
       if type == 'date'
-        DateAttribute.deserialize_from_client(value)
+        DateConversion.deserialize_from_client(value)
       else
         value
       end

data/lib/scrivito/obj_search_enumerator.rb

@@ -149,8 +149,8 @@ module Scrivito
     include Enumerable
 
     attr_reader :workspace
-
     attr_reader :query
+
     def initialize(workspace, batch_size = nil)
       @workspace = workspace
       @batch_size = batch_size
@@ -288,7 +288,7 @@ module Scrivito
     #
     def batch_size(size)
       @batch_size = size
-      @preload_search_result = true
+      @preload_batch = true
 
       self
     end
@@ -497,17 +497,16 @@ module Scrivito
     # @raise [Scrivito::ClientError] If the maximum number of results has been exceeded.
     #   The number of results is limited to 100 with respect to the facets themselves and the included Objs.
     #
-    def facet(*args)
-      if args.length == 1 && args[0].is_a?(Hash)
-        return {} if args[0].empty?
-        facets_params = multiple_facet_params(args)
-        get_facet_value_objs(facets_params, args[0].keys)
-      else
-        facets_params = [single_facet_params(*args)]
-        attribute_name = args[0]
-        result = get_facet_value_objs(facets_params, [attribute_name])
-        result[attribute_name]
-      end
+    def facet(*facet_params)
+      search_params = search_dsl_params
+      search_params[:size] = 0 unless @preload_batch
+
+      facet_query = FacetQuery.new(facet_params, search_params, workspace)
+      facet_query.execute!
+
+      @preloaded_batch = facet_query.batch if @preload_batch
+
+      facet_query.result
     end
 
     def fetch_batch(continuation=nil)
@@ -539,87 +538,16 @@ module Scrivito
     end
 
     def convert_single_value(value)
-      if value.is_a?(Time) || value.is_a?(Date)
-        DateAttribute.serialize_for_backend(value)
+      case value
+      when Time, Date
+        DateConversion.serialize_for_backend(value)
+      when Integer, Float
+        value
       else
         value.to_s
       end
     end
 
-    def create_facet_value_objs(facet_arrays, obj_collection)
-      result = []
-      facet_arrays.map do |facet|
-        included_objs = []
-        if included_ids = get_objs_facet_ids(facet)
-          obj_collection.each do |basic_obj|
-            if included_ids.include? basic_obj.id
-              included_objs << basic_obj unless included_objs.include? basic_obj
-            end
-          end
-        end
-        result << ObjFacetValue.new(facet["value"], facet["total"], included_objs)
-      end
-      result
-    end
-
-    def get_all_facets_ids(facet_array)
-      result = []
-      facet_array.map do |facet|
-        result += get_objs_facet_ids(facet)
-      end
-      result
-    end
-
-    def multiple_facet_params(facets)
-      facet_params = []
-      facets.first.map do |k, v|
-        facet_params << single_facet_params(k, v)
-      end
-      facet_params
-    end
-
-    def single_facet_params(attribute, options = {})
-      { attribute: attribute }.merge!(options)
-    end
-
-    def get_objs_facet_ids(facet)
-      result = []
-      if included_ids = facet["results"]
-        included_ids.each { |obj| result << obj["id"] }
-      end
-      result
-    end
-
-    def get_facet_value_objs(facets_params, attributes_list = [])
-      result = attributes_list.each_with_object({}) { |v,h| h[v] = [] }
-      included_objs_ids = []
-
-      params = prepare_facet_search_params facets_params
-
-      batch = QueryExecutor.new(workspace).call(params)
-      @preloaded_batch = batch if @preload_search_result
-
-      batch.facets.each do |facets_array|
-        included_objs_ids += get_all_facets_ids(facets_array)
-      end
-
-      obj_collection = workspace.objs.find(included_objs_ids)
-      batch.facets.each_with_index do |facets_array, index|
-        result[result.keys[index]] += create_facet_value_objs(facets_array, obj_collection)
-      end
-      result
-    end
-
-    def prepare_facet_search_params(facet_params)
-      params = { facets: facet_params }
-
-      if query
-        params.merge! search_dsl_params
-      end
-
-      params.reverse_merge(size: 0)
-    end
-
     def operator_mapping(operator)
       case operator.to_sym
       when :contains
@@ -640,17 +568,9 @@ module Scrivito
     end
 
     def search_dsl_params
-      patches = {
-        query: query,
-      }
+      patches = {query: query}
       patches[:size] = @batch_size if @batch_size
-
-      if @include_deleted
-        patches[:options] = {
-          include_deleted: true
-        }
-      end
-
+      patches[:options] = {include_deleted: true} if @include_deleted
       options.merge(patches)
     end
 

data/lib/scrivito/obj_search_enumerator/facet_query.rb

@@ -0,0 +1,105 @@
+module Scrivito
+  class ObjSearchEnumerator
+    #
+    # Response format (assuming we've requested facets for attributes "color" and "size"):
+    #
+    # [
+    #   # Facets for attribute "color"
+    #   [
+    #     {value: "red",   total: 2, results: [{id: "xxx"}, {id: "yyy"}]},
+    #     {value: "blue",  total: 1, results: [{id: "xxx"}]},
+    #     {value: "green", total: 0, results: []},
+    #   ],
+    #
+    #   # Facets for attribute "size"
+    #   [
+    #     {value: "large",  total: 2, results: [{id: "xxx"}, {id: "yyy"}]},
+    #     {value: "medium", total: 1, results: [{id: "xxx"}]},
+    #     {value: "small",  total: 0, results: []},
+    #   ]
+    # ]
+    #
+    #
+    class FacetQuery < Struct.new(:facet_params, :search_params, :workspace)
+      attr_reader :batch, :result
+
+      def execute!
+        @result = case
+          when facet_params.first.empty?
+            {}
+          when facet_params.one? && facet_params.first.is_a?(Hash)
+            fetch_result(multi_facet_params, facet_params.first.keys)
+          else
+            attribute_name = facet_params.first
+            fetch_result([single_facet_params(*facet_params)], [attribute_name])[attribute_name]
+          end
+      end
+
+      private
+
+      def fetch_result(params, attribute_names)
+        result = attribute_names.each_with_object({}) { |v, h| h[v] = [] }
+
+        @batch = QueryExecutor.new(workspace).call(build_search_params(params))
+        objs = workspace.objs.find(obj_ids_from_batch)
+
+        @batch.facets.each_with_index do |facets_per_attribute, i|
+          result[result.keys[i]] += obj_facet_values(facets_per_attribute, objs)
+        end
+
+        result
+      end
+
+      def obj_ids_from_batch
+        ids = []
+
+        @batch.facets.each do |facets_per_attribute|
+          facets_per_attribute.each do |facet_hash|
+            ids += obj_ids_from_facet_hash(facet_hash)
+          end
+        end
+
+        ids
+      end
+
+      def multi_facet_params
+        facet_params.first.map do |attribute_name, options|
+          single_facet_params(attribute_name, options)
+        end
+      end
+
+      def single_facet_params(attribute, options = {})
+        {attribute: attribute}.merge!(options)
+      end
+
+      def obj_facet_values(facets_per_attribute, objs)
+        results = []
+
+        facets_per_attribute.map do |facet_hash|
+          obj_ids = obj_ids_from_facet_hash(facet_hash)
+          included_objs = []
+
+          objs.each do |obj|
+            if obj_ids.include?(obj.id) && !included_objs.include?(obj)
+              included_objs << obj
+            end
+          end
+
+          results << ObjFacetValue.new(facet_hash['value'], facet_hash['total'], included_objs)
+        end
+
+        results
+      end
+
+      def obj_ids_from_facet_hash(facet_hash)
+        facet_hash['results'].map { |obj_hash| obj_hash['id'] }
+      end
+
+      def build_search_params(params)
+        params = {facets: params}
+        params.merge!(search_params) if search_params
+        params.reverse_merge(size: 0)
+      end
+    end
+  end
+end

data/lib/scrivito/page_config.rb

@@ -24,6 +24,7 @@ class PageConfig < Struct.new(:obj, :editing_context, :lookup_context)
     {
       id: obj.id,
       obj_class: obj.obj_class,
+      description_for_editor: obj.description_for_editor,
       has_children: obj.children.any?,
       has_conflict: obj.has_conflict?,
       has_details_view: obj_has_details_view?,

data/lib/scrivito/session.rb

@@ -0,0 +1,23 @@
+module Scrivito
+class Session
+  def self.renew(id, user)
+    payload = {
+      session: {
+        role: 'editor',
+        user_id: user.id,
+        permissions: permissions(user),
+      },
+    }
+
+    CmsRestApi.task_unaware_request(:put, "sessions/#{id}", payload)
+  end
+
+  def self.permissions(user)
+    Hash[user.explicit_rules.map do |permission, verb, _, _|
+      [verb, permission.to_s]
+    end]
+  end
+
+  private_class_method :permissions
+end
+end

data/lib/scrivito/task.rb

@@ -34,7 +34,7 @@ module Scrivito
     def result
       case
       when success? then @result
-      when error?   then raise ClientError.new(@message, 400, @code)
+      when error?   then raise ClientError.new(@message, backend_code: @code)
       else
         poll
         result

data/lib/scrivito/ui_config.rb

@@ -10,6 +10,7 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     {
       app_extension_tags:  app_extension_tags,
       editing_context:     editing_context_config,
+      session:             session_config,
       i18n:                i18n_config,
       is_development_mode: Rails.env.development?,
       resource_dialog:     resource_dialog_config,
@@ -30,6 +31,10 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     }
   end
 
+  def session_config
+    Session.renew(SecureRandom.hex(8), editor)
+  end
+
   def workspace_config(workspace)
     {
       id: workspace.id,
@@ -41,6 +46,7 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
         }
       end,
       outdated: workspace.outdated?,
+      auto_update: workspace.auto_update?,
       title: workspace.title,
     }
   end