infopark_rails_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/lib/rails_connector/liquid_support/liquid_template_handler.rb

@@ -1,6 +1,6 @@
 module RailsConnector::LiquidSupport
 
-  module FieldValueDropPatcher #:nodoc:
+  module FieldValueDropPatcher
     def self.patch(mod)
       mod.module_eval do
         return if method_defined?(:field_value_drop_patched)
@@ -33,9 +33,9 @@ module RailsConnector::LiquidSupport
   # Example:
   #    {% template 'name-of-partial' %}
   class TemplateTag < Liquid::Tag
-    Syntax = /(#{Liquid::QuotedFragment}+)/ #:nodoc:
+    Syntax = /(#{Liquid::QuotedFragment}+)/
 
-    def initialize(tag_name, markup, tokens) #:nodoc:
+    def initialize(tag_name, markup, tokens)
 
       if markup =~ Syntax
         @partial_name = $1
@@ -46,7 +46,7 @@ module RailsConnector::LiquidSupport
       super
     end
 
-    def render(context) #:nodoc:
+    def render(context)
       context.registers[:action_view].controller.__send__(
         :render_to_string, :partial => context[@partial_name]
       )
@@ -57,7 +57,7 @@ module RailsConnector::LiquidSupport
 
   # Das LiquidTemplateRepository kann Liquid-Templates anwenden.
   # Zunächst muss das Template kompiliert werden, danach kann es gerendert werden.
-  class LiquidTemplateRepository #:nodoc:
+  class LiquidTemplateRepository
 
     cattr_accessor :compiled_templates
     self.compiled_templates = {}
@@ -151,7 +151,7 @@ module RailsConnector::LiquidSupport
   # Der Grund ist, dass die Klassen, die in Rails als TemplateHandler registriert
   # sind von Rails eingefroren werden (mittels Object.freeze) und daher keine
   # Klassenvariablen haben können.
-  class LiquidTemplateHandler #:nodoc:
+  class LiquidTemplateHandler
     def self.call(template)
       template_id = LiquidTemplateRepository.compile(template)
       "#{LiquidTemplateRepository}.render('#{template_id}', self)"

data/lib/rails_connector/liquid_support/named_object_drop.rb

@@ -3,7 +3,7 @@ require "singleton"
 module RailsConnector::LiquidSupport
 
   # Dieser Drop realisiert den Zugriff auf Objekte, die per NamedLink referenziert werden
-  class NamedObjectDrop < Liquid::Drop #:nodoc:
+  class NamedObjectDrop < Liquid::Drop
     include Singleton
 
     def before_method(method)

data/lib/rails_connector/liquid_support/obj_drop.rb

@@ -1,7 +1,7 @@
 module RailsConnector::LiquidSupport
 
   # Dieser Drop kapselt ein Obj. Der Zugriff auf das Obj ist nur für [] und ausgewählte Methoden erlaubt.
-  class ObjDrop < Liquid::Drop #:nodoc:
+  class ObjDrop < Liquid::Drop
     def initialize(obj)
       @obj = obj
     end

data/lib/rails_connector/liquid_support/obj_filters.rb

@@ -1,4 +1,4 @@
-module RailsConnector::LiquidSupport #:nodoc:
+module RailsConnector::LiquidSupport
 
   # Filters in general are methods used in Liquid templates.
   # ObjFilters are filters specifically for dealing with CMS objects.

data/lib/rails_connector/liquid_support.rb

@@ -1,7 +1,7 @@
 require 'liquid'
 
 # A collection of modules and classes needed to enable Liquid templates with Rails Connector
-
+# @api public
 module RailsConnector::LiquidSupport
 
   # Helpers can be made available in Liquid templates by enabling them in the
@@ -11,13 +11,15 @@ module RailsConnector::LiquidSupport
   #       :helper_a,
   #       :helper_b
   #     )
+  # @api public
   def self.enable_helpers(*helpers)
     helpers.each do |helper|
       GeneralHelperTag << helper
     end
   end
 
-  # set to true if an error in a liquid template should lead to an 500 server error
+  # set to +true+ if an error in a liquid template should lead to an 500 server error
+  # @api public
   mattr_accessor :raise_template_errors
 
 end

data/lib/rails_connector/markdown_string.rb

@@ -1,7 +1,7 @@
 module RailsConnector
 
   # Include this module in order to tag the string as one with Markdown content
-  module MarkdownString #:nodoc:
+  module MarkdownString
     include LinkResolvable
     # Returns whether the String contains Markdown (default to true, overrides String.markdown?).
     def markdown?
@@ -11,7 +11,7 @@ module RailsConnector
 
 end
 
-class String #:nodoc:
+class String
   # Returns whether the String contains Markdown (default to false).
   def markdown?
     false

data/lib/rails_connector/rateable.rb

@@ -1,6 +1,6 @@
 module RailsConnector
   #
-  # This module provides a mixin for the CMS object model. It provides a +ratings+ association and well as several helper methods.
+  # This module provides a mixin for the CMS object model. It provides a {ratings} association and well as several helper methods.
   module Rateable
 
     # returns all Ratings for this Obj.

data/lib/rails_connector/seo.rb

@@ -1,12 +1,15 @@
 module RailsConnector
   # Search Engine Optimization methods
+  # @api public
   module SEO
 
     # The methods contained herein are attached to the Obj model class.
+    # @api public
     module ClassMethods
       # Finds all objects that shall be included in the SEO <tt>sitemap.xml</tt>.
-      # On each exportable none-image object, <tt>included_in_seo_sitemap?</tt> is called.
-      # Overwrite <tt>included_in_seo_sitemap?</tt> in your +ObjExtensions+ to adjust the criteria.
+      # On each exportable none-image object, {InstanceMethods#included_in_seo_sitemap?} is called.
+      # Overwrite <tt>included_in_seo_sitemap?</tt> in your {ObjExtensions} to adjust the criteria.
+      # @api public
       def find_all_for_sitemap
         start = Obj.homepage
         children = start.toclist
@@ -17,33 +20,38 @@ module RailsConnector
     end
 
     # The methods contained herein are included in the Obj model.
+    # @api public
     module InstanceMethods
 
-      # Returns +true+ by default. Overwrite in your +ObjExtensions+ as you like.
+      # Returns +true+ by default. Overwrite in your {ObjExtensions} as you like.
+      # @api public
       def readable_for_googlebots?
         true
       end
 
       # Default implementation: objects have to be <tt>active?</tt> and at least of one of: permitted for anyone (<tt>permitted_groups = []</tt>), <tt>readable_for_googlebots?</tt>.
-      # Overwrite in your +ObjExtensions+ as you like.
+      # Overwrite in your {ObjExtensions} as you like.
+      # @api public
       def included_in_seo_sitemap?
         (permitted_groups.empty? || readable_for_googlebots?) && active?
       end
 
       # Returns an html-stripped <tt>Obj#body</tt>, truncated to 300 chars.
-      # Overwrite in your +ObjExtensions+ as you like. For example, point to a CMS field.
+      # Overwrite in your {ObjExtensions} as you like. For example, point to a CMS field.
+      # @api public
       def seo_description
         HTML::FullSanitizer.new.sanitize(body.strip.gsub(%r{[\n|\r]}, " ")).mb_chars[0,300] if body
       end
 
-      # Returns +nil+ by default. Overwrite in your +ObjExtensions+ as you like.
+      # Returns +nil+ by default. Overwrite in your {ObjExtensions} as you like.
       # For example, point to a CMS field of your objects.
+      # @api public
       def seo_keywords
         nil
       end
     end
 
-    def self.included(receiver) # :nodoc:
+    def self.included(receiver)
       receiver.extend ClassMethods
       receiver.send :include, InstanceMethods
     end

data/lib/rails_connector/ses.rb

@@ -1,16 +1,17 @@
 module RailsConnector
 
   # This module accesses the Infopark Search Engine Server.
+  # @api public
   module SES
 
     autoload :VerityAccessor, "rails_connector/ses/verity_accessor"
 
     # This method enables Obj to perform searches using the SES Search Engine Server.
-    def self.enable #:nodoc:
+    def self.enable
       ::Obj.extend Obj::ClassMethods
     end
 
-    module Obj #:nodoc:
+    module Obj
       # Extends the model class Obj with the class method find_with_ses.
       module ClassMethods
         # Queries the search engine and returns a SearchResult. The parameters
@@ -25,42 +26,49 @@ module RailsConnector
       end
     end
 
-    class SearchError < StandardError # :nodoc:
+    class SearchError < StandardError
     end
 
     # SearchResult is the list of hits in response to a search query. Since the
     # maximum number of hits to return has been specified, there might be more
     # hits available in the search engine.
+    # @api public
     class SearchResult < Array
       # The total number of hits.
+      # @api public
       attr_reader :total_hits
 
-      def initialize(total_hits) # :nodoc:
+      def initialize(total_hits)
         super()
         @total_hits = total_hits
       end
     end
 
     # A hit represents a found document for a particular search query.
+    # @api public
     class Hit
       # The ID of the found Obj.
+      # @api public
       attr_reader :id
 
       # The score of the hit.
+      # @api public
       attr_reader :score
 
       # The raw result hash returned by the search engine, for a low-level access.
       # Don't use this unless you know what you're doing.
       # Be aware that this is not migration safe.
+      # @api public
       attr_reader :doc
 
-      def initialize(id, score, doc={}) # :nodoc:
+      def initialize(id, score, doc={})
         @id = id
         @score = score
         @doc = doc
       end
 
       # Returns the hit's corresponding Obj (or nil if none found in the database).
+      # @api public
       def obj
         @obj ||= ::Obj.find(@id)
       rescue RailsConnector::ResourceNotFound

data/lib/rails_connector/string_tagging.rb

@@ -1,7 +1,7 @@
 module RailsConnector
 
   # adds flavour to strings
-  module StringTagging #:nodoc: all
+  module StringTagging
 
     # html flavour
     def self.tag_as_html(string, source)

data/lib/rails_connector/syndicateable.rb

@@ -2,8 +2,10 @@ module RailsConnector
   # This module is included if the <tt>:rss</tt> addon is
   # enabled:
   #     RailsConnector::Configuration.enable(:rss)
+  # @api public
   module Syndicateable
-    # Overwrite this method in your +ObjExtensions+ in order to display another field in your feed.
+    # Overwrite this method in your {ObjExtensions} in order to display another field in your feed.
+    # @api public
     def rss_description
       body
     end

data/lib/search_request.rb

@@ -1,2 +1,3 @@
+# @api public
 class SearchRequest < RailsConnector::DefaultSearchRequest
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: infopark_rails_connector
 version: !ruby/object:Gem::Version 
-  hash: 93109800
+  hash: 448206178
   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 
@@ -206,57 +206,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- app/helpers/crm_form_helper.rb
-- app/helpers/user_helper.rb
-- app/helpers/cms_routing_helper.rb
-- app/helpers/cms_helper.rb
-- app/helpers/ratings_helper.rb
-- app/helpers/rails_connector/display_helper.rb
-- app/helpers/rails_connector/default_cms_helper.rb
-- app/helpers/rails_connector/time_machine_helper.rb
-- app/helpers/rails_connector/link_helper.rb
-- app/helpers/rails_connector/cms_asset_helper.rb
-- app/helpers/rails_connector/layout_helper.rb
-- app/helpers/rails_connector/default_user_helper.rb
-- app/helpers/rails_connector/table_of_contents_helper.rb
-- app/helpers/rails_connector/menu_helper.rb
-- app/helpers/rails_connector/seo_helper.rb
-- app/helpers/rails_connector/default_crm_form_helper.rb
-- app/helpers/rails_connector/default_ratings_helper.rb
-- app/helpers/rails_connector/micronav_helper.rb
-- app/helpers/rails_connector/tracking_helper.rb
-- app/helpers/rails_connector/error_messages_helper.rb
-- app/helpers/rails_connector/mandatory_label_helper.rb
-- app/helpers/rails_connector/default_cms_routing_helper.rb
-- app/controllers/rss_controller.rb
-- app/controllers/search_controller.rb
-- app/controllers/pdf_controller.rb
-- app/controllers/ratings_controller.rb
-- app/controllers/user_controller.rb
-- app/controllers/cms_controller.rb
-- app/controllers/seo_sitemap_controller.rb
-- app/controllers/rails_connector/default_rss_controller.rb
-- app/controllers/rails_connector/default_search_controller.rb
-- app/controllers/rails_connector/time_machine_controller.rb
-- app/controllers/rails_connector/default_comments_controller.rb
-- app/controllers/rails_connector/default_pdf_controller.rb
-- app/controllers/rails_connector/default_cms_controller.rb
-- app/controllers/rails_connector/pdf_external_controller.rb
-- app/controllers/rails_connector/default_crm_form_controller.rb
-- app/controllers/rails_connector/default_ratings_controller.rb
-- app/controllers/rails_connector/default_user_controller.rb
-- app/controllers/comments_controller.rb
-- app/controllers/crm_form_controller.rb
-- app/models/crm_form.rb
-- app/models/obj.rb
-- app/models/named_link.rb
-- app/models/rails_connector/default_comment.rb
-- app/models/rails_connector/default_rating.rb
-- app/models/rails_connector/link_list.rb
-- app/mailers/confirmation_mailer.rb
-- README
+extra_rdoc_files: []
+
 files: 
+- .yardopts
+- README
 - app/assets/images/admin/minus.gif
 - app/assets/images/bg80.png
 - app/assets/images/edit.png
@@ -438,18 +392,13 @@ files:
 - lib/search_request.rb
 - lib/tasks/check.rake
 - lib/tasks/cms_license_check.rake
-- README
-has_rdoc: true
+has_rdoc: yard
 homepage: http://www.infopark.de
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-- --title
-- Infopark Rails Connector
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement