scrivito_sdk 0.70.2 → 0.71.0.rc1

data/lib/scrivito/date_attribute.rb

@@ -2,7 +2,7 @@ module Scrivito
 
   # Adds support for string columns which contain ISO dates
   module DateAttribute
-    def self.deserialize_from_backend(iso_date_time)
+    def self.parse(iso_date_time)
       return nil unless iso_date_time
 
       if iso_date_time.to_s =~ /^(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/
@@ -12,7 +12,7 @@ module Scrivito
       end
     end
 
-    def self.deserialize_from_client(iso8601_date_time)
+    def self.parse_iso8601(iso8601_date_time)
       return unless iso8601_date_time
 
       DateTime.iso8601(iso8601_date_time).in_time_zone
@@ -20,17 +20,13 @@ module Scrivito
       raise "The value is not a valid ISO 8601 date time: #{iso8601_date_time.inspect}"
     end
 
-    def self.serialize_for_backend(attribute_value)
+    def self.serialize(attribute_value)
       attribute_value = case attribute_value
         when Date then attribute_value.to_time
         when Time then attribute_value.to_time.utc
         end
       attribute_value.strftime('%Y%m%d%H%M%S') if attribute_value
     end
-
-    def self.serialize_for_client(attribute_value)
-      attribute_value.utc.iso8601
-    end
   end
 
 end

data/lib/scrivito/editing_context.rb

@@ -50,13 +50,13 @@ class EditingContext
   end
 
   # defaults to "published" if no workspace with `selected_workspace_id` can be found.
-  # @return [Workspace]
+  # @return [Scrivito::Workspace]
   def selected_workspace
     @selected_workspace ||= find_selected_workspace
   end
 
   # when authenticated_editor? return selected_workspace, otherwise published workspace.
-  # @return [Workspace]
+  # @return [Scrivito::Workspace]
   def visible_workspace
     @visible_workspace ||= find_visible_workspace
   end
@@ -118,7 +118,7 @@ class EditingContext
     Workspace.published
   end
 
-  # @return [Revision] or +nil+
+  # @return [Scrivito::Revision] or +nil+
   def compare_revision
     case display_mode
     when 'added'

data/lib/scrivito/editing_context_middleware.rb

@@ -48,13 +48,13 @@ class EditingContextMiddleware
     if editing_auth_callback = Configuration.editing_auth_callback
       -> { editing_auth_callback.call(env) }
     else
-      Rails.logger.warn(%{
-        WARNING!
+      Warning.warn <<-EOS
 
         Application is running in "#{Rails.env}" environment, but authentication is not configured.
         For security reasons the in-place editing is disabled.
         Please see https://scrivito.com/permissions for details.
-      })
+
+      EOS
       nil
     end
   end

data/lib/scrivito/errored_widget_tag.rb

@@ -0,0 +1,34 @@
+module Scrivito
+class ErroredWidgetTag < BaseWidgetTag
+  attr_reader :error
+
+  def initialize(view, widget, options)
+    @error = options.fetch(:error)
+    super
+  end
+
+  def content
+    if view.controller.respond_to?(:on_scrivito_widget_error, true)
+      view.controller.__send__(:on_scrivito_widget_error, widget, error)
+    else
+      handle_render_error(widget, error)
+    end
+  end
+
+  private
+
+  def description_for_editor
+    "Error in #{widget.class.description_for_editor}"
+  end
+
+  def handle_render_error(widget, error)
+    message = "Rendering widget with ID #{widget.id} and obj_class #{widget.obj_class} for "\
+      "obj with ID #{widget.obj.id} failed"
+    Warning.error(message, error)
+
+    "We're sorry, but something went wrong. "\
+      "If you are the application owner check the logs for more information."
+  end
+end
+
+end

data/lib/scrivito/errors.rb

@@ -38,4 +38,10 @@ end
 class TransferModificationsError < ScrivitoError
 end
 
+class TransferModificationsModifiedError < TransferModificationsError
+end
+
+class TransferModificationsConflictError < TransferModificationsError
+end
+
 end # module Scrivito

data/lib/scrivito/future_binary.rb

@@ -0,0 +1,23 @@
+module Scrivito
+
+# @api public
+# The FutureBinary class represents the data to be stored in a binary field.
+# See {Scrivito::Binary.upload} and {Scrivito::Binary#copy} for details.
+class FutureBinary
+  attr_reader :filename, :content_type, :id_to_be_copied, :file_to_be_uploaded
+
+  def initialize(filename:, content_type:, id_to_be_copied: nil, file_to_be_uploaded: nil)
+    @filename = filename
+    @content_type = content_type || content_type_of_filename(filename)
+    @id_to_be_copied = id_to_be_copied
+    @file_to_be_uploaded = file_to_be_uploaded
+  end
+
+  private
+
+  def content_type_of_filename(filename)
+    MIME::Types.type_for(filename).first.try(:content_type)
+  end
+end
+
+end

data/lib/scrivito/link_parser.rb

@@ -40,7 +40,18 @@ module Scrivito
     private
 
     def application_uri?(uri)
-      uri.absolute? && internal_uri?(uri) || uri.relative? && uri.path.present?
+      absolute_uri?(uri) && internal_uri?(uri) || relative_uri?(uri) && uri.path.present?
+    end
+
+    def absolute_uri?(uri)
+      # Ruby's URI parser assumes URLs without a scheme as relativ, while a browser assumes a
+      # schemeless "//scrivito.com" as absolute. Since the URLs are for the browser, we cannot use
+      # Ruby's URI here.
+      uri.to_s =~ /\A([a-z][a-z\d\-+\.]*:|\/\/).*/i
+    end
+
+    def relative_uri?(uri)
+      !absolute_uri?(uri)
     end
 
     def internal_uri?(uri)

data/lib/scrivito/membership_collection.rb

@@ -1,7 +1,7 @@
 module Scrivito
   # @api public
-  # The MembershipCollection includes all members of a given {Workspace}.
-  # You can access it using the {Workspace#memberships} method.
+  # The Scrivito::MembershipCollection includes all members of a given {Scrivito::Workspace}.
+  # You can access it using the {Scrivito::Workspace#memberships} method.
   class MembershipCollection
     extend Forwardable
     include Enumerable
@@ -10,10 +10,10 @@ module Scrivito
 
     # @api public
     # @!method each
-    # Iterate over all {Membership Memberships} of a specific {Workspace}. Allows
-    # you to use all the methods defined by Ruby's Enumerable module.
+    # Iterate over all {Scrivito::Membership Memberships} of a specific {Scrivito::Workspace}.
+    # Allows you to use all the methods defined by Ruby's Enumerable module.
     #
-    # @yield [Membership]
+    # @yield [Scrivito::Membership]
     #
     # @return [Enumerator] if no block is given, an Enumerator is returned
     #
@@ -41,7 +41,7 @@ module Scrivito
 
     # @api public
     # Returns a hash where the keys are +user_id+s and the values are Membership instances.
-    # @return [Hash<String, Membership>]
+    # @return [Hash<String, Scrivito::Membership>]
     def to_h
       memberships.inject(HashWithIndifferentAccess.new) do |hash, membership|
         hash[membership.user_id] = membership
@@ -52,8 +52,8 @@ module Scrivito
     # @api public
     # Returns the membership of a user or nil.
     #
-    # @param  [User, String] id_or_user
-    # @return [Membership, nil]
+    # @param  [Scrivito::User, String] id_or_user
+    # @return [Scrivito::Membership, nil]
     def [](id_or_user)
       id = if id_or_user.respond_to?(:id)
         id_or_user.id

data/lib/scrivito/obj_collection.rb

@@ -32,7 +32,7 @@ module Scrivito
     # Find the {BasicObj Obj} that has the given path.
     # Returns +nil+ if no matching object exists.
     # @param [String] path Path of the {BasicObj Obj}.
-    # @return [Obj]
+    # @return [Obj,NilClass]
     # @api public
     def find_by_path(path)
       find_by(:path, [path]).first.first
@@ -40,7 +40,7 @@ module Scrivito
 
     # Returns the {BasicObj Obj} that has the given permalink, or +nil+ if no matching object exists.
     # @param [String] permalink The permalink of the {BasicObj Obj}.
-    # @return [Obj]
+    # @return [Obj,NilClass]
     # @api public
     def find_by_permalink(permalink)
       find_by(:permalink, [permalink]).first.first

data/lib/scrivito/obj_create_params_parser.rb

@@ -3,8 +3,8 @@ module Scrivito
     private
 
     def convert_params(params)
-      if obj_class_name = params['_obj_class']
-        obj_class = Obj.type_computer.compute_type_without_fallback(obj_class_name)
+      if obj_class = params['_obj_class']
+        obj_class = Obj.type_computer.compute_type_without_fallback(obj_class)
         convert_field_params(params, obj_class.attribute_definitions)
       else
         raise ArgumentError, 'Missing "_obj_class" param'

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 parse_date_params(value)
           else value
           end
       end
@@ -49,5 +49,9 @@ module Scrivito
     def parse_binary_params(params)
       UploadedBinary.new(params) if params
     end
+
+    def parse_date_params(params)
+      DateAttribute.parse_iso8601(params)
+    end
   end
 end

data/lib/scrivito/obj_search_builder.rb

@@ -26,11 +26,10 @@ class ObjSearchBuilder < Struct.new(:query)
 
   def set_predicates
     query[:predicates].each do |p|
-      values = deserialize_values(p[:value])
       if p[:negate]
-        enumerator.and_not(p[:field], p[:operator], values)
+        enumerator.and_not(p[:field], p[:operator], p[:value])
       else
-        enumerator.and(p[:field], p[:operator], values, p[:boost])
+        enumerator.and(p[:field], p[:operator], p[:value], p[:boost])
       end
     end
   end
@@ -52,15 +51,6 @@ class ObjSearchBuilder < Struct.new(:query)
     enumerator.include_deleted if query[:include_deleted]
   end
 
-  def deserialize_values(values)
-    values.map do |(type, value)|
-      if type == 'date'
-        DateAttribute.deserialize_from_client(value)
-      else
-        value
-      end
-    end
-  end
 end
 
 end

data/lib/scrivito/obj_search_enumerator.rb

@@ -1,38 +1,40 @@
 # encoding: UTF-8
 module Scrivito
-  # Provides an enumerator for iterating over the results of searches for CMS objects to retrieve instances of these objects.
-  # This is achieved through the {http://ruby-doc.org/core-2.1.3/Enumerable.html <code>Enumerable</code> mixin},
-  # which provides methods such as <code>map</code>, <code>select</code> or <code>take</code>.
+  # Provides an enumerator for iterating over the results of searches for CMS objects to retrieve
+  # instances of these objects. This is achieved through the
+  # {http://ruby-doc.org/core-2.1.3/Enumerable.html +Enumerable+ mixin}, which provides methods such
+  # as +map+, +select+ or +take+.
   #
-  # This enumerator is lazy. If, for example, you are looking for {BasicObj Obj}s whose object class is "Publication",
-  # and there are 93 objects in total, then <code>enum.take(10)</code> fetches the first 10 objects only,
-  # ignoring the other 83.
-  # This implies that repeatedly iterating over this enumerator causes the search results and the objects to be fetched again and again.
-  # If you want to get all objects at once, use <code>enum.to_a</code>.
+  # This enumerator is lazy. If, for example, you are looking for {Scrivito::BasicObj Obj}s whose
+  # object class is +Publication+, and there are 93 objects in total, then +enum.take(10)+ fetches
+  # the first 10 objects only, ignoring the other 83.
+  # This implies that repeatedly iterating over this enumerator causes the search results and the
+  # objects to be fetched again and again. If you want to get all objects at once, use +enum.to_a+.
   #
-  # To start searching, use one of the {BasicObj Obj} methods that return an {ObjSearchEnumerator}. The preferred way is to start with {BasicObj.where Obj.where}.
+  # To start searching, use one of the {Scrivito::BasicObj Obj} methods that return an
+  # {Scrivito::ObjSearchEnumerator}. The preferred way is to start with
+  # {Scrivito::BasicObj.where Obj.where}.
   #
   # == Currently available fields and their values
   #
   # [+:*+]              Searches all fields.
   #                     This is only possible with the +contains+ and +starts_with+ operators.
-  # [+:id+]             Id of an {BasicObj Obj}. This is a +string+ field.
-  # [+:_path+]          Path of an {BasicObj Obj}. This is a +string+ field.
-  # [+:_name+]          Name of an {BasicObj Obj}. This is a +string+ field.
-  # [+:title+]          Title of an {BasicObj Obj}. This is a +string+ field.
-  # [+:body+]           Body of an {BasicObj Obj}. This is an +html+ field. Thus, only the +contains+ and
-  #                     +contains_prefix+ operators can be applied to this field.
-  # [+:_obj_class+]     Object class of an {BasicObj Obj}. This is a +string+ field.
-  # [+:_permalink+]     Permalink of an {BasicObj Obj}. This is a +string+ field.
-  # [+:_last_changed+]  Date of last change of an {BasicObj Obj}.
-  # [every <em><code>:custom_attribute</code></em>] Custom attribute of an {BasicObj Obj}. Note that
-  #                                                 depending on the attribute type (e.g. an
-  #                                                 +html+ field), some operators cannot be applied.
+  # [+:id+]             Id of an {Scrivito::BasicObj Obj}. This is a +string+ field.
+  # [+:_path+]          Path of an {Scrivito::BasicObj Obj}. This is a +string+ field.
+  # [+:_name+]          Name of an {Scrivito::BasicObj Obj}. This is a +string+ field.
+  # [+:title+]          Title of an {Scrivito::BasicObj Obj}. This is a +string+ field.
+  # [+:body+]           Body of an {Scrivito::BasicObj Obj}. This is an +html+ field. Thus, only the
+  #                     +contains+ and +contains_prefix+ operators can be applied to this field.
+  # [+:_obj_class+]     Object class of an {Scrivito::BasicObj Obj}. This is a +string+ field.
+  # [+:_permalink+]     Permalink of an {Scrivito::BasicObj Obj}. This is a +string+ field.
+  # [+:_last_changed+]  Date of last change of an {Scrivito::BasicObj Obj}.
+  # [every +_:custom_attribute_+] Custom attribute of an {Scrivito::BasicObj Obj}. Note that depending on the attribute type (e.g. an +html+ field), some operators cannot be applied.
   #
   # All values are stored as strings.
   #
-  # Date values are stored in the format YYYYMMDDHHMMSS in UTC. For example, 2000-01-01 00:00:00 UTC is stored as "<code>20000101000000</code>".
-  # This is relevant for string comparisons in which the +is_less_than+ and +is_greater_than+ operators are used.
+  # Date values are stored in the format +YYYYMMDDHHMMSS+ in UTC. For example, 2000-01-01 00:00:00
+  # UTC is stored as "+20000101000000+". This is relevant for string comparisons in which the
+  # +is_less_than+ and +is_greater_than+ operators are used.
   #
   # == Currently available operators
   #
@@ -118,7 +120,7 @@ module Scrivito
 
     # @group Chainable methods
 
-    # Adds the given AND subquery to this {ObjSearchEnumerator}.
+    # Adds the given AND subquery to this {Scrivito::ObjSearchEnumerator}.
     #
     # Compares the +field(s)+ with the +value(s)+ using the +operator+ of this subquery.
     # All CMS objects to which this criterion applies remain in the result set.
@@ -126,12 +128,13 @@ module Scrivito
     # @param [Symbol, String, Array<Symbol, String>] field Name(s) of the field(s) to be searched.
     #   For arrays, the subquery matches if one or more of these fields meet this criterion.
     # @param [Symbol, String] operator See "Currently available operators" above.
-    # @param [String, Array<String>] value The value(s) to compare with the field value(s) using the +operator+ of this subquery.
-    #   For arrays, the subquery matches if the condition is met for one or more of the array elements.
-    # @param [Hash] boost A hash where the keys are field names and their values are boosting factors.
-    #   Boosting factors must be in the range from 1 to 10.
-    #   Boosting can only be applied to subqueries in which the +contains+ or +contains_prefix+ operator is used.
-    # @return [ObjSearchEnumerator]
+    # @param [String, Array<String>] value The value(s) to compare with the field value(s) using the
+    #   +operator+ of this subquery. For arrays, the subquery matches if the condition is met for
+    #   one or more of the array elements.
+    # @param [Hash] boost A hash where the keys are field names and their values are boosting
+    #   factors. Boosting factors must be in the range from 1 to 10. Boosting can only be applied to
+    #   subqueries in which the +contains+ or +contains_prefix+ operator is used.
+    # @return [Scrivito::ObjSearchEnumerator]
     # @api public
     def and(field, operator, value, boost = nil)
       real_operator = operator_mapping(operator)
@@ -151,7 +154,7 @@ module Scrivito
       self
     end
 
-    # Adds the given negated AND subquery to this {ObjSearchEnumerator}.
+    # Adds the given negated AND subquery to this {Scrivito::ObjSearchEnumerator}.
     #
     # Compares the +field(s)+ with the +value(s)+ using the negated +operator+ of this subquery.
     # All CMS objects to which this criterion applies are removed from the result set.
@@ -161,9 +164,10 @@ module Scrivito
     # @param [Symbol, String] operator Only applicable to subqueries in which the +equals+,
     #   +starts_with+, +is_greater_than+ or +is_less_than+ operator is used.
     #   (See "Currently available operators" above).
-    # @param [String, Array<String>] value The value(s) to compare with the field value(s) using the +operator+ of this subquery.
-    #   For arrays, the subquery matches if the condition is met for one or more of the array elements.
-    # @return [ObjSearchEnumerator]
+    # @param [String, Array<String>] value The value(s) to compare with the field value(s) using the
+    #   +operator+ of this subquery. For arrays, the subquery matches if the condition is met for
+    #   one or more of the array elements.
+    # @return [Scrivito::ObjSearchEnumerator]
     # @api public
     def and_not(field, operator, value)
       real_operator = operator_mapping(operator)
@@ -180,8 +184,9 @@ module Scrivito
     end
 
     # Orders the results by +field_name+.
-    # @param [Symbol, String] field_name This parameter specifies the field by which the hits are sorted (e.g. +:_path+).
-    # @return [ObjSearchEnumerator]
+    # @param [Symbol, String] field_name This parameter specifies the field by which the hits are
+    #   sorted (e.g. +:_path+).
+    # @return [Scrivito::ObjSearchEnumerator]
     # @api public
     def order(field_name)
       options[:sort_by] = field_name
@@ -190,7 +195,7 @@ module Scrivito
     end
 
     # Reverses the order of the results. Requires {#order} to be applied before.
-    # @return [ObjSearchEnumerator]
+    # @return [Scrivito::ObjSearchEnumerator]
     # @api public
     def reverse_order
       options[:sort_by].present? or raise "A search order has to be specified"\
@@ -203,7 +208,7 @@ module Scrivito
     # Number of search results to be returned by each of the internal search requests.
     # The default is +10+. The server may reduce large batches to a reasonable size.
     # @param [Integer] size A value in the range from +1+ to +100+.
-    # @return [ObjSearchEnumerator]
+    # @return [Scrivito::ObjSearchEnumerator]
     # @api public
     def batch_size(size)
       options[:size] = size
@@ -212,9 +217,9 @@ module Scrivito
     end
 
 
-    # Omits the first +amount+ of {BasicObj Obj}s from the results. The default is +0+.
+    # Omits the first +amount+ of {Scrivito::BasicObj Obj}s from the results. The default is +0+.
     # @param [Integer] amount
-    # @return [ObjSearchEnumerator]
+    # @return [Scrivito::ObjSearchEnumerator]
     # @api public
     def offset(amount)
       options[:offset] ||= 0
@@ -231,7 +236,7 @@ module Scrivito
 
     # @!endgroup
 
-    # Iterates over the search result, yielding {BasicObj Obj}.
+    # Iterates over the search result, yielding {Scrivito::BasicObj Obj}.
     # @yield [Obj]
     # @return [void]
     # @api public
@@ -273,7 +278,7 @@ module Scrivito
     end
 
     # Loads a single batch of search results from the backend.
-    # @return [Array] of {BasicObj Obj}.
+    # @return [Array] of {Scrivito::BasicObj Obj}.
     # Usually returns +batch_size+ results if available,
     # but may occasionally return fewer than +batch_size+ results (due to rate limit, for example).
     # @api public
@@ -303,7 +308,7 @@ module Scrivito
 
     def convert_single_value(value)
       if value.is_a?(Time) || value.is_a?(Date)
-        DateAttribute.serialize_for_backend(value)
+        DateAttribute.serialize(value)
       else
         value.to_s
       end