scrivito_sdk 0.12.0

data/app/helpers/scrivito/cms_tag_helper.rb

@@ -0,0 +1,231 @@
+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
+
+    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 %>
+      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 [Obj] A {Obj} 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 [Obj] 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>
+    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,
+                      obj = @obj,
+                      field_name = widget.container_field_name,
+                      container = widget.container)
+      options = {}
+
+      if inplace_editing_allowed?
+        options['data-scrivito-private-widget-id'] = widget.id
+        options['data-scrivito-widget-obj-class'] = widget.obj_class_name
+
+        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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,130 @@
+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
+      dont_resolve_blobs = options.delete(:dont_resolve_blobs)
+      if permalink
+        __send__("cms_permalink_#{path_or_url}", options.merge(:permalink => permalink))
+      elsif obj.homepage?
+        __send__("root_#{path_or_url}", options)
+      else
+        if obj.binary? && !dont_resolve_blobs
+          if obj.body_data_url
+            enforce_protocol_from_request(obj.body_data_url)
+          else
+            LINK_TO_EMPTY_BLOB
+          end
+        else
+          __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
+        options.delete(:dont_resolve_blobs)
+        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

data/app/helpers/scrivito/display_helper.rb

@@ -0,0 +1,71 @@
+module Scrivito
+
+  # This module contains a helper that can be used to render attributes of the CMS models.
+  # @api public
+  module DisplayHelper
+
+    # For a consistent look of your site and easy maintenance, only the display helpers
+    # should be used to render an attribute <em>value</em> of a CMS model.
+    #
+    #   <%= display_value @obj.title %>
+    # Renders the value, taking its type into account.
+    # * An HtmlString will be exported by converting its links
+    # * A Time will be exported in an international form: Year-Month-Day Hour:Minutes
+    # * A non-HTML String will be quoted
+    # * other values will be rendered unchanged
+    #
+    # @api public
+    def display_value(value)
+      case value
+        when HtmlString then convert_links(value).html_safe
+        when String then h(value)
+        when Time then h(l(value))
+        else value
+      end
+    end
+
+    def display_original_value(value)
+      case value
+        when HtmlString then convert_links(value, :dont_resolve_blobs => true).html_safe
+        else display_value(value)
+      end
+    end
+
+    # Renders a field from the CMS.
+    #
+    # <%= display_field @obj, :title %>
+    #
+    # @api public
+    def display_field(obj, attr, options = {})
+      display_value obj[attr]
+    end
+
+    # Legacy method - deprecated
+    #
+    # Use display_value and display_field instead
+    def display(*args)
+      if args.last.kind_of? Hash
+        options = args.pop
+      else
+        options = {}
+      end
+      return display_value(args.first) if args.size == 1
+      display_field(args[0], args[1], options)
+    end
+
+    private
+
+    def convert_links(html, cms_path_options = {})
+      if html
+        html.gsub(%r{<?\bobjid:([a-f0-9]{16})\b>?}) do
+          if obj = Obj.find_by_id($1)
+            cms_path(obj, cms_path_options)
+          else
+            "#__target_object_not_reachable"
+          end
+        end
+      end
+    end
+
+  end
+end