scrivito_sdk 1.1.1 → 1.2.0.rc1

data/lib/scrivito/cms_backend.rb

@@ -1,45 +1,8 @@
 module Scrivito
-  class CmsBackend
+  module CmsBackend
     VALID_INDEX_NAMES = %w[id path ppath permalink].freeze
 
-    class << self
-      def instance
-        @instance ||= new
-      end
-    end
-
-    def initialize
-      @query_counter = 0
-      @caching = true
-    end
-
-    def begin_caching
-      @caching = true
-    end
-
-    def end_caching
-      CmsDataCache.clear_request_cache
-      @caching = false
-    end
-
-    def clear_cache
-      CmsDataCache.clear_request_cache
-    end
-
-    def caching?
-      !!@caching
-    end
-
-    def query_counter
-      @query_counter
-    end
-
-    # For test purpose only.
-    def reset_query_counter!
-      @query_counter = 0
-    end
-
-    def find_workspace_data_from_cache(id)
+    def self.find_workspace_data_from_cache(id)
       cached_workspace_state = CmsDataCache.read_workspace_state(id)
       cached_data_tag = cached_workspace_state.try(:second)
       cached_content_state_id = cached_workspace_state.try(:first)
@@ -51,7 +14,7 @@ module Scrivito
       end
     end
 
-    def find_workspace_data_by_id(id, timeout=nil)
+    def self.find_workspace_data_by_id(id, timeout=nil)
       options = timeout ? {timeout: timeout} : {}
 
       cached_workspace_state = CmsDataCache.read_workspace_state(id)
@@ -82,7 +45,7 @@ module Scrivito
       end
     end
 
-    def find_obj_data_by(revision, index, keys)
+    def self.find_obj_data_by(revision, index, keys)
       index = index.to_s
 
       if index == "id"
@@ -94,7 +57,7 @@ module Scrivito
       end
     end
 
-    def find_blob_data(id, access, verb, options = {})
+    def self.find_blob_data(id, access, verb, options = {})
       if blob_data = find_blob_data_from_cache(id, access, verb, options)
         blob_data
       else
@@ -105,12 +68,12 @@ module Scrivito
       end
     end
 
-    def find_blob_data_from_cache(id, access, verb, options)
+    def self.find_blob_data_from_cache(id, access, verb, options)
       cache_key = blob_data_cache_key(normalize_blob_id(id), access, verb, options)
       CmsDataCache.cache.read(cache_key)
     end
 
-    def find_binary_meta_data(blob_id)
+    def self.find_binary_meta_data(blob_id)
       blob_id = normalize_blob_id(blob_id)
       cache_key = "binary_meta_data/#{blob_id}"
       if meta_data = CmsDataCache.cache.read(cache_key)
@@ -122,7 +85,7 @@ module Scrivito
       end
     end
 
-    def search_objs(workspace, params)
+    def self.search_objs(workspace, params)
       cache_index = 'search'
       cache_key = params.to_param
       cache = Backend::ObjDataCache.view_for_revision(workspace.revision)
@@ -137,23 +100,32 @@ module Scrivito
       result
     end
 
-    def create_obj(workspace_id, attributes)
+    def self.create_obj(workspace_id, attributes)
       write_obj(:post, "/workspaces/#{workspace_id}/objs", attributes)
     end
 
-    def update_obj(workspace_id, obj_id, attributes)
+    def self.update_obj(workspace_id, obj_id, attributes)
       write_obj(:put, "/workspaces/#{workspace_id}/objs/#{obj_id}", attributes)
     end
 
-    private
+    # For test purpose only.
+    def self.query_counter
+      @query_counter
+    end
+
+    # For test purpose only.
+    def self.reset_query_counter!
+      @query_counter = 0
+    end
 
-    def write_obj(verb, path, attributes)
+    def self.write_obj(verb, path, attributes)
       Backend::ObjDataFromRest.new(CmsRestApi.task_unaware_request(verb, path, attributes))
     end
+    private_class_method :write_obj
 
-    def update_workspace_cache(id, cached_data_tag, changed_workspace, options)
-      if changed_workspace
-        workspace_data = changed_workspace
+    def self.update_workspace_cache(id, cached_data_tag, workspace, options)
+      if workspace
+        workspace_data = workspace
       else
         if cached_workspace_data = fetch_cached_data_by_tag(cached_data_tag)
           workspace_data = cached_workspace_data
@@ -167,16 +139,19 @@ module Scrivito
 
       [workspace_data, workspace_data_tag]
     end
+    private_class_method :update_workspace_cache
 
-    def fetch_cached_data_by_tag(data_tag)
+    def self.fetch_cached_data_by_tag(data_tag)
       data_tag && CmsDataCache.read_data_from_tag(data_tag)
     end
+    private_class_method :fetch_cached_data_by_tag
 
-    def build_workspace_data(raw_data, content_state_id)
+    def self.build_workspace_data(raw_data, content_state_id)
       WorkspaceData.new(raw_data.merge('content_state_id' => content_state_id))
     end
+    private_class_method :build_workspace_data
 
-    def update_obj_cache(workspace_id, cached_csid, changes)
+    def self.update_obj_cache(workspace_id, cached_csid, changes)
       objs = changes["objs"]
       if objs.present? && objs != "*"
         last_state = Backend::ContentStateNode.find(cached_csid)
@@ -189,14 +164,18 @@ module Scrivito
         end
       end
     end
+    private_class_method :update_obj_cache
 
-    def request_search_result_from_backend(workspace, params)
+    def self.request_search_result_from_backend(workspace, params)
       params = params.merge(consistent_with: workspace.content_state_id)
       CmsRestApi.get("workspaces/#{workspace.id}/objs/search", params)
     end
+    private_class_method :request_search_result_from_backend
 
-    def request_blob_datas_from_backend(id, options)
+    def self.request_blob_datas_from_backend(id, options)
+      @query_counter ||= 0
       @query_counter += 1
+
       case
       when transformation_definition = options[:transformation_definition]
         CmsRestApi.get("blobs/#{id}/transform", transformation: transformation_definition)
@@ -206,8 +185,9 @@ module Scrivito
         CmsRestApi.get("blobs/#{id}")
       end
     end
+    private_class_method :request_blob_datas_from_backend
 
-    def store_blob_datas_in_cache(id, options, blob_datas)
+    def self.store_blob_datas_in_cache(id, options, blob_datas)
       %w[public_access private_access].each do |access|
         %w[get head].each do |verb|
           if access_blob_data = blob_datas[access]
@@ -219,8 +199,9 @@ module Scrivito
         end
       end
     end
+    private_class_method :store_blob_datas_in_cache
 
-    def blob_data_cache_key(id, access, verb, options)
+    def self.blob_data_cache_key(id, access, verb, options)
       cache_key = "blob_data/#{id}/#{access}/#{verb}"
 
       if transformation_definition = options[:transformation_definition]
@@ -233,9 +214,11 @@ module Scrivito
 
       cache_key
     end
+    private_class_method :blob_data_cache_key
 
-    def normalize_blob_id(id)
+    def self.normalize_blob_id(id)
       CmsRestApi.normalize_path_component(id)
     end
+    private_class_method :normalize_blob_id
   end
 end

data/lib/scrivito/cms_data_cache.rb

@@ -5,29 +5,29 @@ module CmsDataCache
   VERSION = 'v3'.freeze
 
   class << self
-    attr_reader :second_level_cache
-    attr_writer :cache_path
-
     def cache
-      @cache_chain ||= Cache::RamStore.new(next_store: first_level_cache, cache_prefix: VERSION)
+      Thread.current[:scrivito_cms_data_cache_chain] ||=
+        Cache::RamStore.new(next_store: first_level_cache, cache_prefix: VERSION)
     end
 
     def cache_path=(path)
       clear_cache_chain
-      @cache_path = path
+      Thread.current[:scrivito_cms_data_cache_path] = path
     end
 
     def first_level_cache
-      @first_level_cache ||= Cache::FileStore.new(path: @cache_path, next_store: second_level_cache)
-    end
-
-    def clear_request_cache
-      cache.clear
+      cache_path = Thread.current[:scrivito_cms_data_cache_path]
+      Thread.current[:scrivito_cms_data_first_level_cache] ||=
+        Cache::FileStore.new(path: cache_path, next_store: second_level_cache)
     end
 
     def second_level_cache=(cache_store)
       clear_cache_chain
-      @second_level_cache = cache_store
+      Thread.current[:scrivito_cms_data_second_level_cache] = cache_store
+    end
+
+    def second_level_cache
+      Thread.current[:scrivito_cms_data_second_level_cache]
     end
 
     SCHEMA = {
@@ -77,12 +77,16 @@ module CmsDataCache
       read_tag_data(tag)
     end
 
+    def clear_request_cache
+      cache.clear
+    end
+
     private
 
     def clear_cache_chain
-      @cache_chain = nil
-      @first_level_cache = nil
-      @second_level_cache = nil
+      Thread.current[:scrivito_cms_data_cache_chain]        = nil
+      Thread.current[:scrivito_cms_data_first_level_cache]  = nil
+      Thread.current[:scrivito_cms_data_second_level_cache] = nil
     end
   end
 end

data/lib/scrivito/cms_field_tag.rb

@@ -46,7 +46,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
       'field-obj-class'              => obj_or_widget.obj_class,
       'field-type'                   => field_type,
       'private-editor'               => editing_options[:editor],
-      'private-field-allowed-values' => allowed_values,
+      'private-field-allowed-values' => valid_values,
       'private-field-workspace-id'   => current_workspace_id,
     }
 
@@ -158,7 +158,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
     end
   end
 
-  def allowed_values
+  def valid_values
     MultiJson.encode(obj_or_widget.attribute_definitions[field_name].try(:values) || [])
   end
 

data/lib/scrivito/cms_rest_api.rb

@@ -70,8 +70,8 @@ module Scrivito
 
     def self.upload_future_binary(future_binary, obj_id)
       if future_binary.id_to_copy
-        id = normalize_path_component(future_binary.id_to_copy)
-        put("blobs/#{id}/copy", future_binary.to_h.merge(destination_obj_id: obj_id))
+        copy_binary(normalize_path_component(future_binary.id_to_copy),
+          future_binary.to_h.merge(destination_obj_id: obj_id))
       else
         permission = get('blobs/upload_permission')
         upload = upload_file(future_binary.file_to_upload, future_binary.content_type, permission)
@@ -83,6 +83,10 @@ module Scrivito
       put('blobs/activate_upload', params)
     end
 
+    def self.copy_binary(id, params)
+      put("blobs/#{id}/copy", params)
+    end
+
     def self.normalize_path_component(component)
       Addressable::URI.normalize_component(component,
         Addressable::URI::CharacterClasses::UNRESERVED)
@@ -135,7 +139,7 @@ module Scrivito
         response = retry_once_on_network_error(method, timer) do
           CmsRestApi::RateLimit.retry_on_rate_limit(timer) do
             request_timeout = [timer.remaining_time, MAX_REQUEST_TIME].min
-            connection_manager.request(request, request_timeout)
+            ConnectionManager.request(request, timeout: request_timeout)
           end
         end
 
@@ -189,7 +193,8 @@ module Scrivito
           upload_io = UploadIO.new(open_file, content_type, File.basename(file))
           params = upload_permission['fields'].merge('file' => upload_io)
           request = Net::HTTP::Post::Multipart.new(uri.path, params)
-          response = ConnectionManager.request(uri, request)
+          response = ConnectionManager.request(request, uri: uri)
+
           if response.code.starts_with?('2')
             upload_permission['blob']
           else
@@ -231,10 +236,6 @@ module Scrivito
         "/#{Configuration.endpoint_uri.path}/#{path}".squeeze('/')
       end
 
-      def connection_manager
-        ConnectionManager.instance
-      end
-
       def build_timer(options={})
         CmsRestApi::RequestTimer.new(options.fetch(:timeout, DEFAULT_TIMEOUT))
       end

data/lib/scrivito/cms_routing.rb

@@ -77,7 +77,7 @@ class CmsRouting < Struct.new(:request, :context, :scrivito_engine, :image_optio
 
   def path_or_url_for_objs(obj, path_or_url, options)
     permalink = obj.permalink
-    if permalink && route_defined?(:permalink)
+    if permalink && route_defined?(:permalink) && permalink.split('/').first != 'scrivito'
       use_route(:permalink, path_or_url, options.merge(:permalink => permalink))
     elsif homepage?(obj) && route_defined?(:homepage)
       use_route(:homepage, path_or_url, options)

data/lib/scrivito/configuration.rb

@@ -297,11 +297,22 @@ Please use the new scrivito_route api to replicate the legacy routes:
 
       attr_reader :default_image_transformation
 
-      # Configure a callback to be invoked when the Scrivito SDK delivers the homepage.
-      # The given callback will receive the rack env
-      # and must return an {BasicObj Obj} to be used as the homepage.
-      # If no callback is configured, {BasicObj.root Obj.root} will be used as the default.
       # @api public
+      #
+      # A callback that can be provided for determining the CMS object to be used when visiting
+      # the homepage. See {Scrivito::RoutingExtensions#scrivito_route scrivito_route} for
+      # details on how to define routes. The callback is called once per request and receives
+      # the rack environment as its only parameter. By default, the CMS object at the root
+      # path (+/+) is used as the homepage.
+      #
+      # @yield Rack environment of the current request
+      #
+      # @example
+      #   Scrivito.configure do |config|
+      #     config.choose_homepage do |env|
+      #       Obj.root # Replace with code to set the homepage
+      #     end
+      #   end
       def choose_homepage(&block)
         self.choose_homepage_callback = block
       end

data/lib/scrivito/connection_manager.rb

@@ -1,3 +1,5 @@
+require 'connection_pool'
+
 module Scrivito
   class ConnectionManager
     DEFAULT_TIMEOUT = 10.freeze
@@ -5,22 +7,15 @@ module Scrivito
     attr_reader :uri
 
     class << self
-      def instance
-        @instance ||= new(Configuration.endpoint_uri)
-      end
-
-      # For test purpose only.
-      def reset_instance!
-        @instance = nil
-      end
-
-      def request(uri, request, timeout = nil)
-        instance_for(uri).request(request, timeout)
+      def request(request, timeout: nil, uri: nil)
+        connection_pool_for(uri || Configuration.endpoint_uri).with do |connection|
+          connection.request(request, timeout)
+        end
       end
 
       # For test purpose only.
       def clear_cache!
-        @instances = nil
+        @connection_pools = nil
         @cert_store = nil
       end
 
@@ -33,15 +28,17 @@ module Scrivito
 
       private
 
-      def instance_for(uri)
+      def connection_pool_for(uri)
         endpoint_url = "#{uri.scheme}://#{uri.host}:#{uri.port}"
-        instances.fetch(endpoint_url) do
-          instances[endpoint_url] = new(URI.parse(endpoint_url))
+        connection_pools.fetch(endpoint_url) do
+          connection_pools[endpoint_url] = ConnectionPool.new(size: 100, timeout: 0) do
+            new(URI.parse(endpoint_url))
+          end
         end
       end
 
-      def instances
-        @instances ||= {}
+      def connection_pools
+        @connection_pools ||= {}
       end
     end
 
@@ -53,12 +50,16 @@ module Scrivito
       request['User-Agent'] = user_agent
       ensure_started(timeout)
 
-      begin
-        connection.request(request)
-      rescue => e
-        ensure_finished
-        raise NetworkError.from_socket_error(e)
-      end
+      # This should never happen!
+      raise InternalError, 'Connection is already in use!' if @in_use
+
+      @in_use = true
+      connection.request(request)
+    rescue => e
+      ensure_finished
+      raise NetworkError.from_socket_error(e)
+    ensure
+      @in_use = false
     end
 
     # for testing purposes
@@ -66,6 +67,11 @@ module Scrivito
       @connect_count || 0
     end
 
+    # For test purpose only.
+    def in_use?
+      !!@in_use
+    end
+
     private
 
     attr_accessor :connection

data/lib/scrivito/model_library.rb

@@ -4,10 +4,13 @@ module Scrivito
 # @api public
 #
 class ModelLibrary
-  attr_reader :custom_pages, :custom_widgets, :custom_paths
+  attr_reader :custom_pages, :custom_widgets, :custom_objs, :custom_paths
 
   def initialize
-    @custom_pages, @custom_widgets, @custom_paths = [], [], []
+    @custom_pages   = []
+    @custom_widgets = []
+    @custom_objs    = []
+    @custom_paths   = []
   end
 
   #
@@ -17,13 +20,14 @@ class ModelLibrary
   # @see Scrivito.models
   #
   def clear_cache
-    @pages = nil
+    @pages   = nil
     @widgets = nil
-    @paths = nil
+    @objs    = nil
+    @paths   = nil
   end
 
   #
-  # Configures which models Scrivito assumes as pages and widgets.
+  # Configures which models Scrivito assumes as pages, widgets and objs.
   #
   # @api public
   # @see Scrivito.models
@@ -54,6 +58,25 @@ class ModelLibrary
     @widgets ||= load_models('widget', Scrivito::BasicWidget)
   end
 
+  #
+  # Lists available CMS object models.
+  #
+  # @api public
+  # @see Scrivito.models
+  # @return [Scrivito::ClassCollection] available CMS object classes
+  #
+  def objs
+    @objs ||= load_obj_models
+  end
+
+  def load_obj_models
+    base_class = Scrivito::BasicObj
+    model_classes = load_models_from_paths('obj', base_class) +
+      load_custom_models('obj', base_class) +
+      load_custom_models('page', base_class)
+    ClassCollection.new(model_classes)
+  end
+
   #
   # Lists available paths to scan for models.
   #
@@ -69,7 +92,7 @@ class ModelLibrary
 
   def load_models(type, base_class)
     model_classes = load_models_from_paths(type, base_class) + load_custom_models(type, base_class)
-    ClassCollection.new(model_classes.compact)
+    ClassCollection.new(model_classes)
   end
 
   def load_models_from_paths(type, base_class)
@@ -78,20 +101,25 @@ class ModelLibrary
 
   def load_models_from_path(type, path, base_class)
     candidates_from_path(type, path).map do |file_path|
-      load_model(file_path.gsub(path, '').gsub('.rb', '').classify, base_class)
+      load_model(file_path.gsub(path, '').gsub('.rb', '').camelize, base_class)
     end
   end
 
   def candidates_from_path(type, path)
-    result = Dir["#{path}/**/*_#{type}.rb"]
-    result += Dir["#{path}/**/page.rb"] if type == 'page'
-    result
+    Dir["#{path}/**/*.rb"].select do |file_path|
+      case type
+      when 'page'   then file_path.ends_with?('page.rb')
+      when 'widget' then file_path.ends_with?('_widget.rb')
+      else true
+      end
+    end
   end
 
   def load_model(class_name, base_class)
     model_class = class_name.constantize
     model_class if model_class.ancestors.include?(base_class)
-  rescue NameError
+  rescue LoadError
+    # Ignore files with invalid models, e.g. empty files.
   end
 
   def load_custom_models(type, base_class)
@@ -107,6 +135,10 @@ class ModelLibrary
   end
 
   class DSL < Struct.new(:model_library)
+    def obj(*names)
+      model_library.custom_objs.push(*names)
+    end
+
     def page(*names)
       model_library.custom_pages.push(*names)
     end

data/lib/scrivito/obj_collection.rb

@@ -137,7 +137,7 @@ module Scrivito
     # Accepts the name of an "obj_by" view, a list of keys.
     # Returns a list of lists of Objs: a list of Objs for each given key.
     def find_by_including_deleted(view, keys)
-      result = CmsBackend.instance.find_obj_data_by(
+      result = CmsBackend.find_obj_data_by(
         workspace.revision,
         view,
         keys)

data/lib/scrivito/obj_params_parser.rb

@@ -54,25 +54,7 @@ module Scrivito
 
     def parse_binary_params(params)
       return unless params
-
-      if params[:copy]
-        parse_copy_binary_params(params[:copy])
-      else
-        UploadedBinary.new(params)
-      end
-    end
-
-    def parse_copy_binary_params(params)
-      obj = Obj.find(params[:obj_id])
-
-      if widget_id = params[:widget_id]
-        widget = obj.widgets[widget_id]
-        raise_widget_not_found_error(widget_id) unless widget
-      end
-
-      if binary = (widget || obj)[params[:attribute_name]]
-        binary.copy(params.slice(:filename, :content_type).compact)
-      end
+      UploadedBinary.new(params)
     end
 
     def raise_widget_not_found_error(widget_id)

data/lib/scrivito/obj_search_enumerator/query_executor.rb

@@ -7,7 +7,7 @@ class ObjSearchEnumerator
 
     def call(query, continuation=nil, fetched_ids=[])
       query['continuation'] = continuation if continuation
-      response = CmsBackend.instance.search_objs(workspace, query)
+      response = CmsBackend.search_objs(workspace, query)
 
       ObjSearchEnumerator::Batch.new(
         build_objs(response),

data/lib/scrivito/obj_search_enumerator.rb

@@ -349,7 +349,7 @@ module Scrivito
         }
       end
 
-      @size ||= CmsBackend.instance.search_objs(workspace, size_query)['total'].to_i
+      @size ||= CmsBackend.search_objs(workspace, size_query)['total'].to_i
     end
 
     # Loads a single batch of search results from the backend.

data/lib/scrivito/ui_config.rb

@@ -1,19 +1,22 @@
 module Scrivito
 
-class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extension_tags)
+class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extension_tags,
+                            :obj_models, :widget_models)
   def initialize(**named_params)
     named_params.each { |key, value| self[key] = value }
   end
 
   def to_json
     {
+      app_extension_tags:  app_extension_tags,
       editing_context:     editing_context_config,
       i18n:                i18n_config,
       is_development_mode: Rails.env.development?,
       resource_dialog:     resource_dialog_config,
       user:                user_config,
       user_permissions:    user_permissions_config,
-      app_extension_tags:  app_extension_tags,
+      obj_class:           obj_class_config,
+      widget_class:        widget_class_config,
     }.to_json
   end
 
@@ -46,6 +49,14 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     {locale: Scrivito::Configuration.ui_locale || I18n.locale}
   end
 
+  def obj_class_config
+    obj_models.map(&:as_json)
+  end
+
+  def widget_class_config
+    widget_models.map(&:as_json)
+  end
+
   def resource_dialog_config
     return {} unless resource
     {