scrivito_sdk 0.41.1 → 0.42.0

data/lib/scrivito/sdk_engine.rb

@@ -6,7 +6,13 @@ require 'net/http/post/multipart'
 
 module ::Scrivito
   class SdkEngine < Rails::Engine
-    config.to_prepare { Scrivito::Configuration.to_prepare }
+    config.to_prepare do
+      Scrivito::Configuration.to_prepare
+
+      unless Rails.application.config.cache_classes
+        Scrivito.models.clear_cache
+      end
+    end
 
     # make sure our exceptions cause an adequate error page and http status code
     config.action_dispatch.rescue_responses.merge!("Scrivito::ResourceNotFound" => :not_found)

data/lib/scrivito/user.rb

@@ -108,8 +108,9 @@ module Scrivito
 
     def can?(verb, workspace)
       assert_valid_verb(verb)
-      verb == :read && workspace.published? || can_always?(verb, :workspace) ||
-          owner_of?(workspace) && !can_never?(verb, :workspace)
+      verb == :read && workspace.published? ||
+        can_always?(verb, :workspace) ||
+        verb != :create && owner_of?(workspace) && !can_never?(verb, :workspace)
     end
 
     def can_always?(verb, subject)

data/lib/scrivito/workspace_data.rb

@@ -0,0 +1,19 @@
+module Scrivito
+  class WorkspaceData
+    class << self
+      private
+
+      def data_attr_reader(attr_name)
+        define_method(attr_name) { @data[attr_name.to_s] }
+      end
+    end
+
+    data_attr_reader :id
+    data_attr_reader :title
+    data_attr_reader :memberships
+
+    def initialize(data)
+      @data = data
+    end
+  end
+end

data/lib/scrivito/workspace_data_from_rest_api.rb

@@ -0,0 +1,6 @@
+module Scrivito
+
+class WorkspaceDataFromRestApi < WorkspaceData
+end
+
+end

data/lib/scrivito/workspace_data_from_service.rb

@@ -1,6 +1,6 @@
 module Scrivito
 
-class WorkspaceDataFromService
+class WorkspaceDataFromService < WorkspaceData
   class << self
     # Fetches a workspace data previously store in cache storage.
     # Returns nil if not found.
@@ -9,26 +9,13 @@ class WorkspaceDataFromService
         new(data)
       end
     end
-
-    private
-
-    def data_attr_reader(attr_name)
-      define_method(attr_name) { @data[attr_name.to_s] }
-    end
   end
 
-  data_attr_reader :id
-  data_attr_reader :title
   data_attr_reader :revision_id
   data_attr_reader :content_state_id
   data_attr_reader :base_revision_id
   data_attr_reader :base_content_state_id
   data_attr_reader :diff
-  data_attr_reader :memberships
-
-  def initialize(data)
-    @data = data
-  end
 
   def content_state
     @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id

data/lib/scrivito_sdk.rb

@@ -18,6 +18,100 @@ module Scrivito
     yield Configuration
   end
 
+  #
+  # Configures which models Scrivito assumes as pages and widgets.
+  #
+  # @api private
+  #
+  # 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. That models can be defined in
+  # the Rails application itself or in 3rd-party gems.
+  #
+  # Scrivito will automatically assume all the classes descending from {Scrivito::BasicObj}, whose
+  # class names are ending with +Page+ are pages (e.g. +MyPage+, +HomePage+, +BlogPostPage+ etc.).
+  # It will also automatically assume all the classes descending from {Scrivito::BasicWidget}, whose
+  # class names are ending with +Widget+ are widgets (e.g. +TextWidget+, +ImageWdidget+ etc.).
+  #
+  # Scrivito will recursively scan for such models in all directories from
+  # {Scrivito::ModelLibrary#paths Scrivito.models.paths}, which is an array of strings.
+  # It by default includes the directory +app/models+ of the Rails application. For example it will
+  # find following page and widget models:
+  #
+  # +app/models/my_page.rb+
+  #
+  # +app/models/my_widget.rb+
+  #
+  # +app/models/my_namespace/my_other_page.rb+
+  #
+  # +app/models/my_namespace/my_other_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+
+  #
+  # Also {Scrivito::ModelLibrary#paths Scrivito.models.paths} will include all directories ending
+  # with +app/models+ of any available Rails engine, as long as that directory is included in the
+  # autoload paths of Rails (which is the default). For example it will find following page and
+  # widget models in an engine:
+  #
+  # +/../some_engine/app/models/my_page.rb+
+  #
+  # +/../some_engine/app/models/my_widget.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_namespace/my_other_special_page.rb+
+  #
+  # +/../some_engine/app/models/my_namespace/my_other_namespace/my_other_special_widget.rb+
+  #
+  # You can add custom directories to scan for models and register single page and widget models
+  # with {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 all available pages.
+  # The loaded widgets can be inspected with {Scrivito::ModelLibrary#widgets Scrivito.models.widgets},
+  # which will return a {Scrivito::ClassCollection} containing all available widgets.
+  #
+  # The scan results are cached. If +Rails.application.config.cache_classes+ is +false+, then the
+  # cache will be cleared on every request. Otherwise the cache will be kept between the requests.
+  # You can clear the cache with {Scrivito::ModelLibrary#clear_cache Scrivito.models.clear_cache}.
+  #
+  # @example Register a custom path
+  #   Scrivito.models.define do
+  #     paths << Rails.root + 'lib/special_models'
+  #   end
+  #
+  # @example Register pages and widgets with inconvenient names
+  #   Scrivito.models.define do
+  #     page 'MyCrazyPageModel'
+  #     page 'MyOtherCrazyPageModel1', 'MyOtherCrazyPageModel2'
+  #
+  #     widget 'MyCrazyWidgetModel'
+  #     widget 'MyOtherCrazyWidgetModel1', 'MyOtherCrazyWidgetModel2'
+  #   end
+  #
+  # @example Iterate over available pages
+  #   Scrivito.models.pages.each do |page_class|
+  #     puts page_class.name
+  #   end
+  #   #=> "MyPage"
+  #   #=> "MyOtherPage"
+  #   # ...
+  #
+  # @example Iterate over available widgets
+  #   Scrivito.models.widgets.each do |widget_class|
+  #     puts widget_class.name
+  #   end
+  #   #=> "MyWidget"
+  #   #=> "MyOtherWidget"
+  #   # ...
+  #
+  def self.models
+    @models ||= ModelLibrary.new
+  end
+
   def self.autoload_all_sources
     source_files = Dir.glob(File.expand_path("../scrivito/*.rb", __FILE__)).map do |file|
       File.basename(file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 0.41.1
+  version: 0.42.0
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -256,6 +256,8 @@ files:
 - lib/scrivito/attribute.rb
 - lib/scrivito/attribute_collection.rb
 - lib/scrivito/attribute_content.rb
+- lib/scrivito/attribute_definition.rb
+- lib/scrivito/attribute_definition_collection.rb
 - lib/scrivito/backend_error.rb
 - lib/scrivito/basic_obj.rb
 - lib/scrivito/basic_widget.rb
@@ -267,6 +269,7 @@ files:
 - lib/scrivito/cache_garbage_collector.rb
 - lib/scrivito/cache_middleware.rb
 - lib/scrivito/child_list_tag.rb
+- lib/scrivito/class_collection.rb
 - lib/scrivito/client_config.rb
 - lib/scrivito/client_error.rb
 - lib/scrivito/cms_backend.rb
@@ -314,6 +317,7 @@ files:
 - lib/scrivito/migrations/migrator.rb
 - lib/scrivito/migrations/workspace_lock.rb
 - lib/scrivito/model_identity.rb
+- lib/scrivito/model_library.rb
 - lib/scrivito/modification.rb
 - lib/scrivito/named_link.rb
 - lib/scrivito/network_error.rb
@@ -348,6 +352,8 @@ files:
 - lib/scrivito/widget_tag.rb
 - lib/scrivito/workspace.rb
 - lib/scrivito/workspace/publish_checker.rb
+- lib/scrivito/workspace_data.rb
+- lib/scrivito/workspace_data_from_rest_api.rb
 - lib/scrivito/workspace_data_from_service.rb
 - lib/scrivito/workspace_selection_middleware.rb
 - lib/scrivito_sdk.rb