scrivito_sdk 1.11.0 → 1.12.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1573d7607de4def110eeba58f89dfc3979bf6f3
-  data.tar.gz: 184a0d601bd86625525adc9389bd8b55819023d8
+  metadata.gz: efd3bed6bd4541b87b1b2f29aca12b7f52b1987f
+  data.tar.gz: 50ec7bd514f1eb7753fad198e5e94fc76ccb5d24
 SHA512:
-  metadata.gz: 0718021d9b1e40a36f516343bc5db251149163d94351b2ca7bb09213cb9932065c2b93e2b3a41f680b795ede481ead7ad79a6ac13becc5a7d71ab8ec0c02f59b
-  data.tar.gz: e91555d9f7f889963b9ea417b85826d190c95ccdf926375d76f0701fcc35a0919f435d4d4bf73cea9f4a4186ae920864899b75e0d757546a4798aadc162c88c8
+  metadata.gz: b299c648eda1d976a51e0166cc21916af96b70df1e33c8e2109af73ea9e6c047b843d682371fdc8814ce0efa67a5a882fee1148a24c809ad8574ed84fdfda452
+  data.tar.gz: 3b96d94c18acf4e6c517922f57f64bed70aad55de66d76ed122048983a204f0a790e4a78f05b8e6676d8af8df04586b5d9287f49be1412f61ebdf7307bcba510

data/app/cms/scrivito/attribute_content.rb

@@ -556,14 +556,14 @@ module AttributeContent
     #     end
     #   end
     #
+    #   MyUser.find_by(email: 'alice@scrivito.com').preferences[:locale] # => 'en'
     #   alice = Scrivito::User.define('alice@scrivito.com')
-    #   alice.preferences[:locale] # => 'en'
     #
     #   my_page = MyPage.create({_path: '/de/test'}, alice)
     #   my_page.title # => 'Your title here'
     #
+    #   MyUser.find_by(email: 'bob@scrivito.com').preferences[:locale] # => 'de'
     #   bob = Scrivito::User.define('bob@scrivito.com')
-    #   bob.preferences[:locale] # => 'de'
     #
     #   my_page = MyPage.create({_path: '/en/test'}, bob)
     #   my_page.title # => 'Hier den Titel eingeben'

data/app/cms/scrivito/basic_obj.rb

@@ -59,7 +59,7 @@ module Scrivito
     include Associations
 
     def self.type_computer
-      @_type_computer ||= TypeComputer.new(Scrivito::BasicObj, ::Obj)
+      @_type_computer ||= TypeComputer.new(BasicObj, ::Obj)
     end
 
     def self.reset_type_computer!
@@ -164,7 +164,7 @@ module Scrivito
     end
 
     private_class_method def self.assert_not_basic_obj(method_name)
-      if self == Scrivito::BasicObj
+      if self == BasicObj
         raise ScrivitoError, "Can not call #{method_name} on Scrivito::BasicObj."\
           " Only call it on Obj or subclasses of Obj"
       end
@@ -264,7 +264,7 @@ module Scrivito
     # @api public
     def self.where(field, operator, value, boost = nil)
       assert_not_basic_obj('.where')
-      if self == ::Obj
+      if type_computer.special_class?(self)
         Workspace.current.objs.where(field, operator, value, boost)
       else
         Workspace.current.objs.where(:_obj_class, :equals, name)
@@ -279,7 +279,7 @@ module Scrivito
     # @api public
     def self.all
       assert_not_basic_obj('.all')
-      if self == ::Obj
+      if type_computer.special_class?(self)
         Workspace.current.objs.all
       else
         find_all_by_obj_class(name)
@@ -300,7 +300,8 @@ module Scrivito
     # @return [Obj]
     # @api public
     def self.find_by_path(path)
-      Workspace.current.objs.find_by_path(path)
+      Workspace.current.objs.find_one_by(:path, path,
+          obj_class_name: type_computer.obj_class_name_for_type(self))
     end
 
     # Find an {Scrivito::BasicObj Obj} with the given name.
@@ -327,7 +328,8 @@ module Scrivito
     # @return [Obj]
     # @api public
     def self.find_by_permalink(permalink)
-      Workspace.current.objs.find_by_permalink(permalink)
+      Workspace.current.objs.find_one_by(:permalink, permalink,
+          obj_class_name: type_computer.obj_class_name_for_type(self))
     end
 
     # Returns the {Scrivito::BasicObj Obj} with the given permalink, or raises
@@ -337,8 +339,10 @@ module Scrivito
     # @return [Obj]
     # @api public
     def self.find_by_permalink!(permalink)
-      find_by_permalink(permalink) or
-        raise ResourceNotFound, "Could not find Obj with permalink '#{permalink}'"
+      find_by_permalink(permalink) or begin
+        model_name = type_computer.obj_class_name_for_type(self) || 'Obj'
+        raise ResourceNotFound, "Could not find #{model_name} with permalink '#{permalink}'"
+      end
     end
 
     # Hook method that lets you control which page classes are made available for pages with the given path.

data/app/cms/scrivito/cms_rest_api/widget_extractor.rb

@@ -18,7 +18,7 @@ module Scrivito
         end
 
         updated_attributes.each do |attribute_name, value|
-          if value.is_a?(Array) && value.all? {|w| w.is_a?(BasicWidget)}
+          if value.is_a?(Array) && value.all? { |w| w.is_a?(BasicWidget) }
             value.each do |widget|
               unless widget.persisted?
                 attach_widget_to_obj(widget, obj)

data/app/cms/scrivito/configuration.rb

@@ -11,7 +11,7 @@ module Scrivito
     #
     DEFAULT_CA_FILE = File.expand_path('../../../../config/ca-bundle.crt', __FILE__)
 
-    # Determine if current visitor is permitted to edit content.
+    # Determine if the current visitor is permitted to edit content.
     def self.find_user_proc=(value)
       @find_user_proc = value
     end
@@ -21,15 +21,15 @@ module Scrivito
     end
 
     #
-    # Configures a callback to be invoked when the SDK determines whether current visitor is
+    # Configures a callback to be invoked when the SDK determines whether the current visitor is
     # permitted to edit content.
     #
     # If the callback is missing in the +development+ or +test+ environment, then the SDK will
-    # assume, that the current visitor is {Scrivito::User.system_user}, who can always create
+    # assume that the current visitor is {Scrivito::User.system_user}, who can always create
     # workspaces, can always read, write, publish, delete and invite to any workspace.
     #
     # If the callback is missing in any other environment (for example in +production+ or
-    # +staging+), then the SDK will assume, that the current visitor is not permitted to edit
+    # +staging+), then the SDK will assume that the current visitor is not permitted to edit
     # content.
     #
     # @api public
@@ -58,14 +58,14 @@ module Scrivito
       @editing_auth_callback || default_editing_auth_callback
     end
 
-    # Configures how to find users for the in-place GUI.
+    # Configures how to find users for the in-place UI.
     # @api public
     # @param [Proc] find_user_proc proc for finding a user by the user id
     # @yieldparam [String] user_id id of the user
     # @yieldreturn [Scrivito::User] if the user with the given user id was found
     # @yieldreturn [NilClass] if the user with the given user id was not found
     # @raise [Scrivito::ScrivitoError] if the proc returns neither a {Scrivito::User}, nor +nil+
-    # @note This configuration key is optional. If it is not configured the in-place GUI would
+    # @note This configuration key is optional. If it is not configured the in-place UI would
     #   behave normally, but would not be able to find any users.
     # @example Return a "dummy" {Scrivito::User}
     #   Scrivito.configure do |config|
@@ -110,10 +110,10 @@ module Scrivito
     #
     # Sets the second level cache.
     #
-    # If it is set, then +Scrivito+ will additionaly store its cache in both: the filesystem cache
+    # If it is set, then +Scrivito+ will additionally store its cache in both: the filesystem cache
     # and the second level cache. Also +Scrivito+ will search in the second level cache if
-    # searching in the filesystem cache returns no results. If the second level cache returns
-    # results, then the results will be store in the filesystem cache.
+    # a search in the filesystem cache returns no results. If the second level cache returns
+    # results, then the results will be stored in the filesystem cache.
     #
     # By default it is not set.
     #
@@ -271,9 +271,12 @@ module Scrivito
     # Configures the in-place UI to use a locale different from the one used by the rest of the
     # application.
     #
+    # This configuration overrides the browser-based UI language detection.
+    # The per-user {UserDefinition#ui_locale UI language definition} overrides this.
+    #
     # @api public
     # @example
-    #   # The application will use +:de+ as locale.
+    #   # The application will use +:de+ as the locale.
     #   I18n.locale = :de
     #
     #   Scrivito.configure do |config|
@@ -293,8 +296,8 @@ module Scrivito
     # @deprecated The legacy routing is deprecated and will be removed in the next major
     #   version of Scrivito.
     #
-    # Scrivito changed its routing to a slug first url scheme. This configuration option
-    # allows you to switch back to the old id first url scheme.
+    # Scrivito changed its routing to a slug-first url scheme. This configuration option
+    # allows you to switch back to the old id-first url scheme.
     def self.legacy_routing
       @legacy_routing
     end
@@ -364,7 +367,7 @@ scrivito_route '/*permalink', using: 'permalink', via: all
     # When delivering binary Objs, the default image transformation will be applied.
     #
     # If not changed the default image transformation is an empty transformation (an empty
-    # +Hash+). Set it to +false+ to disabled the default image transformation completely.
+    # +Hash+). Set it to +false+ to disable the default image transformation completely.
     #
     # @param [Hash] value the {Scrivito::Binary#transform transformation definition}
     #
@@ -417,7 +420,7 @@ scrivito_route '/*permalink', using: 'permalink', via: all
 
     def self.register_obj_format(name, &block)
       if name.start_with? '_'
-        raise InvalidFormatNameError.new('Format names starting with underscore are not allowed.')
+        raise InvalidFormatNameError, 'Format names starting with an underscore are not allowed.'
       else
         obj_formats[name] = block
       end

data/app/cms/scrivito/controller_helper.rb

@@ -42,7 +42,7 @@ module Scrivito
     end
 
     #
-    # Returns whether the GUI is in the +editable+ view.
+    # Returns whether the UI is in the +editable+ view.
     #
     # @api public
     #

data/app/cms/scrivito/obj_collection.rb

@@ -43,7 +43,7 @@ module Scrivito
     # @return [NilClass] if no {Scrivito::BasicObj Obj} with the given +path+ exists.
     #
     def find_by_path(path)
-      find_by(:path, [path]).first.min_by(&:id)
+      find_one_by(:path, path)
     end
 
     #
@@ -60,7 +60,7 @@ module Scrivito
     # @return [NilClass] if no {Scrivito::BasicObj Obj} with the given +permalink+ exists.
     #
     def find_by_permalink(permalink)
-      find_by(:permalink, [permalink]).first.min_by(&:id)
+      find_one_by(:permalink, permalink)
     end
 
     # Returns an {ObjSearchEnumerator} with the given initial subquery consisting of the
@@ -98,6 +98,10 @@ module Scrivito
       all.and(:_obj_class, :equals, obj_class)
     end
 
+    def find_one_by(view, value, **options)
+      find_by(view, [value], options).first.min_by(&:id)
+    end
+
     def find_by_parent_path(path)
       find_by(:ppath, [path]).first
     end
@@ -134,24 +138,24 @@ module Scrivito
       end
     end
 
-    def find_by(view, keys)
-      find_by_including_deleted(view, keys).map do |list|
-        list.reject(&:deleted?)
-      end
+    def find_by(view, keys, **options)
+      find_by_including_deleted(view, keys, options).each { |objs| objs.reject!(&:deleted?) }
     end
 
     # Accepts the name of an "obj_by" view, a list of keys.
     # Returns a list of lists of Objs: a list of Objs for each given key.
-    def find_by_including_deleted(view, keys)
-      result = CmsBackend.find_obj_data_by(
-        workspace.revision,
-        view,
-        keys)
-
-      result.map do |list|
-        list.map do |obj_data|
+    def find_by_including_deleted(view, keys, obj_class_name: nil)
+      revision = workspace.revision
+      CmsBackend.find_obj_data_by(revision, view, keys).map do |obj_datas|
+        if obj_class_name
+          obj_datas = obj_datas.select do |obj_data|
+            obj_class_name == obj_data.value_of('_obj_class')
+          end
+        end
+
+        obj_datas.map do |obj_data|
           obj = BasicObj.instantiate(obj_data)
-          obj.revision = workspace.revision
+          obj.revision = revision
 
           obj
         end

data/app/cms/scrivito/obj_facet_value.rb

@@ -18,9 +18,7 @@ module Scrivito
     #
     # @return [String]
     # @api public
-    def name
-      @name
-    end
+    attr_reader :name
 
     # Total number of Objs available that have this value.
     #
@@ -29,9 +27,7 @@ module Scrivito
     #
     # @return [Integer]
     # @api public
-    def count
-      @count
-    end
+    attr_reader :count
 
     # The Objs that were included in this search.
     #
@@ -41,9 +37,7 @@ module Scrivito
     #
     # @return [Array<BasicObj>]
     # @api public
-    def included_objs
-      @included_objs
-    end
+    attr_reader :included_objs
 
   end
 end

data/app/cms/scrivito/sdk_engine.rb

@@ -1,6 +1,7 @@
 require 'rails'
 
 require 'jbuilder'
+require 'jquery-rails'
 require 'net/http/post/multipart'
 require_relative './legacy_switch'
 require_relative './errors'

data/app/cms/scrivito/type_computer.rb

@@ -5,8 +5,8 @@ class TypeComputer
     @base_class, @fallback_class = base_class, fallback_class
   end
 
-  def compute_type(obj_class)
-   load_class(obj_class) || @fallback_class
+  def compute_type(obj_class_name)
+   load_class(obj_class_name) || @fallback_class
   end
 
   def compute_type_without_fallback(obj_class_name)
@@ -21,17 +21,19 @@ class TypeComputer
     klass == @base_class || klass == @fallback_class
   end
 
+  def obj_class_name_for_type(klass)
+    unless special_class?(klass)
+      klass.name
+    end
+  end
+
   private
 
   def load_class(obj_class)
     klass = obj_class.constantize
-    klass if inherits_from_base?(klass)
+    klass if klass < @base_class
   rescue NameError
   end
-
-  def inherits_from_base?(klass)
-    klass.ancestors.include?(@base_class) && klass != @base_class
-  end
 end
 
 end

data/app/cms/scrivito/ui_config.rb

@@ -22,7 +22,8 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
   private
 
   def i18n_config
-    {locale: Scrivito::Configuration.ui_locale || I18n.locale}
+    locale = editor.try!(:ui_locale) || Scrivito::Configuration.ui_locale
+    {locale: locale}
   end
 
   def obj_class_config

data/app/cms/scrivito/user.rb

@@ -131,14 +131,20 @@ module Scrivito
       end
     end
 
-    attr_reader :id, :explicit_rules, :description_proc, :suggest_users_proc, :restriction_set
+    attr_reader :id
+    attr_reader :description_proc
+    attr_reader :explicit_rules
+    attr_reader :restriction_set
+    attr_reader :suggest_users_proc
+    attr_reader :ui_locale
 
     def initialize(options)
       @id                 = options[:id]
-      @explicit_rules     = options[:explicit_rules]
       @description_proc   = options[:description_proc]
-      @suggest_users_proc = options[:suggest_users_proc]
+      @explicit_rules     = options[:explicit_rules]
       @restriction_set    = options[:restriction_set]
+      @suggest_users_proc = options[:suggest_users_proc]
+      @ui_locale          = options[:ui_locale]
 
       @explicit_rules.each { |rule| assert_valid_verb(rule.second) }
       @explicit_rules_set = Set.new(@explicit_rules.map { |rule| rule.take(3) })

data/app/cms/scrivito/user_definition.rb

@@ -22,7 +22,7 @@ module Scrivito
     #
     # @param [Symbol] verb the verb of the action (see {Scrivito::User::VERBS}).
     # @param [Symbol] subject the subject of the action. Currently, only +:workspace+ is supported.
-    # @param [String] message optional message to be displayed in the UI.
+    # @param [String] message an optional message to be displayed in the UI.
     #
     # @raise [Scrivito::ScrivitoError] if the given verb is invalid
     # @raise [Scrivito::ScrivitoError] if the specified rule conflicts with a
@@ -57,7 +57,7 @@ module Scrivito
     #
     # @param [Symbol] verb the verb of the action (see {Scrivito::User::VERBS}).
     # @param [Symbol] subject the subject of the action. Currently, only +:workspace+ is supported.
-    # @param [String] message optional message to be displayed in the UI.
+    # @param [String] message an optional message to be displayed in the UI.
     #
     # @raise [Scrivito::ScrivitoError] if the given verb is invalid
     # @raise [Scrivito::ScrivitoError] if the specified rule conflicts with a
@@ -82,7 +82,7 @@ module Scrivito
     end
 
     #
-    # Enable the user to create workspaces, to read from, write to, publish, delete workspaces,
+    # Enables the user to create workspaces, to read from, write to, publish, delete workspaces,
     # and to invite others to collaborate on any workspace.
     #
     # @api public
@@ -92,21 +92,21 @@ module Scrivito
     end
 
     #
-    # Defines the user description to be displayed in the in-place GUI, e.g. in the workspace menu.
+    # Defines the user description to be displayed in the in-place UI, e.g. in the workspace menu.
     #
     # @api public
     #
     # @param [String] description_string the description, defaults to the the user id.
-    # @param [Proc] description_proc proc to calculate the description, defaults to the the user id.
+    # @param [Proc] description_proc a proc to calculate the description, defaults to the user id.
     #
-    # @note The description is calculated "lazyly". The calculated description is cached.
+    # @note The description is calculated "lazily". The calculated description is cached.
     #
     # @see Scrivito::User.define
     #
-    # @example Display the user +alice+ as "alice" in the in-place GUI:
+    # @example Displays the user +alice+ as "alice" in the in-place UI:
     #   alice = Scrivito::User.define('alice')
     #
-    # @example Display the user +bob+ as "Bob Doe" in the in-place GUI:
+    # @example Displays the user +bob+ as "Bob Doe" in the in-place UI:
     #   bob = Scrivito::User.define('bob') do |user|
     #     user.description('Bob Doe')
     #   end
@@ -126,17 +126,17 @@ module Scrivito
     end
 
     #
-    # Defines the proc for fetching users for autocompletion purposes in the in-place GUI.
+    # Defines the proc for fetching users for autocompletion purposes in the in-place UI.
     # User autocompletion is used in the settings dialog of a workspace.
     # If the proc is not set, {Scrivito::User.find} is used to fetch the suggested users,
     # assuming the input is part of the user id.
     #
     # @api public
     #
-    # @note Only the first 20 users returned are displayed in the in-place GUI.
+    # @note Only the first 20 users returned are displayed in the in-place UI.
     # @note +suggest_users_proc+ may also be invoked with an empty string.
     #
-    # @param [Proc] suggest_users_proc proc for fetching users to be suggested in the in-place GUI
+    # @param [Proc] suggest_users_proc proc for fetching users to be suggested in the in-place UI
     # @yieldparam [String] input an arbitrary string originating from the user autocompletion input field,
     #   e.g. the first letters of a user name
     # @yieldreturn [Array<Scrivito::User>] users that were found on account of the given input string
@@ -168,7 +168,7 @@ module Scrivito
     #   with this attribute.
     #
     # @param [Hash] options
-    # @option options [Symbol] :using the attribute you with to refer to in the callback
+    # @option options [Symbol] :using the attribute you wish to refer to in the callback
     # @yield [attribute] the value of the specified attribute
     # @yieldreturn [String, false] either return a message for the user or +false+ if
     #   no restriction applies
@@ -200,13 +200,35 @@ module Scrivito
       restriction_set.add(options, &block)
     end
 
+    #
+    # Lets you specify the user's in-place UI language.
+    #
+    # Overrides auto-detection from browser language.
+    # Overrides the application-wide scrivito {Configuration.ui_locale UI locale configuration}.
+    #
+    # @api public
+    #
+    # @param [String] language a language code (e.g. 'en')
+    #
+    # @see Scrivito::User.define
+    #
+    # @example Have +robert+ use a UI with German titles:
+    #   robert = Scrivito::User.define('robert') do |user|
+    #     user.ui_locale('de')
+    #   end
+    #
+    def ui_locale(language)
+      @ui_locale = language
+    end
+
     def user
       User.new(
         id: @user_id,
         explicit_rules: @explicit_rules,
         description_proc: @description_proc,
         suggest_users_proc: @suggest_users_proc,
-        restriction_set: restriction_set
+        restriction_set: restriction_set,
+        ui_locale: @ui_locale,
       )
     end
 

data/app/cms/scrivito/workspace.rb

@@ -265,9 +265,7 @@ class Workspace
   # Returns the id of the workspace.
   # @api public
   # @return [String]
-  def id
-    @id
-  end
+  attr_reader :id
 
   def revision_id
     data.revision_id