scrivito_sdk 0.16.0 → 0.17.0

data/lib/scrivito/attribute_collection.rb

@@ -0,0 +1,72 @@
+module Scrivito
+  # Represents a collection of {Scrivito::Attribute} instances. It provides convienient ways to
+  # find and add attributes and is returned by {Scrivito::ObjClass#attributes}. It behaves almost
+  # exactly as an Array, so methods like `#each`, `#select` etc. are available. It is not necessary
+  # to manually create an {Scrivito::AttributeCollection}, because a simple Array with attributes
+  # can be used instead.
+  #
+  # @api public
+  class AttributeCollection
+    include Enumerable
+    extend Forwardable
+
+    # Initializes an attribute collection for an obj class.
+    #
+    # @param [Scrivito::ObjClass] obj_class
+    # @param [Array<Scrivito::Attribute>] attributes
+    # @return [Scrivito::AttributeCollection]
+    def initialize(obj_class, attributes)
+      @obj_class = obj_class
+      @attributes = attributes
+    end
+
+    # Yields successive attributes of the collection. Implements the {Enumerable} interface.
+    # @api public
+    def_delegators :@attributes, :each
+
+    # Finds an attribute in this collection by its name.
+    #
+    # @api public
+    #
+    # See {Scrivito::ObjClass#attributes} for example of how to find an attribute by name.
+    #
+    # @param [String] name
+    # @return [Scrivito::Attribute]
+    # @raise [Scrivito::ResourceNotFound] Raised when no attribute with the given +name+ can be found.
+    def [](name)
+      attribute = @attributes.detect { |attribute| attribute.name == name.to_s }
+
+      unless attribute
+        raise ResourceNotFound, "Could not find #{Attribute} with name '#{name}' for" \
+          " obj class '#{@obj_class.name}'."
+      end
+
+      attribute
+    end
+
+    # Adds an attribute to this collection and updates the obj class.
+    #
+    # @api public
+    #
+    # See {Scrivito::ObjClass#attributes} for example of how to add an attribute.
+    #
+    # @param [Scrivito::Attribute, Hash] attribute The attribute to add. Can be either an attribute
+    #   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
+
+      @attributes << attribute
+
+      @obj_class.update(attributes: @attributes)
+
+      self
+    end
+    alias_method :<<, :add
+
+    # Deletes all attributes from this collection that are equal to the given attribute.
+    def_delegators :@attributes, :delete
+  end
+end

data/lib/scrivito/attribute_content.rb

@@ -4,7 +4,7 @@ module AttributeContent
   extend ActiveSupport::Concern
 
   def respond_to?(method_id, include_private=false)
-    if has_attribute?(method_id)
+    if has_custom_attribute?(method_id)
       true
     else
       super
@@ -12,7 +12,7 @@ module AttributeContent
   end
 
   def method_missing(method_name, *args)
-    if has_attribute?(method_name)
+    if has_custom_attribute?(method_name)
       read_attribute(method_name.to_s)
     else
       super
@@ -39,9 +39,10 @@ module AttributeContent
     end
   end
 
-  def has_attribute?(name)
+  def has_custom_attribute?(name)
     data_from_cms.has_custom_attribute?(name.to_s)
   end
+  alias_method :has_attribute?, :has_custom_attribute?
 
   # @return [String]
   def type_of_attribute(field_name)
@@ -121,6 +122,8 @@ module AttributeContent
       DateAttribute.parse(attribute_value) if attribute_value
     when "linklist"
       build_links(attribute_value)
+    when "link"
+      build_link(attribute_value)
     when "reference"
       BasicObj.find([attribute_value]).first
     when "referencelist"
@@ -148,6 +151,39 @@ module AttributeContent
     end
   end
 
+  def build_link(attribute_value)
+    return unless attribute_value
+    
+    if attribute_value['destination']
+      build_internal_link(attribute_value)
+    else
+      build_external_link(attribute_value)
+    end
+  end
+
+  def build_internal_link(attribute_value)
+    properties = {
+      obj: Obj.find(attribute_value['destination']),
+      title: attribute_value['title'],
+      query: attribute_value['query'],
+      fragment: attribute_value['fragment'],
+      target: attribute_value['target'],
+    }
+
+    Link.new(properties)
+  rescue ResourceNotFound
+  end
+
+  def build_external_link(attribute_value)
+    properties = {
+      url: attribute_value['url'],
+      title: attribute_value['title'],
+      target: attribute_value['target'],
+    }
+
+    Link.new(properties)
+  end
+
   def build_widgets(widget_data, attribute_name)
     widget_data.map do |widget_id|
       widget = widget_from_pool(widget_id)

data/lib/scrivito/basic_obj.rb

@@ -42,6 +42,12 @@ module Scrivito
     #     Link.new(:obj => other_obj, :title => "Other Obj")
     #   ])
     #
+    # @example Passing a {Link Link} allows you to set a link.
+    #   Obj.create(
+    #     external_link: Link.new(url: 'http://www.example.com', title: 'Example')
+    #     internal_link: Link.new(obj: other_obj, title: 'Other Obj')
+    #   )
+    #
     # @example Dates attributes accept Time, Date and their subclasses (DateTime for example)
     #   Obj.create(:date => Time.new)
     #   Obj.create(:date => Date.now)
@@ -74,6 +80,7 @@ module Scrivito
       json = CmsRestApi.post(cms_rest_api_path, obj: api_attributes)
       obj = find(json['id'] || json['_id'])
       CmsRestApi::WidgetExtractor.notify_persisted_widgets(obj, widget_properties)
+      Workspace.current.reload
       obj
     end
 
@@ -106,11 +113,11 @@ module Scrivito
     # @return [Obj, Array<Obj>]
     # @api public
     def self.find(id_or_list)
-      Workspace.current.find_obj(id_or_list)
+      Workspace.current.objs.find(id_or_list)
     end
 
     def self.find_by_id(id)
-      Workspace.current.find_obj_by_id(id)
+      Workspace.current.objs.find_by_id(id)
     end
 
     # Find a {BasicObj Obj} by its id.
@@ -120,7 +127,7 @@ module Scrivito
     # @return [Obj, Array<Obj>]
     # @api public
     def self.find_including_deleted(id_or_list)
-      Workspace.current.find_obj_including_deleted(id_or_list)
+      Workspace.current.objs.find_including_deleted(id_or_list)
     end
 
     # Returns a {ObjSearchEnumerator} with the given initial subquery consisting of the four arguments.
@@ -138,7 +145,7 @@ module Scrivito
     # @return [ObjSearchEnumerator]
     # @api public
     def self.where(field, operator, value, boost = nil)
-      ObjSearchEnumerator.new.and(field, operator, value, boost)
+      Workspace.current.objs.where(field, operator, value, boost)
     end
 
     # Returns a {ObjSearchEnumerator} of all {BasicObj Obj}s.
@@ -147,7 +154,7 @@ module Scrivito
     # @api public
     def self.all
       if superclass == Scrivito::BasicObj
-        search_for_all
+        Workspace.current.objs.all
       else
         find_all_by_obj_class(name)
       end
@@ -158,7 +165,7 @@ module Scrivito
     # @return [ObjSearchEnumerator]
     # @api public
     def self.find_all_by_obj_class(obj_class)
-      search_for_all.and(:_obj_class, :equals, obj_class)
+      Workspace.current.objs.find_all_by_obj_class(obj_class)
     end
 
     # Find the {BasicObj Obj} with the given path.
@@ -167,7 +174,7 @@ module Scrivito
     # @return [Obj]
     # @api public
     def self.find_by_path(path)
-      Workspace.current.find_obj_by_path(path)
+      Workspace.current.objs.find_by_path(path)
     end
 
     # Find an {BasicObj Obj} with the given name.
@@ -193,7 +200,7 @@ module Scrivito
     # @return [Obj]
     # @api public
     def self.find_by_permalink(permalink)
-      Workspace.current.find_obj_by_permalink(permalink)
+      Workspace.current.objs.find_by_permalink(permalink)
     end
 
     # Returns the {BasicObj Obj} with the given permalink, or raise ResourceNotFound if no matching Obj exists.
@@ -257,7 +264,7 @@ 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
+      workspace.reload
       reload
       CmsRestApi::WidgetExtractor.notify_persisted_widgets(self, widget_properties)
       self
@@ -272,7 +279,7 @@ module Scrivito
 
       CmsRestApi.delete(cms_rest_api_path)
 
-      Workspace.reload
+      workspace.reload
     end
 
     def to_param
@@ -298,7 +305,7 @@ module Scrivito
         list << list.last + component
       end
       ancestor_paths[0] = "/"
-      Workspace.current.find_objs_by_paths(ancestor_paths)
+      Workspace.current.objs.find_by_paths(ancestor_paths)
     end
 
     # return a list of all child {BasicObj Obj}s.
@@ -307,7 +314,7 @@ module Scrivito
     def children
       return [] unless path
 
-      Workspace.current.find_objs_by_parent_path(path)
+      workspace.objs.find_by_parent_path(path)
     end
 
     ### ATTRIBUTES #################
@@ -464,6 +471,16 @@ module Scrivito
       end
     end
 
+    def has_attribute?(key)
+      key = key.to_s
+
+      if INTERNAL_KEYS.include?(key)
+        true
+      else
+        super
+      end
+    end
+
     # Reloads the attributes of this object from the database.
     # Notice that the ruby class of this Obj instance will NOT change,
     # even if the obj_class in the database has changed.
@@ -472,7 +489,7 @@ module Scrivito
       id = self.id.to_s
 
       reload_data = Proc.new do
-        CmsBackend.instance.find_obj_data_by(Workspace.current.revision, :id, [id]).first.first
+        CmsBackend.instance.find_obj_data_by(workspace.revision, :id, [id]).first.first
       end
 
       update_data(reload_data)
@@ -484,9 +501,11 @@ module Scrivito
       read_attribute('_obj_class')
     end
 
+    # Returns the {Scrivito::ObjClass} of this object.
+    # @return [Scrivito::ObjClass]
+    # @api public
     def obj_class
-      raise ScrivitoError, "BasicObj#obj_class is no longer available"+
-        ", please use BasicObj#obj_class_name instead."
+      ObjClass.find(obj_class_name)
     end
 
     # @api public
@@ -512,7 +531,7 @@ module Scrivito
       end
     end
 
-    def modification(revision=Workspace.current.base_revision)
+    def modification(revision=workspace.base_revision)
       return Modification::UNMODIFIED unless revision
 
       obj_data_from_revision = cms_data_for_revision(revision)
@@ -646,7 +665,7 @@ 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.current.assert_revertable
+      workspace.assert_revertable
 
       if binary?
         raise "revert not supported for binary objs"
@@ -656,7 +675,7 @@ module Scrivito
           # don't do anything
         when Modification::EDITED
           previous_content = CmsRestApi.get(
-              "revisions/#{Workspace.current.base_revision_id}/objs/#{id}")
+              "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
@@ -756,7 +775,15 @@ module Scrivito
     end
 
     def cms_rest_api_path(obj_id = id)
-      "#{self.class.cms_rest_api_path}/#{obj_id}"
+      "#{self.class.cms_rest_api_path(workspace)}/#{obj_id}"
+    end
+
+    def workspace
+      if revision.workspace
+        revision.workspace
+      else
+        raise ScrivitoError, "No workspace set for this obj"
+      end
     end
 
     def child_path?
@@ -776,8 +803,8 @@ module Scrivito
         CmsRestApi.post(cms_rest_api_path, obj: obj_attributes)
       end
 
-      def cms_rest_api_path
-        "workspaces/#{Workspace.current.id}/objs"
+      def cms_rest_api_path(workspace = Workspace.current)
+        "workspaces/#{workspace.id}/objs"
       end
 
       def prepare_attributes_for_rest_api(attributes, obj)
@@ -794,12 +821,6 @@ module Scrivito
 
         [api_attributes, widget_properties]
       end
-
-      private
-
-      def search_for_all
-        ObjSearchEnumerator.new.batch_size(1000)
-      end
     end
   end
 

data/lib/scrivito/basic_widget.rb

@@ -103,9 +103,11 @@ class BasicWidget
     data_from_cms.value_of('_obj_class')
   end
 
+  # Returns the {Scrivito::ObjClass} of this widget.
+  # @return [Scrivito::ObjClass]
+  # @api public
   def obj_class
-    raise ScrivitoError, "BasicWidget#obj_class is no longer available"+
-      ", please use BasicWidget#obj_class_name instead."
+    ObjClass.find(obj_class_name)
   end
 
   def ==(other)
@@ -121,19 +123,19 @@ class BasicWidget
   # This method does not work with +new+ or +deleted+ widgets.
   # This method also does also not work for the +published+ workspace or the +rtc+ working copy.
   def revert
-    Workspace.current.assert_revertable
+    workspace.assert_revertable
 
     case modification
     when Modification::UNMODIFIED
       # do nothing
     when Modification::EDITED
       previous_obj_content =
-          CmsRestApi.get("revisions/#{Workspace.current.base_revision_id}/objs/#{obj.id}")
+          CmsRestApi.get("revisions/#{workspace.base_revision_id}/objs/#{obj.id}")
       previous_widget_content = previous_obj_content["_widget_pool"]["#{id}"]
       previous_widget_content.delete_if do |attribute_name, _|
         type_of_attribute(attribute_name) == "widget"
       end
-      CmsRestApi.put("workspaces/#{Workspace.current.id}/objs/#{obj.id}",
+      CmsRestApi.put("workspaces/#{workspace.id}/objs/#{obj.id}",
           { obj: {_widget_pool: {id => previous_widget_content}} })
     else
       raise ScrivitoError, "cannot revert changes, since widget is #{modification}."
@@ -232,6 +234,14 @@ class BasicWidget
 
   private
 
+  def workspace
+    if revision.workspace
+      revision.workspace
+    else
+      raise ScrivitoError, "No workspace set for the obj of this widget"
+    end
+  end
+
   def data_from_cms
     if persisted?
       super

data/lib/scrivito/client_config.rb

@@ -1,24 +1,28 @@
 module Scrivito
 
-class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context)
+class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resource, :return_to)
+  def initialize(obj, editing_context, lookup_context, options = {})
+    super(obj, editing_context, lookup_context, *options.values_at(:resource, :return_to))
+  end
+
   def to_json
     config = {}
     config[:editing_context] = editing_context_config
+    config[:user_permissions] = user_permissions_config
     config[:i18n] = i18n_config
     config[:obj] = obj_config
-    config[:open_resource_dialog] = @resource_dialog_config
+    config[:resource_dialog] = resource_dialog_config
     config.to_json
   end
 
-  def open_resource_dialog(obj_id, redirect_to)
-    @resource_dialog_config = {
-      obj_id: obj_id,
-      redirect_to: redirect_to,
+  private
+
+  def user_permissions_config
+    {
+      publish_workspace: can_publish_workspace
     }
   end
 
-  private
-
   def editing_context_config
     {
       display_mode: editing_context.display_mode,
@@ -35,20 +39,32 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context)
     }
   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
 
   def obj_config
     if obj
-      {current_page: {
-        id: obj.id,
-        obj_class_name: obj.obj_class_name,
-        has_children: obj.children.any?,
-        has_conflict: obj.has_conflict?,
-        has_details_view: obj_has_details_view?,
-        modification: obj_modification,
-      }}
+      {
+        current_page: {
+          id: obj.id,
+          obj_class_name: obj.obj_class_name,
+          has_children: obj.children.any?,
+          has_conflict: obj.has_conflict?,
+          has_details_view: obj_has_details_view?,
+          modification: modification(obj),
+        }
+      }
+    else
+      {}
     end
   end
 
@@ -58,11 +74,22 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context)
     false
   end
 
-  def obj_modification
+  def resource_dialog_config
+    if resource
+      {
+        obj: Configuration.obj_formats.fetch('_default').call(resource),
+        return_to: return_to,
+      }
+    else
+      {}
+    end
+  end
+
+  def modification(obj_or_resource)
     if editing_context.comparison.active?
-      editing_context.comparison.modification(obj)
+      editing_context.comparison.modification(obj_or_resource)
     else
-      obj.modification
+      obj_or_resource.modification
     end
   end
 end