infopark_rails_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/app/helpers/rails_connector/display_helper.rb

@@ -1,6 +1,7 @@
 module RailsConnector
 
   # 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
@@ -9,10 +10,11 @@ module RailsConnector
     #   <%= 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-Mounth-Day Hour:Minutes
+    # * 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 MarkdownString then markdown(convert_links(value)).html_safe
@@ -24,12 +26,13 @@ module RailsConnector
     end
 
     # Renders a field from the CMS, including an edit marker for the preview
-    # If the option :marker is false, no edit marker will be rendered.
+    # If the option :marker is +false+, no edit marker will be rendered.
     #
     # <%= display_field @obj, :title %>
     #
-    # When creating an edit marker, all options except :marker are passed to MarkerHelper::edit_marker.
+    # When creating an edit marker, all options except :marker are passed to {MarkerHelper#edit_marker}.
     #
+    # @api public
     def display_field(obj, attr, options = {})
       options.reverse_merge!({
         :marker => ![:id, :path, :created, :last_changed, :version].include?(attr.to_sym)
@@ -46,8 +49,7 @@ module RailsConnector
     # Legacy method - deprecated
     #
     # Use display_value and display_field instead
-    #
-    def display(*args) #:nodoc:
+    def display(*args)
       if args.last.kind_of? Hash
         options = args.pop
       else

data/app/helpers/rails_connector/layout_helper.rb

@@ -2,10 +2,12 @@ module RailsConnector
 
   # This module contains helpers that render tags for the html head
   # and the end of the html body.
+  # @api public
   module LayoutHelper
     include TrackingHelper
 
     # Renders all tags needed in the html head for the enabled features.
+    # @api public
     def rails_connector_header_tags
       html = "".html_safe
       html += tag('meta', :name => 'generator',
@@ -19,6 +21,7 @@ module RailsConnector
     end
 
     # Renders all tags needed at the end of the body tag for the enabled features.
+    # @api public
     def rails_connector_after_content_tags
       html = "".html_safe
       html += render_marker_code

data/app/helpers/rails_connector/link_helper.rb

@@ -3,6 +3,7 @@ require "uri"
 module RailsConnector
 
   # This module contains a helper that can be used to build markup for a link, e.g. a download link.
+  # @api public
   module LinkHelper
     # Generates a link by producing the corresponding HTML markup.
     # <em>link</em> is the Link to be rendered, you may specify the following <em>options</em>:
@@ -45,6 +46,7 @@ module RailsConnector
     #   <a class='link' href='destination'>
     #     <span class='file_extension'>title</span>
     #   </a>
+    # @api public
     def link(link, options = {})
       link_attributes = {
         :href => cms_path(link),
@@ -65,6 +67,7 @@ module RailsConnector
     # For a list of valid <em>options</em> see #link.
     #
     # The generated list element has the CSS class 'linklist'.
+    # @api public
     def link_list(link_list, options = {})
       return if link_list.blank?
       markup = "<ul class='linklist'>"

data/app/helpers/rails_connector/mandatory_label_helper.rb

@@ -7,4 +7,4 @@ module RailsConnector
       form.label(object, html, :class => "mandatory")
     end
   end
-end
+end

data/app/helpers/rails_connector/menu_helper.rb

@@ -1,6 +1,7 @@
 module RailsConnector
 
   # This module contains helpers that can be used to build all kinds of menus.
+  # @api public
   module MenuHelper
     include DisplayHelper
 
@@ -51,7 +52,7 @@ module RailsConnector
     #     </li>
     #   </ul>
     #
-
+    # @api public
     def build_menu(start_obj, current_obj, html_options, &block)
       children = table_of_contents(start_obj)
       content_tag(:ul, html_options) do

data/app/helpers/rails_connector/micronav_helper.rb

@@ -1,6 +1,7 @@
 module RailsConnector
 
   # This module contains a helper that can be used to build a micronavigation.
+  # @api public
   module MicronavHelper
 
     # Generates a micronavigation by producing HTML markup.
@@ -84,6 +85,7 @@ module RailsConnector
     #   <ul id='<em><b>micronav_below_banner</b></em>'></tt>
     #     ...
     #   </ul>
+    # @api public
     def micronav(obj, options = {})
       options.reverse_merge!({:start => 1, :micronav_id => 'micronav'})
       ancestors = obj.ancestors

data/app/helpers/rails_connector/seo_helper.rb

@@ -1,6 +1,7 @@
 module RailsConnector
 
   # This helper provides methods for Search Engine Optimization.
+  # @api public
   module SeoHelper
 
     # Generate search engine optimized meta tags for the html head.
@@ -21,6 +22,7 @@ module RailsConnector
     #   <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" />
+    # @api public
     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])

data/app/helpers/rails_connector/table_of_contents_helper.rb

@@ -3,6 +3,7 @@ module RailsConnector
   #
   # This module contains a helper that can be used to build a table of contents of an object.
   #
+  # @api public
   module TableOfContentsHelper
 
     #
@@ -13,6 +14,7 @@ module RailsConnector
     # 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.
     #
+    # @api public
     def table_of_contents(obj)
       obj.sorted_toclist.reject { |o| not o.permitted_for_user?(current_user) }
     end

data/app/helpers/rails_connector/time_machine_helper.rb

@@ -1,9 +1,11 @@
 module RailsConnector
 
   # A helper to access the preview time machine.
+  # @api public
   module TimeMachineHelper
 
     # Renders a link to open the time machine.
+    # @api public
     def time_machine_link(content)
       if Configuration.enabled?(:time_machine) && Configuration.editor_interface_enabled?
         (<<-EOF).html_safe

data/app/helpers/rails_connector/tracking_helper.rb

@@ -1,12 +1,14 @@
 module RailsConnector
 
   # This module contains helpers for Google Analytics and Infopark Tracking.
+  # @api public
   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.
+    # @api public
     def google_analytics
       if domain_code = Configuration::GoogleAnalytics.domain_code(request.host)
         raw %Q{

data/app/helpers/ratings_helper.rb

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

data/app/helpers/user_helper.rb

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

data/app/mailers/confirmation_mailer.rb

@@ -1,10 +1,15 @@
+# @api public
 class ConfirmationMailer < ActionMailer::Base
+  # @return [void]
+  # @api public
   def reset_password(recipient, confirmation_url)
     @confirmation_url = confirmation_url
     mail(:to => recipient, :subject =>
         I18n.t("rails_connector.views.user.forgot_password_subject"))
   end
 
+  # @return [void]
+  # @api public
   def register_confirmation(recipient, confirmation_url)
     @confirmation_url = confirmation_url
     mail(:to => recipient, :subject =>

data/app/models/crm_form.rb

@@ -1,2 +1,3 @@
+# @api public
 class CrmForm < Obj
 end

data/app/models/rails_connector/default_comment.rb

@@ -5,7 +5,7 @@ module RailsConnector
   # Abstract base class for Comment.
   #
   # Objects do only have comments if the addon <tt>:comments</tt> is enabled
-  # and the module Commentable is thereby included.
+  # and the module {Commentable} is thereby included.
   #
   # A comment must have a name, email, subject, and body.
   class DefaultComment < ActiveRecord::Base

data/app/models/rails_connector/link_list.rb

@@ -1,8 +1,9 @@
 module RailsConnector
 
+  # @api public
   class LinkList < Array
 
-    def initialize(link_definitions) #:nodoc:
+    def initialize(link_definitions)
       if link_definitions.blank?
         super([])
       else
@@ -10,6 +11,7 @@ module RailsConnector
       end
     end
 
+    # @api public
     def destination_objects
       self.map {|link| link.destination_object}.compact
     end

data/lib/generators/rails_connector/comments/comments_generator.rb

@@ -1,4 +1,3 @@
-#:stopdoc:
 require "rails/generators/active_record"
 
 module RailsConnector

data/lib/generators/rails_connector/comments/templates/migration.rb

@@ -1,4 +1,3 @@
-# :stopdoc:
 class CreateComments < ActiveRecord::Migration
   def self.up
     create_table :comments do |t|

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

@@ -1,4 +1,3 @@
-#:stopdoc:
 module RailsConnector
   module Generators
     class InstallGenerator < Rails::Generators::Base

data/lib/generators/rails_connector/install/templates/obj_extensions.rb

@@ -1,3 +1,4 @@
+# @api public
 module ObjExtensions
 
   # Infopark Rails Connector enables the developer to define specific behavior for Fiona CMS
@@ -7,7 +8,7 @@ module ObjExtensions
   #
   # Be careful only to use methods and classes that are part of the documented api.
   # Other methods and classes may change without warning.
-
+  # @api public
   def self.enable
     return if Obj.respond_to? :obj_extensions_enabled
 

data/lib/generators/rails_connector/ratings/ratings_generator.rb

@@ -1,4 +1,3 @@
-#:stopdoc:
 require "rails/generators/active_record"
 
 module RailsConnector

data/lib/generators/rails_connector/ratings/templates/migration.rb

@@ -1,4 +1,3 @@
-# :stopdoc:
 class CreateRatings < ActiveRecord::Migration
   def self.up
     create_table :ratings do |t|

data/lib/infopark_rails_connector.rb

@@ -1,7 +1,8 @@
 require 'rails_connector/core_extensions'
 
+# @api public
 module ::RailsConnector
-  def self.load_platform_gem_if_present(name) # :nodoc:
+  def self.load_platform_gem_if_present(name)
     if Gem.loaded_specs["infopark_#{name}_connector"]
       gem_name = "infopark_#{name}_connector"
 
@@ -14,7 +15,8 @@ module ::RailsConnector
     end
   end
 
-  # return either :fiona or :cloud depending on the app's configuration.
+  # return either <tt>:fiona</tt> or <tt>:cloud</tt> depending on the app's configuration.
+  # @return [Symbol]
   def self.platform
     @platform
   end

data/lib/rails_connector/authenticable.rb

@@ -1,5 +1,5 @@
 module RailsConnector
-  module Authenticable #:nodoc:
+  module Authenticable
     def self.included(mod)
       %w(logged_in? admin? current_user).each do |method_name|
         unless instance_method_defined?(mod, method_name)
@@ -13,7 +13,7 @@ module RailsConnector
       end
     end
 
-    module InstanceMethods  #:nodoc:
+    module InstanceMethods
       def self.logged_in?; false; end
       def self.admin?; false; end
       def self.current_user; nil; end

data/lib/rails_connector/cms_accessible.rb

@@ -1,10 +1,11 @@
 module RailsConnector
 
+  # @api public
   module CmsAccessible
 
   protected
 
-    def set_preview_time # :nodoc:
+    def set_preview_time
       Obj.preview_time = session[:preview_time]
     end
 
@@ -12,7 +13,7 @@ module RailsConnector
     #
     # To require the loading for all actions, use this in your controllers:
     #   before_filter :load_object
-    def load_object # :nodoc:
+    def load_object
       CmsEnv.new(request.env).load
       loaded_obj = request.env[CmsEnv::OBJ_ENV_KEY]
       raise loaded_obj if loaded_obj.is_a?(StandardError)
@@ -25,7 +26,7 @@ module RailsConnector
     # To require the check for all actions, use this in your controllers:
     #   before_filter :load_object
     #   before_filter :ensure_object_is_active
-    def ensure_object_is_active # :nodoc:
+    def ensure_object_is_active
       unless @obj.active?
         @valid_from = @obj.valid_from
         @valid_until = @obj.valid_until
@@ -42,7 +43,7 @@ module RailsConnector
     # To require the check for all actions, use this in your controllers:
     #   before_filter :load_object
     #   before_filter :ensure_object_is_permitted
-    def ensure_object_is_permitted # :nodoc:
+    def ensure_object_is_permitted
       unless is_permitted(@obj)
         @obj = nil
         render_obj_error(403, "forbidden")
@@ -51,10 +52,11 @@ module RailsConnector
       return true
     end
 
-    # This method is called when rendering an error caused by either ensure_object_is_permitted
-    # or ensure_object_is_active before filter. It renders an error template located in
+    # This method is called when rendering an error caused by either {ensure_object_is_permitted}
+    # or {ensure_object_is_active} before filter. It renders an error template located in
     # "errors/*.html.erb" with given HTTP status and content type "text/html" and with no layout.
     # Overwrite this method to change the error page.
+    # @api public
     def render_obj_error(status, name)
       force_html_format
       render(
@@ -66,23 +68,24 @@ module RailsConnector
     end
 
     # Enforce "html" as template format.
-    def force_html_format # :doc:
+    # @api public
+    def force_html_format
       request.format = :html
     end
 
     # Inclusion hook to make is_permitted available as helper method.
-    def self.included(base) # :nodoc:
+    def self.included(base)
       base.__send__ :helper_method, :is_permitted
     end
 
     # Helper method to check live permissions
-    def is_permitted(obj) # :nodoc:
+    def is_permitted(obj)
       obj.permitted_for_user?(current_user)
     end
 
     # Filter method which sets the header 'X-Robots-Tag: unavailable_after'
     # to the valid_until date of the current object.
-    def set_google_expire_header # :nodoc:
+    def set_google_expire_header
       if @obj && (date = @obj.valid_until)
         headers['X-Robots-Tag: unavailable_after'] = date.rfc822
       end
@@ -90,6 +93,7 @@ module RailsConnector
 
     # Deliver the obj's body as response by file or data.
     # May respond with status 304 if a If-Modified-Since header is found.
+    # @api public
     def deliver_file
       if @obj.body_data_url
         redirect_to @obj.body_data_url

data/lib/rails_connector/cms_dispatch_controller.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
   class CmsDispatchController < ActionController::Metal

data/lib/rails_connector/cms_env.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
   class CmsEnv

data/lib/rails_connector/cms_test_request.rb

@@ -1,5 +1,5 @@
 module RailsConnector
-  module CmsTestRequest # :nodoc:
+  module CmsTestRequest
     def for_cms_object(test_obj=nil)
       # prepare the env as if the given obj was loaded by CmsEnv
       env[RailsConnector::CmsEnv::OBJ_ENV_KEY] = test_obj if test_obj

data/lib/rails_connector/commentable.rb

@@ -9,13 +9,13 @@ module RailsConnector
     end
 
     # Returns +true+ by default.
-    # Implement your own conditions by overwriting this method in your +ObjExtensions+.
+    # Implement your own conditions by overwriting this method in your {ObjExtensions}.
     def allow_comments?
       true
     end
 
     # Returns +true+ by default.
-    # Implement your own conditions by overwriting this method in your +ObjExtensions+.
+    # Implement your own conditions by overwriting this method in your {ObjExtensions}.
     def allow_anonymous_comments?
       true
     end

data/lib/rails_connector/configuration/google_analytics.rb

@@ -1,14 +1,16 @@
 module RailsConnector
+  # @api public
   class Configuration
 
     # This module is an extension to the rails connector configuration.
     #
     # Configuration example:
     #
-    #   RailsConnector::Configuration::GoogleAnalytics.domains(
-    #     'www.example.de' => 'UA-example-1',
-    #     'www.example.com' => 'UA-example-2'
-    #   )
+    #     RailsConnector::Configuration::GoogleAnalytics.domains(
+    #       'www.example.de' => 'UA-example-1',
+    #       'www.example.com' => 'UA-example-2'
+    #     )
+    # @api public
     module GoogleAnalytics
       @@domains = {}
 
@@ -16,6 +18,7 @@ module RailsConnector
         @@domains = @@domains.merge(domains_and_codes)
       end
 
+      # @api public
       def self.domains(domains_and_codes)
         self.domains = domains_and_codes
       end

data/lib/rails_connector/configuration/pdf_generator.rb

@@ -1,8 +1,11 @@
 module RailsConnector
+  # @api public
   class Configuration
+    # @api public
     module PdfGenerator
       @@hosts = []
 
+      # @api public
       def self.host_whitelist(*hosts)
         @@hosts = hosts
       end

data/lib/rails_connector/configuration/rss.rb

@@ -1,4 +1,5 @@
 module RailsConnector
+  # @api public
   class Configuration
 
     # This module adds configuration options for the RSS feature.
@@ -6,17 +7,21 @@ module RailsConnector
     # Specify the RSS root in
     # <code><em>RAILS_ROOT</em>/config/initializers/rails_connector.rb</code>:
     #   RailsConnector::Configuration::Rss.root = lambda { NamedLink.get_object('news') }
+    # @api public
     module Rss
 
       # Raised if no RSS root object has been specified.
+      # @api public
       class RootUndefined < StandardError; end
       # Raised if the root is missing when accessing it
-      # Inherits from RootUndefined for compatibility reasons
+      # Inherits from {RootUndefined} for compatibility reasons
+      # @api public
       class RootNotFound < RootUndefined; end
 
       @root_provider = nil
 
       # Stores the obj providing lambda for later use
+      # @api public
       def self.root=(obj_provider)
         case obj_provider
         when Obj
@@ -31,7 +36,8 @@ module RailsConnector
       end
 
       # Returns the RSS root object.
-      # If no RSS root has been specified then Rss::RootUndefined is raised.
+      # If no RSS root has been specified then {Rss::RootUndefined} is raised.
+      # @api public
       def self.root
         raise RootUndefined unless @root_provider
         begin