scrivito_sdk 1.9.1 → 1.10.0.rc1

data/lib/scrivito/sdk_engine.rb

@@ -2,6 +2,7 @@ require 'rails'
 
 require 'jbuilder'
 require 'net/http/post/multipart'
+require_relative './legacy_switch'
 
 module ::Scrivito
   class SdkEngine < Rails::Engine
@@ -62,14 +63,17 @@ module ::Scrivito
       app.config.assets.precompile += %w(*.png *.jpg *.jpeg *.gif)
     end
 
+    initializer 'scrivito.add_middlewares' do |app|
+      config.app_middleware.use Scrivito::EditingContextMiddleware
+      config.app_middleware.use Scrivito::CacheMiddleware
+      config.app_middleware.use Scrivito::WorkspaceSelectionMiddleware
+      config.app_middleware.use Scrivito::DisableBrowserCacheForUiMiddleware
+    end
+
     config.autoload_paths += paths['lib'].to_a
     config.autoload_once_paths += paths['lib'].to_a
     config.eager_load_paths += [root.join('lib', 'scrivito').to_s]
 
-    config.app_middleware.use Scrivito::EditingContextMiddleware
-    config.app_middleware.use Scrivito::CacheMiddleware
-    config.app_middleware.use Scrivito::WorkspaceSelectionMiddleware
-    config.app_middleware.use Scrivito::DisableBrowserCacheForUiMiddleware
   end
 end
 

data/lib/scrivito/tag_renderer.rb

@@ -13,33 +13,27 @@ module TagRenderer
     {}
   end
 
-  class << self
-
-    def render(view, tag, given_options, &block)
-      content = tag.content(&block)
-      tag_name = tag.tag_name
-      options = given_options
-        .merge(tag.html_options)
-        .merge(formatted_options(tag))
-
-      if VOID_TAGS.include?(tag_name.to_s)
-        view.tag(tag_name, options)
-      else
-        view.content_tag(tag_name, content, options)
-      end
+  def self.render(view, tag, given_options, &block)
+    content = tag.content(&block)
+    tag_name = tag.tag_name
+    options = given_options
+      .merge(tag.html_options)
+      .merge(formatted_options(tag))
+
+    if VOID_TAGS.include?(tag_name.to_s)
+      view.tag(tag_name, options)
+    else
+      view.content_tag(tag_name, content, options)
     end
+  end
 
-    private
-
-    def formatted_options(tag)
-      formatted_options = {}
-      tag.options.each do |key, value|
-        formatted_options["data-scrivito-#{key}"] = value
-      end
-
-      formatted_options
+  private_class_method def self.formatted_options(tag)
+    formatted_options = {}
+    tag.options.each do |key, value|
+      formatted_options["data-scrivito-#{key}"] = value
     end
 
+    formatted_options
   end
 
 end

data/lib/scrivito/test_request.rb

@@ -47,15 +47,13 @@ module Scrivito
         end
       end
 
-      class << self
-        def assign_parameters(routes, controller_path, *args)
-          super routes, controller_path, *args
-        rescue *ROUTING_ERRORS => e
-          begin
-            super routes, 'scrivito/cms_dispatch', *args
-          rescue *ROUTING_ERRORS
-            raise e
-          end
+      def self.assign_parameters(routes, controller_path, *args)
+        super routes, controller_path, *args
+      rescue *ROUTING_ERRORS => e
+        begin
+          super routes, 'scrivito/cms_dispatch', *args
+        rescue *ROUTING_ERRORS
+          raise e
         end
       end
     end

data/lib/scrivito/ui_config.rb

@@ -14,8 +14,6 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
       i18n:                i18n_config,
       is_development_mode: Rails.env.development?,
       resource_dialog:     resource_dialog_config,
-      user:                user_config,
-      user_permissions:    user_permissions_config,
       class_datas:         obj_class_config + widget_class_config,
       useRailsEngine:      true,
     }.to_json
@@ -47,23 +45,6 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     }
   end
 
-  def user_permissions_config
-    {
-      create_workspace: editor.can?(:create, :workspace),
-      rename_workspace: editor.can?(:write, selected_workspace),
-      invite_to_workspace: editor.can?(:invite_to, selected_workspace),
-      rebase_workspace: editor.can?(:write, selected_workspace),
-      delete_workspace: editor.can?(:delete, selected_workspace),
-      publish_workspace: editor.can?(:publish, selected_workspace),
-    }
-  end
-
-  def user_config
-    {
-      current: editor.as_json,
-    }
-  end
-
   def editor
     editing_context.editor
   end

data/lib/scrivito/user.rb

@@ -31,108 +31,103 @@ module Scrivito
       :read_history,
     ].freeze
 
-    class << self
-      #
-      # Defines a new user.
-      #
-      # @api public
-      #
-      # @param [String] id The unique, unalterable id of the user.
-      #   The user id is used to associate the user with the corresponding CMS resources.
-      #   It is persisted in the CMS.
-      #
-      # @raise [Scrivito::ScrivitoError] if id is blank
-      # @raise [Scrivito::ScrivitoError] if id is more than 64 characters long
-      #
-      # @yieldparam [Scrivito::UserDefinition] user object to define rules on
-      #
-      # @see Scrivito::UserDefinition#can_always
-      # @see Scrivito::UserDefinition#can_never
-      # @see Scrivito::UserDefinition#description
-      # @see Scrivito::UserDefinition#restrict_obj_publish
-      # @see Scrivito::UserDefinition#suggest_users
-      #
-      # @example
-      #   Scrivito::User.define('alice') do |user_definition|
-      #     user_definition.description { 'Alice Almighty' }
-      #
-      #     user_definition.can_always(:read, :workspace)
-      #     user_definition.can_always(:write, :workspace)
-      #     user_definition.can_always(:publish, :workspace, 'You can always publish workspaces.')
-      #   end
-      #
-      #   Scrivito::User.define('bob') do |user_definition|
-      #     user_definition.description('Bob Doe')
-      #
-      #     user_definition.can_never(:create, :workspace, 'You are not allowed to create workspaces.')
-      #     user_definition.can_always(:read, :workspace)
-      #
-      #     user_definition.restrict_obj_publish(using: :_obj_class) do |obj_class|
-      #       if obj_class == 'BlogPost'
-      #         false
-      #       else
-      #         'You are not allowed to publish blog posts.'
-      #       end
-      #     end
-      #   end
-      #
-      def define(id, &block)
-        assert_valid_id(id)
-        define_user(id, &block)
-      end
-
-      #
-      # Returns an anonymous system user who can always create workspaces, can always read, write,
-      # publish, delete, and invite others to collaborate on any workspace.
-      # @example Check whether the user may publish a particular object:
-      #   Scrivito::User.system_user.can_publish?(Obj.root)
-      #   # => true
-      #
-      # @example Get the notification messages for publishing restrictions. An empty array indicates that no restrictions exist.
-      #   Scrivito::User.system_user.restriction_messages_for(Obj.root)
-      #   # => []
-      #
-      # @api public
-      # @return [Scrivito::User] the system user
-      #
-      def system_user
-        define_user { |user| user.is_admin! }
-      end
+    # Defines a new user.
+    #
+    # @api public
+    #
+    # @param [String] id The unique, unalterable id of the user.
+    #   The user id is used to associate the user with the corresponding CMS resources.
+    #   It is persisted in the CMS.
+    #
+    # @raise [Scrivito::ScrivitoError] if id is blank
+    # @raise [Scrivito::ScrivitoError] if id is more than 64 characters long
+    #
+    # @yieldparam [Scrivito::UserDefinition] user object to define rules on
+    #
+    # @see Scrivito::UserDefinition#can_always
+    # @see Scrivito::UserDefinition#can_never
+    # @see Scrivito::UserDefinition#description
+    # @see Scrivito::UserDefinition#restrict_obj_publish
+    # @see Scrivito::UserDefinition#suggest_users
+    #
+    # @example
+    #   Scrivito::User.define('alice') do |user_definition|
+    #     user_definition.description { 'Alice Almighty' }
+    #
+    #     user_definition.can_always(:read, :workspace)
+    #     user_definition.can_always(:write, :workspace)
+    #     user_definition.can_always(:publish, :workspace, 'You can always publish workspaces.')
+    #   end
+    #
+    #   Scrivito::User.define('bob') do |user_definition|
+    #     user_definition.description('Bob Doe')
+    #
+    #     user_definition.can_never(:create, :workspace, 'You are not allowed to create workspaces.')
+    #     user_definition.can_always(:read, :workspace)
+    #
+    #     user_definition.restrict_obj_publish(using: :_obj_class) do |obj_class|
+    #       if obj_class == 'BlogPost'
+    #         false
+    #       else
+    #         'You are not allowed to publish blog posts.'
+    #       end
+    #     end
+    #   end
+    #
+    def self.define(id, &block)
+      assert_valid_id(id)
+      define_user(id, &block)
+    end
 
-      def unknown_user(id)
-        new(id: id, explicit_rules: {})
-      end
+    #
+    # Returns an anonymous system user who can always create workspaces, can always read, write,
+    # publish, delete, and invite others to collaborate on any workspace.
+    # @example Check whether the user may publish a particular object:
+    #   Scrivito::User.system_user.can_publish?(Obj.root)
+    #   # => true
+    #
+    # @example Get the notification messages for publishing restrictions. An empty array indicates that no restrictions exist.
+    #   Scrivito::User.system_user.restriction_messages_for(Obj.root)
+    #   # => []
+    #
+    # @api public
+    # @return [Scrivito::User] the system user
+    #
+    def self.system_user
+      define_user { |user| user.is_admin! }
+    end
 
-      def find(id)
-        if Configuration.find_user_proc
-          user = Scrivito::Configuration.find_user_proc.call(id)
-          assert_valid_user(user)
-          user
-        end
-      end
+    def self.unknown_user(id)
+      new(id: id, explicit_rules: {})
+    end
 
-      def mget(*ids)
-        ids.map(&method(:find))
+    def self.find(id)
+      if Configuration.find_user_proc
+        user = Scrivito::Configuration.find_user_proc.call(id)
+        assert_valid_user(user)
+        user
       end
+    end
 
-      private
+    def self.mget(*ids)
+      ids.map(&method(:find))
+    end
 
-      def define_user(id = nil)
-        user_definition = UserDefinition.new(id)
-        yield user_definition if block_given?
-        user_definition.user
-      end
+    private_class_method def self.define_user(id = nil)
+      user_definition = UserDefinition.new(id)
+      yield user_definition if block_given?
+      user_definition.user
+    end
 
-      def assert_valid_id(id)
-        raise ScrivitoError.new('User id must be a string') unless id.to_s == id
-        raise ScrivitoError.new('User id can not be blank') if id.blank?
-        raise ScrivitoError.new('User id is too long (max length 64)') if id.length > 64
-      end
+    private_class_method def self.assert_valid_id(id)
+      raise ScrivitoError.new('User id must be a string') unless id.to_s == id
+      raise ScrivitoError.new('User id can not be blank') if id.blank?
+      raise ScrivitoError.new('User id is too long (max length 64)') if id.length > 64
+    end
 
-      def assert_valid_user(user)
-        unless user.is_a?(User) || user.nil?
-          raise ScrivitoError.new("Expected an instance of #{self} or nil, but got #{user.inspect}")
-        end
+    private_class_method def self.assert_valid_user(user)
+      unless user.is_a?(User) || user.nil?
+        raise ScrivitoError.new("Expected an instance of #{self} or nil, but got #{user.inspect}")
       end
     end
 
@@ -235,7 +230,6 @@ module Scrivito
       {
         id: id,
         description: description,
-        explicit_rules: explicit_rules_as_json,
       }
     end
 
@@ -263,9 +257,5 @@ module Scrivito
 
       nil
     end
-
-    def explicit_rules_as_json
-      @explicit_rules.map { |(adverb, verb, _)| "#{adverb}-#{verb}" }
-    end
   end
 end

data/lib/scrivito/workspace.rb

@@ -385,26 +385,22 @@ class Workspace
     end
   end
 
-  class << self
-    private
-
-    def from_workspace_data(id, data)
-      unless data
-        raise ResourceNotFound, "Could not find #{self} with id #{id}"
-      end
-
-      cache[id] = Workspace.new(data)
+  private_class_method def self.from_workspace_data(id, data)
+    unless data
+      raise ResourceNotFound, "Could not find #{self} with id #{id}"
     end
 
-    def warn_backend_not_available(error_message)
-      Warning.warn <<-EOS
+    cache[id] = Workspace.new(data)
+  end
 
-        Couldn't connect to backend to fetch published workspace.
-        #{error_message}
-        Serving from cache.
+  private_class_method def self.warn_backend_not_available(error_message)
+    Warning.warn <<-EOS
 
-      EOS
-    end
+      Couldn't connect to backend to fetch published workspace.
+      #{error_message}
+      Serving from cache.
+
+    EOS
   end
 end
 

data/lib/scrivito/workspace_data.rb

@@ -1,11 +1,7 @@
 module Scrivito
   class WorkspaceData
-    class << self
-      private
-
-      def data_attr_reader(attr_name)
-        define_method(attr_name) { @data[attr_name.to_s] }
-      end
+    private_class_method def self.data_attr_reader(attr_name)
+      define_method(attr_name) { @data[attr_name.to_s] }
     end
 
     data_attr_reader :id

data/lib/scrivito_sdk.rb

@@ -138,19 +138,6 @@ module Scrivito
   def self.models
     @models ||= ModelLibrary.new
   end
-
-  def self.autoload_all_sources
-    source_files = Dir.glob(File.expand_path("../scrivito/*.rb", __FILE__)).map do |file|
-      File.basename(file)
-    end
-
-    source_files.each do |file|
-      name = file.gsub(".rb", "")
-      autoload name.camelcase, "scrivito/#{name}"
-    end
-  end
-
-  autoload_all_sources
 end
 
 require 'scrivito/sdk_engine' if defined?(Rails)

data/lib/tasks/cache.rake

@@ -1,3 +1,5 @@
+require_relative '../scrivito/cache_garbage_collector'
+
 namespace :scrivito do
   namespace :cache do
     desc 'Cap number of cache file inodes at ' \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0.rc1
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -424,9 +438,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8