scrivito_sdk 0.70.2 → 0.71.0.rc1

data/lib/scrivito/page_config.rb

@@ -23,11 +23,12 @@ class PageConfig < Struct.new(:obj, :editing_context, :lookup_context)
     return {} unless obj
     {
       id: obj.id,
-      obj_class_name: obj.obj_class_name,
+      obj_class: obj.obj_class,
       has_children: obj.children.any?,
       has_conflict: obj.has_conflict?,
       has_details_view: obj_has_details_view?,
       modification: modification(obj),
+      parent_path: obj.parent_path,
       restriction_messages: editor.restriction_messages_for(obj),
     }
   end

data/lib/scrivito/type_computer.rb

@@ -5,12 +5,12 @@ class TypeComputer
     @base_class, @fallback_class = base_class, fallback_class
   end
 
-  def compute_type(obj_class_name)
-   load_class(obj_class_name) || @fallback_class
+  def compute_type(obj_class)
+   load_class(obj_class) || @fallback_class
   end
 
-  def compute_type_without_fallback(obj_class_name)
-    if obj_class = load_class(obj_class_name)
+  def compute_type_without_fallback(obj_class)
+    if obj_class = load_class(obj_class)
       obj_class
     else
       raise ObjClassNotFound
@@ -23,8 +23,8 @@ class TypeComputer
 
   private
 
-  def load_class(obj_class_name)
-    klass = obj_class_name.constantize
+  def load_class(obj_class)
+    klass = obj_class.constantize
     klass if inherits_from_base?(klass)
   rescue NameError
   end

data/lib/scrivito/user.rb

@@ -52,8 +52,8 @@ module Scrivito
       #     user_definition.can_never(:create, :workspace, 'You are not allowed to create workspaces.')
       #     user_definition.can_always(:read, :workspace)
       #
-      #     user_definition.restrict_obj_publish(using: :_obj_class_name) do |obj_class_name|
-      #       if obj_class_name == 'BlogPost'
+      #     user_definition.restrict_obj_publish(using: :_obj_class) do |obj_class|
+      #       if obj_class == 'BlogPost'
       #         false
       #       else
       #         'You are not allowed to publish blog posts.'
@@ -155,7 +155,7 @@ module Scrivito
     # Checks whether the User may publish changes to a specific {Scrivito::BasicObj Obj}.
     #
     # @api public
-    # @param [BasicObj] obj the object to be published
+    # @param [Scrivito::BasicObj] obj the object to be published
     # @return [Boolean] true if the user is allowed to publish the object, otherwise false
     #
     def can_publish?(obj)
@@ -164,11 +164,11 @@ module Scrivito
 
     #
     # Checks whether the User may publish changes to an {Scrivito::BasicObj Obj} and returns
-    # the message specified in a {UserDefinition#restrict_obj_publish} callback if they may not.
-    # If the user may publish the CMS object, an empty array is returned.
+    # the message specified in a {Scrivito::UserDefinition#restrict_obj_publish} callback if they
+    # may not. If the user may publish the CMS object, an empty array is returned.
     #
     # @api public
-    # @param [BasicObj] obj the object to be published
+    # @param [Scrivito::BasicObj] obj the object to be published
     # @return [Array<String>] Hints on why the user cannot publish the object
     #
     def restriction_messages_for(obj)
@@ -236,10 +236,9 @@ module Scrivito
     def sandbox_suggest_user_proc(input)
       suggest_users_proc.call(input)
     rescue Exception => e
-      Rails.logger.error(%{
-Method `suggest_users' of the user "#{id}" raised an error on input "#{input}": #{e}
-  #{e.backtrace.join("\n")}
-      })
+      message = %{Method `suggest_users' of the user "#{id}" raised an error on input "#{input}"}
+      Warning.error(message, e)
+
       nil
     end
   end

data/lib/scrivito/user_definition.rb

@@ -185,8 +185,8 @@ module Scrivito
     #           end
     #         end
     #
-    #         user.restrict_obj_publish(using: :_obj_class_name) do |obj_class_name|
-    #           if obj_class_name == 'BlogPost'
+    #         user.restrict_obj_publish(using: :_obj_class) do |obj_class|
+    #           if obj_class == 'BlogPost'
     #             false
     #           else
     #             'You are only allowed to edit Blog Posts.'

data/lib/scrivito/warning.rb

@@ -0,0 +1,17 @@
+module Scrivito
+  module Warning
+    def self.warn(message)
+      Rails.logger.warn("[Scrivito] WARNING! #{message}")
+    end
+
+    def self.error(message, exception=nil)
+      if exception
+        padded_backtrace = exception.backtrace.map { |line| "  #{line}" }
+
+        message += ": #{exception.class.to_s} (#{exception})\n#{padded_backtrace.join("\n")}"
+      end
+
+      Rails.logger.error("[Scrivito] ERROR! #{message}")
+    end
+  end
+end

data/lib/scrivito/widget_garbage_collection.rb

@@ -2,7 +2,7 @@ module Scrivito
 
 class WidgetGarbageCollection
 
-  # @param [BasicObj] obj the Obj that the update applies to
+  # @param [Scrivito::BasicObj] obj the Obj that the update applies to
   # @param [Hash] update the keys are content objects (Obj or Widget)
   #   and the values are their update params.
   #   update params are accepted in the same format as accepted by Obj.create or Obj#update.

data/lib/scrivito/widget_tag.rb

@@ -1,83 +1,58 @@
 module Scrivito
 
-class WidgetTag < Struct.new(:view, :widget, :placement_modification, :template_name, :inner_tag)
-  DEFAULT_TAG = "div"
-
-  include TagRenderer
-
+class WidgetTag < BaseWidgetTag
   def render
     super
   rescue => error
-    if !['development', 'test'].include?(Rails.env) &&
-        view.controller.respond_to?(:on_scrivito_widget_error)
-      view.controller.on_scrivito_widget_error(widget, error)
+    if handle_render_errors?
+      errored_widget_tag(error).render
     else
       raise error
     end
   end
 
-  def tag_name
-    inner_tag || DEFAULT_TAG
-  end
-
   def content
-    view.render(template: template_path, locals: {widget: widget})
-  rescue ActionView::MissingTemplate
-    raise if Rails.env.development? || Rails.env.test?
-    "Missing show template for #{widget.description_for_editor}" if view.scrivito_user
+    render_content(render_context)
   end
 
-  def options
-    options = {}
-
-    if inplace_editing_allowed?
-      options['private-widget-id'] = widget.id
-      options['widget-obj-class'] = widget.obj_class_name
-      options['private-widget-description-for-editor'] = widget.description_for_editor
+  private
 
-      if has_widget_details_view?(widget)
-        options['private-widget-has-details-view'] = true
-      end
+  def errored_widget_tag(error)
+    ErroredWidgetTag.new(view, widget, placement_modification: placement_modification,
+        render_context: render_context, inner_tag: inner_tag, error: error)
+  end
 
-      comparison = editing_context.comparison
-      options['private-widget-modification'] =
-        if comparison.revision == widget.revision
-          if placement_modification
-            unless widget.in_revision(Workspace.current.revision)
-              Modification::DELETED
-            end
-          end
-        else
-          comparison.modification(widget)
-        end
+  def description_for_editor
+    widget.description_for_editor
+  end
 
-      options['private-widget-placement-modification'] =
-        placement_modification
+  def render_content(context)
+    template_path = widget.public_send("#{context}_view_path")
+    view.render(template: template_path, locals: {widget: widget})
+  rescue ActionView::MissingTemplate
+    if context == DEFAULT_RENDER_CONTEXT
+      if view.scrivito_user
+        view.content_tag(:h4, "Error: Missing 'show' template for #{widget.obj_class}",
+          class: 'scrivito_error')
+      end
+    else
+      render_content(DEFAULT_RENDER_CONTEXT)
     end
-
-    options
   end
 
-  private
-
-  def template_path
-    widget.public_send("to_#{template_name}_view_path")
+  def render_context
+    super || DEFAULT_RENDER_CONTEXT
   end
 
   def has_widget_details_view?(widget)
-    view.lookup_context.find(widget.to_details_view_path).present?
+    view.lookup_context.find(widget.details_view_path).present?
   rescue ActionView::MissingTemplate
     false
   end
 
-  def inplace_editing_allowed?
-    editing_context.authenticated_editor?
+  def handle_render_errors?
+    !Rails.env.development? && !Rails.env.test?
   end
-
-  def editing_context
-    EditingContextMiddleware.from_request(view.request)
-  end
-
 end
 
 end

data/lib/scrivito/workspace.rb

@@ -92,34 +92,34 @@ class Workspace
     all.detect { |workspace| workspace.title == title }
   end
 
+  #
   # Find a workspace by its id or title and set it as the currently used workspace.
-  # @example
-  #   Scrivito::Workspace.use('6a75fe694eeeb093')
   #
-  #   Scrivito::Workspace.current.id
-  #   # => '6a75fe694eeeb093'
+  # @api public
   #
-  #   Scrivito::Workspace.use('my working copy')
+  # @param [String] id_or_title id or title of the workspace
+  # @raise [Scrivito::ResourceNotFound]
+  # @return [void]
   #
+  # @example
+  #   Scrivito::Workspace.use("6a75fe694eeeb093")
+  #   Scrivito::Workspace.current.id
+  #   # => "6a75fe694eeeb093"
+  #
+  #   Scrivito::Workspace.use("my working copy")
   #   Scrivito::Workspace.current.title
-  #   # => 'my working copy'
+  #   # => "my working copy"
   #
   #   # raises Scrivito::ResourceNotFound:
-  #   Scrivito::Workspace.use('missing')
-  # @api public
-  # @param [String] id_or_title
-  # @return [void]
-  # @raise [Scrivito::ResourceNotFound]
+  #   Scrivito::Workspace.use("missing")
+  #
   def self.use(id_or_title)
-    workspace = begin
+    self.current = if id_or_title =~ /^[a-z0-9]{16}$/
       find(id_or_title)
-    rescue ResourceNotFound
-      find_by_title(id_or_title)
-    end
-    if workspace.blank?
-      raise(ResourceNotFound, "Could not find #{self} with id or title #{id_or_title}")
+    else
+      find_by_title(id_or_title) or
+        raise ResourceNotFound, "Could not find #{self} with title #{id_or_title}"
     end
-    self.current = workspace
   end
 
   delegate :content_state_id, :base_content_state_id, :content_state,
@@ -170,6 +170,14 @@ class Workspace
     response
   end
 
+  def create_obj(attributes)
+    CmsBackend.instance.create_obj(id, attributes).tap { reload }
+  end
+
+  def update_obj(obj_id, attributes)
+    CmsBackend.instance.update_obj(id, obj_id, attributes).tap { reload }
+  end
+
   def task_unaware_api_request(verb, path, payload = nil)
     CmsRestApi.task_unaware_request(verb, "#{backend_url}#{path}", payload)
   end
@@ -231,7 +239,7 @@ class Workspace
 
   # @api public
   # Returns the memberships (users and their roles) of this workspace.
-  # @return [MembershipCollection]
+  # @return [Scrivito::MembershipCollection]
   def memberships
     @memberships ||= MembershipCollection.new(self)
   end
@@ -289,9 +297,9 @@ class Workspace
     raise ScrivitoError, 'published workspace is not modifiable' if published?
   end
 
-  # Returns an {ObjCollection} of this working copy for accessing its CMS objects.
+  # Returns an {Scrivito::ObjCollection} of this working copy for accessing its CMS objects.
   # @api public
-  # @return {ObjCollection}
+  # @return {Scrivito::ObjCollection}
   def objs
     @objs ||= ObjCollection.new(self)
   end
@@ -355,12 +363,13 @@ class Workspace
     end
 
     def warn_backend_not_available(error_message)
-      message = <<-EOS
+      Warning.warn <<-EOS
+
         Couldn't connect to backend to fetch published workspace.
         #{error_message}
         Serving from cache.
+
       EOS
-      Rails.logger.warn(message)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 0.70.2
+  version: 0.71.0.rc1
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -172,11 +172,10 @@ files:
 - app/views/cms/index.html.erb
 - app/views/google_maps_widget/show.html.erb
 - app/views/scrivito/_editing_auth_warning.html.erb
+- app/views/scrivito/blobs/activate_upload.json.jbuilder
 - app/views/scrivito/blobs/upload_permission.json.jbuilder
 - app/views/scrivito/content_widget/show.html.erb
 - app/views/scrivito/fallback_thumbnail.html.erb
-- app/views/scrivito/objs/copy_widget.html.erb
-- 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
@@ -185,6 +184,7 @@ files:
 - app/views/scrivito/objs/search.json.jbuilder
 - app/views/scrivito/objs/search_only_size.json.jbuilder
 - app/views/scrivito/objs/show.json.jbuilder
+- app/views/scrivito/objs/transfer_modifications.json.jbuilder
 - app/views/scrivito/objs/update.json.jbuilder
 - app/views/scrivito/objs/widget.json.jbuilder
 - app/views/scrivito/objs/widget_class_selection.json.jbuilder
@@ -273,6 +273,7 @@ files:
 - lib/scrivito/backend/path_index.rb
 - lib/scrivito/backend/permalink_index.rb
 - lib/scrivito/backend_error.rb
+- lib/scrivito/base_widget_tag.rb
 - lib/scrivito/basic_obj.rb
 - lib/scrivito/basic_widget.rb
 - lib/scrivito/binary.rb
@@ -317,7 +318,9 @@ files:
 - lib/scrivito/diff.rb
 - lib/scrivito/editing_context.rb
 - lib/scrivito/editing_context_middleware.rb
+- lib/scrivito/errored_widget_tag.rb
 - lib/scrivito/errors.rb
+- lib/scrivito/future_binary.rb
 - lib/scrivito/gem_info.rb
 - lib/scrivito/generator_helper.rb
 - lib/scrivito/html_string.rb
@@ -366,6 +369,7 @@ files:
 - lib/scrivito/uploaded_binary.rb
 - lib/scrivito/user.rb
 - lib/scrivito/user_definition.rb
+- lib/scrivito/warning.rb
 - lib/scrivito/widget_collection.rb
 - lib/scrivito/widget_garbage_collection.rb
 - lib/scrivito/widget_tag.rb
@@ -393,9 +397,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/app/views/scrivito/objs/copy_widget.html.erb

@@ -1 +0,0 @@
-<%= Scrivito::WidgetTag.new(self, @widget).render %>

data/app/views/scrivito/objs/create_widget.html.erb

@@ -1 +0,0 @@
-<%= Scrivito::WidgetTag.new(self, @widget).render %>