scrivito_sdk 0.30.0.rc1 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbff45be246233cd7451a407ed46408c36322d0d
-  data.tar.gz: fb419781d2d22902ebf33cac737e83aab5fab40e
+  metadata.gz: fd0c1ffc8470dc6f7ca27d29bd2d635ceae5c5a1
+  data.tar.gz: 588a8a4d6d2628c11a5925ea7020bd2267f4b3f5
 SHA512:
-  metadata.gz: 688e86b1a099cc1a3dd3c53817be88772167f87fb28fb27c9f5c3aa513bcafff5170a62df30dd174a0d95d103834f6c25871d350d2c3c8d2b2c8d7276b957f4b
-  data.tar.gz: abcea67939882a5911bde30834f84f854397a00fe26ec123f3bba27ad276e19177e507f29d04fff5517ab3e55cdfc3f7cb73e58d60a7b7cf533a147510719246
+  metadata.gz: 62b5c246878323c56f14dd6851ab1f237734d69789df04174a08f9a5b8aadb78c59318c79cd136405752a381713fd50aaea949611402ed4c6437236d570469da
+  data.tar.gz: fca203f4ff776702065138977207743d0a7cdbe99235d01a0f3ee523d8d3119624771cec4c8e85ea88d46d5ece989a684e1ea4d8ffe2f504d49160c286ddf0d4

data/app/helpers/scrivito_helper.rb

@@ -78,17 +78,18 @@ module ScrivitoHelper
   end
 
   #
-  # Calculates an HTML image tag of an image storeg in the CMS for inplace editing.
+  # Calculates an HTML image tag of an image stored in the CMS for inplace editing.
   #
   # @api public
   #
   # @note If you do not specify an HTML +alt+ attribute, the helper method will use
   #   +display_title+ of the target object
   #
-  # @param [Obj] obj Obj with an attribute of type +LinkList+
-  # @param [String, Symbol] field_name Name of +LinkList+, +reference+ or +link+ attribute,
-  #   which contains the image
-  # @param [Hash] tag_options Additional HTML attributes for the tag
+  # @param [Obj] obj Obj with a +link_list+, +reference+, +link+ or +binary+ attribute
+  # @param [String, Symbol, Hash] field_name_or_tag_options Name of +link_list+, +reference+, +link+, or +binary+
+  #   attribute, which contains the image or additional HTML attributes for the tag
+  # @param [Hash]  tag_or_editing_options Additional HTML attributes for the tag or
+  #   the editing options if no +field_name+ was given
   # @param [Hash] editing_options Additional options for inplace editing
   # @option editing_options [String] :placeholder ('/assets/scrivito/image_placeholder.png') URL
   #   or path to image to be displayed if target is missing
@@ -99,17 +100,33 @@ module ScrivitoHelper
   #   scrivito_image_tag @obj, :my_linklist, {}, placeholder: image_path('my_placeholder.png')
   #   scrivito_image_tag @obj, :my_linklist, {class: 'my_image'}, placeholder: 'http://placehold.it/350x150'
   #
-  # @example Create image tag for reference attributes.
+  # @example Create image tag for a reference attribute.
   #   scrivito_image_tag @obj, :my_reference
   #
-  # @example Create image tag for link attributes.
+  # @example Create image tag for a link attribute.
   #   scrivito_image_tag @obj, :my_link
   #
+  # @example Create image tag for a binary attribute
+  #   scrivito_image_tag @obj, :my_binary
+  #
+  # @example Create image tag for a binary object
+  #   scrivito_image_tag @image
+  #
   # @return [String] HTML image tag
   #
-  def scrivito_image_tag(obj, field_name, tag_options = {}, editing_options = {})
+  # @raise [ScrivitoError] if +field_name+ is not set and obj is not binary
+  #
+  def scrivito_image_tag(obj, field_name_or_tag_options=nil,
+                         tag_or_editing_options = {}, editing_options = {})
+    field_name, tag_options, editing_options =
+      if field_name_or_tag_options.is_a?(Hash)
+        [nil, field_name_or_tag_options, tag_or_editing_options]
+      else
+        [field_name_or_tag_options, tag_or_editing_options, editing_options]
+      end
+
     options = Scrivito::ImageTagHelper.new(self).options(obj, field_name,
-        tag_options.symbolize_keys, editing_options.symbolize_keys)
+        tag_options.with_indifferent_access, editing_options.with_indifferent_access)
     scrivito_tag('img', obj, field_name, options)
   end
 

data/lib/assets/javascripts/scrivito_sdk.js

@@ -14802,12 +14802,7 @@ var scrivito = {};
   };
 
   var build_cms_element = function(dom_element) {
-    var cms_element = scrivito.cms_element.from_dom_element(dom_element);
-    if (cms_element) {
-      return cms_element;
-    } else {
-      $.error('Can not call "scrivito" method on a non-cms tag');
-    }
+    return scrivito.cms_element.from_dom_element(dom_element);
   };
 
   var save_content = function(dom_element, content) {
@@ -14846,19 +14841,24 @@ var scrivito = {};
     };
   };
 
-  // @api public
-  $.fn.scrivito = function(method, content) {
-    switch (method) {
-      case 'save':
-        return save_content($(this), content);
-      case 'content':
-        return get_original_content($(this));
-      case 'menu':
-        return get_menu($(this));
-      default:
-        $.error('Unknown method "' + method + '"');
+  $.extend(scrivito, {
+    // @api public
+    jquery_plugin: function(method, content) {
+      switch (method) {
+        case 'save':
+          return save_content($(this), content);
+        case 'content':
+          return get_original_content($(this));
+        case 'menu':
+          return get_menu($(this));
+        default:
+          $.error('Unknown method "' + method + '"');
+      }
     }
-  };
+  });
+
+  $.fn.scrivito = scrivito.jquery_plugin;
+
 }());
 (function() {
   var callbacks = {};
@@ -15925,6 +15925,8 @@ $(function() {
   scrivito.cms_element.definitions.push(scrivito.child_list_element);
 });
 (function() {
+  var expando = "scrivito_cms_element";
+
   $.extend(scrivito, {
     cms_element: {
       create_instance: function(dom_element) {
@@ -15955,13 +15957,27 @@ $(function() {
       },
 
       from_dom_element: function(dom_element) {
-        var cms_element = scrivito.cms_element.create_instance(dom_element);
+        if (!dom_element || !dom_element.jquery || dom_element.length === 0) {
+          $.error("Expected a jquery instance with exactly one element, " +
+              "instead got " + dom_element);
+        }
 
-        var instance;
-        _.find(scrivito.cms_element.definitions, function(definition) {
-          instance = definition.create_instance(cms_element);
-          return instance;
-        });
+        var instance = dom_element[0][expando];
+
+        if (!instance) {
+          var cms_element = scrivito.cms_element.create_instance(dom_element);
+
+          _.find(scrivito.cms_element.definitions, function(definition) {
+            instance =  definition.create_instance(cms_element);
+            return instance;
+          });
+
+          if (!instance) {
+            $.error("This dom element is not a scrivito tag.");
+          }
+
+          dom_element[0][expando] = instance;
+        }
 
         return instance;
       },

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

@@ -6,8 +6,7 @@ module Scrivito
       source_root File.expand_path('../templates', __FILE__)
 
       def self.next_migration_number(dirname)
-        migration_number = current_migration_number(dirname) + 1
-        [Time.now.utc.strftime('%Y%m%d%H%M%S'), '%.14d' % migration_number].max
+        Scrivito::Migration.next_migration_number(current_migration_number(dirname))
       end
 
       def copy_initializer
@@ -24,8 +23,8 @@ module Scrivito
       end
 
       def copy_migration
-        destination_path = File.join(Scrivito::Configuration.migration_path, 'install_scrivito.rb')
-        migration_template 'scrivito/migrate/install_scrivito.rb', destination_path
+        migration_template 'scrivito/migrate/install_scrivito_migration.rb',
+          File.join(Scrivito::Configuration.migration_path, 'install_scrivito_migration.rb')
       end
 
       def copy_page_resources

data/lib/generators/scrivito/install/templates/app/views/page/index.html.erb

@@ -3,7 +3,7 @@
 
   <%= scrivito_tag_list :ul, Obj.homepage, :toclist do |list, page| %>
     <%= list.tag :li do %>
-      <%= link_to page[:title].presence || '(Untitled)', scrivito_path(page) %>
+      <%= link_to page.display_title, scrivito_path(page) %>
     <% end %>
   <% end %>
 

data/lib/generators/scrivito/install/templates/scrivito/migrate/{install_scrivito.rb → install_scrivito_migration.rb}

@@ -1,4 +1,4 @@
-class InstallScrivito < Scrivito::Migration
+class InstallScrivitoMigration < Scrivito::Migration
   def up
     Scrivito::ObjClass.create(name: 'Page', attributes: [
       {name: 'title', type: 'string'},

data/lib/generators/scrivito/migration/migration_generator.rb

@@ -1,16 +1,18 @@
 module Scrivito
-  class MigrationGenerator < ::Rails::Generators::NamedBase
-    include ::Rails::Generators::Migration
+  module Generators
+    class MigrationGenerator < ::Rails::Generators::NamedBase
+      include ::Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
 
-    def self.next_migration_number(dirname)
-      Time.now.utc.strftime('%Y%m%d%H%M%S')
-    end
+      def self.next_migration_number(dirname)
+        Scrivito::Migration.next_migration_number(current_migration_number(dirname))
+      end
 
-    def create_migration_file
-      base_path = Scrivito::Configuration.migration_path
-      migration_template('migration.erb', File.join(base_path, "#{file_name}.rb"))
+      def generate_migration
+        migration_template 'migration.erb',
+          File.join(Scrivito::Configuration.migration_path, "#{file_name}_migration.rb")
+      end
     end
   end
 end

data/lib/generators/scrivito/migration/templates/migration.erb

@@ -1,4 +1,4 @@
-class <%= class_name %> < ::Scrivito::Migration
+class <%= class_name %>Migration < ::Scrivito::Migration
   def up
     # This migration file allows to create and modify object class definitions or to change the CMS
     # content programatically. All Scrivito SDK classes and methods are available and arbitrary Ruby
@@ -15,7 +15,7 @@ class <%= class_name %> < ::Scrivito::Migration
     # To get you started, here is a list of the most common SDK methods to alter the CMS content.
     #
     # @example Create a new non-binary obj class named "Homepage" that has a "string" attribute named "locale".
-    #   Scrivito::ObjClass.create(name: 'Homepage', is_binary: false, attributes: [
+    #   Scrivito::ObjClass.create(name: 'Homepage', attributes: [
     #     {name: 'locale', type: :string}
     #   ])
     #

data/lib/generators/scrivito/page/page_generator.rb

@@ -0,0 +1,32 @@
+module Scrivito
+  module Generators
+    class PageGenerator < ::Rails::Generators::NamedBase
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        Scrivito::Migration.next_migration_number(current_migration_number(dirname))
+      end
+
+      def create_model
+        template 'model.erb', "app/models/#{file_name}.rb"
+      end
+
+      def generate_migration
+        migration_template 'migration.erb',
+          File.join(Scrivito::Configuration.migration_path, "create_#{file_name}_migration.rb")
+      end
+
+      def create_controller
+        template 'controller.erb', "app/controllers/#{file_name}_controller.rb"
+      end
+
+      def create_views
+        copy_file 'index.html.erb', "app/views/#{file_name}/index.html.erb"
+        copy_file 'details.html.erb', "app/views/#{file_name}/details.html.erb"
+        template 'thumbnail.html.erb', "app/views/#{file_name}/thumbnail.html.erb"
+      end
+    end
+  end
+end

data/lib/generators/scrivito/page/templates/controller.erb

@@ -0,0 +1,2 @@
+class <%= class_name %>Controller < CmsController
+end

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

@@ -0,0 +1 @@
+<%= scrivito_tag :div, @obj, :title %>

data/lib/generators/scrivito/page/templates/index.html.erb

@@ -0,0 +1,8 @@
+<%= scrivito_tag_list :ul, @obj, :toclist do |list, child| %>
+  <%= list.tag :li do %>
+    <%= link_to child.display_title, scrivito_path(child) %>
+  <% end %>
+<% end %>
+
+<%= scrivito_tag :h1, @obj, :title %>
+<%= scrivito_tag :div, @obj, :body %>

data/lib/generators/scrivito/page/templates/migration.erb

@@ -0,0 +1,9 @@
+class Create<%= class_name %>Migration < ::Scrivito::Migration
+  def up
+    Scrivito::ObjClass.create(name: '<%= class_name %>', attributes: [
+      {name: 'title',       type: :string},
+      {name: 'body',        type: :widget},
+      {name: 'child_order', type: :referencelist},
+    ])
+  end
+end

data/lib/generators/scrivito/page/templates/model.erb

@@ -0,0 +1,9 @@
+class <%= class_name %> < Obj
+  #
+  # = Scrivito Attributes
+  #
+  #   title:       string
+  #   body:        widget
+  #   child_order: referencelist
+  #
+end

data/lib/generators/scrivito/page/templates/thumbnail.html.erb

@@ -0,0 +1,3 @@
+<%%= scrivito_thumbnail '<%= class_name %>', :content do %>
+  <%= class_name %> Page
+<%% end %>

data/lib/generators/scrivito/widget/templates/migration.erb

@@ -1,12 +1,7 @@
-class Create<%= class_name %> < ::Scrivito::Migration
+class Create<%= class_name %>Migration < ::Scrivito::Migration
   def up
-    Scrivito::ObjClass.create(
-      name: '<%= class_name %>',
-      is_binary: false,
-      title: '<%= class_name.underscore.humanize %>',
-      # attributes: [
-      #   { name: 'example', type: :string },
-      # ]
-    )
+    Scrivito::ObjClass.create(name: '<%= class_name %>', attributes: [
+      # {name: 'example', type: :string},
+    ])
   end
 end

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

@@ -1,3 +1,3 @@
 <%%= scrivito_thumbnail '<%= class_name %>' do %>
-  <% class_name %> Widget
+  <%= class_name %> Widget
 <%% end %>

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

@@ -6,25 +6,22 @@ module Scrivito
       source_root File.expand_path('../templates', __FILE__)
 
       def self.next_migration_number(dirname)
-        max = current_migration_number(dirname)
-        Scrivito::Migration.next_migration_number(max)
+        Scrivito::Migration.next_migration_number(current_migration_number(dirname))
       end
 
-      def generate_model
-        template('model.erb', "app/models/#{file_name}.rb")
+      def create_model
+        template 'model.erb', "app/models/#{file_name}.rb"
       end
 
-      def generate_views
-        path = "app/views/#{file_name}"
-
-        template('show.html.erb', "#{path}/show.html.erb")
-        template('details.html.erb', "#{path}/details.html.erb")
-        template('thumbnail.html.erb', "#{path}/thumbnail.html.erb")
+      def create_views
+        template 'show.html.erb', "app/views/#{file_name}/show.html.erb"
+        template 'details.html.erb', "app/views/#{file_name}/details.html.erb"
+        template 'thumbnail.html.erb', "app/views/#{file_name}/thumbnail.html.erb"
       end
 
       def generate_migration
-        base_path = Scrivito::Configuration.migration_path
-        migration_template('migration.erb', File.join(base_path, "/create_#{file_name}.rb"))
+        migration_template 'migration.erb',
+          File.join(Scrivito::Configuration.migration_path, "create_#{file_name}_migration.rb")
       end
     end
   end

data/lib/scrivito/basic_obj.rb

@@ -484,12 +484,9 @@ module Scrivito
     # handled differently in that they are not rendered using the normal layout
     # but sent as a file. Examples of binary resources are Images or PDFs.
     #
-    # By default every Obj that has an attribute +blob+ of the type +binary+ is
+    # Every Obj that has an attribute +blob+ of the type +binary+ is
     # considered a binary
     #
-    # @note you can override this method to indicate that an Obj is binary,
-    #   if the default behavior doesn't fit your needs
-    #
     # @return true if this Obj represents a binary resource.
     def binary?
       if obj_type = read_attribute('_obj_type')
@@ -663,9 +660,9 @@ module Scrivito
     # This method is intended for Objs that represent binary resources like
     # images or pdf documents. If this Obj represents a binary file, an instance
     # of {Binary} is returned.
-    # The default implementation returns the attribute "blob" (if available and
-    # of type +binary+).
-    # @note You may override this method in your subclasses.
+    #
+    # This method returns the attribute +blob+ if it is of the type +binary+.
+    #
     # @return [Binary, nil]
     def binary
       self[:blob] if self[:blob].is_a?(Binary)

data/lib/scrivito/cms_routing.rb

@@ -46,6 +46,8 @@ class CmsRouting < Struct.new(:request, :main_app)
       else
         return LINK_TO_EMPTY_LINKLIST
       end
+    elsif target.is_a?(Binary)
+      target.url
     else
       raise "scrivito_path or scrivito_url was called with an instance of #{target.class}. "+
         "It must only be called with an Obj or a Link or a non-empty LinkList."
@@ -68,7 +70,7 @@ class CmsRouting < Struct.new(:request, :main_app)
     else
       if obj.binary? && editing_context.display_mode != "editing"
         if obj.binary_url
-          self.class.match_protocol(obj.binary_url, request)
+          obj.binary_url
         else
           LINK_TO_EMPTY_BLOB
         end

data/lib/scrivito/image_tag_helper.rb

@@ -4,19 +4,33 @@ class ImageTagHelper < Struct.new(:view_context)
 
   def self.display_title(target)
     if target.respond_to?(:display_title)
-      return target.display_title
+      target.display_title
     elsif target.respond_to?(:first) && target.first.respond_to?(:display_title)
-      return target.first.display_title
+      target.first.display_title
+    elsif target.respond_to?(:filename)
+      target.filename
     end
   end
 
   def options(obj, field_name, tag_options, editing_options)
+    if field_name.nil?
+      field_name = determine_field_name(obj)
+    end
+
     tag_options.reverse_merge(src: scrivito_image_tag_src(obj, field_name, editing_options),
         alt: scrivito_image_tag_alt(obj, field_name))
   end
 
   private
 
+  def determine_field_name(obj)
+    if obj.binary?
+      :blob
+    else
+      raise ScrivitoError, "when omitting `field_name' you have to pass a binary obj"
+    end
+  end
+
   def scrivito_image_tag_src(obj, field_name, editing_options)
     scrivito_image_tag_path(obj, field_name) || editing_options[:placeholder] ||
         view_context.image_path('scrivito/image_placeholder.png')
@@ -31,8 +45,8 @@ class ImageTagHelper < Struct.new(:view_context)
     field_value = obj[field_name]
 
     case field_type
-    when 'reference' then field_value && view_context.scrivito_path(field_value)
-    when 'link' then field_value && view_context.scrivito_path(field_value)
+    when 'link', 'binary', 'reference'
+      field_value && view_context.scrivito_path(field_value)
     when 'linklist'
       path = view_context.scrivito_path(field_value)
       path == CmsRouting::LINK_TO_EMPTY_LINKLIST ? nil : path

data/lib/scrivito/migrations/migration.rb

@@ -48,14 +48,9 @@ module Scrivito
           end
         end
 
-        def next_migration_number(max)
-          timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-
-          if max >= timestamp
-            timestamp = max + 1
-          end
-
-          timestamp
+        def next_migration_number(current_migration_number)
+          migration_number = current_migration_number + 1
+          [Time.now.utc.strftime('%Y%m%d%H%M%S'), '%.14d' % migration_number].max
         end
       end
 

data/lib/scrivito/routing_helper.rb

@@ -12,7 +12,7 @@ module Scrivito
     #
     # @api public
     #
-    # @param target [Obj, Link, Array<Link>]
+    # @param target [Obj, Link, Array<Link>, Binary]
     #   If +target+ is an +Array+ of +Links+, it must be non-empty.
     #   The first {Link} from the +Array+ will be used.
     # @param options [Hash] include url settings such as path parameters or protocol.
@@ -28,7 +28,7 @@ module Scrivito
     #
     # @api public
     #
-    # @param target [Obj, Link, Array<Link>]
+    # @param target [Obj, Link, Array<Link>, Binary]
     #   If +target+ is an +Array+ of +Links+, it must be non-empty.
     #   The first {Link} from the +Array+ will be used.
     # @param options [Hash] include url settings such as path parameters or protocol.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 0.30.0.rc1
+  version: 0.30.0
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -225,10 +225,17 @@ files:
 - lib/generators/scrivito/install/templates/app/views/text_widget/show.html.erb
 - lib/generators/scrivito/install/templates/app/views/text_widget/thumbnail.html.erb
 - lib/generators/scrivito/install/templates/config/initializers/scrivito.rb
-- lib/generators/scrivito/install/templates/scrivito/migrate/install_scrivito.rb
+- lib/generators/scrivito/install/templates/scrivito/migrate/install_scrivito_migration.rb
 - lib/generators/scrivito/migration/USAGE
 - lib/generators/scrivito/migration/migration_generator.rb
 - lib/generators/scrivito/migration/templates/migration.erb
+- lib/generators/scrivito/page/page_generator.rb
+- lib/generators/scrivito/page/templates/controller.erb
+- lib/generators/scrivito/page/templates/details.html.erb
+- lib/generators/scrivito/page/templates/index.html.erb
+- lib/generators/scrivito/page/templates/migration.erb
+- lib/generators/scrivito/page/templates/model.erb
+- lib/generators/scrivito/page/templates/thumbnail.html.erb
 - lib/generators/scrivito/widget/templates/details.html.erb
 - lib/generators/scrivito/widget/templates/migration.erb
 - lib/generators/scrivito/widget/templates/model.erb
@@ -347,9 +354,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2