scrivito_sdk 1.0.0 → 1.1.0.rc1

data/lib/generators/scrivito/install/install_generator.rb

@@ -72,6 +72,18 @@ module Scrivito
         copy_file 'app/views/image_widget/show.html.erb'
         copy_file 'app/views/image_widget/thumbnail.html.erb'
       end
+
+      def append_scrivito_routes
+        log :route, "Appending Scrivito routes"
+        definition = "\n"\
+          "  # Default Scrivito routes. Adapt them to change the routing of CMS objects.\n"\
+          "  # See the documentation of 'scrivito_route' for a detailed description.\n"\
+          "  scrivito_route '/', using: 'homepage'\n"\
+          "  scrivito_route '(/)(*slug-):id', using: 'slug_id'\n"\
+          "  scrivito_route '/*permalink', using: 'permalink', format: false\n"\
+
+        inject_into_file 'config/routes.rb', definition, before: /^end\s*\z/, verbose: false
+      end
     end
   end
 end

data/lib/generators/scrivito/install/templates/config/initializers/scrivito.rb

@@ -7,4 +7,7 @@ Scrivito.configure do |config|
   # config.tenant = 'my-tenant-123'
   # config.api_key = 'secret'
   #
+
+  # Disable the default routes to allow route configuration
+  config.inject_preset_routes = false
 end

data/lib/scrivito/attribute_definition.rb

@@ -44,7 +44,19 @@ class AttributeDefinition
   private
 
   def assert_valid_options
-    if (values = @options[:values]) && values.include?('')
+    @options.assert_valid_keys(:values, 'values')
+    if values = @options[:values]
+      values.each(&method(:assert_valid_value))
+    end
+  end
+
+  def assert_valid_value(value)
+    unless value.is_a?(String)
+      raise ScrivitoError,
+        %{#{value.class} is not allowed as value for #{type} attribute "#{name}".}
+    end
+
+    if value == ''
       raise ScrivitoError, %{Empty string is not allowed as value for #{type} attribute "#{name}".}
     end
   end

data/lib/scrivito/attribute_deserializer.rb

@@ -41,7 +41,7 @@ class AttributeDeserializer < Struct.new(:model, :workspace)
 
   def deserialize_link_value(attribute_value)
     return unless attribute_value
-    if attribute_value['destination']
+    if attribute_value['obj_id']
       deserialize_internal_link(attribute_value)
     else
       deserialize_external_link(attribute_value)
@@ -52,10 +52,10 @@ class AttributeDeserializer < Struct.new(:model, :workspace)
     if link_definitions.present?
       link_definitions = link_definitions.map(&:with_indifferent_access)
 
-      object_ids = link_definitions.map { |link_data| link_data[:destination] }.compact.uniq
+      object_ids = link_definitions.map { |link_data| link_data[:obj_id] }.compact.uniq
       objects = object_ids.empty? ? [] : workspace.objs.find(object_ids)
       link_definitions.each_with_object([]) do |link_data, links|
-        obj = objects.detect { |o| o && o.id == link_data[:destination] }
+        obj = objects.detect { |o| o && o.id == link_data[:obj_id] }
         link = Link.new(link_data.merge(obj: obj))
         links << link if link.resolved?
       end
@@ -82,7 +82,7 @@ class AttributeDeserializer < Struct.new(:model, :workspace)
 
   def deserialize_internal_link(attribute_value)
     Link.new(attribute_value.slice('title', 'query', 'fragment', 'target').symbolize_keys
-      .merge(obj: workspace.objs.find(attribute_value['destination'])))
+      .merge(obj: workspace.objs.find(attribute_value['obj_id'])))
   rescue ResourceNotFound
   end
 

data/lib/scrivito/attribute_value_renderer.rb

@@ -0,0 +1,79 @@
+module Scrivito
+  class AttributeValueRenderer < Struct.new(:view)
+    def render(value, type)
+      method_name = "render_as_#{type}"
+      respond_to?(method_name) ? public_send(method_name, value) : value
+    end
+
+    def render_as_date(date)
+      if date
+        html_escape(localize(date))
+      end
+    end
+
+    def render_as_enum(enum)
+      enum.to_s
+    end
+
+    def render_as_html(html)
+      if html
+        cms_routing = CmsRouting.new(view.request, view, view.scrivito_engine)
+        cms_routing.convert_links(html).html_safe
+      end
+    end
+
+    def render_as_link(link)
+      if link
+        link_to(link.display_title, scrivito_path(link))
+      end
+    end
+
+    def render_as_linklist(linklist)
+      if linklist.any?
+        content_tag(:ul) do
+          capture do
+            linklist.each do |link|
+              concat content_tag(:li) { render_as_link(link) }
+            end
+          end
+        end
+      end
+    end
+
+    def render_as_multienum(multienum)
+      render_as_stringlist(multienum)
+    end
+
+    def render_as_reference(reference)
+      reference.try(:description_for_editor)
+    end
+
+    def render_as_referencelist(referencelist)
+      if referencelist.any?
+        content_tag(:ul) do
+          capture do
+            referencelist.each do |reference|
+              concat content_tag(:li) { render_as_reference(reference) }
+            end
+          end
+        end
+      end
+    end
+
+    def render_as_string(string)
+      string.is_a?(HtmlString) ? render_as_html(string) : html_escape(string)
+    end
+
+    def render_as_stringlist(stringlist)
+      stringlist.join(', ')
+    end
+
+    private
+
+    delegate :capture, :concat, :content_tag, :localize, :link_to, :scrivito_path, to: :view
+
+    def html_escape(string)
+      ERB::Util.html_escape(string)
+    end
+  end
+end

data/lib/scrivito/backend/obj_data_cache.rb

@@ -45,7 +45,7 @@ module ObjDataCache
   class SimpleCacheView < Struct.new(:cache_id)
 
     def read_obj(id)
-      if tag = CmsDataCache.read_obj_data_rest(cache_id, "id", id)
+      if tag = CmsDataCache.read_obj_data(cache_id, "id", id)
         CmsDataCache.read_data_from_tag(tag)
       end
     end
@@ -58,11 +58,11 @@ module ObjDataCache
       index_access
     end
 
-    def write_index(index, key, data)
+    def write_index(index, key, data, **options)
       index_access
     end
 
-    def write_index_not_updatable(index, key, data)
+    def write_index_not_updatable(index, key, data, **options)
       index_access
     end
 
@@ -77,7 +77,7 @@ module ObjDataCache
     def write_cache(index, key, data)
       raise InternalError unless data
 
-      CmsDataCache.write_obj_data_rest(cache_id, index, key, data)
+      CmsDataCache.write_obj_data(cache_id, index, key, data)
     end
 
   end
@@ -85,7 +85,7 @@ module ObjDataCache
   class IncrementalCacheView < Struct.new(:cache_id, :viewed_state)
 
     def read_index(index, key, &update_function)
-      if hit = CmsDataCache.read_obj_data_rest(cache_id, index, key)
+      if hit = CmsDataCache.read_obj_data(cache_id, index, key)
 
         cached_at = hit.first
         cached_result = hit.second
@@ -106,17 +106,17 @@ module ObjDataCache
       end
     end
 
-    def write_index(index, key, data)
-      write_cache_updatable(index, key, data)
+    def write_index(index, key, data, **options)
+      write_cache_updatable(index, key, data, **options)
     end
 
     # use this to cache data that cannot be updated
-    def write_index_not_updatable(index, key, data)
-      write_cache(index, key, viewed_state.content_state_id, data)
+    def write_index_not_updatable(index, key, data, **options)
+      write_cache(index, key, viewed_state.content_state_id, data, **options)
     end
 
     def read_obj(id)
-      if hit = CmsDataCache.read_obj_data_rest(cache_id, "id", id)
+      if hit = CmsDataCache.read_obj_data(cache_id, "id", id)
         cached_at, cached_tag = hit
 
         tag_in_changes = viewed_state.obj_from_changes(id, cached_at)
@@ -155,15 +155,15 @@ module ObjDataCache
 
     private
 
-    def write_cache_updatable(index, key, data)
-      write_cache(index, key, stable_csid, data)
+    def write_cache_updatable(index, key, data, **options)
+      write_cache(index, key, stable_csid, data, **options)
     end
 
-    def write_cache(index, key, csid, data)
+    def write_cache(index, key, csid, data, **options)
       raise InternalError unless data
 
-      CmsDataCache.write_obj_data_rest(
-          cache_id, index, key, [csid, data])
+      CmsDataCache.write_obj_data(
+          cache_id, index, key, [csid, data], **options)
     end
 
     # tries to update an outdated cache result using the changes recorded in the

data/lib/scrivito/backend/obj_data_from_rest.rb

@@ -14,8 +14,7 @@ class ObjDataFromRest < ObjData
       if attribute_name.starts_with?('_')
         [attribute_data, nil]
       else
-        type = attribute_data[0]
-        [legacy_compatible(attribute_data[1], type), type]
+        [attribute_data[1], attribute_data[0]]
       end
     else
       [nil, nil]
@@ -32,25 +31,6 @@ class ObjDataFromRest < ObjData
 
   private
 
-  def legacy_compatible(value, type)
-    if type == "linklist"
-      value.map(&method(:legacy_link))
-    elsif type == "link"
-      legacy_link(value)
-    else
-      value
-    end
-  end
-
-  def legacy_link(link)
-    return link unless link["obj_id"]
-
-    transformed = link.dup
-    transformed["destination"] = transformed.delete("obj_id")
-
-    transformed
-  end
-
   def value_of_widget_pool
     if widget_pool = @data['_widget_pool']
       # using Hash#merge to "map" to a new Hash

data/lib/scrivito/backend/obj_query.rb

@@ -28,7 +28,7 @@ class << self
       return load_nested_ids(revision, ids_from_cache)
     end
 
-    backend_ids = revision.obj_search_request(index.query(missing_keys))
+    backend_ids, tentative = revision.obj_search_request(index.query(missing_keys))
 
     all_obj_datas = load_nested_ids(revision, ids_from_cache + [backend_ids])
 
@@ -39,7 +39,7 @@ class << self
 
     grouped_backend_results.each_with_index do |result, i|
       ids = result.map { |obj_data| obj_data.value_of("_id") }
-      cache.write_index(index.id, missing_keys[i], ids)
+      cache.write_index(index.id, missing_keys[i], ids, persistent: !tentative)
     end
 
     cache_obj_datas.map do |obj_datas|

data/lib/scrivito/basic_obj.rb

@@ -600,12 +600,23 @@ module Scrivito
       toclist
     end
 
-    # @param objs_to_be_sorted [Array<Scrivito::BasicObj>] unsorted list of CMS objects
-    # @param list [Array<Scrivito::BasicObj>] list of objects that defines the order
-    # @return [Array<Scrivito::BasicObj>] a sorted list of objects. Objects present in
-    #   +objs_to_be_sorted+ but not in +list+ are appended to the end, sorted by +Obj#id+
-    def self.sort_by_list(objs_to_be_sorted, list)
-      (list & objs_to_be_sorted) + (objs_to_be_sorted - list).sort_by(&:id)
+    # @api public
+    #
+    # Returns a list of children that are sorted according to the order specifed in the
+    # +child_order+ attribute. The same sort order is used when rendering navigations using
+    # the {ScrivitoHelper#scrivito_tag_list scrivito_tag_list} helper.
+    #
+    # @return [Array<Obj>]
+    def sorted_toclist
+      if sortable_toclist?
+        (child_order & toclist) + (toclist - child_order).sort_by(&:id)
+      else
+        toclist
+      end
+    end
+
+    def sortable_toclist?
+      has_attribute?(:child_order)
     end
 
     # This should be a Set, because it's faster in this particular case.

data/lib/scrivito/binary.rb

@@ -89,9 +89,15 @@ class Binary
     find_url('get')
   end
 
+  def no_cache_url
+    if private?
+      CmsBackend.instance.find_blob_data(id, 'private_access', 'get', no_cache: true)['url']
+    end
+  end
+
   def url_from_cache
-    blob_data = CmsBackend.instance
-      .find_blob_data_from_cache(id, access_type, 'get', transformation_definition)
+    blob_data = CmsBackend.instance.find_blob_data_from_cache(id, access_type, 'get',
+      transformation_definition: transformation_definition)
     if blob_data
       blob_data['url']
     end
@@ -111,7 +117,7 @@ class Binary
   # @raise [Scrivito::ScrivitoError] If the binary is the result of a transformation.
   def content_type
     raise_field_not_available('Content type') if transformed?
-    headers[:content_type]
+    meta_data[:content_type]
   end
 
   # @api public
@@ -121,7 +127,7 @@ class Binary
   # @raise [Scrivito::ScrivitoError] If the binary is the result of a transformation.
   def content_length
     raise_field_not_available('Content length') if transformed?
-    headers[:content_length].to_i
+    meta_data[:content_length]
   end
 
   #
@@ -283,7 +289,9 @@ class Binary
   end
 
   def find_url(verb)
-    CmsBackend.instance.find_blob_data(id, access_type, verb, transformation_definition)['url']
+    blob_data = CmsBackend.instance.find_blob_data(id, access_type, verb,
+      transformation_definition: transformation_definition)
+    blob_data['url']
   rescue ClientError => e
     case e.backend_code
     when /\Abinary\.unprocessable\.image\.transform\.source\./

data/lib/scrivito/cache/chainable.rb

@@ -11,12 +11,13 @@ module Scrivito
         value
       end
 
-      def write(key, value, expires_in = nil)
+      def write(key, value, expires_in: nil, persistent: true)
         transformed_key = transform_key(key)
-        if forward_write?(key, value, expires_in)
-          next_store.write(transformed_key, value, expires_in)
+        if persistent && forward_write?(key, value, expires_in)
+          next_store.write(transformed_key, value, expires_in: expires_in)
         end
-        internal_write(transformed_key, value, expires_in)
+
+        internal_write(transformed_key, value, expires_in) if persistent || tentative?
       end
 
       def fetch(key, &block)
@@ -34,6 +35,10 @@ module Scrivito
 
       private
 
+      def tentative?
+        raise NotImplementedError
+      end
+
       def next_store
         raise NotImplementedError
       end
@@ -42,7 +47,7 @@ module Scrivito
         raise NotImplementedError
       end
 
-      def internal_write(key, value, expires_in = nil)
+      def internal_write(key, value, expires_in)
         raise NotImplementedError
       end
 

data/lib/scrivito/cache/file_store.rb

@@ -17,6 +17,10 @@ module Cache
 
     delegate :read, to: :internal_store, prefix: :internal
 
+    def tentative?
+      false
+    end
+
     def internal_write(key, value, expires_in = nil)
       internal_store.write(key, value, expires_in: expires_in)
     end

data/lib/scrivito/cache/ram_store.rb

@@ -15,6 +15,10 @@ module Cache
 
     private
 
+    def tentative?
+      true
+    end
+
     def internal_read(key)
       internal_store[key]
     end

data/lib/scrivito/child_list_tag.rb

@@ -23,7 +23,7 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
       'private-obj-description-for-editor' => obj.description_for_editor,
     }
 
-    if obj.has_attribute?(:child_order)
+    if obj.sortable_toclist?
       options['private-child-list-order-obj-id'] = obj.id
       modification = comparison.modification_for_attribute(obj, :child_order)
       if modification == Modification::EDITED
@@ -37,8 +37,8 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
   def content(&block)
     return unless block_given?
 
-    is_sortable = obj.has_attribute?(:child_order) && user_present?
-    rendered_children = sorted_children.map do |child|
+    is_sortable = obj.sortable_toclist? && user_present?
+    rendered_children = obj.sorted_toclist.map do |child|
       obj_tag = ObjTag.new(child, is_sortable, comparison.modification(child), view)
       yield obj_tag, child
       obj_tag.rendered
@@ -48,6 +48,7 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
 
   #
   # This is a helper class for {ScrivitoHelper#scrivito_tag_list}.
+  #
   # @api public
   #
   class ObjTag < Struct.new(:obj, :is_sortable, :modification, :view)
@@ -55,17 +56,23 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
 
     attr_reader :tag_name, :rendered
 
+    #
+    # Renders HTML for the corresponding child with in-place editing enabled.
     #
     # @api public
     #
-    # @param tag_name [String, Symbol] Name of the html tag (e.g. +:div+ or +:span+).
-    # @param html_options [Hash] Additional options, which are passed to +content_tag+.
-    #   Use them to add HTML attributes to the tag.
+    # @note This method can be called only _once_ per child.
+    #
+    # @param tag_name [String, Symbol] Name of the HTML tag (e.g. +:li+ or +:div+).
+    # @param html_options [Hash] Options to be passed to +content_tag+. Use them to add HTML
+    #   attributes to the tag.
     #
-    # @return [String] The rendered html tag
+    # @return [String] The rendered HTML tag.
     #
-    # @example Render a <div> tag containing the text "random content" and assigns the tag a css class called +very_important+.
-    #   list.tag(:div, class: "very_important") do
+    # @see ScrivitoHelper#scrivito_tag_list
+    #
+    # @example Render a +div+ element containing text, and assign to it the +my_list_element+ CSS class.
+    #   list.tag(:div, class: "my_list_element") do
     #     "random content"
     #   end
     #
@@ -102,11 +109,6 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
   def comparison
     EditingContextMiddleware.from_request(view.request).comparison
   end
-
-  def sorted_children
-    children = obj.toclist
-    obj.has_attribute?(:child_order) ? Obj.sort_by_list(children, obj.child_order) : children
-  end
 end
 
 end

data/lib/scrivito/client_error.rb

@@ -8,6 +8,16 @@ module Scrivito
       @backend_code = backend_code
       super(message)
     end
+
+    def ==(client_error)
+      message == client_error.message &&
+        http_code == client_error.http_code &&
+        backend_code == client_error.backend_code
+    end
+
+    def as_json
+      {message: message, backend_code: backend_code}
+    end
   end
 
 end