scrivito_sdk 0.16.0 → 0.17.0

data/lib/assets/stylesheets/scrivito_editing.css

@@ -450,16 +450,16 @@ html.scrivito_bottombar_on {
   line-height: 15px;
   color: #eee;
 }
-.scrivito_menu_box .scrivito_menu_item.disabled span:hover,
-.scrivito_menu_box .scrivito_menu_item.disabled a:hover {
+.scrivito_menu_box .scrivito_menu_item.scrivito_disabled span:hover,
+.scrivito_menu_box .scrivito_menu_item.scrivito_disabled a:hover {
   cursor: help;
   color: #696969!important;
   background: #274324;
 }
-.scrivito_menu_box .scrivito_menu_item.disabled span,
-.scrivito_menu_box .scrivito_menu_item.disabled a,
-.scrivito_menu_box .scrivito_menu_item.disabled span .scrivito_icon,
-.scrivito_menu_box .scrivito_menu_item.disabled a .scrivito_icon {
+.scrivito_menu_box .scrivito_menu_item.scrivito_disabled span,
+.scrivito_menu_box .scrivito_menu_item.scrivito_disabled a,
+.scrivito_menu_box .scrivito_menu_item.scrivito_disabled span .scrivito_icon,
+.scrivito_menu_box .scrivito_menu_item.scrivito_disabled a .scrivito_icon {
   color: #696969!important;
   cursor: help;
 }
@@ -653,6 +653,11 @@ body.scrivito_editing_active {
   -moz-transition: box-shadow linear .5s;
   -o-transition: box-shadow linear .5s;
   transition: box-shadow linear .5s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_topbar .scrivito_first_level .scrivito_button_bar:hover,
 .scrivito_topbar .scrivito_first_level .scrivito_button_bar:focus,
@@ -697,6 +702,11 @@ body.scrivito_editing_active {
   -moz-transition: box-shadow linear .5s;
   -o-transition: box-shadow linear .5s;
   transition: box-shadow linear .5s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_topbar .scrivito_second_level .scrivito_separator {
   display: block;
@@ -788,6 +798,11 @@ body.scrivito_editing_active {
   -moz-transition: all ease-in-out .4s;
   -o-transition: all ease-in-out .4s;
   transition: all ease-in-out .4s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_viewmodes_wrapper.disable_trasitions .scrivito_viewmodes .scrivito_viewmode_pill {
   -webkit-transition: none;
@@ -887,8 +902,12 @@ body.scrivito_editing_active {
   font-size: 7px;
   color: #ddd;
 }
-.scrivito_menu_box.scrivito_switch_mode_menu {
+.scrivito_viewmodes .scrivito_viewmode_label .scrivito_menu_box {
   left: 18px;
+  top: 10px;
+}
+#scrivito_current_page_menu .scrivito_menu_box {
+  top: 20px;
 }
 .scrivito_editing_confirmation {
   display: none;
@@ -945,6 +964,11 @@ body.scrivito_editing_active {
   -moz-transition: background ease-in-out .6s;
   -o-transition: background ease-in-out .6s;
   transition: background ease-in-out .6s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_editing_marker:hover,
 .scrivito_editing_marker:active {
@@ -953,6 +977,11 @@ body.scrivito_editing_active {
   -moz-transition: background ease-in-out .2s;
   -o-transition: background ease-in-out .2s;
   transition: background ease-in-out .2s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_editing_marker .scrivito_icon {
   padding: 0;
@@ -1004,6 +1033,11 @@ body.scrivito_editing_active {
   -moz-transition: opacity ease-in-out .4s;
   -o-transition: opacity ease-in-out .4s;
   transition: opacity ease-in-out .4s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
   pointer-events: none;
 }
 [data-scrivito-display-mode="editing"] [data-scrivito-private-child-list-path].scrivito_entered:hover > .scrivito_editing_marker .scrivito_editing_marker_title,
@@ -1016,6 +1050,11 @@ body.scrivito_editing_active {
   -moz-transition: opacity ease-in-out .4s;
   -o-transition: opacity ease-in-out .4s;
   transition: opacity ease-in-out .4s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_structure_marker {
   display: block;
@@ -1044,6 +1083,11 @@ body.scrivito_editing_active {
   -moz-transition: background ease-in-out .6s;
   -o-transition: background ease-in-out .6s;
   transition: background ease-in-out .6s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_structure_marker:hover,
 .scrivito_structure_marker:active {
@@ -1053,6 +1097,11 @@ body.scrivito_editing_active {
   -moz-transition: background ease-in-out .2s;
   -o-transition: background ease-in-out .2s;
   transition: background ease-in-out .2s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_structure_marker .scrivito_icon {
   padding: 0;
@@ -1222,16 +1271,26 @@ a.scrivito_button:active {
   -moz-transition: opacity 0.1s linear;
   -o-transition: opacity 0.1s linear;
   transition: opacity 0.1s linear;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
   background: rgba(0, 0, 0, 0.8);
 }
 .scrivito_overlay.scrivito_show {
-  z-index: 222222;
+  z-index: 333333;
   opacity: 0.85;
   filter: alpha(opacity=85);
   -webkit-transition: opacity 0.6s linear;
   -moz-transition: opacity 0.6s linear;
   -o-transition: opacity 0.6s linear;
   transition: opacity 0.6s linear;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_overlay .scrivito_processing {
   display: block;
@@ -1563,7 +1622,7 @@ a.scrivito_button:active {
   position: fixed;
   left: 50%;
   top: -100%;
-  z-index: 1000;
+  z-index: 333333;
   overflow: auto;
   color: #fff;
   width: 500px;
@@ -1580,6 +1639,11 @@ a.scrivito_button:active {
   -moz-transition: all 0.45s ease-in;
   -o-transition: all 0.45s ease-in;
   transition: all 0.45s ease-in;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_modal_prompt.scrivito_show {
   top: 50%;
@@ -1667,6 +1731,11 @@ a.scrivito_button:active {
   -moz-transition: all 0.25s ease-in;
   -o-transition: all 0.25s ease-in;
   transition: all 0.25s ease-in;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_modal_small {
   width: 500px;
@@ -1812,6 +1881,12 @@ a.scrivito_button:active {
   vertical-align: middle;
   line-height: 14px;
 }
+.scrivito_details_dialog .scrivito_modal_header .scrivito_saving_state_bar {
+  right: 50px;
+}
+.scrivito_details_dialog .scrivito_modal_header .scrivito_menu_box {
+  top: 20px;
+}
 .scrivito_changes_overview.scrivito_modal_large .scrivito_modal_header select {
   font-weight: normal;
   border: 0px;
@@ -2147,6 +2222,11 @@ a.scrivito_button:active {
   -moz-transition: all ease-in-out .3s;
   -o-transition: all ease-in-out .3s;
   transition: all ease-in-out .3s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
   -webkit-border-radius: 5px;
   -moz-border-radius: 5px;
   border-radius: 5px;
@@ -2161,6 +2241,11 @@ a.scrivito_button:active {
   -moz-transition: all ease-in-out .3s;
   -o-transition: all ease-in-out .3s;
   transition: all ease-in-out .3s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_editing_widget_preview:active,
 .scrivito_editing_widget_preview.selected {
@@ -2173,6 +2258,11 @@ a.scrivito_button:active {
   -moz-transition: all ease-in-out .3s;
   -o-transition: all ease-in-out .3s;
   transition: all ease-in-out .3s;
+  -webkit-transform: translate3d(0, 0, 0);
+  -moz-transform: translate3d(0, 0, 0);
+  -ms-transform: translate3d(0, 0, 0);
+  -o-transform: translate3d(0, 0, 0);
+  transform: translate3d(0, 0, 0);
 }
 .scrivito_editing_widget_preview .scrivito_editing_widget_visualization {
   height: 120px;

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

@@ -1,10 +1,38 @@
 class <%= class_name %> < ::Scrivito::Migration
   def up
-    # get_obj_class('Test')
-    # create_obj_class(name: 'Test', type: :publication, attributes: [])
-    # update_obj_class('Test', title: 'Test Title')
-    # add_attribute_to('Test', { name: 'test', type: 'string' })
-    # update_attribute_for('Test', 'test', { title: 'New Title' })
-    # delete_attribute_from('Test', 'test')
+    # 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
+    # code can be executed.
+    #
+    # Use `bundle exec rake cms:migrate` to run all migrations that are new to the `rtc` workspace.
+    # Migrations are identified by an ID and only get executed once. If you migrate the CMS an
+    # existing `rtc` workspace is used or a new `rtc` workspace is created. Only one developer at a
+    # time can run migrations, which means to quickly try to publish the current migrations.
+    #
+    # Use `bundle exec rake cms:migrate:publish` to publish your `rtc` workspace that holds the
+    # latest unpublished migrations.
+    #
+    # To get you started, here is a list of the most common SDK methods to alter the CMS content.
+    #
+    # @example Create a new obj class named "Homepage" of type "publication" that has a "string" attribute named "locale".
+    #   Scrivito::ObjClass.create(name: 'Homepage', type: :publication, attributes: [
+    #     {name: 'locale', type: :string}
+    #   ])
+    #
+    # @example Find the obj class named "Homepage".
+    #   Scrivito::ObjClass.find('Homepage')
+    #
+    # @example Update the "title" of an obj class named "Homepage".
+    #   Scrivito::ObjClass.find('Homepage').update(title: 'Home')
+    #
+    # @example Add an "enum" attribute named "category" to the obj class named "Homepage".
+    #   Scrivito::ObjClass.find('Homepage').attributes.add(name: 'category', type: :enum, values: %w(tech, social))
+    #
+    # @example Update the "category" attribute and add another value.
+    #   attribute = Scrivito::ObjClass.find('Homepage').attributes['category']
+    #   attribute.update(values: attribute.values << 'media')
+    #
+    # @example Destroy the attribute "category" from the obj class "Homepage".
+    #   Scrivito::ObjClass.find('Homepage').attributes['category'].destroy
   end
 end

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

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

data/lib/scrivito/attribute.rb

@@ -0,0 +1,158 @@
+module Scrivito
+  # This class represents a CMS attribute. Attributes can be created, updated, deleted and all
+  # attribute properties can be read. Attributes are part of an
+  # {Scrivito::ObjClass} and therefore each attribute belongs to exactly
+  # one {Scrivito::ObjClass}. Most of the operations interact with the currently
+  # selected {Scrivito::Workspace}. Operations like +create+, +destroy+
+  # and +update+ need to be performed in the "rtc" workspace.
+  #
+  # @api public
+  class Attribute
+    include ModelIdentity
+
+    # Initializes a new attribute.
+    #
+    # @api public
+    #
+    # This allows you to set the different properties of an attribute by
+    # providing a Hash with the property names as keys and the values you want to set as values.
+    #
+    # @example Create a new attribute with name "locale" and type "string".
+    #   Attribute.new(name: 'locale', type: :string)
+    #
+    # @example Create a new "enum" attribute named "category" and provide values.
+    #   Attribute.new(name: 'category', type: :enum, values: %w(tech social))
+    #
+    # @param [Hash] properties
+    # @option properties [String] :name The name of the attribute.
+    # @option properties [String] :type The type of the attribute, can be +string+, +text+, +html+, +linklist+, +link+, +reference+, +referencelist+, +date+, +binary+, +widget+, +enum+ or +multienum+.
+    # @option properties [Array<String>] :values Possible values if the type is either +enum+ or +multienum+.
+    #
+    # @return [Scrivito::Attribute]
+    # @raise [Scrivito::ScrivitoError] Raised when no +properties+ are provided.
+    def initialize(properties)
+      raise ScrivitoError, 'Please provide a hash of Attribute properties.' unless properties
+
+      update_instance_properties(properties)
+    end
+
+    # Returns the name of this attribute.
+    # @api public
+    # @return [String]
+    def name
+      @name
+    end
+
+    # Returns the type of this attribute. The type is either +string+, +text+, +html+, +linklist+,
+    # +link+, +reference+, +referencelist+, +date+, +binary+, +widget+, +enum+ or +multienum+.
+    # @api public
+    # @return [String]
+    def type
+      @type
+    end
+
+    # Returns the values of this attribute, if it is of type +enum+ or +multienum+.
+    # @api public
+    # @return [Array<String>] values
+    def values
+      @values
+    end
+
+    # Returns the obj class this attribute belongs to.
+    # @api public
+    # @return [Scrivito::ObjClass]
+    attr_reader :obj_class
+
+    # Returns a unique identifier of this attribute. An attribute is unique by
+    # its +name+ and its +obj_class+. Implements the {Scrivito::ModelIdentity} interface.
+    # @return [Array]
+    def id
+      [name, obj_class]
+    end
+
+    # Binds this attribute to an obj class.
+    # @return [Scrivito::ObjClass]
+    attr_writer :obj_class
+
+    # Updates this attribute and persists the changes
+    # in the CMS on its obj class. The +obj_class+ and +name+ of this attribute can not be updated.
+    #
+    # @api public
+    #
+    # See {Attribute#initialize} for a detailed overview of what properties are allowed
+    # and how to set them.
+    #
+    # @example Change the +type+ of the "locale" attribute to "string".
+    #   attribute = ObjClass.find('Homepage').attributes['locale']
+    #   attribute.update(type: :string)
+    #
+    # @example Adding the value "sports" to the +enum+ attribute "category" on the "Homepage" obj class.
+    #   attribute = ObjClass.find('Homepage').attributes['category']
+    #   attribute.update(values: attribute.values << 'sports')
+    #
+    # @param [Hash] properties
+    #
+    # @return [nil]
+    # @raise [Scrivito::ScrivitoError] Raised when trying to change the +name+ or +obj_class+ property.
+    def update(properties)
+      properties = properties.with_indifferent_access
+
+      if properties.has_key?(:name)
+        raise ScrivitoError, "#{self.class} does not support changing its 'name'. Please remove" \
+          " the key from the properties."
+      end
+
+      properties = to_cms_rest_api.merge(properties)
+      update_instance_properties(properties)
+      obj_class.update(attributes: obj_class.attributes.to_a)
+
+      nil
+    end
+
+    # Destroys this attribute and persists the change in the CMS.
+    #
+    # @api public
+    #
+    # @example Remove the "locale" attribute from the "Homepage" obj class.
+    #   ObjClass.find('Homepage').attributes['locale'].destroy
+    #
+    # @return [nil]
+    def destroy
+      obj_class.attributes.delete(self)
+      obj_class.update(attributes: obj_class.attributes.to_a)
+
+      nil
+    end
+
+    # Returns this attribute in the CMS REST API format.
+    #
+    # @return [Hash]
+    def to_cms_rest_api
+      data = {
+        name: name,
+        type: type,
+      }
+
+      if %w(enum multienum).include?(type)
+        data[:values] = values
+      end
+
+      data
+    end
+
+    private
+
+    # Updates the instance properties of this attribute with +properties+
+    # given in the CMS REST API format.
+    #
+    # @param [Hash] properties
+    # @return [void]
+    def update_instance_properties(properties)
+      properties = properties.with_indifferent_access
+
+      @name = properties[:name].to_s
+      @type = properties[:type].to_s
+      @values = (properties[:values] || []).map(&:to_s)
+    end
+  end
+end