scrivito_editors 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e575bd6b6630d8f371dcae393849aba6e297112
-  data.tar.gz: 61a44a43126f3d74ad178590d2a981403ad6ac43
+  metadata.gz: e68077db1a5df9620e228f62c35ba73a45551155
+  data.tar.gz: 5e123dd72c8dbcc44586e5f597976562ecd60419
 SHA512:
-  metadata.gz: 4be2ea874776864a122662d21f8bd392f1265e4c2d034dfbef6ec2efb2199c0b5619c6ce2903bc0b7eeab487481fa6b3095ef2f3c55cd40d8b55d29577c3b940
-  data.tar.gz: 85abc8b64dce2e89c0f98737c6d5e9a16c07146f8ae69d9b498dfcb8b1371db0592ebc4487945eed40839b14bc8157af4f0d2d64530f4c5ed71c33c0c741c7b6
+  metadata.gz: 10872a133c7a89f83f011685f357ed0bb247d94c998457f0000871cc91eef2b918b8eb6a3403e6b4386d22499955d64f84731d44eb0c25c1f290a801dd3f04c4
+  data.tar.gz: a32e8317fefc45cc77632a5fb4bedfade91381849df5c98f92758c1595bc9eb206002d6ad822a4df46a6d9bb3cc2ea49d514f5f3d0153d5a12f6a9ae89220b23

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# v0.0.14
+  * Added the `CmsTagHelper` module containing methods that are needed to render the html for
+    certain editors.
+    You can now safely delete `editing_helper.rb` generated by Scrivito Kickstarter.
+    Kickstarter will still generate this file, while we are in the process of providing you
+    with alternative ways to get you going without the need for Kickstarter.
+    (Keep an eye on https://github.com/infopark/scrivito_example and upcoming Scrivito SDK releases)
+  * Tuned Redactor settings to make the HTML editor less intrusive
+  * Corrected the `jquery-rails` gem version dependency
+  * Solved various editor related issues
+
 # v0.0.13
   * Added `autosave` option to the string editor to prevent that on every input the content is saved
     to the CMS. This is useful when setting a permalink for example, where intermediate strings

data/Rakefile

@@ -2,3 +2,15 @@
 
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks
+
+namespace :test do
+  task :documentation do
+    output = `yard doc --no-cache --no-stats`.strip
+    if output.empty?
+      puts "YARD documentation check successfully finished."
+    else
+      puts output
+      raise "YARD documentation has complained."
+    end
+  end
+end

data/app/assets/javascripts/scrivito_editors/html_editor.js.coffee

@@ -5,6 +5,8 @@
 unless @RedactorPlugins?
   @RedactorPlugins = {}
 
+@RedactorPlugins.over_aggressive_cleanup_fix = init: -> @cleanSavePreCode = (html) -> html
+
 # Plugin for closing the editor with a button in the toolbar.
 @RedactorPlugins.close =
   init: ->
@@ -17,8 +19,17 @@ $ ->
   # Stores redactor options, custom settings and configures callbacks.
   redactorOptions = ->
     return {} =
-      # This setting defines the array of toolbar buttons.
-      # http://imperavi.com/redactor/docs/settings/#set-buttons
+      convertLinks: false
+      formattingPre: false
+      paragraphy: false
+      tidyHtml: false
+
+      dropdownShowCallback: -> @_dropdownOpen = true
+      dropdownHideCallback: -> @_dropdownOpen = false
+      modalOpenedCallback: -> @_modalOpen = true
+      modalClosedCallback: -> @_modalOpen = false
+      focusCallback: -> @_hasFocus = true
+
       buttons: [
         'formatting', 'bold', 'italic', 'deleted', 'underline',
         'unorderedlist', 'orderedlist', 'table', 'link', 'html',
@@ -26,7 +37,7 @@ $ ->
 
       # This options allows to configure what plugins are loaded. Plugins need to be defined in the
       # +RedactorPlugins+ namespace.
-      plugins: ['close']
+      plugins: ['close', 'over_aggressive_cleanup_fix']
 
       # This option allows you to set whether Redactor gets cursor focus on load or not.
       # http://imperavi.com/redactor/docs/settings/#set-focus
@@ -44,8 +55,15 @@ $ ->
       # This callback is triggered when Redactor loses focus.
       # http://imperavi.com/redactor/docs/callbacks/#callback-blurCallback
       blurCallback: ->
-        @.destroy()
-        saveContents(@)
+        editor = @
+        editor._hasFocus = false
+        unless @_dropdownOpen || @_modalOpen
+          # workaround for issue with context menu (e. g. unlink) being neither modal nor dropdown
+          setTimeout ->
+            unless editor._hasFocus
+              saveContents(editor)
+              editor.destroy()
+          , 250
 
       # This callback is triggered when a key is released.
       # http://imperavi.com/redactor/docs/callbacks/#callback-keyupCallback
@@ -82,8 +100,9 @@ $ ->
       cmsField = $(@)
 
       unless cmsField.hasClass('redactor_editor')
-        cmsField.html(cmsField.scrivito('content') || '')
+        cmsField.replaceWith(cmsField = cmsField.clone(true, true))
         cmsField.redactor(redactorOptions())
+        cmsField.redactor('set', cmsField.scrivito('content'), false)
         cmsField.redactor('focus')
 
   # Registers all handlers when content has changed.

data/app/assets/javascripts/scrivito_editors/link_editor.js.coffee

@@ -121,4 +121,5 @@ $ ->
 
   # Initialize link editor and setup event callbacks.
   scrivito.on 'content', (root) ->
-    initialize(root)
+    if scrivito.in_editable_view()
+      initialize(root)

data/app/assets/javascripts/scrivito_editors/referencelist_editor.js.coffee

@@ -55,7 +55,7 @@ $ ->
 
   # Collects all reference ids for a given referencelist.
   getIds = (cmsField) ->
-    items = $(cmsField).find('li')
+    items = $(cmsField).find('[data-id]')
 
     value =
       for item in items

data/app/assets/stylesheets/scrivito_editors/buttons.css

@@ -13,7 +13,7 @@
   font-size: 14px;
   font-weight: normal;
   line-height: 14px;
-  margin: 0 10px 10px 0;
+  margin: 0 10px 0 0;
   min-height: 14px;
   min-width: 30px;
   padding: 8px 15px;

data/app/assets/stylesheets/scrivito_editors/editors/html_editor.css

@@ -3,7 +3,7 @@
 */
 
 .redactor_toolbar li a.re-close {
-  color: #aa4040;
+  color: #658B51;
   font-family: 'editing_iconsregular';
   font-size: 7px;
   padding: 14px 10px 4px 10px;

data/app/assets/stylesheets/scrivito_editors/editors/link_editor.css

@@ -13,20 +13,11 @@
   border-radius: 5px;
   -webkit-border-radius: 5px;
   -moz-border-radius: 5px;
-  margin: 0 0 10px 0;
+  margin: 0;
   overflow: hidden;
-  padding: 10px 10px 10px 10px;
+  padding: 5px 10px;
   position: relative;
-}
-
-[data-scrivito-field-type="link"] ul li:last-child {
-  margin: 0;
-}
-
-[data-scrivito-field-type="link"] ul li .list-content {
-  float: left;
-  line-height: 35px;
-  width: 70%;
+  border: 1px solid #ddd;
 }
 
 [data-scrivito-field-type="link"] ul li .list-content a {
@@ -35,46 +26,48 @@
 
 [data-scrivito-field-type="link"] ul li .actions {
   position: absolute;
-  top: 33px;
-  right: 63px;
+  bottom: 0;
+  right: 0;
 }
 
 [data-scrivito-field-type="link"] ul li .actions .editing-button {
+  border-radius: 0;
   margin: 0;
 }
 
-
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="link"] ul li {
-  padding: 10px 135px 10px 25px;
+  padding: 0;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="link"] ul li input {
   background: #fff;
-  border: 1px solid #ddd;
-  -webkit-border-radius: 5px;
-  -moz-border-radius: 5px;
-  border-radius: 5px;
+  border: 0px solid #ddd;
+  border-top-width: 1px;
+  border-left-width: 1px;
+  border-radius: 0 0 5px 5px;
   color: #555555;
   display: block;
   float: left;
   font-size: 14px;
-  height: 34px;
-  margin: 0 10px 5px 0;
+  height: 31px;
+  margin: 0;
   padding: 6px 12px;
   width: 100%;
 }
 
-@media (max-width: 1100px) {
-  [data-scrivito-display-mode="editing"] [data-scrivito-field-type="link"] ul li {
-    padding: 10px 10px 10px 25px;
-  }
+[data-scrivito-display-mode="editing"] [data-scrivito-field-type="link"] ul li input:first-child {
+  border-radius: 5px 5px 0 0;
+  border-top-width: 0px;
+}
 
+@media (max-width: 550px) {
   [data-scrivito-field-type="link"] ul li .actions {
     float: left;
     position: static;
   }
 
   [data-scrivito-field-type="link"] ul li .actions .editing-button {
-    margin: 0 10px 0 0;
+    border-radius: 5px;
+    margin: 4px 0 0 0;
   }
 }

data/app/assets/stylesheets/scrivito_editors/editors/linklist_editor.css

@@ -9,56 +9,56 @@
 }
 
 [data-scrivito-field-type="linklist"] ul li{
-  background-color: #f1f1f1;
+  background-color: #f3f3f3;
   border-radius: 5px;
   -webkit-border-radius: 5px;
   -moz-border-radius: 5px;
-  margin: 0 0 10px 0;
+  margin: 4px 0;
   overflow: hidden;
-  padding: 10px 10px 10px 10px;
+  padding: 5px 10px;
   position: relative;
-}
-
-[data-scrivito-field-type="linklist"] ul li:last-child {
-  margin: 0;
+  border: 1px solid #ddd;
 }
 
 [data-scrivito-field-type="linklist"] ul li.ui-sortable-placeholder:before {
   display:none;
 }
 
-[data-scrivito-field-type="linklist"] ul li .list-content {
-  float: left;
-  line-height: 35px;
-  width: 70%;
-}
-
 [data-scrivito-field-type="linklist"] ul li .list-content a {
   display:block;
 }
 
 [data-scrivito-field-type="linklist"] ul li .actions {
   position: absolute;
-  top: 11px;
-  right: 11px;
+  bottom: 0;
+  right: 0;
 }
 
 [data-scrivito-field-type="linklist"] ul li .actions .editing-button {
-  margin: 0 0 0 10px;
+  border-radius: 0;
+  margin: 0;
+}
+
+[data-scrivito-field-type="linklist"] ul li .actions .editing-button.delete {
+  margin-left: 1px;
+  float: right;
 }
 
+[data-scrivito-field-type="linklist"] ul li .actions .editing-button.resourcebrowser-open {
+}
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="linklist"] ul li {
-  padding: 10px 135px 10px 25px;
+  padding: 0 0 0 30px;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="linklist"] ul li:before {
+  content: "↕";
   color: #999;
-  content: '||';
-  font-size: 17px;
-  left: 10px;
+  font-size: 19px;
+  line-height: 0;
   position: absolute;
-  top: 35%;
+  left: 7px;
+  top: 50%;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="linklist"] ul li:hover {
@@ -70,36 +70,27 @@
   background: #f3f3f3;
   border: 2px dashed #9bc2cf;
   opacity: .5;
+  height: 63px;
   visibility: visible!important;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="linklist"] ul li input {
   background: #fff;
-  border: 1px solid #ddd;
-  -webkit-border-radius: 5px;
-  -moz-border-radius: 5px;
-  border-radius: 5px;
+  border: 0px solid #ddd;
+  border-top-width: 1px;
+  border-left-width: 1px;
+  border-radius: 0 0 5px 0;
   color: #555555;
   display: block;
   float: left;
   font-size: 14px;
-  height: 34px;
-  margin: 0 10px 5px 0;
+  height: 31px;
+  margin: 0;
   padding: 6px 12px;
   width: 100%;
 }
 
-@media (max-width: 1100px) {
-  [data-scrivito-display-mode="editing"] [data-scrivito-field-type="linklist"] ul li {
-    padding: 10px 10px 10px 25px;
-  }
-
-  [data-scrivito-field-type="linklist"] ul li .actions {
-    float: left;
-    position: static;
-  }
-
-  [data-scrivito-field-type="linklist"] ul li .actions .editing-button {
-    margin: 0 10px 0 0;
-  }
+[data-scrivito-display-mode="editing"] [data-scrivito-field-type="linklist"] ul li input:first-child {
+  border-radius: 0 5px 0 0;
+  border-top-width: 0px;
 }

data/app/assets/stylesheets/scrivito_editors/editors/referencelist_editor.css

@@ -9,49 +9,47 @@
 }
 
 [data-scrivito-field-type="referencelist"] ul li {
-  background-color: #f1f1f1;
+  background-color: #f3f3f3;
   border-radius: 5px;
   -webkit-border-radius: 5px;
   -moz-border-radius: 5px;
-  margin: 0 0 10px 0;
+  margin: 4px 0;
   overflow: hidden;
-  padding: 10px 10px 10px 10px;
+  padding: 5px 10px;
   position: relative;
-}
-
-[data-scrivito-field-type="referencelist"] ul li:last-child {
-  margin: 0;
+  border: 1px solid #ddd;
 }
 
 [data-scrivito-field-type="referencelist"] ul li.ui-sortable-placeholder:before {
   display:none;
 }
 
-[data-scrivito-field-type="referencelist"] ul li .list-content {
-  float: left;
-  width: 70%;
-  line-height: 35px;
-}
-
 [data-scrivito-field-type="referencelist"] ul li .actions {
   float: right;
 }
 
 [data-scrivito-field-type="referencelist"] ul li .actions .editing-button {
-  margin: 0 0 0 10px;
+  position: absolute;
+  top: 0;
+  margin-top: 0;
+  right: -10px;
+  bottom: 0;
+  border-top-left-radius: 0;
+  border-bottom-left-radius: 0;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="referencelist"] ul li {
-  padding: 10px 10px 10px 25px;
+  padding-left: 28px;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="referencelist"] ul li:before {
-  content: '||';
+  content: "↕";
   color: #999;
-  font-size: 17px;
-  left: 10px;
+  font-size: 19px;
+  line-height: 0;
   position: absolute;
-  top: 25%;
+  left: 7px;
+  top: 50%;
 }
 
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="referencelist"] ul li:hover {
@@ -62,6 +60,7 @@
 [data-scrivito-display-mode="editing"] [data-scrivito-field-type="referencelist"] ul li.ui-sortable-placeholder {
   background: #f3f3f3;
   border: 2px dashed #9bc2cf;
+  height: 36px;
   opacity: .5;
   visibility: visible!important;
 }

data/app/helpers/scrivito_editors/cms_tag_helper.rb

@@ -0,0 +1,140 @@
+module ScrivitoEditors
+  # This module includes helpers that render the HTML for specfic CMS
+  # attributes and their JS editors. These special methods are needed
+  # because the editors need additional information that is not provided
+  # by the Scrivito SDK's ++cms_tag++ method.
+  module CmsTagHelper
+
+    # Allows you to edit a CMS ++enum++ attribute using a dropdown
+    #
+    # @param [Obj, Widgegt] object
+    # @param [String, Symbol] attribute_name
+    # @param [Hash] options passed to the ++cms_tag++ helper
+    def cms_edit_enum(object, attribute_name, options = {})
+      values = object.obj_class.attributes[attribute_name].values
+      values |= [object[attribute_name].to_s]
+
+      options.reverse_merge!({
+        data: {
+          values: values,
+          min: values.min,
+          max: values.max,
+        }
+      })
+
+      cms_tag(:div, object, attribute_name, options)
+    end
+
+    # Allows you to edit a CMS ++multienum++ attribute using a multi-select.
+    #
+    # @param [Obj, Widget] object
+    # @param [String, Symbol] attribute_name
+    # @param [Hash] options passed to the ++cms_tag++ helper
+    def cms_edit_multienum(object, attribute_name, options = {})
+      values = object.obj_class.attributes[attribute_name].values
+
+      options.reverse_merge!({
+        multiple: true,
+        data: {
+          values: values,
+        }
+      })
+
+      cms_tag(:div, object, attribute_name, options) do |tag|
+        (object[attribute_name] || []).join(', ')
+      end
+    end
+
+    # Allows you to edit a CMS ++reference++ attribute using the resource
+    # browser.
+    #
+    # @param [Obj, Widget] object
+    # @param [String, Symbol] attribute_name
+    # @param [Hash] options passed to the ++cms_tag++ helper
+    def cms_edit_reference(object, attribute_name, options = {})
+      reference = object[attribute_name]
+
+      cms_tag(:div, object, attribute_name, options) do
+        if reference
+          reference.description_for_editor
+        end
+      end
+    end
+
+    # Allows you to edit a CMS ++referencelist++ attribute using the resource
+    # browser.
+    #
+    # @param [Obj, Widget] object
+    # @param [String, Symbol] attribute_name
+    # @param [Hash] options passed to the ++cms_tag++ helper
+    def cms_edit_referencelist(object, attribute_name, options = {})
+      reference_list = object[attribute_name]
+
+      cms_tag(:div, object, attribute_name, options) do
+        if reference_list.present?
+          content_tag(:ul) do
+            html = ''.html_safe
+
+            reference_list.each do |reference|
+              html << content_tag(:li, data: { name: reference.name, id: reference.id }) do
+                content_tag(:span, reference.description_for_editor, class: 'list-content')
+              end
+            end
+
+            html
+          end
+        end
+      end
+    end
+
+    # Allows you to edit a CMS ++linklist++ attribute
+    #
+    # @param [Obj, Widget] object
+    # @param [String, Symbol] attribute_name
+    # @param [Hash] options passed to the ++cms_tag++ helper
+    def cms_edit_linklist(object, attribute_name, options = {})
+      linklist = object[attribute_name]
+
+      cms_tag(:div, object, attribute_name, options) do
+        if linklist
+          content_tag(:ul) do
+            html = ''.html_safe
+
+            linklist.each do |link|
+              html << _edit_link_li(link)
+            end
+
+            html
+          end
+        end
+      end
+    end
+
+    # Allows you to edit a CMS ++link++ attribute
+    #
+    # @param [Obj, Widget] object
+    # @param [String, Symbol] attribute_name
+    # @param [Hash] options passed to the ++cms_tag++ helper
+    def cms_edit_link(object, attribute_name, options = {})
+      link = object[attribute_name]
+
+      cms_tag(:div, object, attribute_name, options) do
+        content_tag(:ul) { _edit_link_li(link) } if link
+      end
+    end
+
+    private
+
+    def _edit_link_li(link)
+      query = link.query.present? ? "?#{link.query}" : ""
+      url = link.internal? ? cms_path(link).sub(/\?.*/, query) : link.url
+      description = link.internal? ? link.obj.description_for_editor : link.url
+
+      content_tag(:li, data: { title: link.title, url: url }) do
+        content_tag(:span, class: 'list-content') do
+          "#{link.title} #{link_to(description, url, target: :_blank)}".html_safe
+        end
+      end
+    end
+  end
+end

data/lib/scrivito_editors/engine.rb

@@ -4,5 +4,9 @@ require 'scrivito_resourcebrowser'
 module ScrivitoEditors
   class Engine < ::Rails::Engine
     isolate_namespace ScrivitoEditors
+
+    initializer "scrivito_editors.cms_tag_helper" do
+      ActionView::Base.send :include, CmsTagHelper
+    end
   end
 end

data/lib/scrivito_editors/version.rb

@@ -1,3 +1,3 @@
 module ScrivitoEditors
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_editors
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Scrivito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Scrivito Editors
 email:
 - info@infopark.de
@@ -150,10 +164,10 @@ files:
 - app/assets/stylesheets/scrivito_editors/editors/link_editor.css
 - app/assets/stylesheets/scrivito_editors/editors/linklist_editor.css
 - app/assets/stylesheets/scrivito_editors/editors/referencelist_editor.css
-- app/assets/stylesheets/scrivito_editors/editors/text_editor.css
 - app/assets/stylesheets/scrivito_editors/icons.css.erb
 - app/assets/stylesheets/scrivito_editors/placeholder.css
 - app/assets/stylesheets/scrivito_editors/widget_preview.css
+- app/helpers/scrivito_editors/cms_tag_helper.rb
 - lib/scrivito_editors.rb
 - lib/scrivito_editors/engine.rb
 - lib/scrivito_editors/version.rb
@@ -177,8 +191,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.8'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Scrivito Editors
 test_files: []
+has_rdoc: 

data/app/assets/stylesheets/scrivito_editors/editors/text_editor.css

@@ -1,7 +0,0 @@
-/*
-  Styles for the text in-place editor.
-*/
-
-[data-scrivito-display-mode="editing"] .text-editor textarea {
-  width: 98%;
-}