scrivito_sdk 0.17.0 → 0.18.0

data/lib/generators/cms/migration/templates/migration.erb

@@ -14,16 +14,16 @@ class <%= class_name %> < ::Scrivito::Migration
     #
     # To get you started, here is a list of the most common SDK methods to alter the CMS content.
     #
-    # @example Create a new obj class named "Homepage" of type "publication" that has a "string" attribute named "locale".
-    #   Scrivito::ObjClass.create(name: 'Homepage', type: :publication, attributes: [
+    # @example Create a new non-binary obj class named "Homepage" that has a "string" attribute named "locale".
+    #   Scrivito::ObjClass.create(name: 'Homepage', is_binary: false, attributes: [
     #     {name: 'locale', type: :string}
     #   ])
     #
     # @example Find the obj class named "Homepage".
     #   Scrivito::ObjClass.find('Homepage')
     #
-    # @example Update the "title" of an obj class named "Homepage".
-    #   Scrivito::ObjClass.find('Homepage').update(title: 'Home')
+    # @example Update the "is_active" attribute of the obj class named "Homepage".
+    #   Scrivito::ObjClass.find('Homepage').update(is_active: false)
     #
     # @example Add an "enum" attribute named "category" to the obj class named "Homepage".
     #   Scrivito::ObjClass.find('Homepage').attributes.add(name: 'category', type: :enum, values: %w(tech, social))

data/lib/scrivito/attribute_collection.rb

@@ -54,14 +54,9 @@ module Scrivito
     #   instance or an attribute property hash.
     # @return [Scrivito::AttributeCollection]
     def add(attribute)
-      unless attribute.respond_to?(:to_cms_rest_api)
-        attribute = Attribute.new(attribute)
-      end
-
+      attribute = Attribute.new(attribute) unless attribute.respond_to?(:to_cms_rest_api)
       @attributes << attribute
-
       @obj_class.update(attributes: @attributes)
-
       self
     end
     alias_method :<<, :add

data/lib/scrivito/attribute_content.rb

@@ -40,7 +40,8 @@ module AttributeContent
   end
 
   def has_custom_attribute?(name)
-    data_from_cms.has_custom_attribute?(name.to_s)
+    name = name.to_s
+    name != 'blob' && data_from_cms.has_custom_attribute?(name)
   end
   alias_method :has_attribute?, :has_custom_attribute?
 
@@ -54,7 +55,12 @@ module AttributeContent
   # @api public
   def [](key)
     key = key.to_s
-    has_attribute?(key) ? read_attribute(key) : nil
+
+    if key == '_obj_class'
+      obj_class
+    else
+      has_attribute?(key) ? read_attribute(key) : nil
+    end
   end
 
   # Hook method to control which widget classes should be available for this page.
@@ -85,8 +91,8 @@ module AttributeContent
       cms_data_in_revision = cms_data_for_revision(revision)
 
       if cms_data_in_revision
-        other_value = cms_data_in_revision.unchecked_value_of(attribute_name.to_s)
-        if data_from_cms.unchecked_value_of(attribute_name.to_s) == other_value
+        other_value = cms_data_in_revision.value_without_default_of(attribute_name.to_s)
+        if data_from_cms.value_without_default_of(attribute_name.to_s) == other_value
           Modification::UNMODIFIED
         else
           Modification::EDITED
@@ -102,6 +108,22 @@ module AttributeContent
     @attribute_cache = {}
   end
 
+  # Returns the obj class name of this object.
+  # @api public
+  # @return [String]
+  def obj_class_name
+    data_from_cms.value_of('_obj_class')
+  end
+
+  # Returns the obj class of this object.
+  # @api public
+  # @return [ObjClass]
+  def obj_class
+    if obj_class_data = CmsBackend.instance.find_obj_class_data_by_name(revision, obj_class_name)
+      ObjClass.new(obj_class_data, revision.workspace)
+    end
+  end
+
   private
 
   attr_writer :data_from_cms
@@ -140,7 +162,7 @@ module AttributeContent
       link_definitions = link_definitions.map(&:with_indifferent_access)
 
       object_ids = link_definitions.map { |link_data| link_data[:destination] }.compact.uniq
-      objects = object_ids.empty? ? [] : Obj.find(object_ids)
+      objects = object_ids.empty? ? [] : BasicObj.find(object_ids)
       link_definitions.each_with_object([]) do |link_data, links|
         obj = objects.detect { |o| o && o.id == link_data[:destination] }
         link = Link.new(link_data.merge(obj: obj))
@@ -153,7 +175,7 @@ module AttributeContent
 
   def build_link(attribute_value)
     return unless attribute_value
-    
+
     if attribute_value['destination']
       build_internal_link(attribute_value)
     else
@@ -163,7 +185,7 @@ module AttributeContent
 
   def build_internal_link(attribute_value)
     properties = {
-      obj: Obj.find(attribute_value['destination']),
+      obj: BasicObj.find(attribute_value['destination']),
       title: attribute_value['title'],
       query: attribute_value['query'],
       fragment: attribute_value['fragment'],

data/lib/scrivito/basic_obj.rb

@@ -6,6 +6,20 @@ module Scrivito
   # The CMS file class
   # @api public
   class BasicObj
+    UNIQ_ATTRIBUTES = %w[
+      _id
+      _path
+      _permalink
+    ].freeze
+
+    GENERATED_ATTRIBUTES = %w[
+      _conflicts
+      _last_changed
+      _modification
+      _obj_type
+      _text_links
+    ].freeze
+
     extend ActiveModel::Naming
 
     include AttributeContent
@@ -77,10 +91,9 @@ module Scrivito
     def self.create(attributes)
       attributes = with_default_obj_class(attributes)
       api_attributes, widget_properties = prepare_attributes_for_rest_api(attributes, nil)
-      json = CmsRestApi.post(cms_rest_api_path, obj: api_attributes)
-      obj = find(json['id'] || json['_id'])
+      json = Workspace.current.api_request(:post, '/objs', obj: api_attributes)
+      obj = find(json['_id'])
       CmsRestApi::WidgetExtractor.notify_persisted_widgets(obj, widget_properties)
-      Workspace.current.reload
       obj
     end
 
@@ -263,23 +276,36 @@ module Scrivito
     #   )
     def update(attributes)
       api_attributes, widget_properties = prepare_attributes_for_rest_api(attributes)
-      CmsRestApi.put(cms_rest_api_path, obj: api_attributes)
-      workspace.reload
-      reload
+      workspace.api_request(:put, "/objs/#{id}", obj: api_attributes)
+      reload_data
       CmsRestApi::WidgetExtractor.notify_persisted_widgets(self, widget_properties)
       self
     end
 
+    # Copies itself to a given path.
+    # @api public
+    # @param [Hash] options
+    # @option options [String,Symbol] :_path (nil) the path of the copy.
+    # @option options [String,Symbol] :_id (nil) the id of the copy.
+    # @option options [String,Symbol] :_permalink (nil) the permalink of the copy.
+    # @raise [ArgumentError] if +options+ includes invalid keys.
+    # @return [Obj] the created copy
+    # @example Copy a blog post.
+    #   blog_post = Obj.find_by_path('/blog/first_post')
+    #   blog_post.copy(_path: '/blog/second_post')
+    def copy(options)
+      options = options.stringify_keys.assert_valid_keys('_path', '_id', '_permalink')
+      json = workspace.api_request(:post, '/objs', obj: copyable_attributes.merge(options))
+      self.class.find(json['_id'])
+    end
+
     # Destroys the {BasicObj Obj} in the current {Workspace}
     # @api public
     def destroy
       if children.any?
         raise ClientError.new(I18n.t('scrivito.errors.models.basic_obj.has_children'), 412)
       end
-
-      CmsRestApi.delete(cms_rest_api_path)
-
-      workspace.reload
+      workspace.api_request(:delete, "/objs/#{id}")
     end
 
     def to_param
@@ -486,26 +512,15 @@ module Scrivito
     # even if the obj_class in the database has changed.
     # @api public
     def reload
-      id = self.id.to_s
-
-      reload_data = Proc.new do
-        CmsBackend.instance.find_obj_data_by(workspace.revision, :id, [id]).first.first
-      end
-
-      update_data(reload_data)
-    end
-
-    # @return [String]
-    # @api public
-    def obj_class_name
-      read_attribute('_obj_class')
+      workspace.reload
+      reload_data
     end
 
-    # Returns the {Scrivito::ObjClass} of this object.
-    # @return [Scrivito::ObjClass]
-    # @api public
-    def obj_class
-      ObjClass.find(obj_class_name)
+    def reload_data
+      id = self.id.to_s
+      update_data -> {
+        CmsBackend.instance.find_obj_data_by(workspace.revision, :id, [id]).first.first
+      }
     end
 
     # @api public
@@ -665,35 +680,23 @@ module Scrivito
     # This method does not work with +new+ or +deleted+ objects.
     # This method also does also not work for the +published+ workspace or the +rtc+ working copy.
     def revert
-      workspace.assert_revertable
+      assert_revertable
 
-      if binary?
-        raise "revert not supported for binary objs"
-      else
-        case modification
-        when Modification::UNMODIFIED
-          # don't do anything
-        when Modification::EDITED
-          previous_content = CmsRestApi.get(
-              "revisions/#{workspace.base_revision_id}/objs/#{id}")
-          updated_content = previous_content.except('id', '_id')
-
-          added_widget_ids = read_widget_pool.keys - previous_content['_widget_pool'].keys
-          added_widget_ids.each do |added_widget_id|
-            updated_content['_widget_pool'][added_widget_id] = nil
-          end
+      if modification == Modification::EDITED
+        base_revision_path = "revisions/#{workspace.base_revision_id}/objs/#{id}"
+        previous_attributes = CmsRestApi.get(base_revision_path).except('_id')
+        previous_widget_pool = previous_attributes['_widget_pool']
 
-          CmsRestApi.put(cms_rest_api_path, obj: updated_content)
+        ids_of_new_widgets = read_widget_pool.keys - previous_widget_pool.keys
+        ids_of_new_widgets.each { |widget_id| previous_widget_pool[widget_id] = nil }
 
-          reload
-        else
-          raise ScrivitoError, "cannot revert changes, since obj is #{modification}."
-        end
+        workspace.api_request(:put, "/objs/#{id}", obj: previous_attributes)
+        reload
       end
     end
 
     def mark_resolved
-      CmsRestApi.put(cms_rest_api_path, obj: {_conflicts: nil})
+      workspace.api_request(:put, "/objs/#{id}", obj: {_conflicts: nil})
       reload
     end
 
@@ -718,6 +721,10 @@ module Scrivito
       read_attribute('_conflicts') != nil
     end
 
+    def publishable?
+      !has_conflict?
+    end
+
     def all_widgets_from_pool
       read_widget_pool.keys.map do |widget_id|
         widget_from_pool(widget_id)
@@ -734,6 +741,24 @@ module Scrivito
       raise ScrivitoError.new('Could not generate a new unused widget id')
     end
 
+    # Generates a +Hash+ containing all public attributes. The hash will _not_ include attributes,
+    # which are read-only or used for internal purpose.
+    # @api public
+    # @return [Hash] a hash containing all public attributes.
+    # @example
+    #   old_obj = Obj.homepage
+    #   attrs = old_obj.to_h
+    #   puts attrs
+    #   #=> {"_obj_class"=>"Publication", "_path"=>"/", "_id"=>"f64a68258ca15faf", "_widget_pool"=>{}}
+    #   old_obj.destroy
+    #
+    #   new_obj = Obj.create(attrs)
+    #   puts new_obj == old_obj
+    #   #=> true
+    def to_h
+      data_from_cms.to_h.except(*GENERATED_ATTRIBUTES)
+    end
+
     private
 
     def cms_data_for_revision(revision)
@@ -774,10 +799,6 @@ module Scrivito
       Blob.find(blob_spec["id"]) if blob_spec
     end
 
-    def cms_rest_api_path(obj_id = id)
-      "#{self.class.cms_rest_api_path(workspace)}/#{obj_id}"
-    end
-
     def workspace
       if revision.workspace
         revision.workspace
@@ -794,17 +815,26 @@ module Scrivito
       self.class.prepare_attributes_for_rest_api(attributes, self)
     end
 
+    def copyable_attributes
+      workspace.api_request(:get, "/objs/#{id}")
+          .except(*GENERATED_ATTRIBUTES)
+          .except(*UNIQ_ATTRIBUTES)
+    end
+
+    def assert_revertable
+      workspace.assert_revertable
+      raise "revert not supported for binary objs" if binary?
+      if modification == Modification::NEW || modification == Modification::DELETED
+        raise ScrivitoError, "cannot revert changes, since obj is #{modification}."
+      end
+    end
+
     class << self
       def restore(obj_id)
         Workspace.current.assert_revertable
-
         base_revision_path = "revisions/#{Workspace.current.base_revision_id}/objs/#{obj_id}"
-        obj_attributes = CmsRestApi.get(base_revision_path).except('id').merge('_id' => obj_id)
-        CmsRestApi.post(cms_rest_api_path, obj: obj_attributes)
-      end
-
-      def cms_rest_api_path(workspace = Workspace.current)
-        "workspaces/#{workspace.id}/objs"
+        obj_attributes = CmsRestApi.get(base_revision_path).merge('_id' => obj_id)
+        Workspace.current.api_request(:post, '/objs', obj: obj_attributes)
       end
 
       def prepare_attributes_for_rest_api(attributes, obj)

data/lib/scrivito/basic_widget.rb

@@ -99,17 +99,6 @@ class BasicWidget
     @attributes_to_be_saved.nil?
   end
 
-  def obj_class_name
-    data_from_cms.value_of('_obj_class')
-  end
-
-  # Returns the {Scrivito::ObjClass} of this widget.
-  # @return [Scrivito::ObjClass]
-  # @api public
-  def obj_class
-    ObjClass.find(obj_class_name)
-  end
-
   def ==(other)
     other.respond_to?(:obj) && obj == other.obj && other.respond_to?(:id) && id == other.id
   end

data/lib/scrivito/client_config.rb

@@ -7,46 +7,33 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
 
   def to_json
     config = {}
-    config[:editing_context] = editing_context_config
+    config[:editing_context]  = editing_context_config
+    config[:i18n]             = i18n_config
+    config[:obj]              = obj_config
+    config[:resource_dialog]  = resource_dialog_config
+    config[:user]             = user_config
     config[:user_permissions] = user_permissions_config
-    config[:i18n] = i18n_config
-    config[:obj] = obj_config
-    config[:resource_dialog] = resource_dialog_config
     config.to_json
   end
 
   private
 
-  def user_permissions_config
-    {
-      publish_workspace: can_publish_workspace
-    }
-  end
-
   def editing_context_config
     {
       display_mode: editing_context.display_mode,
 
       selected_workspace: {
-        id: editing_context.selected_workspace.id,
-        title: editing_context.selected_workspace.title
+        id: selected_workspace.id,
+        title: selected_workspace.title
       },
 
       visible_workspace: {
-        id: editing_context.visible_workspace.id,
-        title: editing_context.visible_workspace.title
+        id: visible_workspace.id,
+        title: visible_workspace.title
       }
     }
   end
 
-  def can_publish_workspace
-    if editing_context.editor
-      editing_context.editor.able_to?(:publish_workspace)
-    else
-      false
-    end
-  end
-
   def i18n_config
     {locale: I18n.locale}
   end
@@ -61,6 +48,7 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
           has_conflict: obj.has_conflict?,
           has_details_view: obj_has_details_view?,
           modification: modification(obj),
+          restriction_messages: editor.restriction_messages_for(obj),
         }
       }
     else
@@ -77,7 +65,7 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
   def resource_dialog_config
     if resource
       {
-        obj: Configuration.obj_formats.fetch('_default').call(resource),
+        obj: Configuration.obj_formats.fetch('_default').call(resource, editor),
         return_to: return_to,
       }
     else
@@ -85,13 +73,40 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
     end
   end
 
+  def user_permissions_config
+    {
+      publish_workspace: editor.can?(:publish, selected_workspace)
+    }
+  end
+
+  def user_config
+    {
+      current: {
+        id: editor.id
+      }
+    }
+  end
+
   def modification(obj_or_resource)
-    if editing_context.comparison.active?
-      editing_context.comparison.modification(obj_or_resource)
+    comparison = editing_context.comparison
+    if comparison.active?
+      comparison.modification(obj_or_resource)
     else
       obj_or_resource.modification
     end
   end
+
+  def editor
+    editing_context.editor
+  end
+
+  def selected_workspace
+    editing_context.selected_workspace
+  end
+
+  def visible_workspace
+    editing_context.visible_workspace
+  end
 end
 
 end