scrivito_sdk 0.65.2 → 0.66.0.rc1

data/lib/scrivito/workspace_data.rb

@@ -12,29 +12,65 @@ module Scrivito
     data_attr_reader :title
     data_attr_reader :memberships
     data_attr_reader :revision_id
-    data_attr_reader :content_state_id
-    data_attr_reader :uses_obj_classes
     data_attr_reader :base_revision_id
-    data_attr_reader :base_content_state_id
+
+    def content_state_id
+      @data["content_state_id"] or raise InternalError
+    end
+
+    def content_state_id?
+      @data["content_state_id"].present?
+    end
+
+    def base_content_state_id
+      @data["base_content_state_id"] or raise InternalError
+    end
+
+    def base_content_state_id?
+      @data["base_content_state_id"].present?
+    end
 
     def initialize(data)
+      raise InternalError unless Hash === data && data["id"].present?
       @data = data
+      assert_no_obj_classes
     end
 
     def store_in_cache
       CmsDataCache.write_workspace_data(id, to_hash)
     end
 
+    def content_state
+      @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
+    end
+
+    def base_content_state
+      if base_content_state_id
+        @base_content_state ||= ContentState.find_or_create(base_content_state_id)
+      end
+    end
+
     private
 
+    def assert_no_obj_classes
+      if @data['uses_obj_classes']
+        raise ScrivitoError, "The working copy titled #{title} has ObjClasses, which is no longer "\
+          "supported. Please use version 0.60.0 to have CMS-based ObjClasses removed from your "\
+          "working copies. See https://scrivito.com/scrivito/obj-class-migration for a "\
+          "detailed guide on upgrading."
+      end
+    end
+
     def to_hash
+      base_csid = base_content_state_id? ? base_content_state_id : nil
+
       {
         'id'                    => id,
         'revision_id'           => revision_id,
         'title'                 => title,
         'content_state_id'      => content_state_id,
         'base_revision_id'      => base_revision_id,
-        'base_content_state_id' => base_content_state_id,
+        'base_content_state_id' => base_csid,
         'memberships'           => memberships,
       }
     end

data/lib/scrivito/workspace_data_from_service.rb

@@ -32,16 +32,6 @@ class WorkspaceDataFromService < WorkspaceData
     store_in_cache
   end
 
-  def content_state
-    @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
-  end
-
-  def base_content_state
-    if base_content_state_id
-      @base_content_state ||= ContentState.find_or_create(base_content_state_id)
-    end
-  end
-
   private
 
   def create_content_state

data/lib/scrivito_sdk.rb

@@ -123,22 +123,6 @@ module Scrivito
     end
   end
 
-  def self.obj_class_deprecated_message
-    %{
-The SDK now allows defining classes and attributes directly in your application source code.
-Please run the migration tool to have your model migrated automatically in order to use this version of the SDK.
-See https://scrivito.com/obj-class-migration for details.
-    }
-  end
-
-  def self.raise_obj_class_deprecated_error
-    raise ScrivitoError, obj_class_deprecated_message
-  end
-
-  def self.print_obj_class_deprecated_warning
-    Deprecation.warn(obj_class_deprecated_message)
-  end
-
   autoload_all_sources
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 0.65.2
+  version: 0.66.0.rc1
 platform: ruby
 authors:
 - Infopark AG
@@ -172,6 +172,7 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - README.md
+- app/controllers/scrivito/binary_redirect_controller.rb
 - app/controllers/scrivito/blobs_controller.rb
 - app/controllers/scrivito/default_cms_controller.rb
 - app/controllers/scrivito/objs_controller.rb
@@ -192,6 +193,7 @@ files:
 - app/views/scrivito/objs/create_widget.html.erb
 - app/views/scrivito/objs/destroy.json.jbuilder
 - app/views/scrivito/objs/format_missing_error.json.jbuilder
+- app/views/scrivito/objs/is_outdated.json.jbuilder
 - app/views/scrivito/objs/obj.json.jbuilder
 - app/views/scrivito/objs/page_class_selection.json.jbuilder
 - app/views/scrivito/objs/search.json.jbuilder
@@ -222,6 +224,8 @@ files:
 - config/precedence_routes.rb
 - config/routes.rb
 - lib/assets/images/scrivito/image_placeholder.png
+- lib/assets/images/scrivito/source_too_large.png
+- lib/assets/images/scrivito/source_type_invalid.png
 - lib/assets/javascripts/scrivito_sdk.js
 - lib/assets/javascripts/scrivito_ui.js
 - lib/assets/stylesheets/scrivito_sdk.css
@@ -267,12 +271,9 @@ files:
 - lib/generators/scrivito/widget/widget_generator.rb
 - lib/obj.rb
 - lib/scrivito/access_denied.rb
-- lib/scrivito/attribute.rb
-- lib/scrivito/attribute_collection.rb
 - lib/scrivito/attribute_content.rb
 - lib/scrivito/attribute_definition.rb
 - lib/scrivito/attribute_definition_collection.rb
-- lib/scrivito/attribute_definition_migrator.rb
 - lib/scrivito/attribute_deserializer.rb
 - lib/scrivito/attribute_serializer.rb
 - lib/scrivito/backend/content_state_node.rb
@@ -288,6 +289,8 @@ files:
 - lib/scrivito/basic_obj.rb
 - lib/scrivito/basic_widget.rb
 - lib/scrivito/binary.rb
+- lib/scrivito/binary_param_verifier.rb
+- lib/scrivito/binary_rewrite.rb
 - lib/scrivito/cache.rb
 - lib/scrivito/cache/chainable.rb
 - lib/scrivito/cache/file_store.rb
@@ -304,7 +307,6 @@ files:
 - lib/scrivito/cms_env.rb
 - lib/scrivito/cms_field_tag.rb
 - lib/scrivito/cms_rest_api.rb
-- lib/scrivito/cms_rest_api/legacy_attribute_serializer.rb
 - lib/scrivito/cms_rest_api/rate_limit.rb
 - lib/scrivito/cms_rest_api/widget_extractor.rb
 - lib/scrivito/cms_routing.rb
@@ -321,6 +323,7 @@ files:
 - lib/scrivito/controller_runtime.rb
 - lib/scrivito/date_attribute.rb
 - lib/scrivito/deprecation.rb
+- lib/scrivito/dialog_size_helper.rb
 - lib/scrivito/diff.rb
 - lib/scrivito/editing_context.rb
 - lib/scrivito/editing_context_helper.rb
@@ -328,7 +331,7 @@ files:
 - lib/scrivito/errors.rb
 - lib/scrivito/gem_info.rb
 - lib/scrivito/html_string.rb
-- lib/scrivito/image_tag_helper.rb
+- lib/scrivito/image_tag.rb
 - lib/scrivito/layout_tags.rb
 - lib/scrivito/link.rb
 - lib/scrivito/link_parser.rb
@@ -347,9 +350,6 @@ files:
 - lib/scrivito/modification.rb
 - lib/scrivito/named_link.rb
 - lib/scrivito/network_error.rb
-- lib/scrivito/obj_class.rb
-- lib/scrivito/obj_class_collection.rb
-- lib/scrivito/obj_class_data.rb
 - lib/scrivito/obj_collection.rb
 - lib/scrivito/obj_create_params_parser.rb
 - lib/scrivito/obj_data.rb
@@ -359,6 +359,7 @@ files:
 - lib/scrivito/obj_search_builder.rb
 - lib/scrivito/obj_search_enumerator.rb
 - lib/scrivito/obj_update_params_parser.rb
+- lib/scrivito/parent_path.rb
 - lib/scrivito/rate_limit_exceeded.rb
 - lib/scrivito/restriction_set.rb
 - lib/scrivito/revision.rb
@@ -383,7 +384,6 @@ files:
 - lib/scrivito/workspace_selection_middleware.rb
 - lib/scrivito_sdk.rb
 - lib/tasks/cache.rake
-- lib/tasks/migrate_attribute_definitions.rake
 - lib/tasks/migration.rake
 - lib/widget.rb
 homepage: https://scrivito.com
@@ -401,9 +401,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5

data/lib/scrivito/attribute.rb

@@ -1,152 +0,0 @@
-module Scrivito
-  # This class represents a CMS attribute. Attributes can be created, updated, deleted and all
-  # attribute properties can be read. Attributes are part of an
-  # {Scrivito::ObjClass} and therefore each attribute belongs to exactly
-  # one {Scrivito::ObjClass}. Most of the operations interact with the currently
-  # selected {Scrivito::Workspace}. Operations like +create+, +destroy+
-  # and +update+ need to be performed in the "rtc" workspace.
-  #
-  # @api public
-  # @deprecated
-  class Attribute
-    include ModelIdentity
-
-    # Initializes a new attribute.
-    #
-    # @api public
-    # @deprecated
-    #
-    # This allows you to set the different properties of an attribute by
-    # providing a Hash with the property names as keys and the values you want to set as values.
-    #
-    # @example Create a new attribute with name "locale" and type "string".
-    #   Attribute.new(name: 'locale', type: :string)
-    #
-    # @example Create a new "enum" attribute named "category" and provide values.
-    #   Attribute.new(name: 'category', type: :enum, values: %w(tech social))
-    #
-    # @param [Hash] properties
-    # @option properties [String] :name The name of the attribute.
-    # @option properties [String] :type The type of the attribute, can be +string+, +text+, +html+, +linklist+, +link+, +reference+, +referencelist+, +date+, +binary+, +widget+, +enum+ or +multienum+.
-    # @option properties [Array<String>] :values Possible values if the type is either +enum+ or +multienum+.
-    #
-    # @return [Scrivito::Attribute]
-    # @raise [Scrivito::ScrivitoError] Raised when no +properties+ are provided.
-    def initialize(properties)
-      raise ScrivitoError, 'Please provide a hash of Attribute properties.' unless properties
-
-      update_instance_properties(properties)
-    end
-
-    # Returns the name of this attribute.
-    # @api public
-    # @deprecated
-    # @return [String]
-    def name
-      @name
-    end
-
-    # Returns the type of this attribute. The type is either +string+, +text+, +html+, +linklist+,
-    # +link+, +reference+, +referencelist+, +date+, +binary+, +widget+, +enum+ or +multienum+.
-    # @api public
-    # @deprecated
-    # @return [String]
-    def type
-      @type
-    end
-
-    # Returns the values of this attribute, if it is of type +enum+ or +multienum+.
-    # @api public
-    # @deprecated
-    # @return [Array<String>] values
-    def values
-      @values
-    end
-
-    # Returns the obj class this attribute belongs to.
-    # @api public
-    # @deprecated
-    # @return [Scrivito::ObjClass]
-    attr_reader :obj_class
-
-    # Returns a unique identifier of this attribute. An attribute is unique by
-    # its +name+ and its +obj_class+. Implements the {Scrivito::ModelIdentity} interface.
-    # @return [Array]
-    def id
-      [name, obj_class]
-    end
-
-    # Binds this attribute to an obj class.
-    # @return [Scrivito::ObjClass]
-    attr_writer :obj_class
-
-    # Updates this attribute and persists the changes
-    # in the CMS on its obj class. The +obj_class+ and +name+ of this attribute can not be updated.
-    #
-    # @api public
-    # @deprecated
-    #
-    # See {Attribute#initialize} for a detailed overview of what properties are allowed
-    # and how to set them.
-    #
-    # @example Change the +type+ of the "locale" attribute to "string".
-    #   attribute = ObjClass.find('Homepage').attributes['locale']
-    #   attribute.update(type: :string)
-    #
-    # @example Adding the value "sports" to the +enum+ attribute "category" on the "Homepage" obj class.
-    #   attribute = ObjClass.find('Homepage').attributes['category']
-    #   attribute.update(values: attribute.values << 'sports')
-    #
-    # @param [Hash] properties
-    #
-    # @return [nil]
-    # @raise [Scrivito::ScrivitoError] Raised when trying to change the +name+ or +obj_class+ property.
-    def update(properties)
-      Scrivito.raise_obj_class_deprecated_error
-    end
-
-    # Destroys this attribute and persists the change in the CMS.
-    #
-    # @api public
-    # @deprecated
-    #
-    # @example Remove the "locale" attribute from the "Homepage" obj class.
-    #   ObjClass.find('Homepage').attributes['locale'].destroy
-    #
-    # @return [nil]
-    def destroy
-      Scrivito.raise_obj_class_deprecated_error
-    end
-
-    # Returns this attribute in the CMS REST API format.
-    #
-    # @return [Hash]
-    def to_cms_rest_api
-      data = {
-        name: name,
-        type: type,
-      }
-
-      if %w(enum multienum).include?(type)
-        data[:values] = values
-      end
-
-      data
-    end
-
-    private
-
-    # Updates the instance properties of this attribute with +properties+
-    # given in the CMS REST API format.
-    #
-    # @param [Hash] properties
-    # @return [void]
-    def update_instance_properties(properties)
-      properties = properties.with_indifferent_access
-
-      @name = properties[:name].to_s
-      @type = properties[:type].to_s
-      @values = (properties[:values] || []).map(&:to_s)
-    end
-  end
-end

data/lib/scrivito/attribute_collection.rb

@@ -1,66 +0,0 @@
-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
-  # @deprecated
-  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
-    # @deprecated
-    def_delegators :@attributes, :each
-
-    #
-    # Finds an attribute in this collection by its name.
-    #
-    # @api public
-    # @deprecated
-    #
-    # @param [String] name the name of the attribute
-    # @return [Scrivito::Attribute] if there is an attribute with name +name+
-    # @return [nil] if there is no attribute with name +name+
-    #
-    # @see Scrivito::ObjClass#attributes Examples of how to find an attribute by name.
-    #
-    def [](name)
-      @attributes.detect { |attribute| attribute.name == name.to_s }
-    end
-
-    # Adds an attribute to this collection and updates the obj class.
-    #
-    # @api public
-    # @deprecated
-    #
-    # 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)
-      attribute = Attribute.new(attribute) unless attribute.respond_to?(:to_cms_rest_api)
-      @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_definition_migrator.rb

@@ -1,188 +0,0 @@
-require 'thor'
-
-module Scrivito
-
-class AttributeDefinitionMigrator
-  include Thor::Actions
-  include Thor::Base
-  include Thor::Shell
-
-  def initialize(path)
-    self.destination_root = Rails.root.to_s
-    self.options = {}
-    @path = path.to_s
-  end
-
-  def self.migrate_application
-    Dir[Rails.root + 'app/models/**/*.rb'].each do |model_path|
-      new(model_path).migrate
-    end
-    check_abandoned_obj_classes
-  end
-
-  def migrate
-    relative_path = path.gsub("#{Rails.root.to_s}/", '')
-    if model_class && (page_model? || widget_model?)
-      say_status :inspecting, relative_path
-      if obj_class
-        say_status :migrating, relative_path
-        inject_attribute_definitions
-        inject_hide_from_editor if hidden_from_editor?
-        check_model_name
-      else
-        with_padding do
-          say %{[warning] Model "#{model_class}" has no corresponding ObjClass in published workspace.
-  Ignore this message if it is an abstract class and should not have an ObjClass by design.
-  Or maybe "#{model_class}" is not used anymore and file #{relative_path} can be removed?
-}, :yellow
-        end
-        say_status :skipping, relative_path
-      end
-      puts
-    end
-  end
-
-  private
-
-  attr_reader :path
-
-  def model_class
-    @model_class ||= class_name.constantize
-  rescue NameError
-  end
-
-  def page_model?
-    model_class.ancestors.include?(BasicObj) && model_class != ::Obj
-  end
-
-  def widget_model?
-    model_class.ancestors.include?(BasicWidget) && model_class != ::Widget
-  end
-
-  def inject_hide_from_editor
-    inject_into_class(path, model_class, "  hide_from_editor\n\n")
-  end
-
-  def inject_attribute_definitions
-    inject_into_class(path, model_class, "#{attribute_definitions.join}\n", verbose: false)
-  end
-
-  def hidden_from_editor?
-    !obj_class.active? || (page_model? && !template_exists?)
-  end
-
-  def template_exists?
-    lookup_context.template_exists?("#{class_name.underscore}/thumbnail")
-  end
-
-  def class_name
-    @class_name ||= path.gsub(/^.*\/app\/models/, '').gsub('.rb', '').classify
-  end
-
-  def attribute_definitions
-    definitions = obj_class_attributes.map do |attr|
-      attribute_definition = "  attribute :#{attr.name}, :#{type_for(attr.name, attr.type)}"
-      if attr.type == 'enum' || attr.type == 'multienum'
-        attribute_definition << ", values: #{attr.values.to_s}"
-      end
-      attribute_definition << "\n"
-    end
-
-    if page_model? && obj_class.legacy_type?
-      definitions << "  attribute :title, :string\n"
-      if obj_class.is_binary
-        definitions << "  attribute :blob, :binary\n"
-      else
-        definitions << "  attribute :body, :html\n"
-      end
-    end
-
-    definitions.uniq
-  end
-
-  def type_for(name, type)
-    case type
-    when 'text' then 'string'
-    when 'widget' then 'widgetlist'
-    else type
-    end
-  end
-
-  def obj_class_attributes
-    Workspace.published.as_current do
-      obj_class.attributes.sort_by(&:name)
-    end
-  end
-
-  def lookup_context
-    ActionView::LookupContext.new(ActionController::Base.view_paths)
-  end
-
-  def obj_class
-    @obj_class = ObjClass.find(model_class.name)
-  rescue Scrivito::ResourceNotFound
-  end
-
-  def check_model_name
-    name = model_class.name
-
-    if page_model? && !name.ends_with?('Page')
-      is_binary = if obj_class.legacy_type?
-        obj_class.binary?
-      else
-        obj_class.attributes.any? { |attr| attr.name == 'blob' && attr.type == 'binary' }
-      end
-
-      unless is_binary
-        with_padding do
-          say %{[warning] The class name of the non-binary obj model "#{name}" does not end with "Page".
-    Class names of page models should end with "Page" in order to be automatically identified by Scrivito as pages.
-    Please ignore this warning if "#{name}" is not a page by design.
-    Otherwise you need to tell Scrivito about this page explicitly. Please add following to an initializer:
-
-      Scrivito.models.define { page "#{name}" }
-          }, :yellow
-        end
-      end
-    end
-
-    if widget_model? && !name.ends_with?('Widget') &&
-        Scrivito.models.widgets.none? { |w| w.name == name }
-      with_padding do
-        say %{[warning] The class name of the widget model "#{name}" does not end with "Widget".
-  Class names of widget models should end with "Widget" in order to be automatically identified by Scrivito as widgets.
-  You need to tell Scrivito about this widget explicitly. Please add following to an initializer:
-
-    Scrivito.models.define { widget "#{name}" }
-        }, :yellow
-      end
-    end
-  end
-
-  class << self
-    include Thor::Actions
-    include Thor::Base
-    include Thor::Shell
-
-    private
-
-    def check_abandoned_obj_classes
-      ObjClass.all.each do |obj_class|
-        next if obj_class.name == 'MigrationStore'
-        begin
-          obj_class.name.constantize
-        rescue NameError
-          with_padding do
-            say %{[warning] Could not find a ruby class for ObjClass "#{obj_class.name}".
-  Plase create a ruby class for that ObjClass and run this script again.
-
-}, :yellow
-          end
-        end
-      end
-
-    end
-  end
-end
-
-end