infopark_rails_connector 6.8.0.beta.200.621.4c8e1b0

data/lib/rails_connector/liquid_support/obj_filters.rb

@@ -0,0 +1,77 @@
+module RailsConnector::LiquidSupport #:nodoc:
+
+  # Filters in general are methods used in Liquid templates.
+  # ObjFilters are filters specifically for dealing with CMS objects.
+  module ObjFilters
+
+    # Generates a link for the +target+.
+    # +target+ can be an Obj, a Link or a Linklist.
+    # If +target+ is a Linklist, the first element of the list will be used.
+    #
+    # Example:
+    #   {{ "Click me" | link_to: obj }}
+    #
+    def link_to(a, b = nil)
+      if b
+        title = a || ""
+        target =  b
+      else
+        target = a
+      end
+      target = first_link_if_linklist(target)
+      if target
+        action_view.link_to(title || target.display_title, drop_cms_path(target))
+      end
+    end
+
+    # Generates an IMG tag for +target+.
+    # +target+ can be an Obj, a Link or a Linklist.
+    # If +target+ is a Linklist, the first element of the list will be used.
+    #
+    # Example:
+    #   {{ @obj | image_tag }}
+    def image_tag(target, title = nil)
+      action_view.cms_image_tag(unwrap_drop(target), :alt => title)
+    end
+
+    # Generates the URL where +target+ can be reached.
+    # +target+ can be an Obj, a Link or a Linklist.
+    # If +target+ is a Linklist, the first element of the list will be used.
+    #
+    # Example:
+    #   This document can be found at {{ obj | url }}
+    def url(target)
+      target = first_link_if_linklist(target)
+      drop_cms_path(target) if target
+    end
+
+    # Generates an editmarker for +field_value_drop+
+    def editmarker(field_value_drop, visible=true)
+      drop = field_value_drop.dup
+      drop.__marker = visible
+      drop
+    end
+
+  private
+
+    def drop_cms_path(possible_drop)
+      action_view.cms_path(unwrap_drop(possible_drop))
+    end
+
+    def unwrap_drop(possible_drop)
+      possible_drop.respond_to?(:__drop_content) ? possible_drop.__drop_content : possible_drop
+    end
+
+    def action_view
+      @context.registers[:action_view]
+    end
+
+    def first_link_if_linklist(target)
+      return target if target.is_a?(LinkDrop) || target.is_a?(ObjDrop)
+      if target.respond_to?(:first)
+        first_element = target.first.to_liquid
+        return first_element if first_element.is_a?(LinkDrop)
+      end
+    end
+  end
+end

data/lib/rails_connector/liquid_support.rb

@@ -0,0 +1,23 @@
+require 'liquid'
+
+# A collection of modules and classes needed to enable Liquid templates with Rails Connector
+
+module RailsConnector::LiquidSupport
+
+  # Helpers can be made available in Liquid templates by enabling them in the
+  # app initialization like this:
+  #
+  #    RailsConnector::LiquidSupport.enable_helpers(
+  #       :helper_a,
+  #       :helper_b
+  #     )
+  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
+  mattr_accessor :raise_template_errors
+
+end

data/lib/rails_connector/markdown_string.rb

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

data/lib/rails_connector/rateable.rb

@@ -0,0 +1,57 @@
+module RailsConnector
+  #
+  # 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.
+    def ratings
+      Rating.where(:obj_id => id)
+    end
+
+    # Creates/updates the rating for a CMS object.
+    def rate(score)
+      rating = ratings.find_by_score(score) || ratings.build(:score => score)
+      rating.count += 1
+      rating.save
+    end
+
+    # Returns a count for the particular score for a CMS object.
+    def count_for_score(score)
+      rating = ratings.find_by_score(score)
+      rating ? rating.count : 0
+    end
+
+    # Determines if a CMS object has already been rated.
+    def rated?
+      !ratings.empty?
+    end
+
+    # Calculates the average rating for a CMS object.
+    def average_rating
+      raise TypeError unless rated?
+      sum, count = ratings.inject([0, 0]) do |(sum, count), rating|
+        [sum + rating.score * rating.count, count + rating.count]
+      end
+      sum.to_f / count.to_f
+    end
+
+    # Calculates the average rating for a CMS object in per cent.
+    def average_rating_in_percent
+      if rated?
+        (100 * average_rating / Rating::MAXIMUM).to_i
+      else
+        0
+      end
+    end
+
+    # Resets the ratings for a CMS object.
+    def reset_rating
+      ratings.destroy_all
+    end
+
+    # Redefine this method in your application's <tt>obj_extensions.rb</tt> in order to define conditions for allowing a CMS object to be rated.
+    def allow_rating?; true; end
+    # Redefine this method in your application's <tt>obj_extensions.rb</tt> in order to define conditions for allowing a CMS object to be rated anonymously.
+    def allow_anonymous_rating?; true; end
+  end
+end

data/lib/rails_connector/seo.rb

@@ -0,0 +1,52 @@
+module RailsConnector
+  # Search Engine Optimization methods
+  module SEO
+
+    # The methods contained herein are attached to the Obj model class.
+    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.
+      def find_all_for_sitemap
+        start = Obj.homepage
+        children = start.toclist
+        grandchildren = children.map(&:toclist).flatten
+
+        ([start] + children + grandchildren).select(&:included_in_seo_sitemap?)
+      end
+    end
+
+    # The methods contained herein are included in the Obj model.
+    module InstanceMethods
+
+      # Returns +true+ by default. Overwrite in your +ObjExtensions+ as you like.
+      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.
+      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.
+      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.
+      # For example, point to a CMS field of your objects.
+      def seo_keywords
+        nil
+      end
+    end
+
+    def self.included(receiver) # :nodoc:
+      receiver.extend ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+
+  end
+end

data/lib/rails_connector/ses.rb

@@ -0,0 +1,72 @@
+module RailsConnector
+
+  # This module accesses the Infopark Search Engine Server.
+  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:
+      ::Obj.extend Obj::ClassMethods
+    end
+
+    module Obj #:nodoc:
+      # Extends the model class Obj with the class method find_with_ses.
+      module ClassMethods
+        # Queries the search engine and returns a SearchResult. The parameters
+        # are passed on to a SearchRequest (a kind of DefaultSearchRequest by default).
+        #
+        # Exceptions:
+        # * SearchError - The search engine reported an error.
+        #
+        def find_with_ses(query_string, options = {})
+          SearchRequest.new(query_string, options).fetch_hits
+        end
+      end
+    end
+
+    class SearchError < StandardError # :nodoc:
+    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.
+    class SearchResult < Array
+      # The total number of hits.
+      attr_reader :total_hits
+
+      def initialize(total_hits) # :nodoc:
+        super()
+        @total_hits = total_hits
+      end
+    end
+
+    # A hit represents a found document for a particular search query.
+    class Hit
+      # The ID of the found Obj.
+      attr_reader :id
+
+      # The score of the hit.
+      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.
+      attr_reader :doc
+
+      def initialize(id, score, doc={}) # :nodoc:
+        @id = id
+        @score = score
+        @doc = doc
+      end
+
+      # Returns the hit's corresponding Obj (or nil if none found in the database).
+      def obj
+        @obj ||= ::Obj.find(@id)
+      rescue RailsConnector::ResourceNotFound
+        nil
+      end
+    end
+  end
+
+end

data/lib/rails_connector/string_tagging.rb

@@ -0,0 +1,29 @@
+module RailsConnector
+
+  # adds flavour to strings
+  module StringTagging #:nodoc: all
+
+    # html flavour
+    def self.tag_as_html(string, source)
+      unless string.blank?
+        class << string
+          include RailsConnector::HtmlString
+        end
+        string.source = source
+      end
+      string
+    end
+
+    # markdown flavour
+    def self.tag_as_markdown(string, source)
+      unless string.blank?
+        class << string
+          include RailsConnector::MarkdownString
+        end
+        string.source = source
+      end
+      string
+    end
+  end
+
+end

data/lib/rails_connector/syndicateable.rb

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

data/lib/search_request.rb

@@ -0,0 +1,2 @@
+class SearchRequest < RailsConnector::DefaultSearchRequest
+end

data/lib/tasks/check.rake

@@ -0,0 +1,25 @@
+namespace :db do
+
+  namespace :cms do
+
+    desc "Checks if the infopark CMS object classes are valid ruby class names"
+    task :check_obj_classes => :environment do
+      all_obj_classes = Obj.select("distinct(obj_class)").collect(&:obj_class)
+      invalid_names = all_obj_classes.reject { |obj_class|
+        begin
+          obj_class.constantize
+        rescue NameError => e
+          e.message !~ /not a valid constant name/
+        end
+      }
+      if invalid_names.empty?
+        puts "\nAll object class names are valid Ruby class names."
+      else
+        puts "\nThe following object class names are invalid Ruby class names:"
+        y invalid_names
+      end
+    end
+
+  end
+
+end

data/lib/tasks/cms_license_check.rake

@@ -0,0 +1,17 @@
+namespace :cms do
+  namespace :license do
+    desc "Check if a license file is valid (options: FILE=/path/to/license.xml, default: currently installed license)"
+    task :check => :environment do
+      RailsConnector::Configuration.license_file = ENV['FILE']
+      puts "Checking license #{RailsConnector::Configuration.license_file}"
+      begin
+        Obj.root.fetch_attr_values
+        puts "OK, license is valid."
+        exit 0
+      rescue RailsConnector::InvalidLicenseError => e
+        puts e
+        exit 1
+      end
+    end
+  end
+end