scrivito_sdk 0.18.1 → 0.30.0.rc1

data/lib/scrivito/migrations/migrator.rb

@@ -3,7 +3,7 @@ module Scrivito
     class Migrator
       class << self
         def migrations_path
-          Rails.root + 'cms/migrate'
+          Rails.root + Scrivito::Configuration.migration_path
         end
 
         def determine_migrations(paths)
@@ -76,8 +76,7 @@ module Scrivito
             workspace_lock.validate(workspace)
           end
         else
-          CmsRestApi.post('workspaces', :workspace => { :title => 'rtc', :id => 'rtc' })
-          workspace = migration_workspace
+          workspace = Workspace.create(title: 'Migration Working Copy', id: 'rtc')
           workspace_lock.write(workspace)
         end
 

data/lib/scrivito/obj_class.rb

@@ -49,11 +49,16 @@ module Scrivito
       # to set as values. Attributes can be either given as {Scrivito::Attribute} instances or as
       # an attribute property hash.
       #
-      # @example Create a non-binary obj class.
-      #   ObjClass.create(name: 'Homepage', is_binary: false)
+      # @example Create a obj class
+      #   ObjClass.create(name: 'Homepage', attributes: [
+      #     { name: 'title', type: :string },
+      #     { name: 'body', type: :widget }
+      #   ])
       #
       # @example Create a binary obj class.
-      #   ObjClass.create(name: 'Image', is_binary: true)
+      #   ObjClass.create(name: 'Image', attributes: [
+      #     { name: 'blob', type: :binary }
+      #   ])
       #
       # @example Create an obj class with attributes passed in as an Array of attribute property hashes.
       #   ObjClass.create(name: 'Blog', attributes: [
@@ -69,19 +74,23 @@ module Scrivito
       #
       # @param [Hash] properties
       # @option properties [String] :name The name of the obj class.
-      # @option properties [Boolean] :is_binary Is this a binary or non-binary obj class?
       # @option properties [Boolean] :is_active Is it possible to create instances of this obj class?
       # @option properties [Array<Scrivito::Attribute>, Array<Hash>] :attributes A list of
       #   attributes for this obj class. Can be either a list of attribute instances or attribute
       #   property hashes.
       #
+      # @note the +is_binary+ option is deprecated
+      #
       # @return [Scrivito::ObjClass]
       def create(properties)
         properties = properties.with_indifferent_access
 
-        unless properties.has_key?(:is_binary)
-          raise ScrivitoError, 'The "is_binary" property is mandatory. Please provide' \
-            ' a hash containing an "is_binary" key with true or false value.'
+        if properties.key?(:is_binary)
+          Scrivito::Deprecation.warn(
+            "`is_binary' is deprecated and should not be used anymore."\
+            "Please remove the parameter and specify all attributes you need "\
+            "including the previously provided attributes 'title', 'body', 'blob'"
+          )
         end
 
         if properties[:attributes]
@@ -129,6 +138,15 @@ module Scrivito
       @workspace = workspace
     end
 
+    # @api public
+    # Returns true if this ObjClass was created with a +is_binary+ option.
+    # Creating ObjClass with this option is deprecated and will be removed.
+    #
+    # @return [Boolean]
+    def legacy_type?
+      !!obj_class_data.type
+    end
+
     # @!attribute [r] id
     #   @api public
     #   @return [String] unique identifier of this obj class
@@ -138,10 +156,20 @@ module Scrivito
     # @!attribute [r] is_active
     #   @api public
     #   @return [Boolean] whether instances can be created with this obj class
-    # @!attribute [r] is_binary
-    #   @api public
-    #   @return [Boolean] whether instances of this class are binary, e.g. images or PDFs
-    delegate :id, :name, :is_active, :is_binary, to: :obj_class_data
+    delegate :id, :name, :is_active, to: :obj_class_data
+
+    # @api public
+    # @return [Boolean] whether instances of this class are binary, e.g. images or PDFs
+    # @deprecated Please create objects without using the +is_binary+ option
+    # @raise [ScrivitoError] if the method is called on a non-legacy-type ObjClass
+    def is_binary
+      if legacy_type?
+        obj_class_data.is_binary
+      else
+        raise ScrivitoError,
+          %(`is_binary' and `binary?' can only be called on ObjClasses with a legacy_type.)
+      end
+    end
 
     alias_method :active?, :is_active
     alias_method :binary?, :is_binary
@@ -165,14 +193,31 @@ module Scrivito
     #   end
     attr_reader :attributes
 
-    # Updates this obj class and persists the changes in the CMS. It is not possible to
-    # update the +name+ or +is_binary+ property.
-    #
     # @api public
+    # Updates this obj class and persists the changes in the CMS. It is not possible to
+    # update the +name+.
     #
     # See {Scrivito::ObjClass.create} for a detailed overview of
     # what properties are allowed and how to set them.
     #
+    # The +is_binary+ option can only be removed. By passing +nil+ for the
+    # +is_binary+ option to update, you can convert legacy objects. This conversion
+    # removes the fields +title+, +body+ (if +is_binary+ was +false+) or +blob+ (if
+    # +is_binary+ was +true+). If you add the fields in the same request the values
+    # will be kept for all objs.
+    #
+    # @example Removing +is_binary+ but keeping the previously predefined fields
+    #   ObjClass.find('Homepage').update(is_binary: nil, attributes: [
+    #     {name: 'title', type: 'string'},
+    #     {name: 'body',  type: 'html'}
+    #   ])
+    #
+    #   # Binary ObjClass
+    #   ObjClass.find('Image').update(is_binary: nil, attributes: [
+    #     {name: 'title', type: 'string'},
+    #     {name: 'blob',  type: 'binary'}
+    #   ])
+    #
     # @param [Hash] properties
     #
     # @raise [ScrivitoError] Raised when trying to change +name+ or +is_binary+.
@@ -182,8 +227,11 @@ module Scrivito
       params = properties.with_indifferent_access
 
       if params.has_key?(:is_binary)
-        raise ScrivitoError, "#{self.class} does not support changing 'is_binary'. Please remove" \
-          " the key from the properties."
+        if params[:is_binary].nil?
+          params[:type] = params.delete(:is_binary)
+        else
+          raise ScrivitoError, "#{self.class} only supports removing the `is_binary' property"
+        end
       end
 
       if params.has_key?(:name)

data/lib/scrivito/obj_class_data.rb

@@ -25,6 +25,10 @@ class ObjClassData
     !!@raw_data['is_binary']
   end
 
+  def type
+    @raw_data['type']
+  end
+
   def attributes
     @raw_data['attributes'] || []
   end

data/lib/scrivito/obj_search_enumerator.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 module Scrivito
   # Provides an enumerator for iterating over obj search results and retrieving obj instances.
-  # This is done using the {http://ruby-doc.org/core-1.8.7/Enumerable.html <code>Enumerable</code> mixin},
+  # This is done using the {http://ruby-doc.org/core-2.1.3/Enumerable.html <code>Enumerable</code> mixin},
   # which provides methods such as <code>map</code>, <code>select</code> or <code>take</code>.
   #
   # This enumerator is lazy. If for example you are looking for {BasicObj Obj}s with the ObjClass "Publication",

data/lib/scrivito/routing_helper.rb

@@ -0,0 +1,42 @@
+module Scrivito
+  #
+  # The helper contains methods to generate URLs to CMS content.
+  # Use {Scrivito::RoutingHelper#scrivito_path} or {Scrivito::RoutingHelper#scrivito_url} when linking or
+  # redirecting to CMS objects. These methods are available in boths your views and your controllers.
+  #
+  # @api public
+  #
+  module RoutingHelper
+    #
+    # Returns the (URL-)path for a cms object.
+    #
+    # @api public
+    #
+    # @param target [Obj, Link, Array<Link>]
+    #   If +target+ is an +Array+ of +Links+, it must be non-empty.
+    #   The first {Link} from the +Array+ will be used.
+    # @param options [Hash] include url settings such as path parameters or protocol.
+    #
+    # @return [String]
+    #
+    def scrivito_path(target, options = {})
+      CmsRouting.new(request, main_app).path_or_url(target, "path", options)
+    end
+
+    #
+    # Returns the absolute URL for a cms object.
+    #
+    # @api public
+    #
+    # @param target [Obj, Link, Array<Link>]
+    #   If +target+ is an +Array+ of +Links+, it must be non-empty.
+    #   The first {Link} from the +Array+ will be used.
+    # @param options [Hash] include url settings such as path parameters or protocol.
+    #
+    # @return [String]
+    #
+    def scrivito_url(target, options = {})
+      CmsRouting.new(request, main_app).path_or_url(target, "url", options)
+    end
+  end
+end

data/lib/scrivito/{engine.rb → sdk_engine.rb}

@@ -1,13 +1,11 @@
-require "rails"
-require "action_view"
-require "active_model"
+require 'rails'
 
+require 'jbuilder'
 require 'jquery-rails'
-
-require 'scrivito/configuration'
+require 'net/http/post/multipart'
 
 module ::Scrivito
-  class Engine < Rails::Engine
+  class SdkEngine < Rails::Engine
     config.to_prepare { Scrivito::Configuration.to_prepare }
 
     # make sure our exceptions cause an adequate error page and http status code
@@ -20,37 +18,25 @@ module ::Scrivito
 
     # Expose Scrivito SDK runtime to controller for logging.
     initializer "scrivito.log_runtime" do |app|
-      runtime =
-        begin
-          Scrivito::ControllerRuntime
-        rescue NameError
-          nil
-        end
-
-      if runtime
-        Scrivito::LogSubscriber.attach_to :scrivito
-        ActiveSupport.on_load(:action_controller) do
-          include runtime
-        end
+      Scrivito::LogSubscriber.attach_to :scrivito
+      ActiveSupport.on_load(:action_controller) do
+        include Scrivito::ControllerRuntime
       end
     end
 
-    initializer "scrivito.configure_database", :before => :load_config_initializers do |app|
-      Scrivito::Configuration.configure_cms_database
-    end
-
     initializer "scrivito.routing_helpers" do
-      if Rails.env == 'test'
-        ActionDispatch::TestRequest.__send__(:include, Scrivito::CmsTestRequest)
-      end
+      ActiveSupport.on_load(:action_controller) do
+        if Rails.env == 'test'
+          ActionDispatch::TestRequest.__send__(:include, Scrivito::TestRequest)
+        end
 
-      ActionController::Base.__send__(:include, CmsRoutingHelper)
-      ActionView::Base.__send__(:include, CmsRoutingHelper)
+        include Scrivito::RoutingHelper
+      end
     end
 
-    initializer "scrivito.add_assets" do |app|
+    initializer 'scrivito.add_sdk_assets' do |app|
       # Specify which file should be precompiled for packaging
-      app.config.assets.precompile += %w( scrivito_editing.js scrivito_editing.css scrivito.css )
+      app.config.assets.precompile += %w(scrivito_sdk.js scrivito_sdk.css)
       app.config.assets.precompile += %w(*.png *.jpg *.jpeg *.gif)
     end
 

data/lib/scrivito/tag_renderer.rb

@@ -0,0 +1,40 @@
+module Scrivito
+
+module TagRenderer
+
+  VOID_TAGS = %w[area base br col command embed hr img input keygen
+      link meta param source track wbr]
+
+  def render(given_options = {}, &block)
+    TagRenderer.render(view, self, given_options, &block)
+  end
+
+  class << self
+
+    def render(view, tag, given_options, &block)
+      tag_name = tag.tag_name
+      options = given_options.merge(formatted_options(tag))
+
+      if VOID_TAGS.include?(tag_name.to_s)
+        view.tag(tag_name, options)
+      else
+        view.content_tag(tag_name, tag.content(&block), 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
+    end
+
+  end
+
+end
+
+end

data/lib/scrivito/test_request.rb

@@ -0,0 +1,40 @@
+module Scrivito
+  #
+  # @api public
+  #
+  module TestRequest
+    #
+    # Make a test request to act as a CMS request.
+    # This is necessary for testing controllers that include {Scrivito::ControllerActions}, because
+    # these controllers do not have explicit routes by default.
+    #
+    # @api public
+    # @param [Scrivito::BasicObj Obj] test_obj requested +Obj+
+    #
+    # @example
+    #   class MyPageControllerTest < ActionController::TestCase
+    #     test 'should respond with success' do
+    #       request.for_scrivito_obj
+    #       get :index
+    #       assert_response :success
+    #     end
+    #   end
+    #
+    def for_scrivito_obj(test_obj = nil)
+      # prepare the env as if the given obj was loaded by Scrivito::CmsEnv
+      env[Scrivito::CmsEnv::OBJ_ENV_KEY] = test_obj if test_obj
+
+      class << self
+        def assign_parameters(routes, controller_path, action, parameters = {})
+          super(routes, controller_path, action, parameters)
+        rescue ActionController::RoutingError, AbstractController::ActionNotFound => e
+          begin
+            super(routes, "scrivito/cms_dispatch", action, parameters)
+          rescue ActionController::RoutingError, AbstractController::ActionNotFound
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scrivito/type_computer.rb

@@ -3,11 +3,10 @@ module Scrivito
 class TypeComputer
   def initialize(base_class, fallback_class)
     @base_class, @fallback_class = base_class, fallback_class
-    @type_cache = {}
   end
 
   def compute_type(obj_class)
-    @type_cache.fetch(obj_class) { calculate_type(obj_class) }
+    load_class(obj_class) || @fallback_class
   end
 
   def special_class?(klass)
@@ -16,10 +15,6 @@ class TypeComputer
 
   private
 
-  def calculate_type(obj_class)
-    load_class(obj_class) || @fallback_class
-  end
-
   def load_class(obj_class)
     klass = obj_class.constantize
     klass if inherits_from_base?(klass)

data/lib/scrivito/user.rb

@@ -46,17 +46,20 @@ module Scrivito
       #       end
       #     end
       #   end
-      def define(id)
+      def define(id, &block)
         assert_valid_id(id)
-        user_definition = UserDefinition.new(id)
-        yield user_definition if block_given?
-        user_definition.user
+        define_user(id, &block)
       end
 
-      def anonymous_admin
-        explicit_rules = {}
-        VERBS.each { |verb| explicit_rules[[:can_always, verb, :workspace]] = nil }
-        new(id: nil, explicit_rules: explicit_rules)
+      #
+      # Returns an anonymous system user, who can always create workspaces, can always read, write,
+      # publish, delete and invite to any workspace.
+      #
+      # @api public
+      # @return [Scrivito::User] the system user
+      #
+      def system_user
+        define_user { |user| user.is_admin! }
       end
 
       def unknown_user(id)
@@ -73,6 +76,12 @@ module Scrivito
 
       private
 
+      def 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 can not be blank') if id.blank?
         raise ScrivitoError.new('User id is too long (max length 64)') if id.length > 64
@@ -99,7 +108,8 @@ module Scrivito
 
     def can?(verb, workspace)
       assert_valid_verb(verb)
-      can_always?(verb, :workspace) || owner_of?(workspace) && !can_never?(verb, :workspace)
+      verb == :read && workspace.published? || can_always?(verb, :workspace) ||
+          owner_of?(workspace) && !can_never?(verb, :workspace)
     end
 
     def can_always?(verb, subject)
@@ -152,7 +162,7 @@ module Scrivito
 
     def suggest_users(input)
       if suggest_users_proc
-        suggested_users = suggest_users_proc.call(input)
+        suggested_users = sandbox_suggest_user_proc(input)
         suggested_users.nil? ? [] : suggested_users
       else
         user = self.class.find(input)
@@ -160,11 +170,9 @@ module Scrivito
       end
     end
 
-    def as_json(options = nil)
-      {
-        id: id,
-        description: description,
-      }
+    # Per convention only anonymous admin has a nil id.
+    def system_user?
+      id.nil?
     end
 
     private
@@ -176,5 +184,15 @@ module Scrivito
     def assert_valid_verb(verb)
       raise ScrivitoError.new("Invalid verb '#{verb}'") unless VERBS.include?(verb)
     end
+
+    def sandbox_suggest_user_proc(input)
+      suggest_users_proc.call(input)
+    rescue Exception => e
+      Rails.logger.error(%{
+Method `suggest_users' of the user "#{id}" raised an error on input "#{input}": #{e}
+  #{e.backtrace.join("\n")}
+      })
+      nil
+    end
   end
 end