RubyGems - scrivito_sdk - Versions diffs - 0.30.0 → 0.40.0.rc1 - Mend

scrivito_sdk 0.30.0 → 0.40.0.rc1

Files changed (53) hide show

checksums.yaml +4 -4
data/app/controllers/scrivito/objs_controller.rb +29 -20
data/app/controllers/scrivito/ui_controller.rb +18 -0
data/app/helpers/scrivito_helper.rb +21 -4
data/app/views/scrivito/objs/obj.json.jbuilder +1 -0
data/app/views/scrivito/objs/update.json.jbuilder +1 -1
data/app/views/scrivito/ui/index.html.erb +13 -0
data/config/ca-bundle.crt +565 -3
data/config/routes.rb +4 -0
data/lib/assets/javascripts/scrivito_sdk.js +28 -19545
data/lib/assets/javascripts/scrivito_ui.js +30398 -0
data/lib/assets/stylesheets/scrivito_sdk.css +228 -232
data/lib/assets/stylesheets/scrivito_ui.css +3148 -0
data/lib/generators/scrivito/install/install_generator.rb +4 -0
data/lib/generators/scrivito/install/templates/app/views/layouts/scrivito_dialog.html.erb +13 -0
data/lib/generators/scrivito/page/templates/details.html.erb +1 -1
data/lib/generators/scrivito/widget/templates/details.html.erb +1 -1
data/lib/generators/scrivito/widget/templates/show.html.erb +1 -1
data/lib/generators/scrivito/widget/templates/thumbnail.html.erb +2 -2
data/lib/generators/scrivito/widget/widget_generator.rb +12 -0
data/lib/scrivito/attribute_content.rb +4 -5
data/lib/scrivito/basic_obj.rb +47 -8
data/lib/scrivito/basic_widget.rb +41 -14
data/lib/scrivito/cache.rb +2 -0
data/lib/scrivito/child_list_tag.rb +1 -1
data/lib/scrivito/client_config.rb +9 -11
data/lib/scrivito/cms_backend.rb +5 -4
data/lib/scrivito/cms_field_tag.rb +6 -2
data/lib/scrivito/cms_rest_api/attribute_serializer.rb +2 -0
data/lib/scrivito/cms_rest_api/widget_extractor.rb +5 -5
data/lib/scrivito/connection_manager.rb +1 -0
data/lib/scrivito/controller_actions.rb +24 -3
data/lib/scrivito/image_tag_helper.rb +0 -12
data/lib/scrivito/layout_tags.rb +1 -8
data/lib/scrivito/link_parser.rb +5 -0
data/lib/scrivito/{memberships_collection.rb → membership_collection.rb} +2 -2
data/lib/scrivito/obj_class.rb +3 -6
data/lib/scrivito/{objs_collection.rb → obj_collection.rb} +1 -1
data/lib/scrivito/obj_create_params_parser.rb +15 -0
data/lib/scrivito/obj_params_parser.rb +37 -45
data/lib/scrivito/obj_update_params_parser.rb +25 -0
data/lib/scrivito/revision.rb +6 -2
data/lib/scrivito/sdk_engine.rb +6 -1
data/lib/scrivito/test_request.rb +4 -0
data/lib/scrivito/uploaded_binary.rb +4 -0
data/lib/scrivito/user.rb +8 -0
data/lib/scrivito/widget_collection.rb +22 -0
data/lib/scrivito/workspace.rb +11 -6
metadata +17 -11
data/app/views/scrivito/objs/copy.json.jbuilder +0 -1
data/app/views/scrivito/objs/create.json.jbuilder +0 -1
data/app/views/scrivito/objs/details.json.jbuilder +0 -1
data/lib/scrivito/widget_field_params.rb +0 -61

data/lib/generators/scrivito/install/install_generator.rb CHANGED Viewed

@@ -22,6 +22,10 @@ module Scrivito
         copy_file 'app/controllers/cms_controller.rb'
       end
+      def copy_dialog_layout
+        copy_file 'app/views/layouts/scrivito_dialog.html.erb'
+      end
       def copy_migration
         migration_template 'scrivito/migrate/install_scrivito_migration.rb',
           File.join(Scrivito::Configuration.migration_path, 'install_scrivito_migration.rb')

data/lib/generators/scrivito/install/templates/app/views/layouts/scrivito_dialog.html.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <%= scrivito_head_tags %>
+  <%= stylesheet_link_tag 'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body class="scrivito_dialog">
+  <%= scrivito_body_tags %>
+  <%= yield %>
+  <%= javascript_include_tag 'application' %>
+</body>
+</html>

data/lib/generators/scrivito/page/templates/details.html.erb CHANGED Viewed

	@@ -1 +1 @@
1	- <%= scrivito_tag :div, @obj, :title %>
1	+ <b>Title:</b> <%= scrivito_tag :div, @obj, :title %>

data/lib/generators/scrivito/widget/templates/details.html.erb CHANGED Viewed

@@ -1,2 +1,2 @@
-This is the details view of the <%= class_name %>.
+This is the details view of the <%= human_name %>.
 Edit "app/views/<%= file_name %>/details.html.erb" to change its appearance.

data/lib/generators/scrivito/widget/templates/show.html.erb CHANGED Viewed

@@ -1,2 +1,2 @@
-This is the show view of the <%= class_name %>.
+This is the show view of the <%= human_name %>.
 Edit "app/views/<%= file_name %>/show.html.erb" to change its appearance.

data/lib/generators/scrivito/widget/templates/thumbnail.html.erb CHANGED Viewed

@@ -1,3 +1,3 @@
-<%%= scrivito_thumbnail '<%= class_name %>' do %>
-  <%= class_name %> Widget
+<%%= scrivito_thumbnail '<%= human_name %>' do %>
+  <!-- Add the detailed description of the widget here. -->
 <%% end %>

data/lib/generators/scrivito/widget/widget_generator.rb CHANGED Viewed

@@ -23,6 +23,18 @@ module Scrivito
         migration_template 'migration.erb',
           File.join(Scrivito::Configuration.migration_path, "create_#{file_name}_migration.rb")
       end
+      def file_name
+        super.ends_with?('_widget') ? super : "#{super}_widget"
+      end
+      def class_name
+        super.ends_with?('Widget') ? super : "#{super}Widget"
+      end
+      def human_name
+        class_name.underscore.humanize
+      end
     end
   end
 end

data/lib/scrivito/attribute_content.rb CHANGED Viewed

@@ -59,16 +59,15 @@ module AttributeContent
     has_attribute?(key) ? read_attribute(key) : nil
   end
-  # Hook method to control which widget classes should be available for this page.
-  # Override it to allow only certain classes or none.
+  # Hook method to control which widget classes should be available for this page
+  # or widget. Override it to allow only certain classes or none.
   # Must return either +NilClass+, or +Array+.
   #
-  # If +nil+ is returned (default), then all widget classes will be available for this page.
+  # If +nil+ is returned (default), then all widget classes will be available for this page or widget.
   #
   # If +Array+ is returned, then it should include desired class names.
   # Each class name must be either a +String+ or a +Symbol+.
-  # Only this class names will be available for this page.
-  # Order of the class names will be preserved.
+  # Only these class names will be available and their order will be preserved.
   #
   # @param [String] field_name Name of the widget field.
   # @return [nil, Array<Symbol, String>]

data/lib/scrivito/basic_obj.rb CHANGED Viewed

@@ -76,12 +76,12 @@ module Scrivito
     # @example Arrays of {String Strings} allow you to set multi enum fields
     #   Obj.create(:tags => ["ruby", "rails"])
     #
-    # @example Simply pass an Array of {Scrivito::BasicWidget Widgets} to change a widget field. See {Scrivito::BasicWidget#clone Widget#clone} on how to clone a widget.
+    # @example Simply pass an Array of {Scrivito::BasicWidget Widgets} to change a widget field. See {Scrivito::BasicWidget#copy Widget#copy} on how to copy a widget.
     #   # Add new widgets
     #   Obj.create(:widgets => [Widget.new(_obj_class: 'TitleWidget', title: 'My Title')])
     #
-    #   # Add a widget clone
-    #   Obj.create(:widgets => [another_obj.widgets.first.clone])
+    #   # Add a widget copy
+    #   Obj.create(:widgets => [another_obj.widgets.first.copy])
     #
     #   # Changing a widget field
     #   obj.update(:widgets => [obj.widgets.first])
@@ -304,7 +304,7 @@ module Scrivito
       self
     end
-    # Copies itself to a given path.
+    # Creates a copy of the +Obj+.
     # @api public
     # @param [Hash] options
     # @option options [String,Symbol] :_path (nil) the path of the copy.
@@ -315,7 +315,7 @@ module Scrivito
     # @example Copy a blog post.
     #   blog_post = Obj.find_by_path('/blog/first_post')
     #   blog_post.copy(_path: '/blog/second_post')
-    def copy(options)
+    def copy(options={})
       options = options.stringify_keys.assert_valid_keys('_path', '_id', '_permalink')
       json = workspace.api_request(:post, '/objs', obj: copyable_attributes.merge(options))
       self.class.find(json['_id'])
@@ -390,7 +390,7 @@ module Scrivito
       BasicObj.find_by_path('/') or raise ResourceNotFound,
           '"Obj.root" not found: There is no "Obj" with path "/". '\
           'Maybe you forgot the migration when setting up your Scrivito application? '\
-          'Try "rake scrivito:migrate" and "rake scrivito:migrate:publish".'
+          'Try "bundle exec rake scrivito:migrate scrivito:migrate:publish".'
     end
     # Returns the homepage obj. This can be overwritten in your application's +Obj+.
@@ -720,6 +720,17 @@ module Scrivito
       instantiate_widget(widget_id, widget_data) if widget_data
     end
+    # @api public
+    # Allows accessing the {Scrivito::BasicWidget Widgets} of this Obj
+    #
+    # @example Access a widget by its id
+    #   obj.widgets['widget_id']
+    #
+    # @return [Scrivito::WidgetCollection]
+    def widgets
+      @widgets ||= WidgetCollection.new(self)
+    end
     # for internal testing purposes only
     def blob_id
       find_blob.try(:id)
@@ -756,6 +767,30 @@ module Scrivito
       end
     end
+    def restore_widget(widget_id)
+      Workspace.current.assert_revertable
+      return if modification == Modification::UNMODIFIED
+      if modification == Modification::DELETED
+        raise ScrivitoError, 'Can not restore a widget inside a deleted obj'
+      end
+      unless widget = in_revision(Workspace.current.base_revision).widgets[widget_id]
+        raise ResourceNotFound, "Could not find widget with id #{widget_id}"
+      end
+      container = widget.container
+      if container.kind_of?(BasicWidget) && !widgets[container.id]
+        raise ScrivitoError, 'Can not restore a widget inside a deleted widget'
+      end
+      widget_copy = widget.copy_for_restore(read_widget_pool.keys)
+      field_name = widget.container_field_name
+      current_container = widgets[container.id] || self
+      current_container.update(field_name =>
+        current_container[field_name].insert(widget.container_field_index, widget_copy))
+    end
     def mark_resolved
       workspace.api_request(:put, "/objs/#{id}", obj: {_conflicts: nil})
       reload
@@ -802,10 +837,13 @@ module Scrivito
       raise ScrivitoError.new('Could not generate a new unused widget id')
     end
+    #
     # Generates a +Hash+ containing all public attributes. The hash will _not_ include attributes,
     # which are read-only or used for internal purpose.
-    # @api public
+    #
+    # @api private
     # @return [Hash] a hash containing all public attributes.
+    #
     # @example
     #   old_obj = Obj.homepage
     #   attrs = old_obj.to_h
@@ -816,12 +854,13 @@ module Scrivito
     #   new_obj = Obj.create(attrs)
     #   puts new_obj == old_obj
     #   #=> true
+    #
     def to_h
       data_from_cms.to_h.except(*GENERATED_ATTRIBUTES)
     end
     def parent_path
-      unless root?
+      unless root? || path.nil?
         path.gsub(/\/[^\/]+$/, '').presence || '/'
       end
     end

data/lib/scrivito/basic_widget.rb CHANGED Viewed

@@ -66,25 +66,42 @@ class BasicWidget
     container.update(container_field_name => new_widget_list)
   end
-  # Clones the {Scrivito::BasicWidget Widget}. The clone gets all
-  # attributes of the original widget except nested widget attributes.
-  # The clone is not attached to an {Scrivito::BasicObj Obj} initially.
-  # It only becomes usable by assigning it to a widget attribute of an Obj.
   #
-  # @example
-  #   # From another_obj, take the first widget in my_widgets,
-  #   # and put a clone in obj's my_widgets.
-  #   obj.update(my_widgets: [another_obj.my_widgets.first.clone])
+  # Create a copy of a {Scrivito::BasicWidget Widget}.
   #
   # @api public
-  def clone
-    attributes = {}
-    data_from_cms.all_custom_attributes.each do |attr_name|
-      if type_of_attribute(attr_name) != 'widget'
-        attributes[attr_name] = read_attribute(attr_name)
+  #
+  # The copy will have all attributes of the original widget including its widgets.
+  # Its attributes can be accessed only after it has been stored in a widget field of an
+  # {Scrivito::BasicObj Obj}, since initially the copy is not stored in any widget field.
+  #
+  # @example Duplicate the first widget in field +my_widget+
+  #   obj.update(my_widgets: obj.my_widgets.push(obj.my_widgets.first.copy))
+  #
+  def copy
+    attrs = {}
+    each_custom_attribute do |attr_name, attr_value, attr_type|
+      attrs[attr_name] = attr_type == 'widget' ? attr_value.map(&:copy) : attr_value
+    end
+    self.class.new(attrs)
+  end
+  def copy_for_restore(referenced_ids)
+    attrs = {}
+    each_custom_attribute do |attr_name, attr_value, attr_type|
+      attrs[attr_name] = if attr_type == 'widget'
+        attr_value.reject { |widget| referenced_ids.include?(widget.id) }
+          .map { |widget| widget.copy_for_restore(referenced_ids) }
+      else
+        attr_value
       end
     end
-    self.class.new(attributes)
+    attrs['_id'] = id
+    self.class.new(attrs)
+  end
+  def clone
+    raise "The method `clone' was removed. Please use `copy' instead"
   end
   def id
@@ -193,6 +210,10 @@ class BasicWidget
     @container_field_name || cache_container_and_field_name_for_widget.second
   end
+  def container_field_index
+    container[container_field_name].index(self)
+  end
   def has_attribute?(key)
     key.to_s == '_obj_class' || super
   end
@@ -265,6 +286,12 @@ class BasicWidget
   def cache_container_and_field_name_for_widget
     @cache_container_and_field_name_for_widget ||= obj.container_and_field_name_for_widget(id)
   end
+  def each_custom_attribute
+    data_from_cms.all_custom_attributes.each do |attr_name|
+      yield attr_name, read_attribute(attr_name), type_of_attribute(attr_name)
+    end
+  end
 end
 end

data/lib/scrivito/cache.rb CHANGED Viewed

@@ -33,6 +33,8 @@ class Cache
   private
   def cache_key_for_fallback_backend(key)
+    # Workaround for rails/rails#15616. Will be fixed in Rails 4.2.
+    key = Digest::SHA1.hexdigest(key)
     @cache_prefix ? "#{@cache_prefix}/#{key}" : key
   end
 end

data/lib/scrivito/child_list_tag.rb CHANGED Viewed

@@ -11,7 +11,7 @@ class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
   end
   def options
-    return {} unless user_present?
+    return {} unless user_present? || obj.path.nil?
     options = {
       'private-child-list-allowed-classes' => Obj.valid_page_classes_beneath(obj.path).to_json,

data/lib/scrivito/client_config.rb CHANGED Viewed

@@ -7,9 +7,9 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
   def to_json
     config = {}
+    config[:current_page]     = current_page_config
     config[:editing_context]  = editing_context_config
     config[:i18n]             = i18n_config
-    config[:obj]              = obj_config
     config[:resource_dialog]  = resource_dialog_config
     config[:user]             = user_config
     config[:user_permissions] = user_permissions_config
@@ -39,18 +39,16 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
     {locale: I18n.locale}
   end
-  def obj_config
+  def current_page_config
     if obj
       {
-        current_page: {
-          id: obj.id,
-          obj_class_name: obj.obj_class_name,
-          has_children: obj.children.any?,
-          has_conflict: obj.has_conflict?,
-          has_details_view: obj_has_details_view?,
-          modification: modification(obj),
-          restriction_messages: editor.restriction_messages_for(obj),
-        }
+        id: obj.id,
+        obj_class_name: obj.obj_class_name,
+        has_children: obj.children.any?,
+        has_conflict: obj.has_conflict?,
+        has_details_view: obj_has_details_view?,
+        modification: modification(obj),
+        restriction_messages: editor.restriction_messages_for(obj),
       }
     else
       {}

data/lib/scrivito/cms_backend.rb CHANGED Viewed

@@ -246,7 +246,7 @@ module Scrivito
     end
     def blob_metadata_cache_key(id)
-      "blob_metadata/#{Digest::SHA1.hexdigest(id)}" # id of a blob is a URI.
+      "blob_metadata/#{id}"
     end
     def find_obj_data_filtering_deleted_by(revision, index, keys, include_deleted)
@@ -312,9 +312,10 @@ module Scrivito
         include_deleted: true
       }
-      # Not every revision has a workspace,
-      # e.g. when requesting with the base revision of the current workspace.
-      params[:workspace_id] = revision.workspace.id if revision.workspace
+      # A base revision doesn't have a directly corresponding workspace. Instead it uses its
+      # derivative workspace as fallback to access the contents. Thus fallback workspace of a base
+      # revision may not be used for backend requests.
+      params[:workspace_id] = revision.workspace.id unless revision.base?
       params
     end

data/lib/scrivito/cms_field_tag.rb CHANGED Viewed

@@ -43,7 +43,7 @@ class CmsFieldTag < Struct.new(
     if FIELD_TYPES_WITH_ORIGINAL_CONTENT.include?(field_type)
       original_value = view.scrivito_value(current_value)
-      original_content = original_content(field_type, original_value)
+      original_content = original_content(field_type, original_value, current_value)
       encoded_content = Base64.strict_encode64(MultiJson.encode(original_content))
       options['private-field-original-content'] = encoded_content
     end
@@ -99,6 +99,8 @@ class CmsFieldTag < Struct.new(
     referencelist
     string
     text
+    binary
+    date
   ]
   def authenticated_editor?
@@ -109,10 +111,12 @@ class CmsFieldTag < Struct.new(
     EditingContextMiddleware.from_request(view.request)
   end
-  def original_content(field_type, field_value)
+  def original_content(field_type, field_value, raw_value)
     case field_type
     when 'reference' then field_value.try(:id)
     when 'referencelist' then field_value.map(&:id)
+    when 'binary' then field_value && {}
+    when 'date' then raw_value.try(:utc).try(:iso8601)
     else field_value
     end
   end

data/lib/scrivito/cms_rest_api/attribute_serializer.rb CHANGED Viewed

@@ -41,6 +41,8 @@ module Scrivito
                 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

data/lib/scrivito/cms_rest_api/widget_extractor.rb CHANGED Viewed

@@ -31,11 +31,7 @@ module Scrivito
       end
       def self.attach_widget_to_obj(widget, obj)
-        widget.id = if obj.present?
-          obj.generate_widget_pool_id
-        else
-          BasicObj.generate_widget_pool_id
-        end
+        widget.id = widget.attributes_to_be_saved.delete('_id') || generate_widget_pool_id(obj)
         widget.obj = obj
       end
@@ -47,6 +43,10 @@ module Scrivito
           end
         end
       end
+      def self.generate_widget_pool_id(obj)
+        obj.presence ? obj.generate_widget_pool_id : BasicObj.generate_widget_pool_id
+      end
     end
   end
 end

data/lib/scrivito/connection_manager.rb CHANGED Viewed

@@ -34,6 +34,7 @@ module Scrivito
       # For test purpose only.
       def clear_cache!
         @instances = nil
+        @cert_store = nil
       end
       def cert_store