scrivito_sdk 0.18.1 → 0.30.0.rc1

data/README

@@ -1,6 +0,0 @@
-= Scrivito SDK
-
-The Scrivito SDK makes CMS objects maintained by means of the cloud-based Scrivito CMS available to your Rails application.
-It offers easy-to-use functionality for rendering CMS content, doing searches, etc.
-
-For more information about Scrivito, please visit {http://scrivito.com/}.

data/app/controllers/cms_controller.rb

@@ -1,7 +0,0 @@
-# This controller inherits all of its behavior from
-# {Scrivito::DefaultCmsController}.
-#
-# {CmsController} is referenced by the Scrivito routes.
-# @api public
-class CmsController < Scrivito::DefaultCmsController
-end

data/app/helpers/cms_helper.rb

@@ -1,7 +0,0 @@
-# {CmsHelper} is a wrapper around {Scrivito::DefaultCmsHelper}.
-# It can be replaced in your application in order to add or
-# modify helpers.
-# @api public
-module CmsHelper
-  include Scrivito::DefaultCmsHelper
-end

data/app/helpers/cms_routing_helper.rb

@@ -1,7 +0,0 @@
-# {CmsRoutingHelper} is a wrapper around {Scrivito::DefaultCmsRoutingHelper}.
-# It can be replaced in your application in order to add or
-# modify helpers.
-# @api public
-module CmsRoutingHelper
-  include Scrivito::DefaultCmsRoutingHelper
-end

data/app/helpers/scrivito/cms_asset_helper.rb

@@ -1,110 +0,0 @@
-module Scrivito
-
-  # This module contains helpers that can be used to reference images and other assets stored in the CMS.
-  #
-  # @api public
-  module CmsAssetHelper
-
-    # Calculates an HTML image tag for an image stored in the CMS.
-    #
-    # @note There are two different signatures of this method: the first one generates an HTML image tag with no
-    #   inplace editing possible, the second one generated an HTML image tag for inplace editing.
-    #
-    # @overload cms_image_tag target, tag_options={}
-    #   @note If you do not specify an HTML +alt+ attribute, the helper method will use +target+'s +display_title+.
-    #   Calculates HTML image tag (no inplace editing possible).
-    #
-    #   @param [Obj, Link] target Target containing image stored in CMS.
-    #   @param [Hash] tag_options Additional HTML attributes for the tag.
-    #
-    #   @example
-    #     cms_image_tag @target
-    #     cms_image_tag @target, alt: 'Interesting picture', class: 'my_image'
-    #
-    # @overload cms_image_tag obj, linklist, tag_options={}, editing_options={}
-    #   @note If you do not specify an HTML +alt+ attribute, the helper method will use +display_title+ of the target object.
-    #   Calculates HTML image tag for inplace editing.
-    #
-    #   @param [Obj] obj Obj with an attribute of type +LinkList+.
-    #   @param [String, Symbol] linklist Name of +LinkList+, +reference+ or +link+ attribute, which contains the image.
-    #   @param [Hash] tag_options Additional HTML attributes for the tag.
-    #
-    #   @param [Hash] editing_options Additional options for inplace editing.
-    #   @option editing_options [String] :placeholder ('/assets/scrivito/image_placeholder.png') URL or path to image to be displayed if target is missing.
-    #
-    #   @example
-    #     cms_image_tag @obj, :my_linklist
-    #     cms_image_tag @obj, :my_linklist, alt: 'Interesting picture', class: 'my_image'
-    #     cms_image_tag @obj, :my_linklist, {}, placeholder: image_path('my_placeholder.png')
-    #     cms_image_tag @obj, :my_linklist, {class: 'my_image'}, placeholder: 'http://placehold.it/350x150'
-    #
-    #   @example Create image tag for reference attributes.
-    #     cms_image_tag @obj, :my_reference
-    #
-    #   @example Create image tag for link attributes.
-    #     cms_image_tag @obj, :my_link
-    #
-    # @return [String] HTML image tag
-    # @api public
-    def cms_image_tag(*args)
-      if args.second.nil? || args.second.is_a?(Hash)
-        # Backwards compatibility.
-        target = args.first
-
-        tag_options = args.second || {}
-        tag_options.symbolize_keys!
-        tag_options[:src] = cms_path(target)
-        tag_options[:alt] ||= display_title(target)
-
-        tag('img', tag_options)
-      else
-        obj             = args.first
-        field_name      = args.second
-        tag_options     = args.third || {}
-        editing_options = args.fourth || {}
-
-        cms_tag('img', obj, field_name, cms_image_tag_options(obj, field_name,
-            tag_options.symbolize_keys, editing_options.symbolize_keys))
-      end
-
-    end
-
-    private
-
-    def cms_image_tag_options(obj, field_name, tag_options, editing_options)
-      tag_options.reverse_merge(src: cms_image_tag_src(obj, field_name, editing_options),
-          alt: cms_image_tag_alt(obj, field_name))
-    end
-
-    def cms_image_tag_src(obj, field_name, editing_options)
-      cms_image_tag_path(obj, field_name) || editing_options[:placeholder] ||
-          image_path('scrivito/image_placeholder.png')
-    end
-
-    def cms_image_tag_alt(obj, field_name)
-      display_title(obj[field_name])
-    end
-
-    def cms_image_tag_path(obj, field_name)
-      field_type = obj.type_of_attribute(field_name)
-      field_value = obj[field_name]
-
-      case field_type
-      when 'reference' then field_value && cms_path(field_value)
-      when 'link' then field_value && cms_path(field_value)
-      when 'linklist'
-        path = cms_path(field_value)
-        path == DefaultCmsRoutingHelper::LINK_TO_EMPTY_LINKLIST ? nil : path
-      end
-    end
-
-    def display_title(target)
-      if target.respond_to?(:display_title)
-        return target.display_title
-      elsif target.respond_to?(:first) && target.first.respond_to?(:display_title)
-        return target.first.display_title
-      end
-    end
-
-  end
-end

data/app/helpers/scrivito/cms_tag_helper.rb

@@ -1,232 +0,0 @@
-module Scrivito
-
-  # @api public
-  module CmsTagHelper
-    VOID_TAGS = %w[area base br col command embed hr img input keygen
-        link meta param source track wbr]
-
-    # Returns an HTML block tag containing content from an Obj.
-    # Add HTML attributes by passing an attributes hash to options.
-    # The helper method is somewhat similar to (and internally uses) http://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag.
-    #
-    # This helper method also renders additional data attributes, which are needed for inplace editing.
-    # These attributes are only rendered when appropriate, i.e. not for a regular visitor.
-    #
-    # @param tag_name [String, Symbol] Name of the html tag (e.g. +:h1+ or +:div+).
-    # @param obj_or_widget [BasicObj, BasicWidget] A {BasicObj} or {BasicWidget} from which the +field_name+ is read.
-    # @param field_name [String, Symbol] Which field of the Obj should be rendered.
-    # @param options [Hash] Additional options, which are passed to +content_tag+. Use them to add HTML attributes to the tag.
-    # @param block [Proc] Optional block to render inner HTML. If none given the value of attribute will be rendered instead.
-    # @return [String] The rendered html tag
-    #
-    # @example Renders an <h2> tag containing the text of the +headline+ attribute of +@obj+ and assigns the tag a css class called +very_important+.
-    #     <%= cms_tag :h2, @obj, :headline, class: "very_important" %>
-    #
-    # @example Renders an <h2> tag containing an escaped +headline+.
-    #     <%= cms_tag :h2, @obj, :headline do %>
-    #       <%= strip_tags @obj.headline %>
-    #     <% end %>
-    #
-    # @api public
-    def cms_tag(tag_name, obj_or_widget, field_name, options = {}, &block)
-      cms_field_tag = CmsFieldTag.new(
-        self, cms_editing_context, obj_or_widget, field_name.to_s
-      )
-
-      begin
-        field_type = cms_field_tag.field_type
-      rescue ScrivitoError => e
-        return content_tag(tag_name, '', options)
-      end
-
-      options.merge!(cms_field_tag.options)
-
-      if VOID_TAGS.include?(tag_name.to_s)
-        tag(tag_name, options)
-      else
-        inner_html =
-          if block_given? && field_type != 'widget'
-            capture { yield }
-          else
-            to_render = cms_field_tag.default_content
-
-            if field_type == 'widget'
-              modifications = cms_field_tag.modification_info || []
-              rendered_widgets = to_render.each_with_index.map do |widget, index|
-                render_widget(widget, modifications[index])
-              end
-
-              safe_join(rendered_widgets)
-            else
-              display_value(to_render)
-            end
-          end
-
-        content_tag(tag_name, inner_html, options)
-      end
-    end
-
-    # This is a helper class for {Scrivito::CmsTagHelper#cms_tag_list}.
-    # @api public
-    class List
-
-      attr_reader :output
-
-      def initialize(template, child_obj, show_sortable_options, modification)
-        @template = template
-        @child_obj = child_obj
-        @show_sortable_options = show_sortable_options
-        @modification = modification
-      end
-
-      # @param tag_name [String, Symbol] Name of the html tag (e.g. +:div+ or +:span+).
-      # @param options [Hash] Additional options, which are passed to +content_tag+. Use them to add HTML attributes to the 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 %>
-      #     random content
-      #   <% end %>
-      # @api public
-      def tag(tag_name, options = {}, &block)
-        if @output.present?
-          raise '"list.tag" can only be called once per iteration!'
-        else
-          if @show_sortable_options
-            options = options.merge({
-              'data-scrivito-private-obj-id' => @child_obj.id,
-              'data-scrivito-private-obj-description-for-editor' => @child_obj.description_for_editor,
-            })
-
-            if @modification == Modification::NEW || @modification == Modification::DELETED
-              options['data-scrivito-private-obj-modification'] = @modification
-            end
-          end
-
-          @output = @template.content_tag(tag_name, options, &block) + "\n"
-
-          nil
-        end
-      end
-
-    end
-
-    # @param tag_name [String, Symbol] Name of the html tag (e.g. +:h1+ or +:div+).
-    # @param obj [BasicObj] A {BasicObj} from which method_name is read.
-    # @param method_name [String, Symbol] Which method_name of the Obj should be rendered. Currently only +toclist+ is supported
-    # @param options [Hash] Additional options, which are passed to +content_tag+. Use them to add HTML attributes to the tag.
-    # @yieldparam [List] list An instance, where +tag+ should be called once.
-    # @yieldparam [BasicObj] child Each child of +toclist+
-    # @return [String] The rendered html tag
-    #
-    # @example
-    #   <%= cms_tag_list :div, @obj, :toclist, class: "very_important" do |list, child| %>
-    #     <%= list.tag :div, class: "also_important" do %>
-    #       <%= link_to cms_path(child) do %>
-    #         <%= cms_tag :span, child, :title %>
-    #       <% end %>
-    #     <% end %>
-    #   <% end %>
-    #
-    #   # results for an obj with two children in
-    #
-    #   <div class="very_important">
-    #     <div class="also_important"><a href="/child1"><span>Child 1</span></a></div>
-    #     <div class="also_important"><a href="/child2"><span>Child 2</span></a></div>
-    #   </div>
-    # @api public
-    def cms_tag_list(tag_name, obj, method_name, options = {})
-      if method_name.to_s == 'toclist'
-        items = obj.toclist
-      else
-        raise "#{method_name} is not (yet) supported. Currently only toclist is supported."
-      end
-
-      children_sortable = false
-
-      if inplace_editing_allowed?
-        options['data-scrivito-private-obj-description-for-editor'] = obj.description_for_editor
-      end
-
-      if obj.has_attribute?(:child_order)
-        items = Obj.sort_by_list(items, obj.child_order)
-        children_sortable = inplace_editing_allowed?
-
-        if children_sortable
-          options = options.merge({
-            'data-scrivito-private-child-list-order-obj-id' => obj.id,
-          })
-
-          modification = cms_editing_context.comparison.modification_for_attribute(obj,
-              :child_order)
-          if modification == Modification::EDITED
-            options['data-scrivito-private-child-list-modification'] = modification
-          end
-        end
-      end
-
-      inner_html = "\n".html_safe
-
-      items.each do |item|
-        item_modification = cms_editing_context.comparison.modification(item)
-        list = List.new(self, item, children_sortable, item_modification)
-
-        yield list, item
-
-        inner_html << list.output
-      end
-
-      valid_page_classes = Obj.valid_page_classes_beneath(obj.path)
-
-      if inplace_editing_allowed?
-        options = options.merge({
-          'data-scrivito-private-child-list-path' => obj.path,
-          'data-scrivito-private-child-list-allowed-classes' => valid_page_classes.to_json,
-        })
-      end
-
-      content_tag(tag_name, inner_html, options)
-    end
-
-    def render_widget(widget, container_modification = nil)
-      options = {}
-
-      if inplace_editing_allowed?
-        options['data-scrivito-private-widget-id'] = widget.id
-        options['data-scrivito-widget-obj-class'] = widget.obj_class_name
-        options['data-scrivito-private-widget-description-for-editor'] = widget.description_for_editor
-
-        if has_widget_details_view?(widget)
-          options['data-scrivito-private-widget-has-details-view'] = true
-        end
-
-        comparison = cms_editing_context.comparison
-        options['data-scrivito-private-widget-modification'] =
-          if comparison.revision == widget.revision
-            if container_modification
-              unless widget.in_revision(Workspace.current.revision)
-                Modification::DELETED
-              end
-            end
-          else
-            comparison.modification(widget)
-          end
-
-        options['data-scrivito-private-widget-container-modification'] =
-          container_modification
-      end
-
-      content_tag(:div, options) do
-        render(template: "#{widget.class.to_s.underscore}/show", locals: {widget: widget})
-      end
-    end
-
-    def has_widget_details_view?(widget)
-      details_template_path = "#{widget.obj_class_name.underscore}/details"
-      lookup_context.find(details_template_path).present?
-    rescue ActionView::MissingTemplate
-      false
-    end
-  end
-
-end

data/app/helpers/scrivito/default_cms_helper.rb

@@ -1,21 +0,0 @@
-module Scrivito
-
-  # This is a wrapper module for the default set of Scrivito helper modules.
-  #
-  # To make autoloading from +CmsController+ work, this module must be wrapped
-  # by a module named +CmsHelper+:
-  #
-  #   module CmsHelper
-  #     include Scrivito::DefaultCmsHelper
-  #   end
-  # @api public
-  module DefaultCmsHelper
-    include DisplayHelper
-    include CmsAssetHelper
-    include Scrivito::CmsAssetHelper
-    include Scrivito::EditingHelper
-    include Scrivito::LayoutHelper
-    include Scrivito::CmsTagHelper
-  end
-
-end

data/app/helpers/scrivito/default_cms_routing_helper.rb

@@ -1,128 +0,0 @@
-module Scrivito
-
-  # @api public
-  module DefaultCmsRoutingHelper
-    # Returns the path for +target+ using the +CmsController+ routes.
-    # +target+ can be an +Obj+ or a +Link+ or a +LinkList+.
-    # If +target+ is a +Linklist+, it must be non-empty. The first +Link+ from the +LinkList+ will be used.
-    # +options+ are optional and include url settings such as path parameters or protocol.
-    # @return [String]
-    # @api public
-    def cms_path(target, options = {})
-      cms_path_or_url(target, "path", options)
-    end
-
-    # Returns the absolute URL for target using the +CmsController+ routes.
-    # +target+ can be an +Obj+ or a +Link+ or a +LinkList+.
-    # If +target+ is a +Linklist+, it must be non-empty. The first +Link+ from the +LinkList+ will be used.
-    # +options+ are optional and include url settings such as path parameters or protocol.
-    # @return [String]
-    # @api public
-    def cms_url(target, options = {})
-      cms_path_or_url(target, "url", options)
-    end
-
-    LINK_TO_EMPTY_LINKLIST = "#__empty_linklist"
-    LINK_TO_EMPTY_BLOB = "#__empty_blob"
-
-    def cms_path_or_url(target, path_or_url, options)
-      if cms_with_editing_context?(target)
-        cms_path_or_url_with_editing_context(target, path_or_url, options)
-      else
-        cms_path_or_url_without_editing_context(target, path_or_url, options)
-      end
-    end
-
-    def cms_path_or_url_with_editing_context(target, path_or_url, options)
-      cms_path_or_url_without_editing_context(target, path_or_url,
-          options.merge(cms_editing_context.to_params))
-    end
-
-    def cms_path_or_url_without_editing_context(target, path_or_url, options)
-      if target.is_a?(Link)
-        cms_path_or_url_for_links(target, path_or_url, options)
-      elsif target.is_a?(Obj)
-        cms_path_or_url_for_objs(target, path_or_url, options)
-      elsif target.respond_to?(:first)
-        if target.first.is_a?(Link)
-          cms_path_or_url_for_links(target.first, path_or_url, options)
-        else
-          return LINK_TO_EMPTY_LINKLIST
-        end
-      else
-        raise "cms_path or cms_url was called with an instance of #{target.class}. "+
-          "It must only be called with an Obj or a Link or a non-empty LinkList."
-      end
-    end
-
-    def cms_path_or_url_for_links(link, path_or_url, options = {})
-      url = basic_url_or_path_for_link(link, path_or_url,
-          Rack::Utils.parse_nested_query(link.query).merge(options))
-      url = url + "##{link.fragment}" if link.fragment.present?
-      url
-    end
-
-    def cms_path_or_url_for_objs(obj, path_or_url, options = {})
-      permalink = obj.permalink
-      if permalink
-        main_app.public_send("cms_permalink_#{path_or_url}", options.merge(:permalink => permalink))
-      elsif obj.homepage?
-        main_app.public_send("cms_root_#{path_or_url}", options)
-      else
-        if obj.binary? && cms_editing_context.display_mode != "editing"
-          if obj.body_data_url
-            enforce_protocol_from_request(obj.body_data_url)
-          else
-            LINK_TO_EMPTY_BLOB
-          end
-        else
-          main_app.public_send(
-            "cms_id_#{path_or_url}",
-            options.merge(
-              id: obj.id,
-              slug: obj.slug.presence
-            )
-          )
-        end
-      end
-    end
-
-    def cms_editing_context
-      request.env[EditingContextMiddleware::ENVKEY] || EditingContext.new
-    end
-
-    def inplace_editing_allowed?
-      cms_editing_context.authenticated_editor?
-    end
-
-    private
-
-    def cms_with_editing_context?(target)
-      inplace_editing_allowed? && (!target.is_a?(Link) || target.internal?)
-    end
-
-    def basic_url_or_path_for_link(link, path_or_url, options = {})
-      if link.internal?
-        cms_path_or_url_without_editing_context(link.obj, path_or_url, options)
-      else
-        url = link.url
-        url = merge_options(url, options) if options.any?
-        url
-      end
-    end
-
-    def merge_options(url, options)
-      parsed_url = URI.parse(url)
-
-      query = Rack::Utils.parse_query(parsed_url.query)
-      merged_query = query.merge(options.stringify_keys)
-      parsed_url.query = merged_query.to_query
-
-      parsed_url.to_s
-    end
-
-    def enforce_protocol_from_request(url)
-      request.ssl? && !url.starts_with?('https') ? url.gsub(/^http/, 'https') : url
-    end
-  end
-end