scrivito_sdk 0.50.1 → 0.60.0.rc1

data/lib/scrivito/cms_rest_api/{attribute_serializer.rb → legacy_attribute_serializer.rb}

@@ -1,6 +1,6 @@
 module Scrivito
   class CmsRestApi
-    module AttributeSerializer
+    module LegacyAttributeSerializer
       class << self
 
         def generate_widget_pool_changes(widget_hash)

data/lib/scrivito/cms_routing.rb

@@ -73,30 +73,36 @@ class CmsRouting < Struct.new(:request, :main_app)
   end
 
   def path_or_url_for_objs(obj, path_or_url, options = {})
+    if editing_context.display_mode == "editing"
+      return id_path_or_url_for_objs(obj, path_or_url, options)
+    end
+
     permalink = obj.permalink
     if permalink
       main_app.public_send("scrivito_permalink_#{path_or_url}", options.merge(:permalink => permalink))
     elsif obj.homepage?
       main_app.public_send("scrivito_root_#{path_or_url}", options)
-    else
-      if obj.binary? && editing_context.display_mode != "editing"
-        if obj.binary_url
-          obj.binary_url
-        else
-          LINK_TO_EMPTY_BLOB
-        end
+    elsif obj.binary?
+      if obj.binary_url
+        obj.binary_url
       else
-        main_app.public_send(
-          "cms_id_#{path_or_url}",
-          options.merge(
-            id: obj.id,
-            slug: obj.slug.presence
-          )
-        )
+        LINK_TO_EMPTY_BLOB
       end
+    else
+      id_path_or_url_for_objs(obj, path_or_url, options)
     end
   end
 
+  def id_path_or_url_for_objs(obj, path_or_url, options)
+    main_app.public_send(
+      "cms_id_#{path_or_url}",
+      options.merge(
+        id: obj.id,
+        slug: obj.slug.presence
+      )
+    )
+  end
+
   def editor_authenticated?
     editing_context.authenticated_editor?
   end

data/lib/scrivito/configuration.rb

@@ -65,7 +65,7 @@ module Scrivito
       # @example Return a "dummy" {Scrivito::User}
       #   Scrivito.configure do |config|
       #     config.find_user do |user_id|
-      #       Scrivito::User.new(user_id)
+      #       Scrivito::User.define(user_id)
       #     end
       #   end
       # @example Find the user with a custom user model and convert it to a {Scrivito::User}

data/lib/scrivito/controller_actions.rb

@@ -84,7 +84,7 @@ module ControllerActions
   end
 
   def editing_context
-    request.env[EditingContextMiddleware::ENVKEY] || EditingContext.new
+    EditingContextMiddleware.from_request(request)
   end
 
   delegate :comparison, to: :editing_context
@@ -97,9 +97,17 @@ module ControllerActions
   end
 
   def load_widget
-    if widget = @obj.widget_from_pool(params[:widget_id])
-      widget
-    elsif comparison.active? # The "diff" mode.
+    widget = widget_from_current_revision || widget_from_base_revision
+    raise ResourceNotFound, "Widget with ID #{params[:widget_id]} not found!" unless widget
+    widget
+  end
+
+  def widget_from_current_revision
+    @obj.widget_from_pool(params[:widget_id])
+  end
+
+  def widget_from_base_revision
+    if comparison.active? # The "diff" mode.
       @obj.in_revision(editing_context.selected_workspace.base_revision)
         .widget_from_pool(params[:widget_id])
     end

data/lib/scrivito/date_attribute.rb

@@ -11,6 +11,14 @@ module Scrivito
         raise "The value is not a valid ISO date time: #{iso_date_time.inspect}"
       end
     end
+
+    def self.serialize(attribute_value)
+      attribute_value = case attribute_value
+        when Date then attribute_value.to_time
+        when Time then attribute_value.to_time.utc
+        end
+      attribute_value.strftime('%Y%m%d%H%M%S') if attribute_value
+    end
   end
 
 end

data/lib/scrivito/diff.rb

@@ -7,7 +7,7 @@ class Diff; class << self
 
   def for(mode, field_type, old, new)
     case field_type
-    when "widget"
+    when "widgetlist"
       ListComparison.for(mode, old || [], new || [])
     when "html"
       for_html(mode, old, new)

data/lib/scrivito/editing_context.rb

@@ -20,7 +20,7 @@ class EditingContext
       if @editor && !@editor.is_a?(Scrivito::User)
         raise ScrivitoError.new(
           "The editing auth callback has to return a Scrivito::User or falsy."+
-          " To upgrade please return Scrivito::User.new(id) and set the permissions" +
+          " To upgrade please return Scrivito::User.define(id) and set the permissions" +
           " of the user. See the documentation for further details."
         )
       end

data/lib/scrivito/editing_context_middleware.rb

@@ -6,7 +6,7 @@ class EditingContextMiddleware
   ENVKEY = 'SCRIVITO_EDITING_CONTEXT'
 
   def self.from_request(request)
-    request.env[ENVKEY]
+    request.env[ENVKEY] || EditingContext.new
   end
 
   def initialize(app)

data/lib/scrivito/errors.rb

@@ -8,4 +8,8 @@ end
 class ResourceNotFound < ScrivitoError
 end
 
+# @api public
+class ObjClassNotFound < ResourceNotFound
+end
+
 end # module Scrivito

data/lib/scrivito/link_parser.rb

@@ -10,7 +10,7 @@ module Scrivito
     def parse(url)
       uri = Addressable::URI.parse(url)
 
-      if (params = route(uri.to_s)) && params[:controller] == 'scrivito/ui'
+      if (params = sdk_route(uri.to_s)) && params[:controller] == 'scrivito/ui'
         uri.path = params[:application_path]
       end
 
@@ -69,6 +69,11 @@ module Scrivito
       route_params && route_params[:controller] == 'scrivito/cms_dispatch'
     end
 
+    def sdk_route(uri)
+      Scrivito::SdkEngine.routes.recognize_path(uri.to_s, method: :get)
+    rescue ActionController::RoutingError
+    end
+
     def route(uri)
       Rails.application.routes.recognize_path(uri.to_s, method: :get)
     rescue ActionController::RoutingError

data/lib/scrivito/migrations/cms_backend.rb

@@ -2,67 +2,36 @@ module Scrivito
   module Migrations
     class CmsBackend
       def read
-        obj = find_migration_store_obj
-
-        if obj
-          obj[attribute_name]
+        if obj = find_migration_store_obj
+          obj.data_from_cms.value_of('versions')
         else
-          initial_value
+          ''
         end
       end
 
       def save(value)
-        CmsRestApi.put(
-          endpoint("objs/#{migration_store_obj.id}"),
-          :obj => {
-            attribute_name => value
-          }
-        )
+        if Workspace.current.uses_obj_classes
+          CmsRestApi.put(endpoint("objs/#{migration_store_obj.id}"), obj: {versions: value})
+        else
+          CmsRestApi.put(endpoint("objs/#{migration_store_obj.id}"),
+            obj: {versions: ['string', value]})
+        end
       end
 
       private
 
       def create
-        # Create obj class
-        CmsRestApi.post(
-          endpoint('obj_classes'),
-          :obj_class => {
-            :name => obj_class_name,
-            :attributes => [
-              {
-                :name => attribute_name,
-                :type => :text,
-              },
-            ],
-            :type => :publication,
-            :title => obj_class_name,
-          }
-        )
-
-        # Create obj
-        CmsRestApi.post(
-          endpoint('objs'),
-          :obj => {
-            :_path => path,
-            :_obj_class => obj_class_name,
-            attribute_name => initial_value,
-          }
-        )
-
-        # Deactivate obj class
-        CmsRestApi.put(
-          endpoint("obj_classes/#{obj_class_name}"),
-          :obj_class => {
-            :is_active => false,
-          }
-        )
+        if Workspace.current.uses_obj_classes
+          CmsRestApi.post(endpoint('objs'),
+            obj: {_path: path, _obj_class: 'MigrationStore', versions: ''})
+        else
+          CmsRestApi.post(endpoint('objs'),
+            obj: {_path: path, _obj_class: 'MigrationStore', versions: ['string', '']})
+        end
       end
 
       def migration_store_obj
-        unless find_migration_store_obj
-          create
-        end
-
+        create unless find_migration_store_obj
         find_migration_store_obj
       end
 
@@ -70,22 +39,10 @@ module Scrivito
         Obj.find_by_path(path)
       end
 
-      def attribute_name
-        'versions'
-      end
-
-      def obj_class_name
-        'MigrationStore'
-      end
-
       def path
         '/_internal/migration-store'
       end
 
-      def initial_value
-        ''
-      end
-
       def endpoint(path)
         "workspaces/#{Workspace.current.id}/#{path}"
       end

data/lib/scrivito/migrations/migration_store.rb

@@ -15,7 +15,6 @@ module Scrivito
 
       def add_version(version)
         versions << version
-
         backend.save(MultiJson.dump(versions))
       end
     end

data/lib/scrivito/model_library.rb

@@ -1,7 +1,7 @@
 module Scrivito
 
 #
-# @api private
+# @api public
 #
 class ModelLibrary
   attr_reader :custom_pages, :custom_widgets, :custom_paths
@@ -13,7 +13,7 @@ class ModelLibrary
   #
   # Clears model cache.
   #
-  # @api private
+  # @api public
   # @see Scrivito.models
   #
   def clear_cache
@@ -25,7 +25,7 @@ class ModelLibrary
   #
   # Configures which models Scrivito assumes as pages and widgets.
   #
-  # @api private
+  # @api public
   # @see Scrivito.models
   #
   def define(&block)
@@ -35,7 +35,7 @@ class ModelLibrary
   #
   # Lists available page models.
   #
-  # @api private
+  # @api public
   # @see Scrivito.models
   # @return [Scrivito::ClassCollection] available page classes
   #
@@ -46,7 +46,7 @@ class ModelLibrary
   #
   # Lists available widget models.
   #
-  # @api private
+  # @api public
   # @see Scrivito.models
   # @return [Scrivito::ClassCollection] available widget classes
   #
@@ -57,7 +57,7 @@ class ModelLibrary
   #
   # Lists available paths to scan for models.
   #
-  # @api private
+  # @api public
   # @see Scrivito.models
   # @return [Array<String>] available paths to scan for models.
   #

data/lib/scrivito/obj_class.rb

@@ -4,13 +4,36 @@ module Scrivito
   # are defined by {Scrivito::Attribute} instances.
   #
   # @api public
+  # @deprecated
   class ObjClass
     include ModelIdentity
 
     class << self
       #
+      # Remove all obj classes.
+      #
+      # This method removes all classes in the corresponding workspace. By doing that it migrates
+      # the contents of the workspace. The migrated workspace will not use {Scrivito::ObjClass},
+      # {Scrivito::Attribute} etc. anymore to determine which attributes an {Obj} has, but will
+      # use attributes defined in model with {Scrivito::AttributeContent::ClassMethods#attribute}.
+      # The +id+ of the current workspace must be +"rtc"+.
+      # For detailed migration instructions please visit https://scrivito.com/obj-class-migration.
+      #
+      # @api public
+      # @see Scrivito::AttributeContent::ClassMethods#attribute
+      # @raise [ScrivitoError] if the +id+ of the corresponding workspace is not +"rtc"+
+      #
+      def remove
+        if Workspace.current.rtc?
+          Workspace.current.api_request(:delete, '/obj_classes')
+        else
+          raise ScrivitoError, 'Scrivito::ObjClass.remove is only allowed in the "rtc" workspace.'
+        end
+      end
+
       # Returns all obj classes.
       # @api public
+      # @deprecated
       # @return Scrivito::ObjClassCollection
       #
       def all
@@ -20,6 +43,7 @@ module Scrivito
       # Finds an obj class by its name.
       #
       # @api public
+      # @deprecated
       #
       # @example Find the obj class named "Homepage" in the current {Scrivito::Workspace}.
       #   ObjClass.find('Homepage')
@@ -40,6 +64,7 @@ module Scrivito
       # Creates a new obj class and persists it in the CMS.
       #
       # @api public
+      # @deprecated
       #
       # This allows you to set the different properties of an obj class by
       # providing a hash with the property names as keys and the values you want
@@ -80,26 +105,7 @@ module Scrivito
       #
       # @return [Scrivito::ObjClass]
       def create(properties)
-        properties = properties.with_indifferent_access
-
-        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]
-          properties[:attributes].map! do |attribute|
-            attribute.respond_to?(:to_cms_rest_api) ? attribute : Attribute.new(attribute)
-          end
-        end
-
-        workspace = Workspace.current
-        raw_obj_class_data = workspace.api_request(:post, '/obj_classes',
-            obj_class: format_properties_for_cms(properties))
-        new(ObjClassData.new(raw_obj_class_data), workspace)
+        Scrivito.raise_obj_class_deprecated_error
       end
 
       private
@@ -136,6 +142,7 @@ module Scrivito
     end
 
     # @api public
+    # @deprecated
     # Returns true if this ObjClass was created with a +is_binary+ option.
     # Creating ObjClass with this option is deprecated and will be removed.
     #
@@ -146,16 +153,20 @@ module Scrivito
 
     # @!attribute [r] id
     #   @api public
+    #   @deprecated
     #   @return [String] unique identifier of this obj class
     # @!attribute [r] name
     #   @api public
+    #   @deprecated
     #   @return [String] the name of this obj class
     # @!attribute [r] is_active
     #   @api public
+    #   @deprecated
     #   @return [Boolean] whether instances can be created with this obj class
     delegate :id, :name, :is_active, to: :obj_class_data
 
     # @api public
+    # @deprecated
     # @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
@@ -172,6 +183,7 @@ module Scrivito
     alias_method :binary?, :is_binary
 
     # @api public
+    # @deprecated
     # @return [Scrivito::AttributeCollection] the attributes of this obj class.
     #
     # @example Find an attribute named "locale" for the obj class "Homepage".
@@ -191,6 +203,7 @@ module Scrivito
     attr_reader :attributes
 
     # @api public
+    # @deprecated
     # Updates this obj class and persists the changes in the CMS. It is not possible to
     # update the +name+.
     #
@@ -221,34 +234,7 @@ module Scrivito
     #
     # @return [nil]
     def update(properties)
-      params = properties.with_indifferent_access
-
-      if params.has_key?(:is_binary)
-        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)
-        raise ScrivitoError, "#{self.class} does not support changing 'name'. Please remove" \
-          " the key from the properties."
-      end
-
-      if params.has_key?(:attributes)
-        params[:attributes].map! do |attribute|
-          attribute = Attribute.new(attribute) unless attribute.respond_to?(:to_cms_rest_api)
-          attribute.obj_class = self
-          attribute.to_cms_rest_api
-        end
-      end
-
-      raw_obj_class_data = workspace.api_request(:put, "/obj_classes/#{name}", obj_class: params)
-      update_obj_class_data(ObjClassData.new(raw_obj_class_data))
-      workspace.reload
-
-      nil
+      Scrivito.raise_obj_class_deprecated_error
     end
 
     def update_obj_class_data(obj_class_data)