infopark_fiona_connector 6.9.2.1.125136549 → 6.9.3.1.36404185

data/app/helpers/rails_connector/display_helper.rb

@@ -0,0 +1,126 @@
+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
+    # should be used to render an attribute <em>value</em> of a CMS model.
+    #
+    #   <%= 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-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
+        when HtmlString then convert_links(value).html_safe
+        when String then h(value)
+        when Time then h(l(value))
+        else value
+      end
+    end
+
+    def display_original_value(value)
+      case value
+        when HtmlString then convert_links(value, :ignore_body_data_url => true).html_safe
+        else display_value(value)
+      end
+    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.
+    #
+    # <%= display_field @obj, :title %>
+    #
+    # 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)
+        })
+      if options.delete :marker
+        edit_marker(obj, attr, options) do |obj, attr|
+          display_value obj[attr]
+        end
+      else
+        display_value obj[attr]
+      end
+    end
+
+    # Legacy method - deprecated
+    #
+    # Use display_value and display_field instead
+    def display(*args)
+      if args.last.kind_of? Hash
+        options = args.pop
+      else
+        options = {}
+      end
+      return display_value(args.first) if args.size == 1
+      display_field(args[0], args[1], options)
+    end
+
+    private
+
+    def markdown(string)
+      require 'maruku'
+      Maruku.new(string).to_html
+    end
+
+    LINK_PATTERN = '<?\binternallink:(\d+)\b>?'
+    LINK_EXPRESSION = %r(#{LINK_PATTERN})
+
+    def convert_links(content_attribute, cms_path_options = {})
+      return content_attribute unless content_attribute =~ LINK_EXPRESSION
+      link_map = content_attribute.source.text_links.each_with_object({}) do |link, map|
+        map[link.id.to_s] = link
+      end
+      content_attribute.gsub(%r(#{LINK_PATTERN}(['"]?))) do
+        link = link_map[$1.to_s]
+        if link.blank?
+          "#{CmsRoutingHelper::LINK_TO_UNREACHABLE}#{$2}"
+        else
+          uri = "#{cms_path(link, cms_path_options)}#{$2}"
+          if link.markdown?
+            markdown_link(link, uri)
+          else
+            html_link(link, uri)
+          end
+        end
+      end
+    end
+
+    def html_link(link, uri)
+      subst = uri
+      name, value =
+          case link.tag_name
+          when 'img', 'input'
+            ['alt', link.title || ""]
+          when 'a', 'link'
+            ['title', begin link.title unless link.title.blank? end]
+          end
+      if value
+        subst << %( #{name}="#{h(value)}")
+      end
+      subst << %( target="#{h(link.target)}") unless link.target.blank?
+      subst
+    end
+
+    def markdown_link(link, uri)
+      subst = "<#{uri}>"
+      unless link.title.blank?
+        case link.markdown_type
+        when 'inline', 'reference'
+          subst << %( "#{h(link.title)}")
+        end
+      end
+      subst
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module RailsConnector
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy Infopark Rails Connector files to your application."
+
+      # Normally, you'd just call 'source_root' as a class method from here,
+      # but we need to glob the dir ourselves. Hence our own method.
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+      def install_configuration
+        copy_file "initializers/rails_connector.rb", "config/initializers/rails_connector.rb"
+        template 'app/models/obj.rb.erb', 'app/models/obj.rb'
+        copy_file "local/configuration.rb", "config/local/configuration.rb"
+      end
+
+      def append_asset_manifests
+        append_file("app/assets/javascripts/application.js", "//= require infopark_rails_connector")
+        gsub_file("app/assets/stylesheets/application.css", "*= require_tree .",
+            "*= require_tree .\n *= require infopark_rails_connector")
+      end
+
+      def remove_public_index_html
+        remove_file "public/index.html"
+        remove_file "app/assets/images/rails.png"
+      end
+
+      def patch_default_application_layout
+        gsub_file("app/views/layouts/application.html.erb", %r{</head>},
+            "<%= rails_connector_header_tags %>\n</head>")
+        gsub_file("app/views/layouts/application.html.erb", %r{</body>},
+            "<%= rails_connector_after_content_tags %>\n</body>")
+      end
+    end
+  end
+end

data/lib/generators/rails_connector/install/templates/app/models/obj.rb.erb

@@ -0,0 +1,5 @@
+# This is the base class for accessing CMS objects.
+# See the documentation for details: http://rubydoc.info/gems/infopark_<%= RailsConnector.platform %>_connector/RailsConnector/BasicObj
+class Obj < RailsConnector::BasicObj
+  # Your custom code goes here...
+end

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

@@ -0,0 +1,2 @@
+# Name of the CMS Fiona Instance to access
+RailsConnector::Configuration.instance_name = 'default'

data/lib/generators/rails_connector/install/templates/local/configuration.rb

@@ -0,0 +1,2 @@
+# Put your local configuration here.
+# Don't forget to configure your SCM to ignore this file.

data/lib/rails_connector/configuration.rb

@@ -0,0 +1,176 @@
+require "helpful_configuration"
+require 'rails_connector/cms_base_model'
+require "rails_connector/blob"
+
+module RailsConnector
+
+  # @api public
+  class Configuration
+    # @api public
+    DEFAULT_MODE = :live
+
+    class << self
+
+      # there are three available modes for the rails connector:
+      # <tt>live</tt> (show released contents only),
+      # <tt>preview</tt> (show edited contents)
+      # <tt>editor</tt> (show edited contents and editor interface (e.g. edit markers))
+      # Default mode is <tt>live</tt>.
+      # @api public
+      attr_accessor :mode
+
+      # default options for {SearchRequest}
+      # @api public
+      attr_writer :search_options
+
+      # default options for {SearchRequest}
+      # @api public
+      def search_options
+        @search_options || local_config_file["search"].symbolize_keys
+      end
+
+      # define a non-default blob cache dir.
+      # +fiona connector+ only. has no effect when used with the +cloud connector+.
+      # @api public
+      attr_accessor :blob_cache_dir
+
+      # @api public
+      def mode=(new_mode)
+        new_mode = new_mode.to_sym
+        raise ArgumentError, "Unknown Mode #{new_mode}" unless [:editor, :preview, :live].include?(new_mode)
+        @mode = new_mode
+      end
+
+      # there are three available modes for the rails connector:
+      # <tt>live</tt> (show released contents only),
+      # <tt>preview</tt> (show edited contents)
+      # <tt>editor</tt> (show edited contents and editor interface (e.g. edit markers))
+      # Default mode is <tt>live</tt>.
+      # @api public
+      def mode
+        @mode || DEFAULT_MODE
+      end
+
+      def editor_interface_enabled?
+        mode == :editor
+      end
+
+      def use_edited_content?
+        mode == :preview || mode == :editor
+      end
+
+      # Configures your CMS instance name.
+      #
+      # Example call as to be used in <tt>rails_connector.rb</tt>:
+      #   RailsConnector::Configuration.instance_name = 'internet'
+      # @api public
+      def instance_name=(name)
+        RailsConnector::CmsBaseModel.instance_name = name if RailsConnector.platform_fiona?
+      end
+
+      def after_initialize
+        enable_ses
+        enable_authentication
+        ::RailsConnector::BasicObj.configure_for_content(
+          ::RailsConnector::Configuration.use_edited_content? ? :edited : :released
+        )
+      end
+
+      def to_prepare
+        unless Rails.configuration.cache_classes
+          after_initialize
+          NamedLink.reset_cache
+          BasicObj.reset_type_cache
+          ::ApplicationController.__send__(:helper, :cms)
+        end
+      end
+
+      def configure_cms_database
+        RailsConnector::CmsBaseModel.configure_database('cms')
+      end
+
+      attr_accessor :choose_homepage_callback
+
+      # Configure a callback to be invoked when the rails connector delivers the homepage.
+      # The given callback will receive the rack env
+      # and must return an Obj to be used as the homepage.
+      # If no callback is configured, Obj.homepage will be used as the default.
+      # @api public
+      def choose_homepage(&block)
+        self.choose_homepage_callback = block
+      end
+
+      def cms_routes(*args)
+        raise <<-EOS.gsub(/\s+/, ' ')
+        Calling RailsConnector::Configuration.cms_routes is not needed anymore.
+        Please remove it from config/routes.rb
+        EOS
+      end
+
+      def use_x_sendfile=(value)
+        raise 'Configuration.use_x_sendfile is now available as Rails configuration:'\
+              ' config.action_dispatch.x_sendfile_header = "X-Sendfile"'
+      end
+
+      def local_config_file
+        @local_config_file ||= read_local_config_file
+      end
+
+      def local_config_file_name
+        (Rails.root + "config/rails_connector.yml").expand_path
+      end
+
+      # for test purposes only
+      def reset_local_config_file_cache
+        @local_config_file = nil
+      end
+
+      protected
+
+      def enable_authentication
+        ::ApplicationController.__send__(:include, RailsConnector::Authenticable)
+      end
+
+      def read_local_config_file
+        contents = YAML.load_file(local_config_file_name) if File.exists?(local_config_file_name)
+        contents ||= {}
+
+        config = HelpfulConfiguration.new(
+          contents,
+          local_config_file_name
+        )
+        config.explain(
+          "cms_database",
+          "a hash of options, including type, that specify the database configuration"
+        )
+        config.explain(
+          "cms_blob_storage",
+          "a hash of options, including type, that specify the cms blob storage configuration"
+        )
+        config.explain(
+          "cms_dict_storage",
+          "a hash of options, including type, that specify the cms dict storage configuration"
+        )
+        config.explain(
+          "search",
+          "a hash of options that specify access to the search server"
+        )
+        config.explain(
+          "cms_api",
+          "a hash of options that specify access to the cms api"
+        )
+        config.explain 'content_service', 'a hash of options that specify access to content service'
+        config
+      end
+
+      def enable_ses
+        require 'rails_connector/ses'
+
+        RailsConnector::SES.enable
+      end
+    end
+  end
+
+  class ConfigurationError < StandardError
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: infopark_fiona_connector
 version: !ruby/object:Gem::Version
-  version: 6.9.2.1.125136549
+  version: 6.9.3.1.36404185
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: helpful_configuration
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: The Fiona Connector for Infopark CMS Fiona enables you to develop modern,
   dynamic Web 2.0 applications using Ruby on Rails and at the same time display CMS
   managed content.
@@ -71,8 +87,13 @@ files:
 - README
 - app/helpers/rails_connector/cms_asset_helper.rb
 - app/helpers/rails_connector/cms_tag_helper.rb
+- app/helpers/rails_connector/display_helper.rb
 - app/helpers/rails_connector/editing_helper.rb
 - app/helpers/rails_connector/marker_helper.rb
+- lib/generators/rails_connector/install/install_generator.rb
+- lib/generators/rails_connector/install/templates/app/models/obj.rb.erb
+- lib/generators/rails_connector/install/templates/initializers/rails_connector.rb
+- lib/generators/rails_connector/install/templates/local/configuration.rb
 - lib/infopark_fiona_connector.rb
 - lib/rails_connector/attr_dict.rb
 - lib/rails_connector/attr_value_provider.bundle
@@ -84,6 +105,7 @@ files:
 - lib/rails_connector/blob_oracle.rb
 - lib/rails_connector/cache_middleware.rb
 - lib/rails_connector/cms_base_model.rb
+- lib/rails_connector/configuration.rb
 - lib/rails_connector/date_attribute.rb
 - lib/rails_connector/default_search_request.rb
 - lib/rails_connector/errors.rb
@@ -112,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -343485329
+      hash: -246534353
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: