infopark_fiona_connector 6.9.4 → 7.0.1.5.2.3.rc4

data/lib/rails_connector/cms_base_model.rb

@@ -25,6 +25,15 @@ module RailsConnector
       true
     end
 
+    # FIXME: Find a more stable solution for this
+    #
+    # Since ActiveRecord 4.2 finding Objs by name is no longer consistent when
+    # switching between edited and released content at runtime. As long as we
+    # find a better solution this mitigates the behaviour.
+    def self.find_by(arg, *args)
+      where(arg, *args).take
+    end
+
     def readonly?
       true
     end

data/lib/rails_connector/cms_dispatch_controller.rb

@@ -0,0 +1,46 @@
+module RailsConnector
+
+  class CmsDispatchController < ActionController::Metal
+    def process(action)
+      CmsEnv.new(request.env).load
+      controller = target_controller(request.env)
+      request.env["action_dispatch.request.path_parameters"][:controller] = controller.controller_path
+
+      if !obj_not_found? && action == 'index'
+        action = loaded_obj.controller_action_name
+      end
+
+      request.env["action_dispatch.request.path_parameters"][:action] = action
+
+      self.response = controller.action(action).call(request.env)
+    end
+
+    private
+
+    def target_controller(env)
+      return default_controller if obj_not_found?
+      controller = "#{loaded_obj.controller_name}Controller".constantize
+
+      if controller.respond_to?(:use_for_obj_dispatch?) && controller.use_for_obj_dispatch?
+        controller
+      else
+        default_controller
+      end
+    rescue NameError
+      default_controller
+    end
+
+    def loaded_obj
+      request.env[CmsEnv::OBJ_ENV_KEY]
+    end
+
+    def obj_not_found?
+      loaded_obj.is_a?(StandardError)
+    end
+
+    def default_controller
+      CmsController
+    end
+  end
+
+end

data/lib/rails_connector/cms_env.rb

@@ -0,0 +1,68 @@
+module RailsConnector
+
+  class CmsEnv
+
+    OBJ_ENV_KEY = "INFOPARK_OBJ"
+
+    def initialize(env)
+      @env = env
+    end
+
+    def load
+      return if env[OBJ_ENV_KEY]
+      load_object
+    end
+
+    protected
+
+    attr_reader :env
+
+    def load_object
+      env[OBJ_ENV_KEY] =
+        begin
+          find_obj
+        rescue StandardError => e
+          e
+        end
+    end
+
+    def find_obj
+      found_obj =
+        if params[:id]
+          Obj.find(params[:id])
+        elsif params[:permalink].present?
+          self.class.find_permalink_by_param(params[:permalink])
+        else
+          if callback = RailsConnector::Configuration.choose_homepage_callback
+            callback_result = callback.call(env)
+            if callback_result.is_a?(Obj)
+              callback_result
+            else
+              raise "choose_homepage callback did not return an Obj. "\
+                "Instead saw #{callback_result.class}."
+            end
+          else
+            Obj.homepage
+          end
+        end
+
+      if found_obj.suppressed?
+        raise RailsConnector::ResourceNotFound,
+          "Tried to access Obj #{found_obj.inspect}, but it is suppressed (suppress_export is set)!"
+      end
+
+      found_obj
+    end
+
+    def params
+      env["action_dispatch.request.path_parameters"]
+    end
+
+    def self.find_permalink_by_param(permalink_param)
+      permalink =  Array(permalink_param).join("/")
+      Obj.find_by_permalink!(permalink)
+    end
+
+  end
+
+end

data/lib/rails_connector/cms_test_request.rb

@@ -0,0 +1,8 @@
+module RailsConnector
+  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
+    end
+  end
+end

data/lib/rails_connector/configuration.rb

@@ -77,6 +77,8 @@ module RailsConnector
       end
 
       def to_prepare
+        BasicObj.reset_reflections
+
         unless Rails.configuration.cache_classes
           after_initialize
           NamedLink.reset_cache
@@ -86,7 +88,7 @@ module RailsConnector
       end
 
       def configure_cms_database
-        RailsConnector::CmsBaseModel.configure_database('cms')
+        RailsConnector::CmsBaseModel.configure_database(:cms)
       end
 
       attr_accessor :choose_homepage_callback

data/lib/rails_connector/content.rb

@@ -0,0 +1,11 @@
+module RailsConnector
+
+  # This class allows us to read out the editor of an Obj,
+  # if it has edited content
+  class Content < CmsBaseModel
+
+    self.primary_key = :content_id
+
+  end
+
+end

data/lib/rails_connector/core_extensions.rb

@@ -0,0 +1 @@
+require "rails_connector/core_extensions/time"

data/lib/rails_connector/core_extensions/time.rb

@@ -0,0 +1,18 @@
+class Time
+
+  # Returns a new Time created from the ISO date format String "YYYYMMDDhhmmss"
+  def self.from_iso(t)
+    return nil unless t
+    if t.to_s =~ /^(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/
+      utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i)
+    else
+      raise ArgumentError, "invalid iso time format: #{t}"
+    end
+  end
+
+  # Returns the Time as ISO date format String "YYYYMMDDhhmmss"
+  def to_iso
+    getutc.strftime('%Y%m%d%H%M%S')
+  end
+
+end

data/lib/rails_connector/date_attribute.rb

@@ -25,4 +25,4 @@ module RailsConnector
     end
   end
 
-end
+end

data/lib/rails_connector/engine.rb

@@ -0,0 +1,68 @@
+require 'rails'
+require 'active_record/railtie'
+require 'action_view'
+
+require 'jquery-rails'
+
+require 'rails_connector/configuration'
+
+module ::RailsConnector
+  class Engine < Rails::Engine
+    config.to_prepare { RailsConnector::Configuration.to_prepare }
+    config.after_initialize { RailsConnector::Configuration.after_initialize }
+
+    # make sure our exceptions cause an adequate error page and http status code
+    config.action_dispatch.rescue_responses.merge!("RailsConnector::ResourceNotFound" => :not_found)
+
+    initializer 'rails_connector.add_fiona_time_type' do
+      ActiveRecord::Type.register(:fiona_datetime, ::FionaDateTime)
+    end
+
+    initializer "rails_connector.add_cms_routing_paths", :after => :add_routing_paths do |app|
+      cms_route = File.expand_path("cms_routes.rb", paths['config'].to_a.first)
+      app.routes_reloader.paths.push(cms_route)
+    end
+
+    initializer "rails_connector.add_assets" do |app|
+      app.config.assets.precompile += %w[
+        editmarker.css editmarker.js
+      ]
+    end
+
+    # Expose rails connector runtime to controller for logging.
+    initializer "rails_connector.log_runtime" do |app|
+      runtime =
+        begin
+          RailsConnector::ControllerRuntime
+        rescue NameError
+          nil
+        end
+
+      if runtime
+        RailsConnector::LogSubscriber.attach_to :rails_connector
+        ActiveSupport.on_load(:action_controller) do
+          include runtime
+        end
+      end
+    end
+
+    initializer "rails_connector.configure_database", :before => :load_config_initializers do |app|
+      RailsConnector::Configuration.configure_cms_database
+    end
+
+    initializer "rails_connector.routing_helpers" do
+      if Rails.env == 'test'
+        ActionDispatch::TestRequest.__send__(:include, RailsConnector::CmsTestRequest)
+      end
+
+      ActionController::Base.__send__(:include, CmsRoutingHelper)
+      ActionView::Base.__send__(:include, CmsRoutingHelper)
+    end
+
+
+    config.autoload_paths += paths['lib'].to_a
+    config.autoload_once_paths += paths['lib'].to_a
+
+    RailsConnector.rack_middlewares.each { |middleware| config.app_middleware.use middleware }
+  end
+end

data/lib/rails_connector/fiona_datetime.rb

@@ -0,0 +1,14 @@
+require 'active_record/type'
+class FionaDateTime < ActiveRecord::Type::Time
+  def type
+    :fiona_datetime
+  end
+
+  def serialize(value)
+    value.to_iso if value
+  end
+
+  def deserialize(value)
+    Time.from_iso(value).in_time_zone if value
+  end
+end

data/lib/rails_connector/html_string.rb

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

data/lib/rails_connector/job.rb

@@ -0,0 +1,13 @@
+module RailsConnector
+
+  # This class allows us to read out basic information about jobs
+  class Job < CmsBaseModel
+
+    self.primary_key = "job_id"
+
+    def self.table_name
+      "#{table_name_prefix}" "jobs"
+    end
+  end
+
+end

data/lib/rails_connector/link_list.rb

@@ -0,0 +1,32 @@
+module RailsConnector
+
+  # @api public
+  class LinkList < Array
+
+    def initialize(link_definitions)
+      if link_definitions.blank?
+        super([])
+      else
+        super(build_links(link_definitions.map(&:symbolize_keys)))
+      end
+    end
+
+    # @api public
+    def destination_objects
+      self.map {|link| link.destination_object}.compact
+    end
+
+    private
+
+    def build_links(link_definitions)
+      object_ids = link_definitions.map { |link_data| link_data[:destination] }.compact.uniq
+      objects = object_ids.empty? ? [] : Obj.find(object_ids)
+      link_definitions.each_with_object([]) do |link_data, links|
+        link = Link.new(link_data, objects.detect { |o| o && o.id == link_data[:destination] })
+        links << link if link.active?
+      end
+    end
+
+  end
+
+end

data/lib/rails_connector/link_resolvable.rb

@@ -0,0 +1,9 @@
+module RailsConnector
+
+  module LinkResolvable
+    attr_accessor :source
+
+  end
+
+
+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
+    include LinkResolvable
+    # Returns whether the String contains Markdown (default to true, overrides String.markdown?).
+    def markdown?
+      true
+    end
+  end
+
+end
+
+class String
+  # Returns whether the String contains Markdown (default to false).
+  def markdown?
+    false
+  end
+end

data/lib/rails_connector/meta.rb

@@ -0,0 +1,148 @@
+module RailsConnector
+
+  module Meta
+
+    # This method is an equivalent of Rails.logger.silence, which has been deprecated
+    def self.hello_im_rails_and_im_retarted_so_please_be_patient(&block)
+      begin
+        old_logger_level, Rails.logger.level = Rails.logger.level, Logger::ERROR
+        yield self
+      ensure
+        Rails.logger.level = old_logger_level
+      end
+    end
+
+    def self.included(base) #:nodoc:
+      #  Class enhancements
+      base.extend(ClassMethods)
+    end
+
+    # The RailsConnector::ObjClass object for this file format.
+    # This will always return a proper object, even if no custom
+    # Ruby class exists.
+    def obj_class_definition
+      @obj_class_definition ||= RailsConnector::Meta::EagerLoader.instance.obj_class(self.obj_class)
+    end
+    alias_method :obj_class_def, :obj_class_definition
+
+    # Returns true, if there is a custom Ruby class defined for the object
+    # or false, if it is represented by RailsConnector::Obj
+    def has_custom_ruby_class?
+      self.class.is_custom_ruby_class?
+    end
+
+    # Returns the custom attributes in the form of a Hash.
+    def custom_attributes
+      self.obj_class_definition.custom_attributes
+    end
+
+    # Returns true, if the file format has an attribute of the given name.
+    def custom_attribute?(attr)
+      self.obj_class_definition.custom_attribute?(attr)
+    end
+
+    # Returns an Array of String of all mandatory attributes, no mather if it's
+    # custom or built-in. Built-in attributes are underscored (valid_from,
+    # not validFrom).
+    # Possible +options+ are:
+    # <tt>:only_custom_attributes</tt>:: Return only custom attributes, omit
+    # built-in attributes like content_type or valid_from.
+    def mandatory_attribute_names(options = {})
+      self.obj_class_definition.mandatory_attribute_names(options)
+    end
+
+    # Returns true, if the file format has an mandatory attribute of the given name.
+    def mandatory_attribute?(attr)
+      self.obj_class_definition.mandatory_attribute?(attr)
+    end
+
+    # Returns the version of this object. This number is increased every time
+    # this object is released.
+    def version
+      load_meta_details
+      @object_with_meta_data.version.presence.to_i || 0
+    end
+
+    # Returns the time of the reminder, if it is set.
+    def reminder_from
+      load_meta_details
+      @object_with_meta_data.reminder_from.presence &&
+          ::ActiveModel::Type::DateTime.new.deserialize(@object_with_meta_data.reminder_from)
+    end
+
+    # Returns the reminder comment, if a reminder is set.
+    def reminder_comment
+      load_meta_details
+      @object_with_meta_data.reminder_comment
+    end
+
+    # Return the name of the workflow, that is assigned to this object.
+    def workflow_name
+      load_meta_details
+      @object_with_meta_data.workflow_name
+    end
+
+    # Return the current editor as a String. If there is no edited content,
+    # which is always the case in live mode, an empty String is returned.
+    # The 'contents' table is queried for this information.
+    def editor
+      return @editor if @editor
+
+      load_meta_details
+
+      content_id = if self.edited?
+        @object_with_meta_data.edited_content_id
+      else
+        @object_with_meta_data.released_cont_id
+      end
+
+      if content_id
+        content = RailsConnector::Content.find(content_id)
+        @editor = content.editor
+      else
+        @editor = ''
+      end
+    end
+
+    def committed?
+      load_meta_details
+      !@object_with_meta_data.committed_cont_id.nil?
+    end
+
+    private
+
+    # Load the objects details from the `objects' tables.
+    def load_meta_details #:nodoc:
+      return if @object_with_meta_data
+
+      @object_with_meta_data = RailsConnector::ObjectWithMetaData.find(self.id)
+
+      # reset depending instance variables
+      @editor = nil
+    end
+
+
+    # the methods in this module will become class methods
+    module ClassMethods
+
+      # The RailsConnector::ObjClass object for this file format.
+      # This will only return a proper object if a custom Ruby class exists
+      # and will throw a RuntimeError otherwise.
+      def obj_class_definition
+        raise "Obtaining the obj_class_definition of an Obj without custom Ruby class " \
+                  "is logically impossible." unless is_custom_ruby_class?
+        @obj_class_definition ||= RailsConnector::Meta::EagerLoader.instance.obj_class(self.name)
+      end
+      alias_method :obj_class_def, :obj_class_definition
+
+      # RailsConnector::AbstractObj returns false, everything else true.
+      # TODO: RailsConnector::AbstractObj does not exist here
+      def is_custom_ruby_class?
+        self != RailsConnector::BasicObj
+      end
+
+    end
+
+  end
+
+end