liquid_cms 0.3.0.10 → 0.3.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,15 @@
+== 0.3.1.0
+
+* Enhancements
+  * Many improvements to assets including the addition of meta data fields, tags and the ability to specify custom image sizes.
+  * Assets can now be searched for using the liquid 'asset_data' tag.  {% asset_data tag:'test' %}
+    See the built-in docs for more details on how to use "asset_data" and asset drops.
+  * Asset drops (accessible via the asset_data tag) give you access to the meta data and custom image information.
+  * limit and random ordering for collection retrieved from the asset_data tag.
+
+* Fixes
+  * Optimize asset image file sizes with -strip
+
 == 0.3.0.10
 
 * Enhancements

data/app/controllers/cms/assets_controller.rb

@@ -6,11 +6,13 @@ class Cms::AssetsController < Cms::MainController
   end
 
   def new
-    @asset = Cms::Asset.new
+    @asset = create_tagged_asset
   end
 
   def create
-    @asset = @context.assets.build params[:cms_asset]
+    @asset = @context.assets.build
+    @asset.assign_ordered_attributes params[:cms_asset]
+
     if @asset.save
       flash[:notice] = t('assets.flash.created')
       redirect_to cms_root_path
@@ -25,14 +27,9 @@ class Cms::AssetsController < Cms::MainController
 
   def update
     @asset = @context.assets.find params[:id]
+    @asset.assign_ordered_attributes params[:cms_asset]
 
-    success = if params[:file_content].present?
-      @asset.write params[:file_content]
-    else
-      @asset.update_attributes params[:cms_asset]
-    end
-
-    if success
+    if @asset.save
       flash[:notice] = t('assets.flash.updated')
       redirect_to cms_root_path
     else
@@ -48,7 +45,32 @@ class Cms::AssetsController < Cms::MainController
     
     respond_to do |format|
       format.html { redirect_to cms_root_path }
-      format.js
+    end
+  end
+
+protected
+  # pre-populate an asset with tagged data and meta fields if a tag param is present
+  def create_tagged_asset
+    asset = Cms::Asset.new
+    curr_tag = (params[:tag] || '').strip
+
+    if curr_tag.present?
+      asset.tag_list = curr_tag
+    
+      meta_asset = @context.assets.tagged_with(curr_tag).first :conditions => 'meta_data is not null'
+      if meta_asset
+        # 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 => ''}}
+
+        # assign custom dims
+        asset.custom_width = meta_asset.custom_width
+        asset.custom_height = meta_asset.custom_height
+      end
+
+      asset
+    else
+      asset
     end
   end
 end

data/app/controllers/cms/components_controller.rb

@@ -17,10 +17,10 @@ class Cms::ComponentsController < Cms::MainController
       @component = Cms::Component.new(@context, @path)
       @component.write params[:file_content]
 
-      flash[:notice] = "Component file updated."
+      flash[:notice] = "The component file has been updated."
       redirect_to cms_root_path
     else
-      flash[:error] = "Not an editable file."
+      flash[:error] = "Not an editable component."
       redirect_to :controller => 'cms/components', :action => 'edit', :url => @path
     end
   end
@@ -39,7 +39,7 @@ class Cms::ComponentsController < Cms::MainController
     component_zip = params[:zip_file]
 
     if component_zip.present? && File.extname(component_zip.original_filename) == '.zip'
-      Cms::Component.new(@context).expand component_zip.path
+      Cms::Component.expand @context, component_zip.path
       flash[:notice] = 'The component has been uploaded.'
     else
       flash[:error] = 'The component file must be a zip archive.'

data/app/controllers/cms/main_controller.rb

@@ -20,5 +20,7 @@ protected
     @cms_pages = @context.pages.ordered.all(:conditions => {:layout_page_id => nil})
     @cms_assets = @context.assets.ordered
     @cms_components = @context.components
+
+    @context_asset_tags = Cms::Asset.tags_for_context(@context)
   end
 end

data/app/controllers/cms/pages_controller.rb

@@ -10,7 +10,7 @@ class Cms::PagesController < Cms::MainController
   end
 
   def create
-    @page = @context.pages.build({:updated_by => current_user}.merge(params[:cms_page] || {}))
+    @page = @context.pages.build(params[:cms_page])
     if @page.save
       flash[:notice] = t('pages.flash.created')
       redirect_to cms_root_path
@@ -25,7 +25,7 @@ class Cms::PagesController < Cms::MainController
 
   def update
     @page = @context.pages.find params[:id]
-    if @page.update_attributes({:updated_by => current_user}.merge(params[:cms_page] || {}))
+    if @page.update_attributes(params[:cms_page])
       flash[:notice] = t('pages.flash.updated')
       redirect_to edit_cms_page_path(@page)
     else

data/app/helpers/cms/pages_helper.rb

@@ -3,18 +3,6 @@ module Cms::PagesHelper
     page.new_record? ? @context.pages.layouts : @context.pages.layouts.reject{|pg| pg == page}
   end
 
-  def delete_page_link(page)
-    options = {:method => :delete, :confirm => "Are you sure you want to delete the \"#{page}\" page?"}
-  
-    # use a remote link if there are no children since if we remove the current page list item, all the children items get removed (in the UI) as well
-    # it's easier to just remove the item otherwise with a normal post and refresh the page
-    if page.content_pages.empty?
-      link_to cms_icon('delete.png', :title => 'Delete'), cms_page_path(page), {:remote => true, :indicator => dom_id(page, 'progress')}.merge(options)
-    else
-      link_to cms_icon('delete.png', :title => 'Delete'), cms_page_path(page), options
-    end
-  end
-
   # find the # of term matches in each page and sorts the pages by the match count (highest to lowest)
   # only shows the first SEARCH_LIMIT pages
   def page_match_order(pages, term)

data/app/liquid/cms_paperclip_extension.rb

@@ -7,7 +7,7 @@ module Paperclip
         all_styles = self.styles.keys + ['original']
         all_styles.each do |style|
           g = Paperclip::Geometry.from_file(self.path(style)) rescue nil
-          h[style] = {'width' => g.width.to_i, 'height' => g.height.to_i, 'url' => self.url(style)} unless g.nil?
+          h[style.to_s] = {'width' => g.width.to_i, 'height' => g.height.to_i, 'url' => self.url(style)} unless g.nil?
         end
       end
     end

data/app/liquid/drops/cms_asset_drop.rb

@@ -0,0 +1,15 @@
+require 'cms_common_drop'
+
+class Cms::AssetDrop < Cms::CommonDrop
+  def meta
+    {}.tap do |h|
+      (@record.meta_data || []).each do |mh|
+        h[mh[:name]] = mh[:value]
+      end
+    end
+  end
+
+  def image
+    @record.asset
+  end
+end

data/app/liquid/filters/cms_filters.rb

@@ -114,7 +114,7 @@ module CmsFilters
 
   def component_url(path)
     context = @context.registers[:context]
-    "/" + File.join(Cms::Component.base_path(context), Cms::Component.component_path(context, path))
+    "/" + Cms::Component.base_path(context).join(path).to_s
   end
 end
 

data/app/liquid/tags/asset_search_tag.rb

@@ -0,0 +1,26 @@
+# Syntax
+# {% asset_data tag'test', as:'sale_vehicles' %}
+
+class AssetDataTag < Cms::DataTag
+  def get_data
+    raise Liquid::ArgumentError.new("The required 'tag' parameter is missing.") if options[:tag].blank?
+
+    collection = uses_random do |random_func|
+      assets = context_object.assets.tagged_with(options[:tag])
+
+      assets = if options[:random] == true
+        assets.order(random_func)
+      else
+        assets.order('cms_assets.created_at ASC')
+      end
+
+      assets = assets.limit(options[:limit]) if options[:limit]
+
+      assets.all
+    end
+
+    yield 'assets', collection
+  end
+end
+
+Liquid::Template.register_tag('asset_data', AssetDataTag)

data/app/liquid/tags/cms/tag_common.rb

@@ -0,0 +1,29 @@
+module Cms::TagCommon
+  extend ActiveSupport::Memoizable
+
+  HyphenatedTagAttributes = /([\w-]+)\s*\:\s*(#{Liquid::QuotedFragment})/
+
+  def parse_options(context, markup)
+    begin
+      options = HashWithIndifferentAccess.new
+      return options if markup.blank?
+
+      markup.scan(HyphenatedTagAttributes) do |key, value|
+        options[key.to_sym] = context[value]
+      end
+
+      options
+    rescue ArgumentError => e
+      raise SyntaxError.new("Syntax Error in 'tag options' - Valid syntax: name:value")
+    end
+  end
+
+  def context_object(context)
+    context.registers[:context].object
+  end
+  memoize :context_object
+
+  def params(context)
+    context.registers[:controller].params.except(:controller, :action)
+  end
+end

data/app/liquid/tags/data_tag.rb

@@ -0,0 +1,59 @@
+class Cms::DataTag < Liquid::Tag
+  module TagMethods
+    extend Cms::TagCommon
+  end
+
+  attr_reader :context
+  attr_reader :options
+
+  def initialize(tag_name, markup, tokens)
+    @markup = markup
+    super
+  end
+
+  def context_object
+    TagMethods.context_object(@context)
+  end
+
+  def params
+    TagMethods.params(@context)
+  end
+
+  def render(context)
+    @context = context
+    @options = TagMethods.parse_options(context, @markup)
+
+    get_data do |name, data|
+      context[@options[:as] || name] = data
+    end
+    ''
+  end 
+
+  def uses_random(&block)
+    collection = []
+
+    # random sql func supported by postgresql and sqlite (perhaps others)
+    random_func = "random()"
+
+    begin
+      collection = yield random_func
+    rescue ActiveRecord::StatementInvalid => e
+      if options[:random] == true
+        # the random function used was invalid, so we'll try an alternative syntax for mysql (perhaps others)
+        mysql_func = "rand()"
+
+        if random_func != mysql_func
+          random_func = mysql_func
+        else
+          # set random to false and just use the default order since the alt didn't work either
+          options[:random] = false
+        end
+
+        # retry the query
+        retry
+      end
+    end
+
+    collection
+  end
+end

data/app/models/cms/asset.rb

@@ -1,22 +1,76 @@
 module Cms
   class Asset < ActiveRecord::Base
+    unloadable
+
     set_table_name 'cms_assets'
 
+    include Cms::Taggable
+    define_tag_association :assets
+
+    def self.tags_for_context(context)
+      common_options = {:order => 'name ASC'}
+      context.object ? Cms::Tag.all({:include => :assets, :conditions => {'cms_assets.context_id' => context.object.id}}.merge(common_options)) : Cms::Tag.all(common_options)
+    end
+
+    class Meta
+      attr_reader :name, :value, :errors
+
+      def initialize(data)
+        @name, @value = data[:name], data[:value]
+        @errors = ActiveModel::Errors.new(self)
+      end
+
+      def valid?
+        validate
+        errors.empty?
+      end
+
+      def validate
+        errors.clear
+        if @name.blank?
+          errors.add :name, 'must be set'
+        else
+          errors.add :name, "is an invalid format" if (@name =~ /^[a-z]+[a-z0-9_]*$/).nil?
+        end
+      end
+    end
+
+    serialize :meta_data
+
     has_attached_file :asset,
-      :styles => { :tiny => '50x50>', :thumb => '100x100>' }, #:custom => Proc.new { |instance| "#{instance.photo_width}x#{instance.photo_height}>" } },
+      :styles => { :tiny => '50x50>', :thumb => '100x100>', :large => '200x200>', :custom => Proc.new{|instance| custom_dimensions(instance)} },
+      :convert_options => {:all => '-strip -quality 90'},
       :path => ":rails_root/public/cms/assets/:id/:style/:filename",
       :url => "/cms/assets/:id/:style/:filename"
 
     validates_attachment_presence :asset
+    validate :meta_data_check
 
     scope :ordered, :order => 'asset_file_name ASC'
 
+    after_save :reprocess_custom_dimensions
     before_post_process :process_check
 
     def to_s
       asset_file_name
     end
 
+    def assign_ordered_attributes(params)
+      # force the custom dimensions to be assigned first so that when the asset is assigned, the custom dims are present
+      # if the custom dims aren't set before the asset is assigned, the custom size won't be generated properly
+      # this can occur if the attribute hash is iterated with the asset coming before the dims
+      self.attributes = params.slice(:custom_height, :custom_width)
+      self.attributes = params
+    end
+
+    def self.context_tags(context)
+      if context
+        Tag.all :joins => 'inner join taggings on taggings.tag_id = tags.id inner join cms_assets on taggings.taggable_id = cms_assets.id', :conditions => {'cms_assets.context_id' => context.id}
+      else
+        Tag.all
+      end
+    end
+
     def image?
       !(asset_content_type =~ /^image.*/).blank?
     end
@@ -30,6 +84,40 @@ module Cms
       !(asset_content_type =~ /(javascript|css|xml|html)$/).blank?
     end
 
+    def file_content
+      read
+    end
+
+    def file_content=(content)
+      write content
+    end
+
+    def meta
+      return @_meta if @_meta.present?
+      @_meta = (meta_data || []).collect{|m| Meta.new(m)}
+    end
+
+    def meta=(data)
+      # reset the cached meta collection
+      @_meta = nil
+
+      # data ex:
+      # {"new_1301457489798"=>{"name"=>"test1", "value"=>"test1"}, "new_1301457493800"=>{"name"=>"test2", "value"=>"test2"}}
+      # converted to:
+      # [{"name"=>"test1", "value"=>"test1"}, {"name"=>"test2", "value"=>"test2"}]
+      # strip spaces of name and value
+      temp_data = data.to_a.sort{|a,b| a.first <=> b.first}.collect{|a| h = a[1]; {:name => h[:name].strip, :value => h[:value].strip} }
+      # remove any elements that have both name and value blank
+      temp_data = temp_data.reject{|d| d[:name].blank? && d[:value].blank?}
+
+      self.meta_data = temp_data
+    end
+
+    def to_liquid
+      Cms::AssetDrop.new(self)
+    end
+
+  protected
     def read
       return '' if !editable?
       asset.to_file(:original).read
@@ -46,9 +134,28 @@ module Cms
       end
     end
 
-  protected
+    def meta_data_check
+      if !meta.find_all{|m| !m.valid?}.empty?
+        errors.add :meta_data, "is invalid"
+      end
+    end
+
+    def self.custom_dimensions(record)
+      if !record.custom_width.to_i.zero? && !record.custom_height.to_i.zero?
+        "#{record.custom_width}x#{record.custom_height}>"
+      else
+        ''
+      end
+    end
+
     def process_check
       image? && !icon?
     end
+
+    def reprocess_custom_dimensions
+      if custom_height_changed? || custom_width_changed?
+        asset.reprocess!
+      end
+    end
   end
 end