scrivito_sdk 0.66.0 → 0.70.0.rc1

data/lib/scrivito/controller_actions.rb

@@ -20,10 +20,11 @@ module ControllerActions
       :show_widget,
       :widget_details,
       :page_details,
-      :resource_details,
     ]
 
     before_filter :load_object
+
+    helper_method :scrivito_in_editable_view?
   end
 
   #
@@ -60,11 +61,70 @@ module ControllerActions
     render 'scrivito/page_details', layout: 'scrivito_dialog'
   end
 
-  def resource_details
-    assert_dialog_layout
-    @scrivito_resource = editing_context.selected_workspace.objs
-        .find_including_deleted(params[:resource_id])
-    render text: '', layout: 'scrivito_dialog'
+  # How to handle widget errors in +production+.
+  #
+  # When an exception is raised from within a widget, the entire page is not available.
+  # Often, this is the case in production if the developer has forgotten to handle specific
+  # content scenarios such as empty date attributes, missing titles, unmanaged enum values, etc.
+  # but also for simple coding mistakes during development.
+  #
+  # Override this method to prevent the entire page from being unavailable due to widget errors.
+  #
+  # The overridden method allows to:
+  # * catch a widget error and replace it with an HTML placeholder.
+  # * report a widget error to an external service like Honeybadger or Airbrake.
+  #
+  # This method is _not_ called if Rails is in the +development+ or +test+ environment.
+  # In those environments, all widget errors are just raised.
+  #
+  # By default, this method just reraises the given error.
+  #
+  # @param widget [Scrivito::BasicWidget] the flawed widget
+  # @param error [StandardError] the error that occurred
+  # @raise [StandardError] if this method is not overridden, the +error+ passed to it is reraised.
+  #
+  # @example Notify external service about widget error and render an HTML placeholder:
+  #   def on_scrivito_widget_error(widget, error)
+  #     # Report error to external service (e.g. Honeybadger or Airbrake):
+  #     Honeybadger.notify(error)
+  #     notify_airbrake(error)
+  #
+  #     # Replace corrupted widget output with a placeholder:
+  #     message = "Rendering #{widget.description_for_editor} failed with #{error.message}"
+  #     return "<!--#{message}-->".html_safe if Rails.env.production?
+  #     "<p>#{message}</p>".html_safe
+  #   end
+  # @api public
+  def on_scrivito_widget_error(widget, error)
+    raise error
+  end
+
+  #
+  # Returns whether the GUI is in the +editable+ view.
+  #
+  # +scrivito_in_editable_view?+ is also a helper method.
+  #
+  # @api public
+  # @return +true+ if the current visitor is an authenticated editor, the selected workspace is
+  #   editable and the display mode is +editing+.
+  # @return +false+ otherwise.
+  #
+  def scrivito_in_editable_view?
+    editing_context.editable_display_mode?
+  end
+
+  #
+  # Returns the current user.
+  #
+  # +scrivito_user+ is also a helper method.
+  #
+  # @api public
+  # @return [Scrivito::User] if the {Scrivito::Configuration.editing_auth} callback returns an
+  #   instance of {Scrivito::User}.
+  # @return +nil+ otherwise.
+  #
+  def scrivito_user
+    editing_context.editor
   end
 
   module ClassMethods
@@ -126,7 +186,8 @@ module ControllerActions
   # @api public
   #
   def deliver_file
-    if url = @obj.binary_url
+    if binary = @obj.binary
+      url = BinaryRouting.new(request, scrivito_engine).resolved_binary_obj_url(@obj, binary)
       redirect_to CmsRouting.match_protocol(url, request)
     else
       render text: 'Empty Blob', status: 404

data/lib/scrivito/controller_runtime.rb

@@ -9,6 +9,14 @@ protected
 
   attr_internal :scrivito_runtime
 
+  def process_action(action, *args)
+    # We also need to reset the runtime before each action
+    # because of queries in middleware or in cases we are streaming
+    # and it won't be cleaned up by the method below.
+    reset_scrivito_runtime
+    super
+  end
+
   def cleanup_view_runtime
     self.scrivito_runtime = reset_scrivito_runtime
 

data/lib/scrivito/date_attribute.rb

@@ -12,6 +12,14 @@ module Scrivito
       end
     end
 
+    def self.parse_iso8601(iso8601_date_time)
+      return unless iso8601_date_time
+
+      DateTime.iso8601(iso8601_date_time).in_time_zone
+    rescue ArgumentError
+      raise "The value is not a valid ISO 8601 date time: #{iso8601_date_time.inspect}"
+    end
+
     def self.serialize(attribute_value)
       attribute_value = case attribute_value
         when Date then attribute_value.to_time

data/lib/scrivito/errors.rb

@@ -17,7 +17,7 @@ end
 class InternalError < ScrivitoError
 end
 
-# @api beta
+# @api public
 class TransformationError < ScrivitoError
   attr_reader :code
 
@@ -27,12 +27,15 @@ class TransformationError < ScrivitoError
   end
 end
 
-# @api beta
+# @api public
 class TransformationSourceError < TransformationError
 end
 
-# @api beta
+# @api public
 class TransformationDefinitionError < TransformationError
 end
 
+class TransferModificationsError < ScrivitoError
+end
+
 end # module Scrivito

data/lib/scrivito/generator_helper.rb

@@ -0,0 +1,13 @@
+module Scrivito
+module GeneratorHelper
+  class << self
+    def attribute_definition(arg)
+      if %w(enum multienum).include?(arg.type.to_s)
+        "attribute :#{arg.name}, :#{arg.type}, values: []"
+      else
+        "attribute :#{arg.name}, :#{arg.type}"
+      end
+    end
+  end
+end
+end

data/lib/scrivito/image_tag.rb

@@ -1,51 +1,45 @@
 module Scrivito
 
 class ImageTag < Struct.new(:view_context)
-  def options(obj, attribute_name, tag_options, editing_options)
+  def options(obj_or_widget, attribute_name, tag_options, editing_options)
     tag_options.reverse_merge(
-      src: src(obj, attribute_name, editing_options),
-      alt: alt(obj, attribute_name)
+      src: src(obj_or_widget, attribute_name, editing_options),
+      alt: alt(obj_or_widget, attribute_name)
     )
   end
 
   private
 
-  def src(obj, attribute_name, editing_options)
-    path(obj, attribute_name, editing_options) ||
+  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')
   end
 
-  def alt(obj, attribute_name)
-    case target = obj[attribute_name]
-    when Binary then obj.try(:alt_description)
+  def alt(obj_or_widget, attribute_name)
+    case target = obj_or_widget[attribute_name]
+    when Binary then obj_or_widget.try(:alt_description)
     when Enumerable then target.first.try(:alt_description)
     else target.try(:alt_description)
     end
   end
 
-  def path(obj, attribute_name, editing_options)
-    if target = target(obj, attribute_name, editing_options)
-      image_options = editing_options.slice(:transform)
-      cms_routing = CmsRouting.new(request, main_app, scrivito_engine, image_options)
-      cms_routing.path_or_url(target, :path)
-    end
-  end
-
-  def target(obj, attribute_name, editing_options)
-    target = obj[attribute_name]
-    target = link_target(target) if target.is_a?(Link)
-    target = linklist_target(target) if target.is_a?(Enumerable)
-    target
-  end
-
-  def link_target(link)
-    link.internal? ? link.obj : link
-  end
-
-  def linklist_target(linklist)
-    if linklist.any?
-      link_target(linklist.first)
+  def path(obj_or_widget, attribute_name, editing_options)
+    attribute_value = obj_or_widget[attribute_name]
+    return if attribute_value.blank?
+
+    image_options = editing_options.slice(:transform)
+
+    if attribute_value.is_a?(Binary)
+      if obj_or_widget.is_a?(Widget)
+        raise ScrivitoError, 'scrivito_image_tag does not accept widgets with binary attributes'
+      end
+      BinaryRouting.new(request, scrivito_engine)
+        .binary_obj_url(obj_or_widget, attribute_value, image_options)
+    else
+      path = CmsRouting.new(request, main_app, scrivito_engine, image_options)
+        .path_or_url(attribute_value, :path)
+      path unless path == CmsRouting::LINK_TO_EMPTY_BLOB
     end
   end
 

data/lib/scrivito/layout_tags.rb

@@ -1,14 +1,14 @@
 module Scrivito
 
 class LayoutTags < Struct.new(:view)
-  def client_config(obj, resource)
+  def page_config(obj)
     if view.scrivito_user
-      editing_context = EditingContextMiddleware.from_request(view.request)
-      config = ClientConfig.new(obj, editing_context, view.lookup_context,
-        resource: resource,
-        return_to: view.params[:return_to]
+      page_config = PageConfig.new(
+        obj: obj,
+        editing_context: editing_context,
+        lookup_context: view.lookup_context,
       ).to_json
-      view.content_tag(:div, '', 'data-scrivito-private-config' => config)
+      view.content_tag(:div, '', 'data-scrivito-private-page-config' => page_config)
     end
   end
 
@@ -21,6 +21,12 @@ class LayoutTags < Struct.new(:view)
     content << "; Version #{GemInfo.version}" if view.scrivito_user
     view.tag(:meta, name: 'generator', content: content)
   end
+
+  private
+
+  def editing_context
+    EditingContextMiddleware.from_request(view.request)
+  end
 end
 
 end

data/lib/scrivito/link.rb

@@ -1,14 +1,14 @@
 require 'active_model/naming'
 
 module Scrivito
-  # This class provides an interfaces for handling CMS Links.
-  # To format a link for rendering in an html page, use the +scrivito_path+ or +scrivito_url+ methods.
+  # This class provides an interface for handling CMS links.
+  # To format a link for rendering on an HTML page, use the +scrivito_path+ or +scrivito_url+ methods.
   # @api public
   class Link
 
     extend ActiveModel::Naming
 
-    # Parses a url and returns a {Link} object. Determines internal urls based on the given
+    # Parses a URL and returns a {Link} object. Determines internal URLs based on the given
     # +hostname+ and +port+.
     # @api public
     # @param [String] url
@@ -18,7 +18,9 @@ module Scrivito
       LinkParser.new(host, port).parse(url)
     end
 
-    # Create a new link obj
+    # Create a new link object.
+    # @example Set the 'current_campaign' link of an object:
+    #   obj.update(current_campaign: Scrivito::Link.new(obj: Obj.find('55dd1ce50ecc41c8')))
     # @api public
     # @param [Hash] link_data
     # @option link_data [String] url
@@ -31,57 +33,56 @@ module Scrivito
       @link_data = link_data.with_indifferent_access
     end
 
-    # The link's external url. Only available for external links.
-    # Warning: Do not output the url directly unless you know what you are doing.
-    # Normally you want to use the +scrivito_path+ or +scrivito_url+ methods to format a link.
+    # The external URL of the link. Only available for external links.
+    # Warning: Do not output the URL directly unless you know what you are doing.
+    # Normally, you want to use the +scrivito_path+ or +scrivito_url+ methods to format a link.
     # @api public
     def url
       @link_data[:url]
     end
 
-    # Set the link's external url. This will lead to an external link.
+    # Set the external URL of the link. This causes the link to become an external link.
     # @api public
     # @param value [String] the url of the link
     def url=(value)
       @link_data[:url] = value
     end
 
-    # Returns the {BasicObj Obj} this link is referencing. May be nil if the
+    # Returns the {BasicObj Obj} this link references. May be +nil+ if the
     # link is external.
     # @api public
     def obj
       @link_data[:obj]
     end
 
-    # Set the {BasicObj Obj} this link is referencing. May be nil if the
-    # link is external.
+    # Set the {BasicObj Obj} this link should reference.
     # @api public
-    # @param value [Obj] the obj this link should be referencing
+    # @param value [Obj] the obj this link should point to
     def obj=(value)
       @link_data[:obj] = value
     end
 
-    # The link's title.
+    # Returns the title of the link.
     # @api public
     def title
       @link_data[:title]
     end
 
-    # Set the link's title.
+    # Set the link title.
     # @api public
-    # @param value [String] the link's title
+    # @param value [String] the title of the link
     def title=(value)
       @link_data[:title] = value
     end
 
-    # Returns the link's query string as in "index.html?query_string".
+    # Returns the query string of the link as in "index.html?query_string".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
     # @api public
     def query
       @link_data[:query]
     end
 
-    # Set the link's query string as in "index.html?query_string".
+    # Set the query string of the link as in "index.html?query_string".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
     # @api public
     # @param value [String] the query string of the link
@@ -89,31 +90,39 @@ module Scrivito
       @link_data[:query] = value
     end
 
-    # Returns the link's anchor as in "index.html#anchor".
+    # Returns the anchor of the link as in "index.html#anchor".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
     # @api public
     def fragment
       @link_data[:fragment]
     end
 
-    # Set the link's anchor as in "index.html#anchor".
+    # Set the anchor of the link as in "index.html#anchor".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
     # @api public
-    # @param value [String] the anchor or fragement of the link
+    # @param value [String] the anchor or fragment of the link
     def fragment=(value)
       @link_data[:fragment] = value
     end
 
+    # Returns the link target. "target" refers to the equally-named HTML attribute,
+    # not the link destination.
+    # @api public
     def target
       @link_data[:target]
     end
 
+    # Set the link target. "target" refers to the equally-named HTML attribute,
+    # not the link destination.
+    # @api public
+    # @param value [String] the target of the link
     def target=(value)
       @link_data[:target] = value
     end
 
-    # Returns the file extension (e.g. zip, pdf) of this link's (internal or external) target.
-    # Returns an empty string if the file extension is can not be determined.
+    # Returns the file extension (e.g. zip, pdf) of the (internal or external) destination
+    # of this link.
+    # Returns an empty string if the file extension cannot be determined.
     # @api public
     def file_extension
       if internal?
@@ -124,9 +133,8 @@ module Scrivito
       end
     end
 
-    # Returns the title of this Link if it is set.
-    # Otherwise it returns the display_title of the destination object for internal Links
-    # or the URL for external Links.
+    # Returns the title of this Link if it is set. If not, the +display_title+ of the destination
+    # object is returned for internal links, or the +url+ for external links.
     # @api public
     def display_title
       dt = title
@@ -135,10 +143,10 @@ module Scrivito
       dt
     end
 
-    # The alt description of a +Link+ used for {ScrivitoHelper#scrivito_image_tag}.
+    # The alt description of a +Link+, used by {ScrivitoHelper#scrivito_image_tag}.
     #
-    # By default this method returns the +title+ of this +Link+.
-    # If +title+ is nil and this +Link+ references an {BasicObj Obj}
+    # By default, this method returns the +title+ of this +Link+.
+    # If +title+ is +nil+ and this +Link+ references an {BasicObj Obj}, the
     # +alt_description+ of that {BasicObj Obj} is used.
     #
     # @api public
@@ -147,13 +155,13 @@ module Scrivito
       obj.alt_description if internal?
     end
 
-    # Returns true this Link links to a CMS Object.
+    # Returns true if this Link points to a CMS object.
     # @api public
     def internal?
       url.nil?
     end
 
-    # Returns true if this Link links to an external URL.
+    # Returns true if this Link points to an external location.
     # @api public
     def external?
       !internal?
@@ -190,12 +198,20 @@ module Scrivito
         params[:title] = title if title
         params[:query] = query if query
         params[:fragment] = fragment if fragment
+        params[:target] = target if target
       else
         params[:url] = url
         params[:title] = title if title
+        params[:target] = target if target
       end
 
       params
     end
+
+    def ==(other)
+      return false unless other.is_a?(Link)
+
+      to_cms_api_linklist_params == other.to_cms_api_linklist_params
+    end
   end
 end

data/lib/scrivito/log_subscriber.rb

@@ -21,6 +21,21 @@ module Scrivito
       debug "  #{name}  #{event.payload[:index]} #{event.payload[:keys].inspect}"
     end
 
+    def backend_request(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      duration = '(%.1fms)' % [event.duration]
+
+      param = event.payload[:params]
+      param_text = " #{param}" if param
+
+      verb_text = event.payload[:verb].upcase
+      path_text = event.payload[:path]
+
+      debug "  Scrivito #{verb_text} #{path_text}#{param_text} #{duration}"
+    end
+
     def logger
       Rails.logger
     end

data/lib/scrivito/membership.rb

@@ -1,7 +1,7 @@
 module Scrivito
 
   # @api public
-  # Represents a Membership of a {User} in a {Workspace}
+  # Represents a Membership of a {User} in a {Workspace}.
   class Membership
 
     # @api public
@@ -15,7 +15,7 @@ module Scrivito
     #
     # @note Currently the only available role is "owner".
     #
-    # @return [String] the name of role
+    # @return [String] the name of the role
     attr_reader :role
 
     def initialize(user_id, data)
@@ -28,7 +28,7 @@ module Scrivito
     # @api public
     # @return The value returned by the proc set in {Configuration.find_user}.
     # @return An unknown user if no proc is set in {Configuration.find_user} or the proc returns a
-    #     falsy value. The unknown user will have the id of the original user and no abilities.
+    #     falsy value. The unknown user will have the id of the original user and no capabilities.
     # @see Scrivito::Configuration.find_user
     def user
       User.find(user_id) || User.unknown_user(user_id)

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 {Workspace#memberships} method.
+  # You can access it using the {Workspace#memberships} method.
   class MembershipCollection
     extend Forwardable
     include Enumerable
@@ -11,28 +11,28 @@ module Scrivito
     # @api public
     # @!method each
     # Iterate over all {Membership Memberships} of a specific {Workspace}. Allows
-    # you to use all methods defined by ruby's Enumerable module.
+    # you to use all the methods defined by Ruby's Enumerable module.
     #
     # @yield [Membership]
     #
-    # @return [Enumerator] if no block is given an Enumerator is returned
+    # @return [Enumerator] if no block is given, an Enumerator is returned
     #
     # @example
-    #   # Obtain all owners of a workspace
+    #   # Obtain all owners of a workspace.
     #   my_workspace.memberships.select do |membership|
     #     membership.role == "owner"
     #   end
     #
-    #   # Get an array of all the members' user_ids
+    #   # Get an array of all the members' user_ids.
     #   my_workspace.memberships.map { |membership| membership.user_id }
     #
-    #   # Or use it directly to iterate over all items
+    #   # Or use it directly to iterate over all items.
     #   my_workspace.memberships.each do |membership|
     #     puts "User #{membership.user_id} has the role #{membership.role}"
     #   end
     #
-    # @note For a complete list of all provided methods please view the
-    #   documentation of the Enumerable module
+    # @note For a complete list of the provided methods, please refer to the
+    #   documentation of the Enumerable module.
     def_delegator :memberships, :each
 
     def initialize(workspace)
@@ -40,7 +40,7 @@ module Scrivito
     end
 
     # @api public
-    # return a hash where the keys are user_ids and the values are Membership-Instances
+    # Returns a hash where the keys are +user_id+s and the values are Membership instances.
     # @return [Hash<String, Membership>]
     def to_h
       memberships.inject(HashWithIndifferentAccess.new) do |hash, membership|
@@ -50,7 +50,7 @@ module Scrivito
     end
 
     # @api public
-    # Returns the membership for a user or nil
+    # Returns the membership of a user or nil.
     #
     # @param  [User, String] id_or_user
     # @return [Membership, nil]

data/lib/scrivito/meta_data_collection.rb

@@ -0,0 +1,22 @@
+module Scrivito
+#
+# This class represents a collection of meta data attributes.
+#
+# @api beta
+#
+class MetaDataCollection
+  def initialize(attributes)
+    @attributes = ActiveSupport::HashWithIndifferentAccess.new(attributes)
+  end
+
+  #
+  # Find value of a meta data attribute.
+  #
+  # @api beta
+  # @param name [Symbol, String] the name of the meta data attribute.
+  # @return [String, Array, Fixnum, Date, nil] meta data attribute value if found or +nil+ otherwise.
+  def [](name)
+    @attributes[name]
+  end
+end
+end

data/lib/scrivito/model_library.rb

@@ -77,11 +77,17 @@ class ModelLibrary
   end
 
   def load_models_from_path(type, path, base_class)
-    Dir["#{path}/**/*_#{type}.rb"].map do |file_path|
+    candidates_from_path(type, path).map do |file_path|
       load_model(file_path.gsub(path, '').gsub('.rb', '').classify, base_class)
     end
   end
 
+  def candidates_from_path(type, path)
+    result = Dir["#{path}/**/*_#{type}.rb"]
+    result += Dir["#{path}/**/page.rb"] if type == 'page'
+    result
+  end
+
   def load_model(class_name, base_class)
     model_class = class_name.constantize
     model_class if model_class.ancestors.include?(base_class)