scrivito_sdk 1.1.1 → 1.2.0.rc1

data/lib/scrivito/widget_collection.rb

@@ -27,7 +27,7 @@ module Scrivito
     # @example Array of all widget ids
     #   obj.widgets.map { |widget| widget.id }
     def each(&block)
-      obj.all_widgets_from_pool.each(&block)
+      obj.contained_widgets.each(&block)
     end
 
     private

data/lib/scrivito/workspace.rb

@@ -19,21 +19,22 @@ class Workspace
   # @api public
   # @param [Scrivito::Workspace] workspace
   def self.current=(workspace)
-    @current = workspace
+    Thread.current[:scrivito_current_workspace] = workspace
   end
 
   def self.current_using_proc=(workspace_proc)
-    @current = workspace_proc
+    Thread.current[:scrivito_current_workspace] = workspace_proc
   end
 
   # Returns the currently used workspace.
   # @api public
   # @return [Scrivito::Workspace]
   def self.current
-    if @current.respond_to? :call
-      @current = @current.call
+    workspace = Thread.current[:scrivito_current_workspace]
+    if workspace.respond_to?(:call)
+      Thread.current[:scrivito_current_workspace] = workspace.call
     else
-      @current ||= published
+      Thread.current[:scrivito_current_workspace] ||= published
     end
   end
 
@@ -57,11 +58,11 @@ class Workspace
   end
 
   def self.published_with_fallback
-    cached_workspace_data = CmsBackend.instance.find_workspace_data_from_cache('published')
+    cached_workspace_data = CmsBackend.find_workspace_data_from_cache('published')
 
     if cached_workspace_data
       workspace_data = begin
-        CmsBackend.instance.find_workspace_data_by_id('published', 0.5)
+        CmsBackend.find_workspace_data_by_id('published', 0.5)
       rescue => e
         warn_backend_not_available(e.message)
         cached_workspace_data
@@ -80,7 +81,7 @@ class Workspace
   # @raise [Scrivito::ResourceNotFound]
   def self.find(id)
     cache.fetch(id) do
-      workspace_data = CmsBackend.instance.find_workspace_data_by_id(id)
+      workspace_data = CmsBackend.find_workspace_data_by_id(id)
 
       from_workspace_data(id, workspace_data)
     end
@@ -97,33 +98,31 @@ class Workspace
   end
 
   #
-  # Find a workspace by its id or title and set it as the currently used workspace.
+  # Find a workspace by its title or ID and set it as the currently used workspace.
   #
   # @api public
   #
-  # @param [String] id_or_title id or title of the workspace
+  # @param [String] title_or_id title or id of the workspace
   # @raise [Scrivito::ResourceNotFound]
-  # @return [void]
+  # @note This method is intended to be used in the Rails console. Please avoid using it in
+  #   application code.
   #
   # @example
-  #   Scrivito::Workspace.use("6a75fe694eeeb093")
-  #   Scrivito::Workspace.current.id
-  #   # => "6a75fe694eeeb093"
-  #
   #   Scrivito::Workspace.use("my working copy")
   #   Scrivito::Workspace.current.title
   #   # => "my working copy"
   #
-  #   # raises Scrivito::ResourceNotFound:
+  #   Scrivito::Workspace.use("6a75fe694eeeb093")
+  #   Scrivito::Workspace.current.id
+  #   # => "6a75fe694eeeb093"
+  #
+  #   # Raises Scrivito::ResourceNotFound:
   #   Scrivito::Workspace.use("missing")
   #
-  def self.use(id_or_title)
-    self.current = if id_or_title =~ /^[a-z0-9]{16}$/
-      find(id_or_title)
-    else
-      find_by_title(id_or_title) or
-        raise ResourceNotFound, "Could not find #{self} with title #{id_or_title}"
-    end
+  def self.use(title_or_id)
+    self.current = find_by_title(title_or_id) || find(title_or_id)
+  rescue ResourceNotFound
+    raise ResourceNotFound, %{Could not find #{self} with title or ID "#{title_or_id}"}
   end
 
   delegate :content_state_id, :base_content_state_id, :content_state,
@@ -196,11 +195,11 @@ class Workspace
   end
 
   def create_obj(attributes)
-    CmsBackend.instance.create_obj(id, attributes).tap { reload }
+    CmsBackend.create_obj(id, attributes).tap { reload }
   end
 
   def update_obj(obj_id, attributes)
-    CmsBackend.instance.update_obj(id, obj_id, attributes).tap { reload }
+    CmsBackend.update_obj(id, obj_id, attributes).tap { reload }
   end
 
   def task_unaware_api_request(verb, path, payload = nil)
@@ -376,7 +375,7 @@ class Workspace
   end
 
   def fetch_workspace_data
-    CmsBackend.instance.find_workspace_data_by_id(id)
+    CmsBackend.find_workspace_data_by_id(id)
   end
 
   def backend_url

data/lib/scrivito_sdk.rb

@@ -19,77 +19,94 @@ module Scrivito
   end
 
   #
-  # Configures which models Scrivito regards as pages and widgets.
+  # Configures which classes Scrivito regards as CMS models.
   #
   # @api public
   #
-  # In order to display a page class selection dialog and a widget class selection dialog, Scrivito
-  # needs to know which page models and widget models are available. These models can be defined in
-  # the Rails application itself or in 3rd-party gems.
+  # In order to provide access to CMS class details, Scrivito needs to know which CMS model classes
+  # are available. These models can be defined in the Rails application itself or in 3rd-party gems.
   #
-  # Scrivito assumes that all the classes descending from {Scrivito::BasicObj}, whose
-  # class names end with +Page+ are pages (e.g. +MyPage+, +HomePage+, +BlogPostPage+ etc.).
-  # It also assumes that all the classes descending from {Scrivito::BasicWidget}, whose
-  # class names end with +Widget+ are widgets (e.g. +TextWidget+, +ImageWdidget+ etc.).
+  # Scrivito assumes that all the classes descending from {Scrivito::BasicObj}, whose class names
+  # end with +"Page"+ are pages (e.g. +MyPage+, +HomePage+, +BlogPostPage+ etc.) and all the classes
+  # descending from {Scrivito::BasicWidget}, whose class names end with +"Widget"+ are widgets (e.g.
+  # +TextWidget+, +ImageWidget+ etc.).
+  # It also assumes that all the classes descending from {Scrivito::BasicObj}, regardless of the
+  # class names, are CMS object models (e.g. all pages, but also +Obj+, +Image+, +Download+ etc.).
   #
-  # Scrivito recursively scans for such models in all directories from
+  # The loaded pages can be inspected with {Scrivito::ModelLibrary#pages Scrivito.models.pages},
+  # which will return a {Scrivito::ClassCollection} containing the available pages and the loaded
+  # widgets can be inspected with {Scrivito::ModelLibrary#widgets Scrivito.models.widgets}, which
+  # will return a {Scrivito::ClassCollection} containing the available widgets.
+  # All available CMS object models can be inspected with
+  # {Scrivito::ModelLibrary#objs Scrivito.models.objs}.
+  # The {Scrivito::ModelLibrary#pages Scrivito.models.pages} will also include the +Page+ model, if
+  # it is defined in +page.rb+, and {Scrivito::ModelLibrary#objs Scrivito.models.objs} will include
+  # the +Obj+ model.
+  #
+  # Scrivito recursively scans for CMS models in all directories from
   # {Scrivito::ModelLibrary#paths Scrivito.models.paths}, which is an array of strings.
   # By default, Scrivito includes the +app/models+ directory of the Rails application when searching
-  # for models. It will, for example, find the following page and widget models:
-  #
-  # +app/models/my_page.rb+
-  #
-  # +app/models/my_widget.rb+
+  # for models. It will, for example, find the following page, widget and obj models:
   #
-  # +app/models/my_namespace/my_other_page.rb+
+  #   app/models/my_page.rb
+  #   app/models/my_widget.rb
+  #   app/models/my_obj.rb
   #
-  # +app/models/my_namespace/my_other_widget.rb+
+  #   app/models/my_namespace/my_other_page.rb
+  #   app/models/my_namespace/my_other_widget.rb
+  #   app/models/my_namespace/my_other_obj.rb
   #
-  # +app/models/my_namespace/my_other_namespace/my_other_special_page.rb+
-  #
-  # +app/models/my_namespace/my_other_namespace/my_other_special_widget.rb+
+  #   app/models/my_namespace/my_other_namespace/my_other_special_page.rb
+  #   app/models/my_namespace/my_other_namespace/my_other_special_widget.rb
+  #   app/models/my_namespace/my_other_namespace/my_other_special_obj.rb
   #
   # Also, {Scrivito::ModelLibrary#paths Scrivito.models.paths} includes all +app/models+
   # directories of any available Rails engine, provided that these directories are included in the
-  # autoload paths of Rails (which is the default). For example, it will find the following page
-  # and widget models in an engine:
-  #
-  # +/../some_engine/app/models/my_page.rb+
+  # autoload paths of Rails (which is the default). For example, it will find the following page,
+  # widget and obj models in an engine:
   #
-  # +/../some_engine/app/models/my_widget.rb+
+  #   /../some_engine/app/models/my_page.rb
+  #   /../some_engine/app/models/my_widget.rb
+  #   /../some_engine/app/models/my_obj.rb
   #
-  # +/../some_engine/app/models/my_namespace/my_other_page.rb+
+  #   /../some_engine/app/models/my_namespace/my_other_page.rb
+  #   /../some_engine/app/models/my_namespace/my_other_widget.rb
+  #   /../some_engine/app/models/my_namespace/my_other_obj.rb
   #
-  # +/../some_engine/app/models/my_namespace/my_other_widget.rb+
-  #
-  # +/../some_engine/app/models/my_namespace/my_other_namespace/my_other_special_page.rb+
-  #
-  # +/../some_engine/app/models/my_namespace/my_other_namespace/my_other_special_widget.rb+
+  #   /../some_engine/app/models/my_namespace/my_other_namespace/my_other_special_page.rb
+  #   /../some_engine/app/models/my_namespace/my_other_namespace/my_other_special_widget.rb
+  #   /../some_engine/app/models/my_namespace/my_other_namespace/my_other_special_obj.rb
   #
   # You can add custom directories to scan for models and register single page and widget models
   # using {Scrivito::ModelLibrary#define Scrivito.models.define} (see examples below).
   #
-  # The loaded pages can be inspected with {Scrivito::ModelLibrary#pages Scrivito.models.pages},
-  # which will return a {Scrivito::ClassCollection} containing the available pages.
-  # The loaded widgets can be inspected with {Scrivito::ModelLibrary#widgets Scrivito.models.widgets},
-  # which will return a {Scrivito::ClassCollection} containing the available widgets.
-  #
   # The scan results are cached. If +Rails.application.config.cache_classes+ is +false+, the
   # cache is cleared on every request. Otherwise, the cache is kept between the requests.
   # You can clear the cache using {Scrivito::ModelLibrary#clear_cache Scrivito.models.clear_cache}.
   #
   # @example Register a custom path:
   #   Scrivito.models.define do
-  #     paths << Rails.root + 'lib/special_models'
+  #     paths << Rails.root + "lib/special_models"
   #   end
   #
   # @example Register pages and widgets with unusual names:
   #   Scrivito.models.define do
-  #     page 'MyCrazyPageModel'
-  #     page 'MyOtherCrazyPageModel1', 'MyOtherCrazyPageModel2'
+  #     page "MyCrazyPageModel"
+  #     page "MyOtherCrazyPageModel1", "MyOtherCrazyPageModel2"
   #
-  #     widget 'MyCrazyWidgetModel'
-  #     widget 'MyOtherCrazyWidgetModel1', 'MyOtherCrazyWidgetModel2'
+  #     widget "MyCrazyWidgetModel"
+  #     widget "MyOtherCrazyWidgetModel1", "MyOtherCrazyWidgetModel2"
+  #   end
+  #
+  # @example Register CMS model classes, whose files Scrivito would _not_ find in {Scrivito::ModelLibrary#paths paths}:
+  #   class MyPage < Obj; end
+  #   class MyWidget < Widget; end
+  #   class MyObj < Obj; end
+  #
+  #   Scrivito.models.define do
+  #     page "MyPage"
+  #     widget "MyWidget"
+  #     obj "MyObj"
   #   end
   #
   # @example Iterate over the available pages:
@@ -108,6 +125,16 @@ module Scrivito
   #   #=> "MyOtherWidget"
   #   # ...
   #
+  # @example Iterate over the available CMS object models:
+  #   Scrivito.models.objs.each do |obj_class|
+  #     puts obj_class.name
+  #   end
+  #   #=> "MyPage"
+  #   #=> "MyOtherPage"
+  #   #=> "MyObj"
+  #   #=> "MyOtherObj"
+  #   # ...
+  #
   def self.models
     @models ||= ModelLibrary.new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0.rc1
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +188,7 @@ 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/blob.json.jbuilder
 - app/views/scrivito/blobs/upload_permission.json.jbuilder
 - app/views/scrivito/completion/suggest.json.jbuilder
 - app/views/scrivito/content_widget/show.html.erb
@@ -233,10 +247,10 @@ files:
 - lib/generators/scrivito/install/templates/app/models/page.rb
 - lib/generators/scrivito/install/templates/app/models/text_widget.rb
 - lib/generators/scrivito/install/templates/app/models/widget.rb
-- lib/generators/scrivito/install/templates/app/views/download/embed.html.erb
+- lib/generators/scrivito/install/templates/app/views/download/details.html.erb
 - lib/generators/scrivito/install/templates/app/views/headline_widget/show.html.erb
 - lib/generators/scrivito/install/templates/app/views/headline_widget/thumbnail.html.erb
-- lib/generators/scrivito/install/templates/app/views/image/embed.html.erb
+- lib/generators/scrivito/install/templates/app/views/image/details.html.erb
 - lib/generators/scrivito/install/templates/app/views/image_widget/show.html.erb
 - lib/generators/scrivito/install/templates/app/views/image_widget/thumbnail.html.erb
 - lib/generators/scrivito/install/templates/app/views/layouts/scrivito_dialog.html.erb
@@ -380,7 +394,6 @@ files:
 - 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
 - lib/scrivito/workspace.rb
 - lib/scrivito/workspace/publish_checker.rb
@@ -405,9 +418,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/generators/scrivito/install/templates/app/views/download/embed.html.erb

@@ -1 +0,0 @@
-<%= link_to obj.display_title, obj.binary_url %>

data/lib/generators/scrivito/install/templates/app/views/image/embed.html.erb

@@ -1 +0,0 @@
-<%= scrivito_image_tag obj %>

data/lib/scrivito/widget_garbage_collection.rb

@@ -1,97 +0,0 @@
-module Scrivito
-
-class WidgetGarbageCollection
-
-  # @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.
-  #   each content object must either be the obj itself or a widget that lives inside the obj.
-  def initialize(obj, update)
-    if update.blank?
-      raise ScrivitoError, "blank update!"
-    end
-
-    update.keys.each do |content|
-      if content.is_a?(BasicObj)
-        raise "invalid obj given" unless content == obj
-      elsif content.is_a?(BasicWidget)
-        raise "invalid widget given" unless content.obj == obj
-      else
-        raise "invalid key"
-      end
-    end
-
-    @update = update
-    @obj = obj
-  end
-
-  # @return [Array] list containing the widgets that are no longer needed after the update.
-  def widgets_to_delete
-    dereferenced = []
-    newreferenced = []
-
-    @update.each do |content, params|
-      (deref, newref) = changed_references_from(content, params)
-      dereferenced += deref
-      newreferenced += newref
-    end
-
-    deleted_by_dereference = dereferenced - newreferenced
-
-    recursively_deleted = []
-    deleted_by_dereference.each do |widget|
-      recursively_deleted += all_widgets_contained_in_except(widget, newreferenced)
-    end
-
-    # we dont want to slow down every request by scanning for orphans, so
-    # we only do this when widgets are being deleted
-    if deleted_by_dereference.present?
-      orphans = @obj.all_widgets_from_pool - @obj.contained_widgets - newreferenced
-    else
-      orphans = []
-    end
-
-    deleted_by_dereference + recursively_deleted + orphans
-  end
-
-  private
-
-  def all_widgets_contained_in_except(widget, exceptions)
-    widget_children = widget.referenced_widgets - exceptions
-
-    widget_descendants = widget_children.map do |child|
-      all_widgets_contained_in_except(child, exceptions)
-    end.flatten
-
-    widget_children + widget_descendants
-  end
-
-  def changed_references_from(content, params)
-    dereferenced_ids = []
-    newreferenced_ids = []
-
-    if content.kind_of?(BasicWidget) && !content.persisted?
-      params.each_value do |value|
-        if value.kind_of?(Array)
-          newreferenced_ids += value.select { |v| v.kind_of?(BasicWidget) }
-        end
-      end
-    else
-      params.each do |key, value|
-        if content.type_of_attribute(key) == 'widgetlist'
-          current = content[key] || []
-          new = value || []
-
-          dereferenced_ids += current - new
-          newreferenced_ids += new - current
-        end
-      end
-    end
-
-    [dereferenced_ids, newreferenced_ids]
-  end
-
-end
-
-end