infopark_rails_connector 6.8.0.beta.200.621.4c8e1b0

data/app/helpers/rails_connector/marker_helper.rb

@@ -0,0 +1,363 @@
+module RailsConnector
+
+  # This module contains helpers that can be used to build markers for the preview.
+  #
+  # The helpers will not render anyhing if not in editor mode!
+  # See RailsConnector::Configuration for information on modes.
+  #
+  # All helpers have the following <em>options</em>, unknown options are passed
+  # to the HTML element which is being created:
+  #
+  # [:context] the context object that will be shown in the preview after editing
+  # [:size] the symbolic size of the target window to open
+  # [:target] the target frame in which the edit window is to be opened.
+  #
+  # You can specify the size of the edit window by means of the <tt>:size</tt> option:
+  #
+  # [<tt>'n'</tt>] normal browser window
+  # [<tt>'udl'</tt>] undecorated large browser window
+  # [<tt>'uds'</tt>] undecorated small browser window
+  # [<tt>'udt'</tt>] undecorated tiny browser window
+  #
+  # The <tt>:target</tt> option becomes the <tt>target</tt> attribute of the <tt><a></tt> tag.
+  module MarkerHelper
+    # Renders an edit marker for a named attribute of an active object in the preview.
+    # <em>obj</em> is the Obj to edit, <em>attr</em> the attribute as a Symbol or String.
+    # The helper will render nothing if the object is inactive! The :context defaults to obj.
+    #
+    # The following code will render an edit marker for the title attribute of the current object:
+    #
+    #   <%= edit_marker @obj, :title %>
+    #
+    # By passing a block, the evaluated block will be included in the marker:
+    #   <%= edit_marker @obj, :title do |obj, attr|
+    #     display_value obj[attr]
+    #   end %>
+    #
+    # The last form is the default of DisplayHelper::display_field without the option :marker => false.
+    # When the blob evaluates to nil, an empty string or array, the markup of the option :default_value
+    # will be rendered.
+    #
+    # Hint: You should not render edit markers within elements that are hidden via CSS (display:none),
+    # otherwise they cannot be displayed correctly.
+    def edit_marker(obj, attr, options = {}, &block)
+      if Configuration.editor_interface_enabled? && !session[:hide_editmarkers]
+        context = (options.delete :context) || @obj
+        default_value = options.delete(:default_value)
+
+        if block_given?
+          content = block.call(obj, attr)
+          content = default_value || raw("&nbsp;") if content.blank?
+        else
+          content = attr.to_s.humanize
+          content = obj.name + ": " + content if obj != context
+        end
+
+        marker_id = store_marker_definition(
+          :obj_id => obj.id,
+          :attribute => format_attribute_name_for_gui(attr),
+          :context_id => context ? context.id : nil,
+          :size => options.delete(:size),
+          :target => options.delete(:target),
+          :memberships => required_memberships_for_editing(obj, attr)
+        )
+
+        store_edit_marker_markup(content_tag(:a, "",
+            :class => "nps_edit_marker nps_marker_id_#{marker_id}"))
+
+        tag_type = options.delete(:tag) || :span
+        content_tag(
+          tag_type,
+          content.to_s,
+          options.merge(:class => "#{options[:class]}", :id => "nps_marker_id_#{marker_id}")
+        )
+      else
+        block_given? ? block.call(obj, attr) : nil
+      end
+    end
+
+    # Renders a link which the editor can use to toggle on/off the editmarkers shown
+    # in the preview.
+    # This link will only be shown if the Rails Connector is in <tt>editor</tt> mode.
+    # <em>value</em> the link text or e.g. an image_tag
+    def toggle_edit_marker_link(value)
+      if Configuration.editor_interface_enabled?
+        link_to value, toggle_markers_url(@obj)
+      end
+    end
+
+    # Renders a marker for an action to be performed with any number of objects.
+    # <em>action</em> the attribute as a Symbol or String.
+    # <em>objs</em> is an Array containing a single, none or more than one Obj.
+    # The helper has additional options:
+    # [:permissions] is an Array of permissions the current user needs to use
+    # the marker: :read, :write, :root, :create_children - defaults to [:read].
+    # This option is available for a single Obj passed to <em>objs</em>.
+    # [:params] a hash of parameters to be passed to the action.
+    #
+    # The following code will render an action marker for the release action of the current object:
+    #
+    #   <%= action_marker :workflow_release, [@obj] %>
+    def action_marker(action, objs, options = {}, &block)
+      return unless Configuration.editor_interface_enabled?
+
+      context = (options.delete :context) || @obj
+      size = options.delete(:size)
+      target = options.delete(:target) || "_blank"
+      params = options.delete(:params)
+      permissions = options.delete(:permissions) || [:read]
+
+      if objs.size == 1
+        memberships = required_memberships_for_permissions(objs.first, permissions)
+      else
+        memberships = []
+      end
+
+      marker_id = store_marker_definition(
+        :memberships => memberships
+      )
+
+      link_to(
+        block_given? ? block.call : action.to_s.humanize,
+        uri_for_action_marker(action, objs, context, size, target, params),
+        options.merge(:class => ["nps_action_marker", "nps_marker_id_#{marker_id}", options[:class]].compact.join(' '))
+      )
+    end
+
+    # Generates an edit marker link.
+    #
+    # [name] the link caption.
+    # [obj] the object for which the edit dialog will be generated.
+    # [attr] the attribute for which the edit dialog will be generated.
+    # [options] options for the edit dialog (see +edit_marker+).
+    def link_to_edit(name, obj, attr, options = {})
+      if Configuration.editor_interface_enabled?
+        context = (options.delete :context) || @obj
+        size = options.delete(:size)
+        target = options.delete(:target) || "_blank"
+
+        link_to_function(name.to_s,
+          "inline_editing.openEditDialog('#{obj.id}', '#{attr}', '#{context.id || 'null'}', '#{size || 'null'}', '#{target || 'null'}')"
+        )
+      end
+    end
+
+    # Renders a folding menu which can be used to insert various edit actions or
+    # informations.
+    #
+    # [left] the left offset.
+    # [top] the top offset.
+    # [&block] the content which will be displayed in the menu.
+    #
+    # To generate a menu you have to create one using the +marker_menu+ helper.
+    # Than you have to mark the target for which the menu should be displayed
+    # using the +marker_menu_target+ helper.
+    #
+    # Usage:
+    #   <%= marker_menu do %>
+    #     Menu
+    #   <% end %>
+    #
+    #   <%= marker_menu_target(:div) do %>
+    #     Content
+    #   <% end %>
+    def marker_menu(left=0, top=0, &block)
+      self.current_marker_menu_id = store_marker_definition(
+        :offset_left => left,
+        :offset_top => top
+      )
+      store_marker_markup(content_tag(
+        :div,
+        marker_menu_markup(capture(&block)),
+        :class => "nps_marker_menu nps_marker_id_#{current_marker_menu_id}",
+        :id => "nps_marker_menu_#{current_marker_menu_id}"
+      ))
+      nil
+    end
+
+    # Marks the given content to display the previous defined marker menu.
+    #
+    # [tag_name] the tag in which the content will be displayed.
+    # [options] the options for the tag.
+    # [&block] the content which will be displayed with the menu.
+    #
+    # See +marker_menu+ for an example.
+    def marker_menu_target(tag_name, options = {}, &block)
+      content_tag(
+        tag_name,
+        capture(&block),
+        options.merge(:class => "#{marker_menu_target_class} #{options[:class]}")
+      )
+    end
+
+    # Returns the css class used for the target element where the marker menu
+    # should be displayed.
+    #
+    # Will be used automatically if you use the helpers +marker_menu+ and
+    # +marker_menu_target+. But if you want to set a marker menu manually to
+    # an element (e.g. an image) you need to supply this css class.
+    def marker_menu_target_class
+      "nps_marker_menu_target nps_marker_menu_target_#{current_marker_menu_id}" if Configuration.editor_interface_enabled?
+    end
+
+    # Renders the necessary JavaScript and CSS includes to use the edit markers.
+    def include_edit_marker_support # :nodoc:
+      if Configuration.editor_interface_enabled?
+        raw <<-EOF
+          #{stylesheet_link_tag :editmarker}
+          #{javascript_include_tag :editmarker}
+          #{content_tag(:script, :type => 'text/javascript') { 'inline_editing.init();' }}
+        EOF
+      end
+    end
+
+    # Renders the necessary marker code to use edit markers and marker menus.
+    def render_marker_code # :nodoc:
+      return unless Configuration.editor_interface_enabled?
+      html = raw("#{render_marker_definitions}\n#{render_marker_menus}\n#{render_edit_markers}")
+      reset_marker_code
+      html
+    end
+
+    # This helper method can be used in +marker_menu+ to generate a list with
+    # actions using +edit_item+ or +action_item+. For each action a icon and
+    # title will be shown.
+    #
+    # Usage:
+    #   <%= marker_menu do %>
+    #     <%= iconlist do %>
+    #       <%= edit_item("edit title", "css_class", @obj, :image) %>
+    #       <%= action_item("edit image", "css_class", @obj, :editImage) %>
+    #     <% end %>
+    #   <% end %>
+    def iconlist(&block)
+      content_tag(:ul, capture(&block)) if block_given?
+    end
+
+    # Creates an edit marker item for the list generated by +iconlist+.
+    #
+    # [title] the title which will be displayed.
+    # [css_class] the css-class can be used to display a different icon.
+    # [obj] the object for which the edit dialog will be generated.
+    # [attribute] the attribute for which the edit dialog will be generated.
+    # [options] options that will be delegated to the +link_to_edit+ helper.
+    def edit_item(title, css_class, obj, attribute, options = {})
+      edit_link = link_to_edit(content_tag(:span, title, :class => css_class), obj, attribute, options)
+      content_tag(:li, edit_link)
+    end
+
+    # Creates an action marker item for the list generated by +iconlist+.
+    #
+    # [title] the title which will be displayed.
+    # [css_class] the css-class can be used to display a different icon.
+    # [objs] the objects for which the action dialog will be generated.
+    # [action] the action for which the action dialog will be generated.
+    # [options] options that will be delegated to the +action_marker+ helper.
+    def action_item(title, css_class, objs, action, options = {})
+      action_link = action_marker(action, objs, options) { content_tag(:span, title, :class => css_class) }
+      content_tag(:li, action_link)
+    end
+
+  private
+
+    attr_accessor :current_marker_menu_id
+
+    def current_marker_menu_id
+      @current_marker_menu_id or raise "Tried to create a marker menu target before a marker menu was created!"
+    end
+
+    JS_HEADER = <<ENDOFSTRING
+<script type="text/javascript">
+// <![CDATA[
+ENDOFSTRING
+
+    JS_FOOTER = <<ENDOFSTRING
+// ]]>
+</script>
+ENDOFSTRING
+
+    def store_marker_definition(definition)
+      @marker_definitions ||= {}
+      marker_id = random_marker_id
+      @marker_definitions[marker_id] = definition
+      marker_id
+    end
+
+    def random_marker_id
+      rand(1_000_000_000)
+    end
+
+    def render_marker_definitions
+      return unless @marker_definitions.present?
+      "#{JS_HEADER}inline_editing.storeMarkerDefinitions(#{@marker_definitions.to_json});" +
+          "#{JS_FOOTER}"
+    end
+
+    def store_marker_markup(markup)
+      @marker_markup ||= []
+      @marker_markup << markup
+    end
+
+    def store_edit_marker_markup(markup)
+      @edit_marker_markup ||= []
+      @edit_marker_markup << markup
+    end
+
+    def reset_marker_code
+      @marker_definitions = @marker_markup = @edit_marker_markup = nil
+    end
+
+    def render_marker_menus
+      (@marker_markup || []).join
+    end
+
+    def render_edit_markers
+      (@edit_marker_markup || []).join
+    end
+
+    def required_memberships_for_editing(obj, attr)
+      permissions = [:read]
+      if [:name, :obj_class, :workflow, :suppressexport, :permalink].include?(attr.to_sym)
+        permissions << :root
+      else
+        permissions << :write
+      end
+
+      required_memberships_for_permissions(obj, permissions)
+    end
+
+    def required_memberships_for_permissions(obj, permissions)
+      permissions.map { |perm| obj.permissions.__send__(perm) }
+    end
+
+    def uri_for_action_marker(action, objects, context = nil, size = nil, target = nil, params = nil) #:nodoc:
+      action = action.to_s
+      objectIds = objects.collect(&:id).to_json
+      contextId = context.nil? ? 'null' : context.id
+      size = size.nil? ? 'null' : "'#{size}'"
+      target = target.nil? ? 'null' : "'#{target}'"
+      params = params.blank? ? 'null' : "'#{escape_javascript(params.to_json.gsub('"','%22'))}'"
+      "javascript:parent.openActionDialog('#{action}',#{objectIds},#{contextId},#{params},#{size},#{target})"
+    end
+
+    def format_attribute_name_for_gui(attr)
+      attr = attr.to_s
+      attr = 'blob' if attr == 'body'
+      attr = attr.camelize(:lower) if %w{ valid_from valid_until obj_class }.include? attr
+      attr
+    end
+
+    def marker_menu_markup(content)
+      raw %Q{<a class="nps_marker_menu_button" name="nps_marker_menu_button" href="#">MENU</a>
+      <div class="nps_marker_menu_content" style="display:none;">
+        <div class="b1"></div><div class="b2"></div><div class="b3"></div><div class="b4"></div>
+        <div class="core">
+          #{content}
+        </div>
+        <div class="b4"></div><div class="b3"></div><div class="b2"></div><div class="b1"></div>
+      </div>}
+    end
+
+  end
+
+end

data/app/helpers/rails_connector/menu_helper.rb

@@ -0,0 +1,72 @@
+module RailsConnector
+
+  # This module contains helpers that can be used to build all kinds of menus.
+  module MenuHelper
+    include DisplayHelper
+
+    # The <tt>build_menu</tt> method should serve as an example of how to build navigational
+    # menus using Infopark Rails Connector. If you need to extend this method, copy it into
+    # the relevant helper for your application.
+    #
+    # Example 1 - Single-tier menu:
+    #
+    #   build_menu(Obj.find(123), nil, :id => "menu")
+    #
+    # produces:
+    #
+    #   <ul id="menu">
+    #     <li>
+    #       <a href="path/to/history">History</a>
+    #     </li>
+    #     <li>
+    #       <a href="path/to/services">Services</a>
+    #     </li>
+    #   </ul>
+    #
+    # <tt>build_menu</tt> also takes a block so you can use it recursively for multiple levels
+    # (<tt>current_page</tt> returns the Obj for "Insurance" in this example):
+    #
+    # Example 2 - Two-tier Menu:
+    #
+    #   build_menu(Obj.find(123), current_page, :id => "main_menu") do |entry|
+    #     build_menu(entry, current_page, :id => "sub_menu")
+    #   end
+    #
+    # produces:
+    #
+    #   <ul id="main_menu">
+    #     <li>
+    #       <a href="path/to/history">History</a>
+    #     </li>
+    #     <li>
+    #       <a href="path/to/products">Services</a>
+    #       <ul id="sub_menu">
+    #         <li>
+    #           <a href="path/to/products/insurance">Insurance</a>
+    #         </li>
+    #         <li>
+    #           <a href="path/to/products/finance">Finance</a>
+    #         </li>
+    #       </ul>
+    #     </li>
+    #   </ul>
+    #
+
+    def build_menu(start_obj, current_obj, html_options, &block)
+      children = table_of_contents(start_obj)
+      content_tag(:ul, html_options) do
+        content = "".html_safe
+        children.each do |child|
+          content << content_tag(:li) do
+            list_entry = link_to(child.display_title, cms_path(child))
+            list_entry += block.call(child) if block_given? && current_obj &&
+              (current_obj == child || current_obj.ancestors.include?(child))
+            list_entry
+          end
+        end
+        content
+      end
+    end
+  end
+
+end

data/app/helpers/rails_connector/micronav_helper.rb

@@ -0,0 +1,107 @@
+module RailsConnector
+
+  # This module contains a helper that can be used to build a micronavigation.
+  module MicronavHelper
+
+    # Generates a micronavigation by producing HTML markup.
+    # <em>obj</em> becomes the rightmost Obj in the micronavigation since it is the one
+    # for which the micronavigation is built. Assume that all the ancestors of this obj are
+    # available as an array starting with the root object at index 1.
+    # The following <em>options</em> exist:
+    #
+    # [:start] index of the ancestor object to start with. Default is 1, i.e. the object Obj::root.
+    # [:micronav_id] ID of the micronavigation. Default is 'micronav'.
+    #
+    # All ancestors of <em>obj</em> are linked to the respective objects. <em>obj</em>
+    # has no linkage. The first and the last <tt><li></tt> tags have apropriate CSS classes.
+    #
+    # For example, assume that you have the following object hierarchy:
+    #
+    # * Root
+    #   * Ancestor_1
+    #     * Ancestor_2
+    #       * Current_Object
+    #
+    # Normal usage with the context Obj set to <tt>@obj</tt>:
+    #
+    #   <%= micronav(@obj) %>
+    #
+    # The helper will start with the Root and will generate the follwing HTML if <tt>@obj</tt> is set to Current_Object:
+    #
+    #   <ul id='micronav'>
+    #     <li class='first'>
+    #       <a href='/2001/Root'>
+    #         Root
+    #       </a>
+    #     </li>
+    #     <li>
+    #       <a href='/2011/Ancestor_1'>
+    #         Ancestor_1
+    #       </a>
+    #     </li>
+    #     <li>
+    #       <a href='/2012/Ancestor_2'>
+    #         Ancestor_2
+    #       </a>
+    #     </li>
+    #     <li class='last'>
+    #       <span>
+    #         Current_Object
+    #       </span>
+    #     </li>
+    #   </ul>
+    #
+    # If the <tt>:start</tt> option is set to 2
+    #
+    #   <%= micronav(@obj, :start => 2) %>
+    #
+    # then the helper will start with Ancestor_1 and will generate:
+    #
+    #   <ul id='micronav'>
+    #     <li class='first'>
+    #       <a href='/2011/Ancestor_1'>
+    #         Ancestor_1
+    #       </a>
+    #     </li>
+    #     <li>
+    #       <a href='/2012/Ancestor_2'>
+    #         Ancestor_2
+    #       </a>
+    #     </li>
+    #     <li class='last'>
+    #       <span>
+    #         Current_Object
+    #       </span>
+    #     </li>
+    #   </ul>
+    #
+    # If you specify the <tt>:micronav_id</tt> option as in
+    #
+    #   <%= micronav(@obj, :micronav_id => '<em><b>micronav_below_banner</b></em>') %>
+    #
+    # then the <tt><ul></tt> tag of the micronavigation will get your custom ID:
+    #
+    #   <ul id='<em><b>micronav_below_banner</b></em>'></tt>
+    #     ...
+    #   </ul>
+    def micronav(obj, options = {})
+      options.reverse_merge!({:start => 1, :micronav_id => 'micronav'})
+      ancestors = obj.ancestors
+      start = options[:start] - 1
+      start = 0 if start < 0
+      ancestors = ancestors[start..-1]
+      ancestors ||= []
+      li_tags = "".html_safe
+      ancestors.each do |ancestor|
+        tag_options = {}
+        tag_options[:class] = "first" if li_tags.empty?
+        li_tags << content_tag(:li, link_to(display_value(ancestor.display_title), cms_path(ancestor)), tag_options)
+      end
+      li_tags << content_tag(:li, content_tag(:span, display_value(obj.display_title)), :class => 'last')
+      content_tag(:ul, li_tags, :id => options[:micronav_id])
+    end
+
+    include DisplayHelper
+  end
+
+end

data/app/helpers/rails_connector/seo_helper.rb

@@ -0,0 +1,44 @@
+module RailsConnector
+
+  # This helper provides methods for Search Engine Optimization.
+  module SeoHelper
+
+    # Generate search engine optimized meta tags for the html head.
+    #
+    # Example:
+    #
+    #   seo_header_tags(
+    #     :company_name => 'Infopark AG',
+    #     :default_keywords => 'default, key, words',
+    #     :default_description => 'one description for all views using this layout'
+    #   )
+    #
+    #   # =>
+    #
+    #   <title>Dialog im Web. | Infopark AG</title>
+    #   <meta name="description" content="SEO description of the current page" />
+    #   <meta content="default, key, words" name="keywords" />
+    #   <meta content="Rails Connector for Infopark CMS Fiona by Infopark AG (www.infopark.de); Version 6.7.1" name="generator" />
+    #   <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+    #   <link href="http://test.host/2001/basisordner" rel="canonical" />
+    def seo_header_tags(options = {})
+      html = content_tag('title', [@obj && @obj.display_title, options[:company_name]].compact.join(' | '))
+      html += tag('meta', :name => 'description', :content => @obj && @obj.seo_description || options[:default_description])
+      html += tag('meta', :name => 'keywords', :content => seo_keywords(options))
+      html += tag('meta', 'http-equiv' => "Content-Type", :content => "text/html; charset=utf-8")
+      html += tag('link', :rel => 'canonical', :href => canonical_url) if @obj
+      html
+    end
+
+  private
+
+    def seo_keywords(options)
+      (@obj && @obj.seo_keywords.to_s.strip).blank? ? options[:default_keywords] : @obj.seo_keywords.strip
+    end
+
+    def canonical_url
+      cms_path_or_url_for_objs(@obj, :url, :protocol => request.ssl? ? 'https' : 'http')
+    end
+  end
+
+end

data/app/helpers/rails_connector/table_of_contents_helper.rb

@@ -0,0 +1,20 @@
+module RailsConnector
+
+  #
+  # This module contains a helper that can be used to build a table of contents of an object.
+  #
+  module TableOfContentsHelper
+
+    #
+    # The <tt>table_of_contents</tt> helper method gets an object as argument and returns an array,
+    # which can be used as the table of contents of the given object.
+    #
+    # The returned array consists of the child objects of the given object.
+    # The array is sorted according to the configured sort order and the sort keys.
+    # It also contains only objects which the current user is permitted to view.
+    #
+    def table_of_contents(obj)
+      obj.sorted_toclist.reject { |o| not o.permitted_for_user?(current_user) }
+    end
+  end
+end

data/app/helpers/rails_connector/time_machine_helper.rb

@@ -0,0 +1,24 @@
+module RailsConnector
+
+  # A helper to access the preview time machine.
+  module TimeMachineHelper
+
+    # Renders a link to open the time machine.
+    def time_machine_link(content)
+      if Configuration.enabled?(:time_machine) && Configuration.editor_interface_enabled?
+        (<<-EOF).html_safe
+          #{link_to_function content, "window.open('#{time_machine_url :action => 'index'}', 'time_machine', 'height=350,location=no,menubar=no,status=no,toolbar=no,width=500')"}
+          <script type="text/javascript">
+          // <!--
+            function sendRequest(url)
+            {
+              jQuery.getScript(url);
+            }
+          // -->
+          </script>
+        EOF
+      end
+    end
+  end
+
+end

data/app/helpers/rails_connector/tracking_helper.rb

@@ -0,0 +1,32 @@
+module RailsConnector
+
+  # This module contains helpers for Google Analytics and Infopark Tracking.
+  module TrackingHelper
+
+    # This helper renders the Google Analytics snippet using the domain code
+    # for the current domain as configured via <tt>Configuration::GoogleAnalytics.domain_code</tt>.
+    # The helper is automatically run when using the +rails_connector_after_content_tags+,
+    # if the feature <tt>:google_analytics</tt> is enabled.
+    def google_analytics
+      if domain_code = Configuration::GoogleAnalytics.domain_code(request.host)
+        raw %Q{
+          <script type="text/javascript" src='#{ga_prefix}google-analytics.com/ga.js'></script>
+          <script type="text/javascript">
+            try {
+              var pageTracker = _gat._getTracker("#{domain_code}");
+              pageTracker._setAllowAnchor(true);
+              pageTracker._addIgnoredOrganic("#{request.host}");
+              pageTracker._trackPageview();
+            } catch(err) {}
+          </script>
+        }
+      end
+    end
+
+    private
+
+    def ga_prefix
+      request.ssl? ? 'https://ssl.' : 'http://www.'
+    end
+  end
+end

data/app/helpers/ratings_helper.rb

@@ -0,0 +1,4 @@
+# This helper includes RailsConnector::DefaultRatingsHelper
+module RatingsHelper
+  include RailsConnector::DefaultRatingsHelper
+end

data/app/helpers/user_helper.rb

@@ -0,0 +1,3 @@
+module UserHelper
+  include RailsConnector::DefaultUserHelper
+end