liquid_cms 0.2.1.1 → 0.2.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 0.2.2.0
+
+* Enhancements
+  * Optimize paperclip image dimension lookup in to_liquid calls.  To make use of optimized paperclip attachments in your custom to_liquid methods, add a column to your table in a migration. See the README under the customization section for more information.
+  * Update to codemirror v2
+  * Ctrl+s now uses ajax for editing pages, textual assets and textual components in order to streamline the editing process.
+
 == 0.2.1.1
 
 * Fixes

data/README.rdoc

@@ -29,7 +29,7 @@ Run the generator:
 Configure the engine in config/initializers/cms/liquid_cms.rb:
 
   If you wish to run the cms under multiple "contexts" (ie. a cms each for a company, business, customer, etc.) then you need to perform the following steps:
-  
+
     * Set the *context_class* attribute to your apps context class:
 
       config.context_class = :Company
@@ -58,6 +58,20 @@ In order to expose data in your application in the templates, liquid filters, dr
 
 A set of filters, drops and tags are provided in addition to the defaults provided by liquid.  The documentation link accessible in the CMS provides additional details.
 
+If you're using paperclip images in any models and exposing them via to_liquid, you can add an addtional column to your table to optimize dimension lookup.
+
+  class Customer
+    has_attached :photo
+
+    def to_liquid
+      photo.to_liquid
+    end
+  end
+
+  change_table :customers do |t|
+    t.text :cms_photo_dimensions # field name must be named after the paperclip name. ie. :cms_{paperclip name}_dimensions
+  end
+
 = Upgrading
 
 To upgrade the liquid_cms engine once you've installed a newer gem, simply re-run the liquid_cms generator. If any differences are found in files, you'll be prompted to overwrite or compare versions.

data/TODO.rdoc

@@ -1,8 +1,6 @@
 * Implement a cleaner, more functional UI.
-* Vestal versions is used, but not exposed via the UI currently to go back to previous versions.
 * No functions are currently limited to specific user roles.  All CMS users can perform the same actions.
 * Implement caching and expiration logic.
 * Provide example apache/nginx/etc. conf files that properly scope cms assets for each context.
 * Generate CMS documentation from rdoc comments in source files?
-* Search functions.  Find templates based on search text.
 * Missing tests... add more coverage.

data/app/controllers/cms/assets_controller.rb

@@ -30,10 +30,21 @@ class Cms::AssetsController < Cms::MainController
     @asset.assign_ordered_attributes params[:cms_asset]
 
     if @asset.save
-      flash[:notice] = t('assets.flash.updated')
-      redirect_to cms_root_path
+      respond_to do |format|
+        format.html {
+          redirect_to edit_cms_asset_path(@asset), :notice => t('assets.flash.updated')
+        }
+        format.js {
+          flash.now[:notice] = t('assets.flash.updated')
+        }
+      end
     else
-      render :action => 'edit'
+      respond_to do |format|
+        format.html {
+          render :action => 'edit'
+        }
+        format.js
+      end
     end
   end
 
@@ -42,7 +53,7 @@ class Cms::AssetsController < Cms::MainController
     @asset.destroy
 
     flash[:notice] = t('assets.flash.deleted')
-    
+
     respond_to do |format|
       format.html { redirect_to cms_root_path }
     end
@@ -62,10 +73,13 @@ protected
         # remove meta values since we only want the key names
         # new values will be provided for the new asset
         asset.meta_data = meta_asset.meta_data.collect{|m| {:name => m[:name], :value => ''}}
+      end
 
+      dims_asset = @context.assets.tagged_with(curr_tag).first :conditions => 'custom_width is not null and custom_height is not null'
+      if dims_asset
         # assign custom dims
-        asset.custom_width = meta_asset.custom_width
-        asset.custom_height = meta_asset.custom_height
+        asset.custom_width = dims_asset.custom_width
+        asset.custom_height = dims_asset.custom_height
       end
 
       asset

data/app/controllers/cms/components_controller.rb

@@ -13,15 +13,23 @@ class Cms::ComponentsController < Cms::MainController
   end
 
   def update
+    edit_url = {:controller => 'cms/components', :action => 'edit', :url => @path}
+
     if Cms::Component.editable?(@path)
       @component = Cms::Component.new(@context, @path)
       @component.write params[:file_content]
 
-      flash[:notice] = "The component file has been updated."
-      redirect_to cms_root_path
+      respond_to do |format|
+        format.html {
+          redirect_to edit_url, :notice => t('components.flash.updated')
+        }
+        format.js {
+          flash.now[:notice] = t('components.flash.updated')
+        }
+      end
     else
       flash[:error] = "Not an editable component."
-      redirect_to :controller => 'cms/components', :action => 'edit', :url => @path
+      redirect_to edit_url
     end
   end
 

data/app/controllers/cms/pages_controller.rb

@@ -26,10 +26,21 @@ class Cms::PagesController < Cms::MainController
   def update
     @page = @context.pages.find params[:id]
     if @page.update_attributes(params[:cms_page])
-      flash[:notice] = t('pages.flash.updated')
-      redirect_to edit_cms_page_path(@page)
+      respond_to do |format|
+        format.html {
+          redirect_to edit_cms_page_path(@page), :notice => t('pages.flash.updated')
+        }
+        format.js {
+          flash.now[:notice] = t('pages.flash.updated')
+        }
+      end
     else
-      render :action => 'edit'
+      respond_to do |format|
+        format.html {
+          render :action => 'edit'
+        }
+        format.js
+      end
     end
   end
 
@@ -38,7 +49,7 @@ class Cms::PagesController < Cms::MainController
     @page.destroy
 
     flash[:notice] = t('pages.flash.deleted')
-    
+
     respond_to do |format|
       format.html { redirect_to cms_root_path }
       format.js

data/app/helpers/cms/common_helper.rb

@@ -13,48 +13,48 @@ module Cms::CommonHelper
 
   def cms_flash_message
     type = (flash[:error] ? :error : :notice)
-    javascript_tag("document.observe('dom:loaded', function(){ humanMsg.displayMsg('#{escape_javascript(flash[type])}', '#{type}');})") if flash[type].present?
+    flash[type].present? ? "humanMsg.displayMsg('#{escape_javascript(flash[type])}', '#{type}')" : nil
+  end
+
+  def load_cms_flash_message
+    msg = cms_flash_message
+    msg.present? ? javascript_tag("document.observe('dom:loaded', function(){ #{msg} })") : nil
   end
 
   def cms_row_class
     cycle 'dark', 'light'
   end
 
-  def codemirror_edit(content_type, form, content_id)
-    js_options = case content_type
+  def cms_ajax_update_form(page, object, path)
+    if object.errors.empty?
+      page << cms_flash_message
+    else
+      page.replace_html 'content', :file => "cms/#{path}/edit.html.erb"
+    end
+  end
+
+  def codemirror_edit(content_type, form, content_id, use_ajax = true, liquid_support = false)
+    mode = nil
+
+    case content_type
     when "text/css"
-      <<-JS
-      parserfile: ["../../javascripts/parseliquid.js", "parsecss.js"],
-      stylesheet: ["/cms/codemirror/css/csscolors.css", "/cms/stylesheets/liquidcolors.css"],
-      JS
+      mode = 'css'
+      content_for :cms_styles do
+        javascript_include_tag '/cms/codemirror/mode/css/css'
+      end
     when "text/javascript"
-      <<-JS
-      parserfile: ["../../javascripts/parseliquid.js", "tokenizejavascript.js", "parsejavascript.js"],
-      stylesheet: ["/cms/codemirror/css/jscolors.css", "/cms/stylesheets/liquidcolors.css"],
-      JS
+      mode = 'javascript'
+      content_for :cms_styles do
+        javascript_include_tag '/cms/codemirror/mode/javascript/javascript'
+      end
     else
-      <<-JS
-      parserfile: ["../../javascripts/parseliquid.js"],
-      stylesheet: ["/cms/codemirror/css/xmlcolors.css", "/cms/stylesheets/liquidcolors.css"],
-      JS
+      mode = 'htmlmixed'
+      content_for :cms_styles do
+        javascript_include_tag '/cms/codemirror/mode/htmlmixed/htmlmixed'
+      end
     end
 
-    javascript_tag do
-      <<-JS
-      var editor = CodeMirror.fromTextArea("#{content_id}", {
-        #{js_options}
-        path: "/cms/codemirror/js/",
-        textWrapping: false,
-        height: '600px',
-        width: '89%',
-        saveFunction: function() {
-          var form = $$('#{form}').first();
-          $('#{content_id}').setValue(editor.getCode());
-          form.submit();
-        }
-      });
-      JS
-    end
+    javascript_tag %(initCodemirror('#{mode}', $$('#{form}').first(), $('#{content_id}'), #{use_ajax}, #{liquid_support}))
   end
 
   def file_type_icon(file_name)

data/app/liquid/cms_paperclip_extension.rb

@@ -3,14 +3,86 @@ module Paperclip
     extend ActiveSupport::Memoizable
 
     def to_liquid
-      {}.tap do |h|
+      style_hash = {}
+
+      style_hash.tap do |h|
         all_styles = self.styles.keys + ['original']
         all_styles.each do |style|
-          g = Paperclip::Geometry.from_file(self.path(style)) rescue nil
-          h[style.to_s] = {'width' => g.width.to_i, 'height' => g.height.to_i, 'url' => self.url(style)} unless g.nil?
+          h[style.to_s] = find_geometry_dims(style)
+          h[style.to_s]['url'] = self.url(style) if h[style.to_s].present?
         end
       end
+
+      save_geometry_dims style_hash
+
+      style_hash
     end
     memoize :to_liquid
+
+    # clear out the dimension attribute when post processing
+    # it'll be updated on the next render via to_liquid
+    def post_process_with_dimension_attribute_clear
+      key = dimension_key
+
+      if instance.has_attribute?(key)
+        instance.send("#{key}=", nil)
+      end
+
+      post_process_without_dimension_attribute_clear
+    end
+
+    alias_method_chain :post_process, :dimension_attribute_clear
+
+  protected
+    def dimension_key
+      "cms_#{name}_dimensions"
+    end
+
+    def find_geometry_dims(style)
+      key = dimension_key
+
+      if instance.has_attribute?(key)
+        # dimension attr found
+        values = YAML::load(instance.send(key) || '{}')
+        if values.blank?
+          # no saved entry
+          geometry_dims(style)
+        else
+          # saved entry
+          dimensions = values[style.to_s]
+          if dimensions.blank?
+            # empty dimensions for the given style
+            geometry_dims(style)
+          else
+            # valid dimensions for the given style
+            {'width' => dimensions['width'].to_i, 'height' => dimensions['height'].to_i}
+          end
+        end
+      else
+        log %{To optimize image data in your liquid templates, add a text column named "#{key}" to your "#{instance.class.table_name}" table.}
+        # no dimensions found
+        geometry_dims(style)
+      end
+    end
+
+    def save_geometry_dims(style_hash)
+      key = dimension_key
+
+      if instance.has_attribute?(key) && YAML::load(instance.send(key) || '{}').all?{|k,v| v.blank?} && style_hash.present?
+        # deep copy hash
+        temp_hash = Marshal.load(Marshal.dump(style_hash))
+        # remove blank styles
+        temp_hash.delete_if{|k,v| v.blank?}
+        # and remove the urls
+        temp_hash.each{|k,v| v.delete_if{|k2,v2| k2 == 'url'}}
+
+        instance.update_attribute key, temp_hash.to_yaml if temp_hash.present?
+      end
+    end
+
+    def geometry_dims(style)
+      g = Paperclip::Geometry.from_file(self.path(style)) rescue nil
+      g.nil? ? {} : {'width' => g.width.to_i, 'height' => g.height.to_i}
+    end
   end
 end

data/app/models/cms/asset.rb

@@ -81,7 +81,7 @@ module Cms
     end
 
     def editable?
-      !(asset_content_type =~ /(javascript|css|xml|html)$/).blank?
+      Cms::Component.editable?(asset_file_name)
     end
 
     def file_content

data/app/models/cms/component.rb

@@ -2,7 +2,7 @@ require 'zip/zip'
 
 class Cms::Component
   attr_reader :path
-  
+
   def initialize(context, path = nil)
     @context = context
     @path = self.class.clean_path(path) if path
@@ -67,7 +67,7 @@ class Cms::Component
       end if exist
     end
   end
-  
+
   def delete
     return false if @path.blank?
 
@@ -78,7 +78,7 @@ class Cms::Component
   end
 
   def self.editable?(file)
-    Cms.editable_component_exts.include?(File.extname(file).downcase)
+    file.present? && Cms.editable_component_exts.include?(File.extname(file).downcase)
   end
 
 protected

data/app/views/cms/assets/_form.html.erb

@@ -25,7 +25,7 @@
       <%= f.input :file_content, :as => :text, :input_html => {:rows => 40, :cols => nil} %>
     </div>
 
-    <%= codemirror_edit Cms::Editable::content_type(@asset.asset_file_name), 'form.simple_form', 'cms_asset_file_content' %>
+    <%= codemirror_edit Cms::Editable::content_type(@asset.asset_file_name), 'form.simple_form', 'cms_asset_file_content', !@asset.new_record? %>
   <% end %>
 
   <div class="dimensions">

data/app/views/cms/assets/update.js.rjs

@@ -0,0 +1 @@
+cms_ajax_update_form page, @asset, 'assets'

data/app/views/cms/components/update.js.rjs

@@ -0,0 +1 @@
+page << cms_flash_message

data/app/views/cms/pages/_form.html.erb

@@ -9,4 +9,4 @@
   <%= f.commit_button_or_cancel %>
 <% end %>
 
-<%= codemirror_edit @page.content_type, 'form.simple_form.cms_page', 'cms_page_content' %>
+<%= codemirror_edit @page.content_type, 'form.simple_form.cms_page', 'cms_page_content', !@page.new_record?, true %>

data/app/views/cms/pages/update.js.rjs

@@ -0,0 +1 @@
+cms_ajax_update_form page, @page, 'pages'

data/app/views/layouts/cms.html.erb

@@ -6,7 +6,8 @@
   <title><%= t 'pages.layout.title' %></title>
   <%= javascript_include_tag 'prototype', 'effects' %>
   <%= javascript_include_tag '/cms/javascripts/humanmsg', '/cms/javascripts/cookiejar', '/cms/javascripts/cms', '/cms/javascripts/livepipe', '/cms/javascripts/tabs', :cache => 'cms_scripts' %>
-  <%= javascript_include_tag '/cms/codemirror/js/codemirror' %>
+  <%= javascript_include_tag '/cms/codemirror/lib/codemirror', '/cms/codemirror/mode/javascript/javascript', '/cms/codemirror/mode/css/css', '/cms/codemirror/mode/xml/xml', '/cms/codemirror/lib/overlay', '/cms/javascripts/codemirror_custom', :cache => 'codemirror_scripts' %>
+  <%= stylesheet_link_tag '/cms/codemirror/lib/codemirror', '/cms/codemirror/theme/default', '/cms/stylesheets/codemirror_changes', :cache => 'codemirror_styles' %>
   <%= stylesheet_link_tag '/cms/stylesheets/simple_form' %>
   <%= stylesheet_link_tag '/cms/stylesheets/clearfix', '/cms/stylesheets/humanmsg', '/cms/stylesheets/styles', '/cms/stylesheets/sidebar', :cache => 'cms_styles' %>
   <%= stylesheet_link_tag '/cms/stylesheets/themes/dark' %>
@@ -26,11 +27,11 @@
   <div id="outer-container" class="clearfix">
     <div id="sidebar" class="shadow curved">
       <%= render 'cms/shared/sidebar' %>
-    </div> 
+    </div>
 
     <div id="content">
       <%= yield %>
-      <%= cms_flash_message %>
+      <%= load_cms_flash_message %>
     </div>
   </div>
 </body>

data/generators/liquid_cms/liquid_cms_generator.rb

@@ -6,6 +6,7 @@ class LiquidCmsGenerator < Rails::Generator::Base
       # migrations
       m.migration_template 'migration.rb', File.join('db', 'migrate'), :migration_file_name => 'create_liquid_cms_setup'
       m.migration_template 'migration_rev1.rb', File.join('db', 'migrate'), :migration_file_name => 'create_liquid_cms_upgrade_rev1'
+      m.migration_template 'migration_rev2.rb', File.join('db', 'migrate'), :migration_file_name => 'create_liquid_cms_upgrade_rev2'
 
       # initializers
       m.directory File.join('config', 'initializers', 'cms')

data/generators/liquid_cms/templates/config/locales/cms/en.yml

@@ -39,6 +39,8 @@ en:
       index:
         title: 'Components'
         none: 'There are currently no components.'
+    flash:
+      updated: 'The component file has been updated.'
 
   simple_form:
     "yes": 'Yes'
@@ -68,6 +70,8 @@ en:
         content: 'To create a layout page, add the <em>{{ content_for_layout }}</em> tag which will act as a placeholder for the contents of another page.  Use ctrl+s to save.'
         slug: 'The url path that will be used to access this page.  Defaults to the page name if not provided. ie. /name.<br/> Ex. /home_page'
         layout_page_id: 'Optional page that will be used as this pages layout.  Ie. This pages content will be inserted into the layout page where the <em>{{ content_for_layout }}</em> tag is specified.'
+        published: 'Make this page accessible via the pages name or url path?'
+        root: 'Make this page the sites root path (/)? Only one page can have this designation.'
       cms_component:
         file_content: '<em>No liquid support for editing components.</em> Use ctrl+s to save.'
       cms_asset:

data/generators/liquid_cms/templates/migration_rev2.rb

@@ -0,0 +1,13 @@
+class CreateLiquidCmsUpgradeRev2 < ActiveRecord::Migration
+  def self.up
+    change_table :cms_assets do |t|
+      t.text :cms_asset_dimensions # serialized yaml
+    end
+  end
+
+  def self.down
+    change_table :cms_assets do |t|
+      t.remove :cms_asset_dimensions
+    end
+  end
+end

data/generators/liquid_cms/templates/public/cms/codemirror/LICENSE

@@ -1,23 +1,19 @@
- Copyright (c) 2007-2010 Marijn Haverbeke
+Copyright (C) 2011 by Marijn Haverbeke <marijnh@gmail.com>
 
- This software is provided 'as-is', without any express or implied
- warranty. In no event will the authors be held liable for any
- damages arising from the use of this software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
- Permission is granted to anyone to use this software for any
- purpose, including commercial applications, and to alter it and
- redistribute it freely, subject to the following restrictions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
- 1. The origin of this software must not be misrepresented; you must
-    not claim that you wrote the original software. If you use this
-    software in a product, an acknowledgment in the product
-    documentation would be appreciated but is not required.
-
- 2. Altered source versions must be plainly marked as such, and must
-    not be misrepresented as being the original software.
-
- 3. This notice may not be removed or altered from any source
-    distribution.
-
- Marijn Haverbeke
- marijnh@gmail.com
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/generators/liquid_cms/templates/public/cms/codemirror/lib/codemirror.css

@@ -0,0 +1,68 @@
+.CodeMirror {
+  line-height: 1em;
+  font-family: monospace;
+}
+
+.CodeMirror-scroll {
+  overflow: auto;
+  height: 300px;
+  /* This is needed to prevent an IE[67] bug where the scrolled content
+     is visible outside of the scrolling box. */
+  position: relative;
+}
+
+.CodeMirror-gutter {
+  position: absolute; left: 0; top: 0;
+  z-index: 10;
+  background-color: #f7f7f7;
+  border-right: 1px solid #eee;
+  min-width: 2em;
+  height: 100%;
+}
+.CodeMirror-gutter-text {
+  color: #aaa;
+  text-align: right;
+  padding: .4em .2em .4em .4em;
+}
+.CodeMirror-lines {
+  padding: .4em;
+}
+
+.CodeMirror pre {
+  -moz-border-radius: 0;
+  -webkit-border-radius: 0;
+  -o-border-radius: 0;
+  border-radius: 0;
+  border-width: 0; margin: 0; padding: 0; background: transparent;
+  font-family: inherit;
+  font-size: inherit;
+  padding: 0; margin: 0;
+  white-space: pre;
+  word-wrap: normal;
+}
+
+.CodeMirror textarea {
+  font-family: inherit !important;
+  font-size: inherit !important;
+}
+
+.CodeMirror-cursor {
+  z-index: 10;
+  position: absolute;
+  visibility: hidden;
+  border-left: 1px solid black !important;
+}
+.CodeMirror-focused .CodeMirror-cursor {
+  visibility: visible;
+}
+
+span.CodeMirror-selected {
+  background: #ccc !important;
+  color: HighlightText !important;
+}
+.CodeMirror-focused span.CodeMirror-selected {
+  background: Highlight !important;
+}
+
+.CodeMirror-matchingbracket {color: #0f0 !important;}
+.CodeMirror-nonmatchingbracket {color: #f22 !important;}