infopark_cloud_connector 7.0.2 → 7.1.0

data/lib/infopark_cloud_connector.rb

@@ -1,5 +1,4 @@
 require 'rails_connector/core_extensions'
-require 'rails_connector/rack_middlewares'
 require "rails_connector/errors"
 
 # @api public

data/lib/rails_connector/attribute_content.rb

@@ -24,24 +24,11 @@ module AttributeContent
     end
   end
 
-  def widgets(attribute_name)
-    if widget_data = read_widget_attribute(attribute_name)
-      (widget_data['list'] || []).map do |list_item|
-        widget_from_pool(list_item['widget'])
-      end
-    else
-      []
-    end
-  end
-
-  def read_attribute(attribute_name, skip_widgets = true)
-    if skip_widgets && (type_of_attribute(attribute_name) == 'widget')
-      raise "Field #{attribute_name} not (yet) available, since it's a widget"
-    end
+  def read_attribute(attribute_name)
     @attribute_cache.fetch(attribute_name) do
       (raw_value, attribute_type) = data_from_cms.value_and_type_of(attribute_name)
       @attribute_cache[attribute_name] =
-        prepare_attribute_value(raw_value, attribute_type)
+        prepare_attribute_value(raw_value, attribute_type, attribute_name)
     end
   end
 
@@ -62,7 +49,7 @@ module AttributeContent
     has_attribute?(key) ? read_attribute(key) : nil
   end
 
-  # Hook method to control which widget classes should be avaiable for this page.
+  # Hook method to control which widget classes should be available for this page.
   # Override it to allow only certain classes or none.
   # Must return either +NilClass+, or +Array+.
   #
@@ -79,40 +66,17 @@ module AttributeContent
   def valid_widget_classes_for(field_name)
   end
 
-  def text_links
-    read_attribute('_text_links')
-  end
-
   private
 
-  def read_widget_attribute(attribute_name)
-    assert_widget_attribute(attribute_name)
-
-    widget_data = read_attribute(attribute_name.to_s, false)
-
-    if widget_data && widget_data['layout'] # Old style widget fields have a 'layout' key.
-      Deprecation.warn("Key 'layout' found in attribute '#{attribute_name}' of type 'widget'." \
-          ' Please migrate the content so that is uses embedded widgets.')
-    end
-
-    widget_data
-  end
-
-  def assert_widget_attribute(attribute_name)
-    unless type_of_attribute(attribute_name) == 'widget'
-      raise "Not a widget field: #{attribute_name}."
-    end
-  end
-
   def update_data(data)
     self.data_from_cms = data
     @attribute_cache = {}
   end
 
-  def prepare_attribute_value(attribute_value, attribute_type)
+  def prepare_attribute_value(attribute_value, attribute_type, attribute_name)
     case attribute_type
     when "html"
-      StringTagging.tag_as_html(convert_links(attribute_value), self)
+      StringTagging.tag_as_html(attribute_value)
     when "date"
       DateAttribute.parse(attribute_value) if attribute_value
     when "linklist"
@@ -121,44 +85,13 @@ module AttributeContent
       BasicObj.find([attribute_value]).first
     when "referencelist"
       BasicObj.find(attribute_value).compact
+    when "widget"
+      build_widgets(attribute_value, attribute_name)
     else
       attribute_value
     end
   end
 
-  def convert_links(html)
-    if html
-      html.gsub(%r{<?\binternallink:(\d+)\b>?(['"]?)}) do
-        link, postfix = text_link_map[$1], $2
-        link ? convert_link(link, postfix) : missing_link_url(postfix)
-      end
-    end
-  end
-
-  def convert_link(link, postfix)
-    link.internal? ? convert_internal_link(link, postfix) : convert_external_link(link, postfix)
-  end
-
-  def convert_internal_link(link, postfix)
-    link.obj ? decorate_link_url(link.internal_url, link, postfix) : missing_link_url(postfix)
-  end
-
-  def convert_external_link(link, postfix)
-    decorate_link_url(link.external_url, link, postfix)
-  end
-
-  def decorate_link_url(url, link, postfix)
-    "#{url}#{link.query_and_fragment}#{postfix} #{link.html_attribute_snippet}"
-  end
-
-  def missing_link_url(postfix)
-    "#{CmsRoutingHelper::LINK_TO_UNREACHABLE}#{postfix}"
-  end
-
-  def text_link_map
-    @_text_link_map ||= text_links.each_with_object({}) { |link, map| map[link.id] = link }
-  end
-
   def build_links(link_definitions)
     if link_definitions.present?
       link_definitions = link_definitions.map(&:with_indifferent_access)
@@ -175,6 +108,24 @@ module AttributeContent
     end
   end
 
+  def build_widgets(widget_data, attribute_name)
+    if widget_data
+      if widget_data['layout'] # Old style widget fields have a 'layout' key.
+        Deprecation.warn("Key 'layout' found in attribute of type 'widget' in obj '#{id}'." \
+            ' Please migrate the content so that is uses embedded widgets.')
+      end
+
+      (widget_data['list'] || []).map do |list_item|
+        widget_from_pool(list_item['widget']).tap do |widget|
+          widget.container = self
+          widget.container_field_name = attribute_name
+        end
+      end
+    else
+      []
+    end
+  end
+
   module ClassMethods
     # Instantiate an {BasicObj Obj} instance from obj_data.
     # If a subclass of Obj with the same name as the property +_obj_class+ exists,

data/lib/rails_connector/backend_error.rb

@@ -0,0 +1,4 @@
+module RailsConnector
+  class BackendError < RailsConnector::CommunicationError
+  end
+end

data/lib/rails_connector/basic_obj.rb

@@ -20,6 +20,51 @@ module RailsConnector
       @_type_computer = nil
     end
 
+    # Create a new {BasicObj Obj} in the cms
+    #
+    # This allows you to set the different attributes types of an obj by
+    # providing a hash with the attributes names as key and the values you want
+    # to set as values
+    #
+    # @example Reference lists have to be provided as an Array of {BasicObj Objs}
+    #   Obj.create(:reference_list => [other_obj])
+    #
+    # @example Passing an {BasicObj Obj} allows you to set a reference
+    #   Obj.create(:reference => other_obj)
+    #
+    # @example you can upload files by passing a ruby File object
+    #   Obj.create(:blob => File.new("image.png"))
+    #
+    # @example Link list can be set as an Array of {Link Links}
+    #   Obj.create(:link_list => [
+    #     # 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)
+    #
+    # @example String, text, html and enum can be set by passing a {String} value
+    #   Obj.create(:title => "My Title")
+    #
+    # @example Arrays of {String Strings} allow you to set multi enum fields
+    #   Obj.create(:tags => ["ruby", "rails"])
+    #
+    # @api public
+    # @param [Hash] attributes
+    # @return [Obj] the newly created {BasicObj Obj}
+    def self.create(attributes)
+      converted_attributes = CmsRestApi::AttributeSerializer.convert(attributes)
+
+      json = CmsRestApi.post("workspaces/#{Workspace.current.id}/objs",
+                             obj: converted_attributes)
+
+      find(json['id'])
+    end
+
     # Create a new {BasicObj Obj} instance with the given values and attributes.
     # Normally this method should not be used.
     # Instead Objs should be loaded from the cms database.
@@ -38,19 +83,27 @@ module RailsConnector
 
     ### FINDERS ####################
 
-    # Find an {BasicObj Obj} by its id.
+    # Find a {BasicObj Obj} by its id.
     # If the paremeter is an Array containing ids, return a list of corresponding Objs.
     # @param [String, Integer, Array<String, Integer>]id_or_list
     # @return [Obj, Array<Obj>]
     # @api public
     def self.find(id_or_list)
-      case id_or_list
-      when Array
-        find_objs_by(:id, id_or_list).map(&:first)
-      else
-        obj = find_objs_by(:id, [id_or_list.to_s]).first.first
-        obj or raise ResourceNotFound, "Could not find Obj with id #{id_or_list}"
-      end
+      find_filtering_deleted(id_or_list, false)
+    end
+
+    def self.find_by_id(id)
+      find_objs_by(:id, [id]).first.first
+    end
+
+    # Find a {BasicObj Obj} by its id.
+    # If the paremeter is an Array containing ids, return a list of corresponding Objs.
+    # The results include deleted objects as well.
+    # @param [String, Integer, Array<String, Integer>]id_or_list
+    # @return [Obj, Array<Obj>]
+    # @api public
+    def self.find_including_deleted(id_or_list)
+      find_filtering_deleted(id_or_list, true)
     end
 
     # Returns a {ObjSearchEnumerator} with the given initial subquery consisting of the four arguments.
@@ -139,10 +192,19 @@ module RailsConnector
         raise ResourceNotFound, "Could not find Obj with permalink '#{permalink}'"
     end
 
-    # accepts the name of an "obj_by" - view and a list of keys.
+    # accepts the name of an "obj_by" - view, a list of keys
+    # and an "include_deleted" flag
     # returns a list of lists of Objs: a list of Objs for each given keys.
-    def self.find_objs_by(view, keys)
-      CmsBackend.find_obj_data_by(Workspace.current.data, view, keys).map do |list|
+    def self.find_objs_by(view, keys, include_deleted = false)
+      if include_deleted
+        finder_method_name = :find_obj_data_including_deleted_by
+      else
+        finder_method_name = :find_obj_data_by
+      end
+
+      result = CmsBackend.instance.public_send(finder_method_name, Workspace.current.revision, view, keys)
+
+      result.map do |list|
         list.map { |obj_data| BasicObj.instantiate(obj_data) }
       end
     end
@@ -167,6 +229,37 @@ module RailsConnector
     def self.valid_page_classes_beneath(parent_path)
     end
 
+    # Update the {BasicObj Obj} with the attributes provided.
+    #
+    # For an overview of which values you can set via this method see the
+    # documentation of {BasicObj.create Obj.create}.
+    #
+    # @api public
+    # @param [Hash] attributes
+    def update(attributes)
+      converted_attributes = CmsRestApi::AttributeSerializer.convert(attributes)
+
+      CmsRestApi.put(
+        "workspaces/#{Workspace.current.id}/objs/#{id}",
+        obj: converted_attributes)
+      Workspace.reload
+
+      reload
+      self
+    end
+
+    # Destroys the {BasicObj Obj} in the current {Workspace}
+    # @api public
+    def destroy
+      if children.any?
+        raise ClientError.new(I18n.t('rails_connector.errors.models.basic_obj.has_children'), 412)
+      end
+
+      CmsRestApi.delete("workspaces/#{Workspace.current.id}/objs/#{id}")
+
+      Workspace.reload
+    end
+
     def to_param
       id
     end
@@ -281,6 +374,13 @@ module RailsConnector
       (title || '').parameterize
     end
 
+    # This method determines the description that is shown in the changes list.
+    # It can be overriden by a custom value.
+    # @api public
+    def description_for_editor
+      slug.presence || path
+    end
+
     # Returns the title of the content or the name.
     # @return [String]
     # @api public
@@ -498,7 +598,7 @@ module RailsConnector
     # even if the obj_class in the database has changed.
     # @api public
     def reload
-      obj_data = CmsBackend.find_obj_data_by(Workspace.current.data, :id, [id.to_s]).first.first
+      obj_data = CmsBackend.instance.find_obj_data_by(Workspace.current.revision, :id, [id.to_s]).first.first
       update_data(obj_data)
     end
 
@@ -523,6 +623,10 @@ module RailsConnector
       read_attribute('_valid_until')
     end
 
+    def modification
+      read_attribute('_modification')
+    end
+
     # For a binary Obj, the content_type is equal to the content_type of its body (i.e. its data).
     # For non-binary Objs, a the default content_type is "text/html".
     # Override this method in subclasses to define a different content_type.
@@ -555,7 +659,7 @@ module RailsConnector
       if binary?
         nil
       else
-        StringTagging.tag_as_html(read_attribute('body'), self)
+        StringTagging.tag_as_html(read_attribute('body'))
       end
     end
 
@@ -601,13 +705,6 @@ module RailsConnector
       "<#{self.class} id=\"#{id}\" path=\"#{path}\">"
     end
 
-    def destroy
-      if children.any?
-        raise ClientError.new(I18n.t('rails_connector.errors.models.basic_obj.has_children'), 412)
-      end
-      CmsRestApi.delete("workspaces/#{Workspace.current.id}/objs/#{id}")
-    end
-
     def edit_view_path
       "#{obj_class.underscore}/edit"
     end
@@ -622,8 +719,54 @@ module RailsConnector
       find_blob.try(:id)
     end
 
+    # Reverts changes of this object.
+    # After calling this method it's as if this object has been never modified in the current working copy.
+    # 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.raise_if_reverting_objs_impossible
+
+      if binary?
+        raise "revert not supported for binary objs"
+      else
+        case modification
+        when nil
+          # don't do anything
+        when 'edited'
+          previous_content = CmsRestApi.get(
+              "revisions/#{Workspace.current.base_revision_id}/objs/#{id}")
+          previous_content.except!('id')
+          CmsRestApi.put("workspaces/#{Workspace.current.id}/objs/#{id}", {obj: previous_content})
+
+          reload
+        else
+          raise "cannot revert changes, since obj is #{modification}."
+        end
+      end
+    end
+
+    def container_and_field_name_for_widget(widget_id)
+      if field_name = field_name_in_data_for_widget(data_from_cms, widget_id)
+        return [self, field_name]
+      else
+        read_widget_pool.each do |parent_widget_id, widget_data|
+          if field_name = field_name_in_data_for_widget(widget_data, widget_id)
+            return [widget_from_pool(parent_widget_id), field_name]
+          end
+        end
+      end
+      [nil, nil]
+    end
+
     private
 
+    def field_name_in_data_for_widget(data, widget_id)
+      data.all_custom_attributes.find do |attribute_name|
+        (value, type) = data.value_and_type_of(attribute_name)
+        type == "widget" && value && (value['list'] || []).include?({"widget" => widget_id})
+      end
+    end
+
     def widget_data_from_pool(widget_id)
       read_widget_pool[widget_id]
     end
@@ -680,6 +823,16 @@ module RailsConnector
     class << self
       private
 
+      def find_filtering_deleted(id_or_list, include_deleted)
+        case id_or_list
+        when Array
+          find_objs_by(:id, id_or_list, include_deleted).map(&:first).compact
+        else
+          obj = find_objs_by(:id, [id_or_list.to_s], include_deleted).first.first
+          obj or raise ResourceNotFound, "Could not find Obj with id #{id_or_list}"
+        end
+      end
+
       def search_for_all
         ObjSearchEnumerator.new(nil).batch_size(1000)
       end

data/lib/rails_connector/basic_widget.rb

@@ -1,5 +1,7 @@
 module RailsConnector
 
+# The CMS widget class
+# @api public
 class BasicWidget
   include AttributeContent
 
@@ -11,7 +13,7 @@ class BasicWidget
     @_type_computer = nil
   end
 
-  attr_accessor :id, :obj
+  attr_accessor :id, :obj, :container, :container_field_name
 
   alias_method :initialize, :update_data
 
@@ -29,9 +31,48 @@ class BasicWidget
     self == other
   end
 
+  # Reverts content changes of this widget. Widget attributes of this widget are not effected.
+  # After calling this method it's as if this widget has been never modified in the current working copy.
+  # 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.raise_if_reverting_objs_impossible
+
+    previous_obj_content =
+        CmsRestApi.get("revisions/#{Workspace.current.base_revision_id}/objs/#{obj.id}")
+
+    if 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}",
+          { obj: {_widget_pool: {id => previous_widget_content}} })
+    else
+      raise "cannot revert changes, since widget is new."
+    end
+  end
+
   def hash
     (id + obj.id).hash
   end
+
+  # returns the entity ({BasicObj} or {BasicWidget}) that references this widget
+  # @api public
+  def container
+    @container || cache_container_and_field_name_for_widget.first
+  end
+
+  # returns the name of the widget field that references this widget
+  # @api public
+  def container_field_name
+    @container_field_name || cache_container_and_field_name_for_widget.second
+  end
+
+  private
+
+  def cache_container_and_field_name_for_widget
+    @cache_container_and_field_name_for_widget ||= obj.container_and_field_name_for_widget(id)
+  end
 end
 
 end