scrivito_sdk 0.65.2 → 0.66.0.rc1

data/lib/scrivito/cms_rest_api/legacy_attribute_serializer.rb

@@ -1,105 +0,0 @@
-module Scrivito
-  class CmsRestApi
-    module LegacyAttributeSerializer
-      class << self
-
-        def generate_widget_pool_changes(widget_hash)
-          widget_pool_changes = {}
-
-          widget_hash.each do |widget, attributes|
-            if attributes.present?
-              widget_pool_changes[widget.id] =
-                self.convert(attributes)
-            else # Empty hash or nil
-              widget_pool_changes[widget.id] = attributes
-            end
-          end
-
-          widget_pool_changes
-        end
-
-        def convert(attributes)
-          Hash[
-            attributes.map do |attribute_name, value|
-              attribute_name = attribute_name.to_s
-
-              converted_value = if value.nil? || value == []
-                nil
-              elsif link_array?(value)
-                convert_links(value)
-              elsif value.is_a?(Link)
-                convert_link(value)
-              elsif value.is_a?(BasicObj)
-                value.id
-              elsif widget_array?(value)
-                convert_widgets(value)
-              elsif obj_array?(value)
-                value.map(&:id)
-              elsif value.is_a?(Time) || value.is_a?(Date)
-                convert_time(value)
-              elsif value.is_a?(Array)
-                value.map(&:to_s)
-              elsif value.is_a?(File)
-                Scrivito::CmsRestApi.upload_file(value)
-              elsif value.is_a?(UploadedBinary)
-                value.params
-              else
-                value.to_s
-              end
-
-              [attribute_name, converted_value]
-            end
-          ]
-        end
-
-        def convert_time(point_in_time)
-          time_object = if point_in_time.instance_of?(Date)
-            point_in_time.to_time
-          else
-            point_in_time.to_time.utc
-          end
-
-          time_object.strftime("%Y%m%d%H%M%S")
-        end
-
-        private
-
-        def widget_array?(value)
-          value.is_a?(Array) && value.all? do |element|
-            element.is_a?(BasicWidget)
-          end
-        end
-
-        def convert_widgets(value)
-          converted_widgets = value.map do |widget|
-            { 'widget' => widget.id }
-          end
-
-          { 'list' => converted_widgets }
-        end
-
-        def link_array?(value)
-          value.is_a?(Array) && value.all? do |element|
-            element.is_a?(Link)
-          end
-        end
-
-        def obj_array?(value)
-          value.is_a?(Array) && value.all? do |element|
-            element.is_a?(BasicObj)
-          end
-        end
-
-        def convert_links(links)
-          links.map do |link|
-            convert_link(link)
-          end
-        end
-
-        def convert_link(link)
-          link.to_cms_api_linklist_params
-        end
-      end
-    end
-  end
-end

data/lib/scrivito/image_tag_helper.rb

@@ -1,46 +0,0 @@
-module Scrivito
-
-class ImageTagHelper < Struct.new(:view_context)
-
-  def self.display_title(target)
-    if target.respond_to?(:display_title)
-      target.display_title
-    elsif target.respond_to?(:first) && target.first.respond_to?(:display_title)
-      target.first.display_title
-    elsif target.respond_to?(:filename)
-      target.filename
-    end
-  end
-
-  def options(obj, field_name, tag_options, editing_options)
-    tag_options.reverse_merge(src: scrivito_image_tag_src(obj, field_name, editing_options),
-        alt: scrivito_image_tag_alt(obj, field_name))
-  end
-
-  private
-
-  def scrivito_image_tag_src(obj, field_name, editing_options)
-    scrivito_image_tag_path(obj, field_name) || editing_options[:placeholder] ||
-        view_context.image_path('scrivito/image_placeholder.png')
-  end
-
-  def scrivito_image_tag_alt(obj, field_name)
-    self.class.display_title(obj[field_name])
-  end
-
-  def scrivito_image_tag_path(obj, field_name)
-    field_type = obj.type_of_attribute(field_name)
-    field_value = obj[field_name]
-
-    case field_type
-    when 'link', 'binary', 'reference'
-      field_value && view_context.scrivito_path(field_value)
-    when 'linklist'
-      path = view_context.scrivito_path(field_value)
-      path == CmsRouting::LINK_TO_EMPTY_LINKLIST ? nil : path
-    end
-  end
-
-end
-
-end

data/lib/scrivito/obj_class.rb

@@ -1,258 +0,0 @@
-module Scrivito
-  # This class represents a CMS obj class. Obj classes can be created, updated and all properties
-  # can be read. The class also provides methods to find obj classes. The attributes of an obj class
-  # 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
-        Workspace.current.obj_classes
-      end
-
-      # 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')
-      #
-      # @param [String] name The name of the obj class.
-      # @return [Scrivito::ObjClass]
-      # @raise [Scrivito::ResourceNotFound] Raised when no obj class with the given +name+ can be found.
-      def find(name)
-        obj_class = Workspace.current.obj_classes[name]
-
-        unless obj_class
-          raise ResourceNotFound, "Could not find '#{ObjClass}' with name '#{name}'."
-        end
-
-        obj_class
-      end
-
-      # 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
-      # to set as values. Attributes can be either given as {Scrivito::Attribute} instances or as
-      # an attribute property hash.
-      #
-      # @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', 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: [
-      #     { name: 'headline', type: :string },
-      #     { name: 'category', type: :enum, values: %w(tech social) },
-      #   ])
-      #
-      # @example Create an obj class with attributes passed in as an Array of {Scrivito::Attribute} instances.
-      #   ObjClass.create(name: 'Blog', attributes: [
-      #     Attribute.new(name: 'headline', type: :string),
-      #     Attribute.new(name: 'category', type: :enum, values: %w(tech social)),
-      #   ])
-      #
-      # @param [Hash] properties
-      # @option properties [String] :name The name of the 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)
-        Scrivito.raise_obj_class_deprecated_error
-      end
-
-      private
-
-      # Formats obj class properties into a CMS REST API format.
-      # @param [Hash] properties
-      # @return [Hash] Properties formated for the CMS.
-      def format_properties_for_cms(properties)
-        params = properties.dup
-
-        if params.has_key?(:is_binary)
-          params[:type] = params.delete(:is_binary) ? :generic : :publication
-        end
-
-        if params.has_key?(:attributes)
-          params[:attributes] = params[:attributes].map(&:to_cms_rest_api)
-        end
-
-        params
-      end
-    end
-
-    # Initializes a new obj class. It expects the CMS backend representation of an obj class.
-    #
-    # See {ObjClass.create} for a detailed overview of how to set properties.
-    #
-    # @param [Hash] obj_class_data
-    # @param [Workspace,NilClass] workspace
-    # @raise [Scrivito::ScrivitoError]
-    # @return [Scrivito::ObjClass]
-    def initialize(obj_class_data, workspace)
-      update_obj_class_data(obj_class_data)
-      @workspace = workspace
-    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.
-    #
-    # @return [Boolean]
-    def legacy_type?
-      !!obj_class_data.type
-    end
-
-    # @!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
-    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
-
-    # @api public
-    # @deprecated
-    # @return [Scrivito::AttributeCollection] the attributes of this obj class.
-    #
-    # @example Find an attribute named "locale" for the obj class "Homepage".
-    #   ObjClass.find('Homepage').attributes['locale']
-    #
-    # @example Add a new +string+ attribute named "headline" to the "Homepage" obj class by providing an attribute property hash.
-    #   ObjClass.find('Homepage').attributes.add(name: 'headline', type: :string)
-    #
-    # @example Add a new +enum+ attribute named "category" to the "Homepage" obj class by providing an attribute instance.
-    #   attribute = Attribute.new(name: 'category', type: :enum, values: %w(tech social))
-    #   ObjClass.find('Homepage').attributes.add(attribute)
-    #
-    # @example Iterate over the list of attributes from the obj class "Homepage" and print their name and type.
-    #   ObjClass.find('Homepage').attributes.each do |attribute|
-    #     puts "#{attribute.name}:#{attribute.type}"
-    #   end
-    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+.
-    #
-    # 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+.
-    #
-    # @return [nil]
-    def update(properties)
-      Scrivito.raise_obj_class_deprecated_error
-    end
-
-    def update_obj_class_data(obj_class_data)
-      @obj_class_data = obj_class_data
-      update_attributes
-    end
-
-    private
-
-    attr_reader :obj_class_data, :workspace
-
-    def update_attributes
-      attributes = @obj_class_data.attributes.map do |attribute_data|
-        attribute = Attribute.new(attribute_data)
-        attribute.obj_class = self
-        attribute
-      end
-      @attributes = AttributeCollection.new(self, attributes)
-    end
-  end
-end

data/lib/scrivito/obj_class_collection.rb

@@ -1,71 +0,0 @@
-module Scrivito
-  # This class allows you to retrieve obj classes from a specific working copy. It behaves almost
-  # exactly as an Array, so methods like +#each+, +#select+ etc. are available. You can get an
-  # instance by accessing {Workspace#obj_classes}.
-  #
-  # @api public
-  # @deprecated
-  class ObjClassCollection
-    include Enumerable
-
-    # Initializes an obj class collection for a workspace.
-    #
-    # @param [Workspace] workspace
-    # @return [ObjClassCollection]
-    def initialize(workspace)
-      @workspace = workspace
-    end
-
-    # Finds an obj class by its name in the working copy of the collection.
-    #
-    # @api public
-    # @deprecated
-    #
-    # @example Find the obj class named "Homepage" in the "rtc" {Workspace}.
-    #   Workspace.find('rtc').obj_classes['Homepage']
-    #
-    # @param [String] name The name of the obj class.
-    # @return [ObjClass, nil] Returns the obj class or nil when no obj class with the given +name+ can be found in the working copy.
-    def [](name)
-      if obj_class_data = CmsBackend.instance.find_obj_class_data_by_name(workspace.revision, name)
-        ObjClass.new(obj_class_data, workspace)
-      end
-    end
-
-    #
-    # @!method each
-    #
-    # Yields successive obj classes of the collection. Implements the +Enumerable+ interface.
-    #
-    # @api public
-    # @deprecated
-    # @see Scrivito::ObjClass.remove
-    #
-    # @yield [ObjClass] successive obj classes of the collection if the corresponding workspace
-    #   still uses {Scrivito::ObjClass}.
-    # @yield [Array] an empty array if the corresponding workspace does not use {Scrivito::ObjClass}
-    #   anymore.
-    #
-    # @example Find all obj classes in the "rtc" {Workspace} and print their name.
-    #   Workspace.find('rtc').obj_classes.each do |obj_class|
-    #     puts obj_class.name
-    #   end
-    #
-    delegate :each, to: :obj_classes
-
-    private
-
-    def obj_classes
-      if workspace.uses_obj_classes
-        CmsBackend.instance.find_all_obj_class_data(workspace.revision).map do |obj_class_data|
-          ObjClass.new(obj_class_data, workspace)
-        end
-      else
-        Scrivito.print_obj_class_deprecated_warning
-        []
-      end
-    end
-
-    attr_reader :workspace
-  end
-end