infopark_fiona_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/.yardopts

@@ -0,0 +1,5 @@
+--hide-void-return
+--protected
+--private
+--non-transitive-tag api
+--api public

data/README

@@ -1,5 +1,5 @@
 = Infopark Fiona Connector
 
-Infopark Fiona Connector integrates the Infopark Rails Connector with the Infopark CMS Fiona.
-
+Infopark Cloud Connector integrates the {https://rubygems.org/gems/infopark_rails_connector Infopark Rails Connector} with the Infopark CMS Fiona.
 
+For more information about Infopark Rails and Fiona Connector, please visit {http://kb.infopark.de/ Infopark’s Knowledge Base}.

data/app/helpers/rails_connector/marker_helper.rb

@@ -2,8 +2,8 @@ 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.
+  # The helpers will not render anything 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:
@@ -20,6 +20,7 @@ module RailsConnector
   # [<tt>'udt'</tt>] undecorated tiny browser window
   #
   # The <tt>:target</tt> option becomes the <tt>target</tt> attribute of the <tt><a></tt> tag.
+  # @api public
   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.
@@ -34,12 +35,13 @@ module RailsConnector
     #     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
+    # The last form is the default of {DisplayHelper#display_field} without the option <code>:marker => false</code>.
+    # 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),
+    # Hint: You should not render edit markers within elements that are hidden via CSS (<code>display:none</code>),
     # otherwise they cannot be displayed correctly.
+    # @api public
     def edit_marker(obj, attr, options = {}, &block)
       if Configuration.editor_interface_enabled? && !session[:hide_editmarkers]
         context = (options.delete :context) || @obj
@@ -80,6 +82,7 @@ module RailsConnector
     # 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
+    # @api public
     def toggle_edit_marker_link(value)
       if Configuration.editor_interface_enabled?
         link_to value, toggle_markers_url(@obj)
@@ -98,6 +101,7 @@ module RailsConnector
     # The following code will render an action marker for the release action of the current object:
     #
     #   <%= action_marker :workflow_release, [@obj] %>
+    # @api public
     def action_marker(action, objs, options = {}, &block)
       return unless Configuration.editor_interface_enabled?
 
@@ -129,7 +133,8 @@ module RailsConnector
     # [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+).
+    # [options] options for the edit dialog (see {MarkerHelper#edit_marker}).
+    # @api public
     def link_to_edit(name, obj, attr, options = {})
       if Configuration.editor_interface_enabled?
         context = (options.delete :context) || @obj
@@ -149,9 +154,9 @@ module RailsConnector
     # [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.
+    # 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.
+    # using the {#marker_menu_target} helper.
     #
     # Usage:
     #   <%= marker_menu do %>
@@ -161,6 +166,7 @@ module RailsConnector
     #   <%= marker_menu_target(:div) do %>
     #     Content
     #   <% end %>
+    # @api public
     def marker_menu(left=0, top=0, &block)
       self.current_marker_menu_id = store_marker_definition(
         :offset_left => left,
@@ -181,7 +187,8 @@ module RailsConnector
     # [options] the options for the tag.
     # [&block] the content which will be displayed with the menu.
     #
-    # See +marker_menu+ for an example.
+    # See {#marker_menu} for an example.
+    # @api public
     def marker_menu_target(tag_name, options = {}, &block)
       content_tag(
         tag_name,
@@ -193,15 +200,16 @@ module RailsConnector
     # 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
+    # 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.
+    # @api public
     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:
+    def include_edit_marker_support
       if Configuration.editor_interface_enabled?
         raw <<-EOF
           #{stylesheet_link_tag :editmarker}
@@ -212,15 +220,15 @@ module RailsConnector
     end
 
     # Renders the necessary marker code to use edit markers and marker menus.
-    def render_marker_code # :nodoc:
+    def render_marker_code
       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
+    # 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:
@@ -230,29 +238,32 @@ module RailsConnector
     #       <%= action_item("edit image", "css_class", [@obj], :editImage) %>
     #     <% end %>
     #   <% end %>
+    # @api public
     def iconlist(&block)
       content_tag(:ul, capture(&block)) if block_given?
     end
 
-    # Creates an edit marker item for the list generated by +iconlist+.
+    # 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.
+    # [options] options that will be delegated to the {#link_to_edit} helper.
+    # @api public
     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+.
+    # 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 array of 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.
+    # [options] options that will be delegated to the {#action_marker} helper.
+    # @api public
     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)
@@ -330,7 +341,7 @@ ENDOFSTRING
       permissions.map { |perm| obj.permissions.__send__(perm) }
     end
 
-    def uri_for_action_marker(action, objects, context = nil, size = nil, target = nil, params = nil) #:nodoc:
+    def uri_for_action_marker(action, objects, context = nil, size = nil, target = nil, params = nil)
       action = action.to_s
       objectIds = objects.collect(&:id).to_json
       contextId = context.nil? ? 'null' : context.id

data/lib/comment.rb

@@ -1,4 +1,5 @@
 # The Comment model inherits all of its behavior from
-# RailsConnector::DefaultComment.
+# {RailsConnector::DefaultComment}.
+# @api public
 class Comment < RailsConnector::DefaultComment
 end

data/lib/infopark_fiona_connector.rb

@@ -2,6 +2,7 @@ require 'rails_connector/rack_middlewares'
 require 'rails_connector/core_extensions'
 require "rails_connector/errors"
 
+# @api public
 module RailsConnector
   def self.autoload_all_sources
     source_files = Dir.glob(File.expand_path("../rails_connector/*.rb", __FILE__)).map do |file|

data/lib/rails_connector/attr_dict.rb

@@ -8,7 +8,7 @@ module RailsConnector
   # [editor] The login of the current editor of the edited content, if set
   #
   # Any custom Attribute can be accessed directly or via [].
-  class AttrDict #:nodoc:
+  class AttrDict
     include DateAttribute
 
     def initialize(object, keys_and_values = {}, defs = {})
@@ -28,7 +28,7 @@ module RailsConnector
       StringTagging.tag_as_html(raw, self)
     end
 
-    def sort_keys #:nodoc:
+    def sort_keys
       [sort_key1, sort_key2, sort_key3]
     end
 
@@ -140,7 +140,7 @@ module RailsConnector
     end
   end
 
-  class UnknownAttributeError < StandardError # :nodoc:
+  class UnknownAttributeError < StandardError
   end
 
 end

data/lib/rails_connector/blob.rb

@@ -2,7 +2,7 @@ module RailsConnector
 
   # A binary containing the blob data of a Content or CMS management
   # data of Attribute (fields), ObjClass (object classes), for example.
-  class Blob < CmsBaseModel #:nodoc:
+  class Blob < CmsBaseModel
     self.primary_key = "blob_name"
 
     class << self

data/lib/rails_connector/blob_mysql.rb

@@ -3,7 +3,7 @@ require 'mysql_blob_streaming'
 
 module RailsConnector
 
-  module BlobMysql #:nodoc:
+  module BlobMysql
     def self.included(base)
       base.instance_eval do
         define_method :store_data do

data/lib/rails_connector/blob_oracle.rb

@@ -1,6 +1,6 @@
 module RailsConnector
 
-  module BlobOracle #:nodoc:
+  module BlobOracle
     def self.included(base)
       base.instance_eval do
         define_method :store_data do

data/lib/rails_connector/cache_middleware.rb

@@ -1,5 +1,5 @@
 module RailsConnector
-  class CacheMiddleware #:nodoc:
+  class CacheMiddleware
     def initialize(app)
       @app = app
     end

data/lib/rails_connector/cms_base_model.rb

@@ -5,7 +5,7 @@ module RailsConnector
   # determined from the instance_name.
   #
   # [instance_name] the name of the CMS instance
-  class CmsBaseModel < ActiveRecord::Base #:nodoc:
+  class CmsBaseModel < ActiveRecord::Base
     @@instance_name = 'default'
     cattr_accessor :instance_name
     self.abstract_class = true

data/lib/rails_connector/date_attribute.rb

@@ -1,7 +1,7 @@
 module RailsConnector
 
   # Adds support for string columns which contain ISO dates
-  module DateAttribute #:nodoc: all
+  module DateAttribute
     module ClassMethods
       def date_attribute(*names)
         names.each do |name|

data/lib/rails_connector/default_search_request.rb

@@ -1,6 +1,7 @@
 module RailsConnector
   # This class provides a default implementation for accessing the search server.
-  # It is used by DefaultSearchController.
+  # It is used by {DefaultSearchController}.
+  # @api public
   class DefaultSearchRequest < VeritySearchRequest
   end
 end

data/lib/rails_connector/errors.rb

@@ -2,6 +2,7 @@ require "active_record/errors"
 
 module RailsConnector
 
+# @api public
 ResourceNotFound = ActiveRecord::RecordNotFound
 
 end # module RailsConnector

data/lib/rails_connector/fiona_engine.rb

@@ -1,5 +1,5 @@
 module ::RailsConnector
-  class FionaEngine < Rails::Engine #:nodoc:
+  class FionaEngine < Rails::Engine
   end
 end
 

data/lib/rails_connector/link.rb

@@ -1,11 +1,12 @@
 module RailsConnector
   # This class provides an interfaces for handling CMS Links.
   # To format a link for rendering in an html page, use the +cms_path+ or +cms_url+ methods.
+  # @api public
   class Link
 
     extend ActiveModel::Naming
 
-    def initialize(link_data, destination_object = nil) #:nodoc:
+    def initialize(link_data, destination_object = nil)
       @link_data = link_data.symbolize_keys
       @destination_object = destination_object
     end
@@ -13,17 +14,20 @@ module RailsConnector
     # The link's external url. Only available for external links.
     # Warning: Do not output the url directly unless you know what you are doing.
     # Normally you want to use the +cms_path+ or +cms_url+ methods to format a link.
+    # @api public
     def url
       @link_data[:url]
     end
 
     # The link's title.
+    # @api public
     def title
       @link_data[:title]
     end
 
     # Returns the link's query string as in "index.html?query_string".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
     def query
       @link_data[:search]
     end
@@ -31,40 +35,44 @@ module RailsConnector
     # Deprecated: use Link#query instead.
     # Returns the link's query string as in "index.html?query_string".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
     def search
       query
     end
 
     # Returns the link's anchor as in "index.html#anchor".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
     def fragment
       @link_data[:fragment]
     end
 
     # Returns the browser window or browser frame to be used as a target for this link.
     # Example: Links that should be opened in a new window will return "_blank" as their target.
+    # @api public
     def target
       @link_data[:target]
     end
 
-    def id #:nodoc:
+    def id
       @link_data[:link_id]
     end
 
-    def tag_name # :nodoc:
+    def tag_name
       @link_data[:tag_name]
     end
 
-    def markdown_type # :nodoc:
+    def markdown_type
       @link_data[:markdown_type]
     end
 
-    def markdown? # :nodoc:
+    def markdown?
       'markdown' == @link_data[:source_format]
     end
 
     # Returns the file extension (e.g. zip, pdf) of this link's (internal or external) target.
     # Returns an empty string if the file extension is can not be determined.
+    # @api public
     def file_extension
       if internal?
         destination_object ? destination_object.file_extension : ""
@@ -75,6 +83,7 @@ module RailsConnector
     end
 
     # Returns the id of the Links' destination_object.
+    # @api public
     def destination_object_id
       destination
     end
@@ -82,6 +91,7 @@ module RailsConnector
     # Returns the title of this Link if it is set.
     # Otherwise it returns the display_title of the destination object for internal Links
     # or the URL for external Links.
+    # @api public
     def display_title
       dt = title
       dt = destination_object.display_title if dt.blank? && !external?
@@ -90,35 +100,39 @@ module RailsConnector
     end
 
     # Returns true this Link links to a CMS Object.
+    # @api public
     def internal?
       url.nil?
     end
 
     # Returns true if this Link links to an external URL.
+    # @api public
     def external?
       !internal?
     end
 
     # An internal Link is active if it's destination object is active.
     # An external Link is always active.
+    # @api public
     def active?
       external? || (destination_object && destination_object.active?)
     end
 
-    def external_prefix? #:nodoc:
+    def external_prefix?
       url =~ /\s?external:/
     end
 
-    def resolved? #:nodoc:
+    def resolved?
       external? || resolved_internal?
     end
 
     # Returns the destination object (+Obj+) of this Link.
+    # @api public
     def destination_object
       @destination_object ||= Obj.find(destination) if resolved_internal?
     end
 
-    def to_liquid # :nodoc:
+    def to_liquid
       LiquidSupport::LinkDrop.new(self)
     end
 

data/lib/rails_connector/liquid_support/action_marker.rb

@@ -1,12 +1,15 @@
-module RailsConnector::LiquidSupport
+module RailsConnector
+
+# @api public
+module LiquidSupport
 
   # Usage example for actionmarkers in Liquid templates:
   #   {% actionmarker obj.images[0] editImageWizard param_a:value_a param_b:value_b %}
   #     [Edit image]
   #   {% endactionmarker %}
   #
-  # The first parameter may be an instance of +ObjDrop+ (usually +obj+ in Liquid templates),
-  # +Array+ (such as a +LinkList+ field), or +LinkDrop+ (as in the example above).
+  # The first parameter may be an instance of {ObjDrop} (usually +obj+ in Liquid templates),
+  # +Array+ (such as a +LinkList+ field), or {LinkDrop} (as in the example above).
   #
   # The second parameter is the action to be run on the target objects.
   # Additional parameters to be forwarded to the action can be added as <tt>key:value</tt> pairs.
@@ -16,7 +19,8 @@ module RailsConnector::LiquidSupport
   # Internally, the parameter <tt>:context</tt> is always set to the currently viewed object (+obj+)
   # and can not be overwritten.
   #
-  # The Liquid actionmarker uses RailsConnector::MarkerHelper#action_marker.
+  # The Liquid actionmarker uses {RailsConnector::MarkerHelper#action_marker}.
+  # @api public
   class ActionMarker < Liquid::Block
     def initialize(tag_name, markup, tokens)
       @obj_name, @method_name = markup.to_s.split(/\s+/)
@@ -67,3 +71,5 @@ module RailsConnector::LiquidSupport
 
   Liquid::Template.register_tag('actionmarker', ActionMarker)
 end
+
+end

data/lib/rails_connector/lucene_search_request.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 require 'rsolr'
 
 module RailsConnector
@@ -36,7 +35,7 @@ module RailsConnector
     end
 
     # Removes unwanted characters from +text+.
-    def self.sanitize(text) #:nodoc:
+    def self.sanitize(text)
       text.gsub(/[^\w\*]/, ' ').gsub(/\s+/, ' ').strip
     end
 

data/lib/rails_connector/named_link.rb

@@ -2,9 +2,10 @@ module RailsConnector
 
   # This class provides methods used to retrieve objects from CMS based an entry
   # in CMS of the obj_class <tt>NamedLink</tt>.
-
+  # @api public
   class NamedLink < Obj
 
+    # @api public
     class NotFound < StandardError
     end
 
@@ -36,38 +37,40 @@ module RailsConnector
 
     # Sets the time in minutes after which the cache will be expired.
     # The default expiry time is set to 1 minute
+    # @api public
     def self.cache_expiry_time=(value)
       @@cache_expiry_time = value
     end
 
-    def self.cache_expiry_time #:nodoc:
+    def self.cache_expiry_time
       @@cache_expiry_time || 1
     end
 
-    def self.cache_expired? #:nodoc:
+    def self.cache_expired?
       @@updated_at.nil? || @@updated_at <= cache_expiry_time.minute.ago
     end
 
     # Returns the CMS object mapped to the given title or nil.
     # The title can be a string of symbol.
     # If :cache => false is provided, the object will not be fetched from the cache.
+    # @api public
     def self.get_object(title, options = {})
       object = named_links[title.to_s]
       raise NotFound, "The NamedLink '#{title.to_s}' does not exist" if object.nil?
       options[:cache] == false ? object.reload : object
     end
 
-    def self.reset_cache #:nodoc:
+    def self.reset_cache
       @@named_links_cache = nil
     end
 
-    def self.named_links #:nodoc:
+    def self.named_links
       reset_cache if cache_expired?
       generate_named_links_cache unless named_links_cache
       named_links_cache
     end
 
-    def self.named_links_cache #:nodoc:
+    def self.named_links_cache
       @@named_links_cache
     end
 

data/lib/rails_connector/news.rb

@@ -4,7 +4,7 @@ module RailsConnector
   #
   # This class models the join table between channels and objects.
   # Instances of this class also hold information about validity range.
-
+  # @api public
   class News < CmsBaseModel
 
     self.primary_key = "news_id"

data/lib/rails_connector/obj.rb

@@ -6,7 +6,7 @@ module RailsConnector
   #
   # [children] an Array of objects, Obj, of which this one is the parent
   # [parent] the Obj of which this one is a child - nil for the root object
-  # [sort_value] the sort value of this object with respect to its siblings, calculated using the sort criteria of the parent
+  # @api public
   class Obj < CmsBaseModel
     include AttrValueProvider
     include DateAttribute
@@ -14,7 +14,7 @@ module RailsConnector
 
     self.store_full_sti_class = false
 
-    def self.configure_for_content(which) # :nodoc:
+    def self.configure_for_content(which)
       case which
       when :released then configure_column_information("objs", true)
       when :edited
@@ -39,7 +39,7 @@ module RailsConnector
     configure_for_content(:released)
 
     # Patch to avoid a type_condition being added by ActiveRecord::Base.add_conditions! for Obj.find(params):
-    def self.descends_from_active_record? # :nodoc:
+    def self.descends_from_active_record?
       superclass == CmsBaseModel
     end
 
@@ -54,15 +54,17 @@ module RailsConnector
     # In any other case, RailsConnector::Obj is used, except when explicitely asked
     # for a model in the RailsConnector namespace (RailsConnector::Permission etc.)
 
-    def self.compute_type(type_name) # :nodoc:
+    def self.compute_type(type_name)
       try_type { type_name.constantize } ||
       self
     end
 
+    # @api public
     def permissions
       @@use_cached_permissions ? attr_dict.permissions : super
     end
 
+    # @api public
     def permitted_for_user?(user)
       if permitted_groups.blank?
         true
@@ -76,22 +78,25 @@ module RailsConnector
     end
 
     # Returns the root Obj. Its id is 2001 and cannot be changed.
+    # @api public
     def self.root
       Obj.find(2001)
     end
 
     # Returns the homepage object. This can be overwritten in your application's +ObjExtensions+.
     # Use <tt>Obj#homepage?</tt> to check if an object is the homepage.
+    # @api public
     def self.homepage
       root
     end
 
     # for testing purposes only
-    def self.reset_homepage #:nodoc:
+    def self.reset_homepage
       @@homepage_id = nil
     end
 
      # returns the obj's permalink.
+     # @api public
      def permalink
        self[:permalink]
      end
@@ -100,6 +105,7 @@ module RailsConnector
     # By default a controller matching the Obj's obj_class will be used.
     # If the controller does not exist, the CmsController will be used as a fallback.
     # Overwrite this method to force a different controller to be used.
+    # @api public
     def controller_name
       obj_class
     end
@@ -107,19 +113,23 @@ module RailsConnector
     # This method determines the action that should be invoked when the Obj is requested.
     # The default action is 'index'.
     # Overwrite this method to force a different action to be used.
+    # @api public
     def controller_action_name
       "index"
     end
 
     @@homepage_id = nil
+
     # Returns true if the current object has the same id as the homepage object. Always use this method instead of
     # manually comparing an object to <tt>Obj.homepage</tt>, as Obj#homepage? caches the object id
     # and thus requires no extra database access.
+    # @api public
     def homepage?
       self.id == (@@homepage_id ||= self.class.homepage.id)
     end
 
     # Returns the title of the content or the name.
+    # @api public
     def display_title
       self.title || name
     end
@@ -132,36 +142,43 @@ module RailsConnector
     }.freeze unless defined?(OBJECT_TYPES)
 
     # Returns the type of the object: :document, :publication, :image or :generic
+    # @api public
     def object_type
       OBJECT_TYPES[obj_type_code]
     end
 
     # Returns true if image? or generic?
+    # @api public
     def binary?
       [:image, :generic].include? object_type
     end
 
     # Returns true if object_type == :image
+    # @api public
     def image?
       object_type == :image
     end
 
     # Returns true if object_type == :generic
+    # @api public
     def generic?
       object_type == :generic
     end
 
     # Returns true if object_type == :publication (for folders)
+    # @api public
     def publication?
       object_type == :publication
     end
 
     # Returns true if object_type == :document
+    # @api public
     def document?
       object_type == :document
     end
 
     # Returns true if this object is active (time_when is in objects time interval)
+    # @api public
     def active?(time_when = nil)
       return false if !valid_from
       time_then = time_when || Obj.preview_time
@@ -171,11 +188,13 @@ module RailsConnector
     # Returns true if this object has edited content.
     # Note that edited content is not available when Configuration.mode == :live
     # and edited? will always return false in this case.
+    # @api public
     def edited?
       (is_edited == 1)
     end
 
     # Returns true if this object has released content
+    # @api public
     def released?
       (is_released == 1)
     end
@@ -184,16 +203,19 @@ module RailsConnector
     # A suppressed Obj does not represent an entire web page, but only a part of a page
     # (for example a teaser) and will not be delivered by the rails application
     # as a standalone web page.
+    # @api public
     def suppressed?
       suppress_export == 1
     end
 
     # Returns true if the export of the object is not suppressed and the content is active?
+    # @api public
     def exportable?(current_time = nil)
       !suppressed? && active?(current_time)
     end
 
     # Returns the file name to which the Content.file_extension has been appended.
+    # @api public
     def filename
       extension = ".#{file_extension}" unless file_extension.blank?
       "#{name}#{extension}"
@@ -203,11 +225,13 @@ module RailsConnector
 
     # Returns an array with the names of groups that are permitted to access this Obj.
     # This corresponds to the cms permission "permissionLiveServerRead".
+    # @api public
     def permitted_groups
       attr_dict.permitted_groups
     end
 
     # Returns true if this object is the root object.
+    # @api public
     def root?
       parent_obj_id.nil?
     end
@@ -217,6 +241,7 @@ module RailsConnector
 
     # Returns a list of exportable? children excluding the binary? ones unless :all is specfied.
     # This is mainly used for navigations.
+    # @api public
     def toclist(*args)
       return [] unless publication?
       time = args.detect {|value| value.kind_of? Time}
@@ -226,6 +251,7 @@ module RailsConnector
     end
 
     # Returns the sorted +toclist+, respecting sort order and type of this Obj.
+    # @api public
     def sorted_toclist(*args)
       list = self.toclist(*args)
       return [] if list.blank?
@@ -257,19 +283,20 @@ module RailsConnector
       return self.sort_order == "descending" ? sorted_list.reverse : sorted_list
     end
 
-    def sort_key1 # :nodoc:
+    def sort_key1
       self[:sort_key1]
     end
 
-    def sort_key2 # :nodoc:
+    def sort_key2
       self[:sort_key2]
     end
 
-    def sort_key3 # :nodoc:
+    def sort_key3
       self[:sort_key3]
     end
 
     # Returns an Array of all the ancestor objects, starting at the root and ending at this object's parent.
+    # @api public
     def ancestors
       if parent
         parent.ancestors + [parent]
@@ -280,6 +307,7 @@ module RailsConnector
 
     # Returns the Object with the given name next in the hierarchy
     # returns nil if no object with the given name was found.
+    # @api public
     def find_nearest(name)
       obj = self.children.find_by_name(name)
       return obj if obj and obj.active?
@@ -289,6 +317,7 @@ module RailsConnector
     # Returns the value of the attribute specified by its name.
     #
     # Passing an invalid key will not raise an error, but return nil.
+    # @api public
     def [](key)
       # convenience access to name
       return name if key.to_sym == :name
@@ -313,6 +342,7 @@ module RailsConnector
     end
 
     # Reloads the attributes of this object from the database, invalidates custom attributes
+    # @api public
     def reload
       super
       @attr_dict = nil
@@ -329,12 +359,14 @@ module RailsConnector
 
     # object_class is a legacy alias to name. Please use obj_class instead, because only obj_class
     # works with ActiveRecord's dynamic finder methods like find_by_obj_class(...)
+    # @api public
     def object_class
       obj_class
     end
 
     # for binary Objs body_length equals the file size
     # for non-binary Objs body_length equals the number of characters in the body (main content)
+    # @api public
     def body_length
       attr_dict.body_length
     end
@@ -352,28 +384,29 @@ module RailsConnector
     #
     # Note also that the url will be used regardless of the Obj's permissions, so be careful not
     # to provide urls that contain unprotected secrets.
+    # @api public
     def body_data_url
       nil
     end
 
-    def set_attr_values(dictionary) # :nodoc:
+    def set_attr_values(dictionary)
       @attr_values = dictionary
       @attr_dict = nil
     end
 
     # Returns an instance of AttrDict which provides access to formatted attribute values (i.e. content).
     # The method uses attr_defs to determine the right formatting depending on the particular field type.
-    def attr_dict # :nodoc:
+    def attr_dict
       @attr_dict ||= AttrDict.new(self, attr_values, attr_defs)
     end
 
     # Returns a nested hash of attribute values.
-    def attr_values # :nodoc:
+    def attr_values
       @attr_values ||= fetch_attr_values
     end
 
     # Returns a nested hash of attribute definitions.
-    def attr_defs # :nodoc:
+    def attr_defs
       @attr_defs ||= JSON.parse(read_attribute(:attr_defs) || "{}")
     end
 
@@ -385,8 +418,7 @@ module RailsConnector
     # constituting a path through the nested (hash) structures of the attribute definition (attr_defs).
     #
     # If the path doesn't fit the metadata structure, the method returns nil and doesn't raise an exception.
-    #
-    def metadata_for_field(field, *args) # :nodoc:
+    def metadata_for_field(field, *args)
       rslt = fiona_fields[field.to_s] || attr_defs[field.to_s]
       args.each do |key|
         rslt = rslt[key.to_s] unless rslt.nil?
@@ -394,14 +426,17 @@ module RailsConnector
       rslt
     end
 
+    # @api public
     def last_changed
       self[:last_changed]
     end
 
+    # @api public
     def valid_from
       self[:valid_from]
     end
 
+    # @api public
     def valid_until
       self[:valid_until]
     end
@@ -413,15 +448,16 @@ module RailsConnector
     end
 
     # Returns the MIME-type as determined from the file_extension - see MIME::Types
+    # @api public
     def mime_type
       @mime_type ||= compute_mime_type
     end
 
-    def to_liquid # :nodoc:
+    def to_liquid
       LiquidSupport::ObjDrop.new(self)
     end
 
-    def respond_to?(method_id, include_private=false) # :nodoc:
+    def respond_to?(method_id, include_private=false)
       if super
         true
       elsif %w(_attr_dict _attr_defs _attr_values).include?(method_id.to_s)
@@ -433,11 +469,11 @@ module RailsConnector
       end
     end
 
-    def self.preview_time=(t) # :nodoc:
+    def self.preview_time=(t)
       Thread.current[:preview_time] = t
     end
 
-    def self.preview_time # :nodoc:
+    def self.preview_time
       Thread.current[:preview_time] || Time.now
     end
 

data/lib/rails_connector/ses/verity_accessor.rb

@@ -4,7 +4,7 @@ module RailsConnector
 
   module SES
 
-    class VerityAccessor # :nodoc:
+    class VerityAccessor
       require 'net/http'
       require 'uri'
       require "rexml/document"

data/lib/rails_connector/verity_search_request.rb

@@ -2,6 +2,7 @@ module RailsConnector
 
   # This class provides an implementation for accessing the Verity based search server.
   # It should be customized by subclassing.
+  # @api public
   class VeritySearchRequest
     attr_reader :query_string
 
@@ -21,6 +22,7 @@ module RailsConnector
     # <tt>:sort_order</tt>:: The sort order of the hits, a list of key-value pairs, each consisting of the sortkey and the sort direction ("asc"=ascending, "desc"=descending), default: <tt>[["score", "desc"], ["name", "asc"]]</tt>
     # <tt>:collections</tt>:: The collections to be searched, default: <tt>['cm-contents']</tt>
     # <tt>:base_query</tt>:: The VQL base query, default: <tt>nil</tt>
+    # @api public
     def initialize(query_string, options=nil)
       @query_string = self.class.sanitize(query_string)
       @options = Configuration.search_options.merge(options || {})
@@ -29,12 +31,13 @@ module RailsConnector
     # Accesses the SES and fetches search hits.
     #
     # Uses the #base_query and +options+ given in #new.
+    # @api public
     def fetch_hits
       SES::VerityAccessor.new(vql_query_for(@query_string), {:base_query => base_query}.merge(@options)).search
     end
 
     # Removes unwanted characters from +text+.
-    def self.sanitize(text) #:nodoc:
+    def self.sanitize(text)
       text.strip.gsub(/[<>"'´`,()\[\]{}=!@\\]/, '')
     end
 
@@ -63,6 +66,7 @@ module RailsConnector
     #       super.merge(:content => '("edited" <#IN> state)'
     #     end
     #   end
+    # @api public
     def base_query_conditions
       conditions = {}
       conditions[:objTypes] = '<#ANY> (
@@ -81,4 +85,4 @@ module RailsConnector
     end
   end
 
-end
+end

data/lib/rating.rb

@@ -1,2 +1,5 @@
+# The Rating model inherits all of its behavior from
+# {RailsConnector::DefaultRating}.
+# @api public
 class Rating < RailsConnector::DefaultRating
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: infopark_fiona_connector
 version: !ruby/object:Gem::Version 
-  hash: -712075784
+  hash: 695044912
   prerelease: 10
   segments: 
   - 6
   - 8
   - 0
-  - 210
-  - ed
-  - 204
-  - b
-  - 0
-  version: 6.8.0.210.ed204b0
+  - 322
+  - c
+  - 3
+  - f
+  - 11
+  version: 6.8.0.322.c003f11
 platform: ruby
 authors: 
 - Infopark AG
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-06 00:00:00 +01:00
+date: 2012-11-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,9 +76,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
+- .yardopts
+- README
 - app/helpers/rails_connector/marker_helper.rb
 - lib/comment.rb
 - lib/infopark_fiona_connector.rb
@@ -107,18 +109,13 @@ files:
 - lib/rails_connector/ses/verity_accessor.rb
 - lib/rails_connector/verity_search_request.rb
 - lib/rating.rb
-- README
-has_rdoc: true
+has_rdoc: yard
 homepage: http://www.infopark.de
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-- --title
-- Infopark Fiona Connector
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement