scrivito_sdk 0.17.0 → 0.18.0

data/lib/scrivito/obj_class_collection.rb

@@ -0,0 +1,53 @@
+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
+  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
+    #
+    # @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
+    # @yield [ObjClass] Successive obj classes of the collection.
+    # @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
+      CmsBackend.instance.find_all_obj_class_data(workspace.revision).map do |obj_class_data|
+        ObjClass.new(obj_class_data, workspace)
+      end
+    end
+
+    attr_reader :workspace
+  end
+end

data/lib/scrivito/obj_class_data.rb

@@ -0,0 +1,33 @@
+module Scrivito
+
+class ObjClassData
+  def initialize(raw_data)
+    raw_data = raw_data.deep_stringify_keys
+    if type = raw_data['type']
+      raw_data['is_binary'] = %w[image generic].include?(type)
+    end
+    @raw_data = raw_data
+  end
+
+  def id
+    @raw_data['id']
+  end
+
+  def name
+    @raw_data['name']
+  end
+
+  def is_active
+    !!@raw_data['is_active']
+  end
+
+  def is_binary
+    !!@raw_data['is_binary']
+  end
+
+  def attributes
+    @raw_data['attributes'] || []
+  end
+end
+
+end

data/lib/scrivito/obj_data.rb

@@ -1,8 +1,6 @@
 module Scrivito
 
   class ObjData
-    MissingAttribute = Class.new
-
     internal_key_list = %w[
       last_changed
       modification
@@ -21,8 +19,6 @@ module Scrivito
 
     INTERNAL_COMPARISON_KEYS = Set.new(internal_comparison_key_list.map { |name| "_#{name}" })
 
-    SPECIAL_KEYS = Set.new(%w[ body title blob ])
-
     ATTRIBUTE_DEFAULT_VALUES = {
       "string"        => "",
       "text"          => "",
@@ -46,27 +42,23 @@ module Scrivito
       value_and_type_of(attribute_name).second
     end
 
-    def unchecked_value_of(attribute_name)
-      unchecked_value_and_type_of(attribute_name).first
+    def value_without_default_of(attribute_name)
+      value_and_type_without_default_of(attribute_name).first
     end
 
     def value_and_type_of(attribute_name)
-      value_and_type = internal_value_and_type_of(attribute_name)
-
-      if value_and_type.first.is_a?(MissingAttribute)
-        raise ScrivitoError.new("Illegal attribute name #{attribute_name}")
+      if internal_attribute?(attribute_name)
+        internal_value_and_type(attribute_name)
       else
-        value_and_type
+        custom_value_and_type_with_default(attribute_name)
       end
     end
 
-    def unchecked_value_and_type_of(attribute_name)
-      value_and_type = internal_value_and_type_of(attribute_name)
-
-      if value_and_type.first.is_a?(MissingAttribute)
-        [nil, nil]
+    def value_and_type_without_default_of(attribute_name)
+      if internal_attribute?(attribute_name)
+        internal_value_and_type(attribute_name)
       else
-        value_and_type
+        raw_value_and_type_of(attribute_name)
       end
     end
 
@@ -76,6 +68,10 @@ module Scrivito
       end
     end
 
+    def to_h
+      raise NotImplementedError, 'implement in subclass'
+    end
+
     def raw_value_and_type_of(attribute_name)
       raise NotImplementedError, "implement in subclass"
     end
@@ -95,7 +91,7 @@ module Scrivito
 
           next if attr.start_with?('_') && !INTERNAL_COMPARISON_KEYS.include?(attr)
 
-          if unchecked_value_of(attr) != other.unchecked_value_of(attr)
+          if value_without_default_of(attr) != other.value_without_default_of(attr)
             return false
           end
         end
@@ -108,24 +104,20 @@ module Scrivito
 
     private
 
-    def internal_value_and_type_of(attribute_name)
-      value_and_type = raw_value_and_type_of(attribute_name)
+    def custom_value_and_type_with_default(attribute_name)
+      value, type = raw_value_and_type_of(attribute_name)
+      value = ATTRIBUTE_DEFAULT_VALUES[type] if value.nil?
+      [value, type]
+    end
 
-      if value_and_type.blank?
-        if INTERNAL_KEYS.include?(attribute_name) || SPECIAL_KEYS.include?(attribute_name)
-          type = type_of_internal(attribute_name)
-          [default_attribute_value(attribute_name), type]
-        else
-          [ObjData::MissingAttribute.new, nil]
-        end
-      else
-        value, type = value_and_type
-        if value.nil? && has_custom_attribute?(attribute_name)
-          value = ATTRIBUTE_DEFAULT_VALUES[type]
-        end
+    def internal_value_and_type(attribute_name)
+      value, type = raw_value_and_type_of(attribute_name)
+      type = type_of_internal(attribute_name)
+      [value, type]
+    end
 
-        [value, type]
-      end
+    def internal_attribute?(attribute_name)
+      attribute_name.starts_with?('_')
     end
 
     def type_of_internal(key)
@@ -136,24 +128,10 @@ module Scrivito
         "linklist"
       when "_last_changed"
         "date"
-      when "title", "body"
-        "html"
-      when "blob"
-        "binary"
       else
         nil
       end
     end
-
-    def default_attribute_value(attribute_name)
-      case attribute_name
-      when "_text_links"
-        []
-      else
-        nil
-      end
-    end
-
   end
 
 end

data/lib/scrivito/obj_data_from_hash.rb

@@ -7,9 +7,7 @@ module Scrivito
     end
 
     def raw_value_and_type_of(attribute_name)
-      if has_custom_attribute?(attribute_name)
-        [@hash[attribute_name], @type_hash[attribute_name]]
-      end
+      [@hash[attribute_name], @type_hash[attribute_name]]
     end
 
     def has_custom_attribute?(name)
@@ -20,12 +18,14 @@ module Scrivito
       @all_attributes ||= begin
         @hash.keys |
           INTERNAL_KEYS.to_a |
-          SPECIAL_KEYS.to_a |
            %w[_id]
       end
     end
 
+    def to_h
+      @hash
+    end
+
   end
 
 end
-

data/lib/scrivito/obj_data_from_service.rb

@@ -9,7 +9,7 @@ module Scrivito
       if attribute_name == '_widget_pool'
         [value_of_widget_pool, nil]
       else
-        type_and_value = @data[attribute_name]
+        type_and_value = @data.fetch(attribute_name, [nil, nil])
 
         if type_and_value.present?
           type = if type_and_value.length == 1
@@ -28,7 +28,13 @@ module Scrivito
     end
 
     def all_attributes
-      @all_attributes ||= (@data.keys | INTERNAL_KEYS.to_a | SPECIAL_KEYS.to_a)
+      @all_attributes ||= (@data.keys | INTERNAL_KEYS.to_a)
+    end
+
+    def to_h
+      @data.dup.tap do |h|
+        h.each_pair { |k, v| h[k] = v.first }
+      end
     end
 
     private
@@ -76,7 +82,7 @@ module Scrivito
     end
 
     def is_custom_attribute?(attribute_name)
-      !attribute_name.starts_with?('_') && !SPECIAL_KEYS.include?(attribute_name)
+      !internal_attribute?(attribute_name)
     end
 
   end

data/lib/scrivito/obj_search_builder.rb

@@ -9,7 +9,6 @@ class ObjSearchBuilder < Struct.new(:query)
     set_offset
     set_order
     set_batch_size
-    set_format
     set_include_deleted
 
     enumerator
@@ -48,10 +47,6 @@ class ObjSearchBuilder < Struct.new(:query)
     enumerator.batch_size(query[:batch_size]) if query[:batch_size]
   end
 
-  def set_format
-    enumerator.format(query[:format]) if query[:format]
-  end
-
   def set_include_deleted
     enumerator.include_deleted if query[:include_deleted]
   end

data/lib/scrivito/obj_search_enumerator.rb

@@ -106,8 +106,6 @@ module Scrivito
   #
   # @api public
   class ObjSearchEnumerator
-    class UnregisteredObjFormat < StandardError; end
-
     include Enumerable
 
     attr_reader :workspace
@@ -271,7 +269,7 @@ module Scrivito
         }
       end
 
-      @size ||= CmsRestApi.get(resource_path, size_query)['total'].to_i
+      @size ||= CmsBackend.instance.search_objs(workspace, size_query)['total'].to_i
     end
 
     # load a single batch of search results from the backend.
@@ -282,18 +280,7 @@ module Scrivito
     def load_batch
       next_batch = fetch_next_batch(options[:offset] || 0)
 
-      formatter = @formatter || -> obj { obj.id }
-      next_batch.first.map { |obj| formatter.call(obj) }
-    end
-
-    def format(name)
-      @formatter = Configuration.obj_formats[name]
-
-      unless @formatter
-        raise UnregisteredObjFormat, "The format with name '#{name}' is not registered."
-      end
-
-      self
+      next_batch.first
     end
 
     # @api public
@@ -342,7 +329,7 @@ module Scrivito
     end
 
     def fetch_next_batch(offset)
-      request_result = CmsRestApi.get(resource_path, search_dsl(offset))
+      request_result = CmsBackend.instance.search_objs(workspace, search_dsl(offset))
 
       obj_ids = request_result['results'].map { |result| result['id'] || result['_id'] }
       objs = workspace.objs.find_including_deleted(obj_ids)
@@ -352,10 +339,6 @@ module Scrivito
       [objs, @size]
     end
 
-    def resource_path
-      "workspaces/#{workspace.id}/objs/search"
-    end
-
     def search_dsl(offset)
       patches = {
         offset: offset,

data/lib/scrivito/objs_collection.rb

@@ -89,6 +89,13 @@ module Scrivito
       find_by(:path, paths).map(&:first)
     end
 
+    def changes(offset, batch_size)
+      where('_modification', 'equals', ['new', 'edited', 'deleted'])
+          .batch_size(batch_size)
+          .offset(offset)
+          .include_deleted
+    end
+
     private
 
     def find_filtering_deleted(id_or_list, include_deleted)

data/lib/scrivito/restriction_set.rb

@@ -20,8 +20,8 @@ module Scrivito
 
     def add(options, &block)
       options = options.with_indifferent_access
-      attribute = options.fetch(:uses) do
-        raise ScrivitoError, 'No "uses" option given when adding a publish restriction'
+      attribute = options.fetch(:using) do
+        raise ScrivitoError, 'No "using" option given when adding a publish restriction'
       end
 
       unless block_given?

data/lib/scrivito/user.rb

@@ -1,40 +1,66 @@
 module Scrivito
-  # @api beta
-  class User < Struct.new(:id, :abilities, :description_proc, :suggest_users_proc, :restriction_set)
+  # @api public
+  class User
+    # Valid action verbs for the explicit rules.
+    # @api public
+    VERBS = [
+      :create,
+      :delete,
+      :invite_to,
+      :publish,
+      :read,
+      :write,
+    ].freeze
+
     class << self
       # Defines a new user.
-      # @api beta
+      # @api public
       # @param [String] id the unique, unalterable id of the user.
       #   The user id is used to associate the user with the corresponding CMS resources.
       #   It will be persisted in the CMS.
       # @raise [Scrivito::ScrivitoError] if id is blank
       # @raise [Scrivito::ScrivitoError] if id is more than 64 characters long
-      # @yieldparam [Scrivito::UserDefinition] user object to define abilities on
-      # @see Scrivito::UserDefinition#can
+      # @yieldparam [Scrivito::UserDefinition] user object to define rules on
+      # @see Scrivito::UserDefinition#can_always
+      # @see Scrivito::UserDefinition#can_never
       # @see Scrivito::UserDefinition#description
+      # @see Scrivito::UserDefinition#restrict_obj_publish
+      # @see Scrivito::UserDefinition#suggest_users
       # @example
       #   Scrivito::User.define('alice') do |user|
-      #     user.can(:publish_workspace) { true }
+      #     user.description { 'Alice Almighty' }
+      #     user.can_always(:read, :workspace)
+      #     user.can_always(:write, :workspace)
+      #     user.can_always(:publish, :workspace, 'You can always publish workspaces.')
       #   end
       #
       #   Scrivito::User.define('bob') do |user|
       #     user.description { 'Bob Doe' }
-      #     user.can(:publish_workspace) { true }
+      #     user.can_never(:create, :workspace, 'You are not allowed to create workspaces.')
+      #     user.can_always(:read, :workspace)
+      #     user.restrict_obj_publish(using: :_obj_class) do |obj_class|
+      #       if obj_class.name == 'BlogPost'
+      #         false
+      #       else
+      #         'You are not allowed to publish blog posts.'
+      #       end
+      #     end
       #   end
-      def define(id, &block)
+      def define(id)
         assert_valid_id(id)
         user_definition = UserDefinition.new(id)
-        yield user_definition
+        yield user_definition if block_given?
         user_definition.user
       end
 
       def anonymous_admin
-        User.new(
-          id: nil,
-          abilities: Hash.new(-> {true}).with_indifferent_access,
-          description_proc: nil,
-          suggest_users_proc: nil
-        )
+        explicit_rules = {}
+        VERBS.each { |verb| explicit_rules[[:can_always, verb, :workspace]] = nil }
+        new(id: nil, explicit_rules: explicit_rules)
+      end
+
+      def unknown_user(id)
+        new(id: id, explicit_rules: {})
       end
 
       def find(id)
@@ -59,18 +85,41 @@ module Scrivito
       end
     end
 
+    attr_reader :id, :explicit_rules, :description_proc, :suggest_users_proc, :restriction_set
+
     def initialize(options)
-      super(*options.values_at(:id, :abilities, :description_proc,
-        :suggest_users_proc, :restriction_set))
+      @id                 = options[:id]
+      @explicit_rules     = options[:explicit_rules]
+      @description_proc   = options[:description_proc]
+      @suggest_users_proc = options[:suggest_users_proc]
+      @restriction_set    = options[:restriction_set]
+
+      @explicit_rules.each_key { |rule| assert_valid_verb(rule.second) }
+    end
+
+    def can?(verb, workspace)
+      assert_valid_verb(verb)
+      can_always?(verb, :workspace) || owner_of?(workspace) && !can_never?(verb, :workspace)
+    end
+
+    def can_always?(verb, subject)
+      assert_valid_verb(verb)
+      @explicit_rules.has_key?([:can_always, verb, subject])
     end
 
-    def able_to?(ability_name)
-      !!abilities[ability_name].call
+    def can_never?(verb, subject)
+      assert_valid_verb(verb)
+      @explicit_rules.has_key?([:can_never, verb, subject])
+    end
+
+    def owner_of?(workspace)
+      membership = workspace.memberships[self]
+      membership ? membership.role == 'owner' : false
     end
 
     # Verfies if the User is able to publish changes to a certain {BasicObj Obj}
     #
-    # @api beta
+    # @api public
     # @param [BasicObj] obj the obj that should be published
     # @return [Boolean] true if the user is allowed to publish otherwise false
     def can_publish?(obj)
@@ -81,11 +130,11 @@ module Scrivito
     # specified in a {UserDefinition#restrict_obj_publish} callback if they are not
     # If the user can publish the obj an empty array is returned
     #
-    # @api beta
+    # @api public
     # @param [BasicObj] obj the obj that should be published
     # @return [Array<String>] Hints why the user can't publish
     def restriction_messages_for(obj)
-      return [] if able_to?(UserDefinition::ADMINISTRATE_CMS_ABILITY)
+      return [] if can_always?(:publish, :workspace)
 
       if obj.modification == Modification::EDITED
         base_revision_obj = obj.in_revision(obj.revision.workspace.base_revision)
@@ -102,7 +151,20 @@ module Scrivito
     end
 
     def suggest_users(input)
-      suggest_users_proc ? suggest_users_proc.call(input) : []
+      if suggest_users_proc
+        suggested_users = suggest_users_proc.call(input)
+        suggested_users.nil? ? [] : suggested_users
+      else
+        user = self.class.find(input)
+        user ? [user] : []
+      end
+    end
+
+    def as_json(options = nil)
+      {
+        id: id,
+        description: description,
+      }
     end
 
     private
@@ -110,5 +172,9 @@ module Scrivito
     def calculate_description
       description_proc ? description_proc.call : id
     end
+
+    def assert_valid_verb(verb)
+      raise ScrivitoError.new("Invalid verb '#{verb}'") unless VERBS.include?(verb)
+    end
   end
 end