radiant-assets-extension 0.0.7 → 0.0.10

data/README.rdoc

@@ -1,22 +1,75 @@
 = Assets
 
-Provides simple image handling, incl. on-the-fly resizing. Intended as a
+Provides simple image/attachment handling. Intended as a
 replacement for paperclipped in the long run, but very barebones right now.
 
-Supports uploading of images as well as other files.
+Features:
 
-== Radius Tags
+* Supports uploading of images as well as other files.
+* Uploading of multiple files at once
+* On-the-fly resizing of images to arbitrary sizes
+* Easy Attachment of assets to pages (and reordering them)
 
-<r:image size="300x" />
+== Example Radius Tags
+
+  <r:image size="300x" />
 
 Proportionally resizes an image to 300px width. Supports imagemagick geometry
 strings to do advanced resizing straight in Radius tags. Resized images are
 cached in Radiant's built-in cache so they don't have to be re-created on every
 request.
 
+  <r:assets:caption />
+
+Renders the current asset’s caption
+
+  <r:attachments:each />
+
+Cycles through all assets that are attached to the current page
+
+== Configuration
+
+You can change the behaviour of this extension using a number of Radiant settings.
+
+===assets.host
+
+If this is set (defaults to not being set), the hostname given will be
+inserted into all URLs generated by the assets extension. If you set up a
+CNAME record in DNS that points to the Radiant app itself, this can improve
+performance of the site by enabling browser to download assets in parallel. It
+can also be used to configure a CDN such as Amazon’s CloudFront.
+
+You will need to make sure this hostname points to the right content yourself.
+
+Example:
+
+  Radiant::Config['assets.host'] = 'cdn.example.com'
+  
+===assets.storage
+
+This defaults to 'file'. Set this to 's3' to store all uploads in Amazon's S3
+service. You will need to supply your Amazon AWS credentials as +s3.key+ and
++s3.secret+
+
+Example:
+
+  Radiant::Config['assets.storage'] = 's3'
+  Radiant::Config['s3.key'] = 'asd123asdklj'
+  Radiant::Config['s3.secret'] = 'a1678123bcd123123efasdc'
+
+===s3.bucket
+
+Set this to the s3 bucket name you want to use. If you don't set this, a
+bucket named "radiant-assets-extension" will be created and used.
+
+===s3.host
+
+If your bucket is located in a region other than the Amazon default of
+us-east-1, set this to the appropriate host, e.g. +s3-eu-west-1.amazonaws.com+
+for the EU (Ireland) region.
+
 == Todo
 
-- Attaching Assets to Pages
 - Easy/Automatic migration from paperclipped (currently this extension should
   only be used on “fresh” radiant sites w/o an asset management solution
   already in place)

data/app/models/asset.rb

@@ -1,5 +1,6 @@
 class Asset < ActiveRecord::Base
-  has_many :attachments, :include => :page, :dependent => :destroy
+  has_many :attachments, :as => :attachable, :dependent => :destroy
+  
   # HACK: incomplete
   AUDIO_FORMATS = [:wav, :mp3, :m4a, :ogg]
   VIDEO_FORMATS = [:mp4, :avi]
@@ -8,6 +9,10 @@ class Asset < ActiveRecord::Base
   validates_presence_of :upload
   delegate :url, :width, :height, :landscape, :portrait, :to => :upload
   
+  def page_attachments
+    attachments.select(&:attached_to_page?)
+  end
+  
   def uploads
     []
   end

data/app/models/asset_tags.rb

@@ -1,10 +1,16 @@
 module AssetTags
   include Radiant::Taggable
-  
   class TagError < StandardError;end
   
   desc %{
-    Renders an image tag
+    Renders an image tag for the current asset (if it’s an image)
+    
+    You can resize the image using the @width@, @height@ and @size@ attributes.
+    
+    Using @width@ and/or @height@ will resize the image to the specified
+    width/height maintaining the aspect ratio. For more complex resizing operations
+    you can use the @size@ attribute which will override any supplied
+    width/height attributes.
     
     Examples of possible values for the @size@ attribute
     
@@ -22,77 +28,102 @@ module AssetTags
     '400x300se'          crop, with south-east gravity
     '400x300+50+100'     crop from the point 50,100 with width, height 400,300
     
-    <r:image id="2" [size="400x200"] />
+    *Usage:* 
+    
+    <pre><code><r:image id="2" [width="200"] [height="400"] [size="400x200"] /></code></pre>
   }
-  # TODO: accept width/height attributes and do something sensible like
-  # resizing proportionally
   tag 'image' do |tag|
-    asset = find_asset(tag)
-    options = tag.attr.dup
-    image = resized_or_original_image(asset, options.delete('size'))
-    %{<img src="#{image.url}"#{html_attributes(options)}>}
+    assign_asset_and_upload!(tag)
+    if tag.locals.asset.image?
+      img = (tag.locals.asset_upload ||= tag.locals.asset.upload)
+      fill_dimension_attributes!(tag)
+      %{<img src="#{img.url}"#{html_attr_string(tag.attr.except('size'))}>}
+    end
   end
   
   desc %{
     Selects an asset. Does not render anything itself but gives access to the
-    asset's attributes such as size
+    asset's attributes such as @caption@, @url@ and @width@/@height@
     
-    <r:asset id="22"><r:url /></r:asset>
-  }
-  tag 'asset' do |tag|
-    tag.locals.asset = find_asset(tag)
-    tag.expand
-  end
-  
-  desc %{
-    Renders the URL of an asset
+    Accepts optional @size@ parameter in which case, if the asset is an image,
+    the asset is resized and any child @url@, @width@ and @height@ tags will refer
+    to the resized image.
     
-    Accepts optional size parameter in which case, if the asset is an image,
-    the URL to a resized version of the image will be returned
+    *Usage:*
     
-    <r:asset:url [size="200x200"] id="22" />
+    <pre><code><r:asset id="22" [size="200x200"]>...</r:asset></code></pre>
+    
+    *Examples:*
+    
+    Will render URL to original uploaded file
+    <pre><code><r:asset id="66"><r:url /></r:asset></code></pre>
+    
+    Will render render height of resized image (500)
+    <pre><code><r:asset id="66" size="x500">New Height: <r:height />px</r:asset></code></pre>
   }
-  tag 'asset:url' do |tag|
-    image = resized_or_original_image(tag.locals.asset, tag.attr['size'])
-    (image && image.url) || tag.locals.asset.url
+  tag 'asset' do |tag|
+    assign_asset_and_upload!(tag)
+    tag.expand
   end
   
-  %w[caption width height].each do |attribute|
+  # NOTE: width/height tags require analysing the image if you resized it
+  # this can be quite slow. Avoid using with resized images.
+  %w[url width height].each do |attribute|
     desc %{
       Renders the #{attribute} of the current asset
+            
+      Accepts optional size parameter in which case, if the asset is an image,
+      the #{attribute} to a resized version of the image will be returned.
+      
+      *Usage:*
+      
+      <pre><code><r:asset:#{attribute} [size="200x200"] id="22" /></code></pre>
     }
     tag "asset:#{attribute}" do |tag|
-      tag.locals.asset.send(attribute.to_sym)
+      assign_asset_and_upload!(tag)
+      (tag.locals.asset_upload ||= tag.locals.asset.upload).send(attribute.to_sym)
     end
   end
+
+  desc %{
+    Renders the caption of the current asset
+  }
+  tag 'asset:caption' do |tag|
+    assign_asset_and_upload!(tag)
+    tag.locals.asset.caption
+  end
   
   desc %{
-    Renders contents if the current asset is an image
+    Renders its contents if the current asset is an image
   }
   tag 'asset:if_image' do |tag|
+    assign_asset_and_upload!(tag)
     tag.expand if tag.locals.asset.image?
   end
 
   desc %{
-    Renders contents if the current asset isn't an image
+    Renders its contents if the current asset isn't an image
   }
   tag 'asset:unless_image' do |tag|
+    assign_asset_and_upload!(tag)
     tag.expand unless tag.locals.asset.image?
   end
   
   %w[landscape portrait].each do |orientation|
     desc %{
-      Renders contents if the current image is in #{orientation} orientation
+      Renders its contents if the current image is in #{orientation} orientation
     }
     tag "asset:if_#{orientation}" do |tag|
-      tag.expand if tag.locals.asset.send "#{orientation}?".to_sym
+      assign_asset_and_upload!(tag)
+      tag.expand if (tag.locals.asset_upload ||= tag.locals.asset.upload).send "#{orientation}?".to_sym
     end
     
     desc %{
-      Renders contents if the current image isn't in #{orientation} orientation
+      Renders its contents if the current image isn't in #{orientation} orientation
     }
     tag "asset:unless_#{orientation}" do |tag|
-      tag.expand unless tag.locals.asset.send "#{orientation}?".to_sym
+      assign_asset_and_upload!(tag)
+      tag.expand unless (tag.locals.asset_upload ||= tag.locals.asset.upload).send "#{orientation}?".to_sym
     end
   end
   
@@ -102,16 +133,39 @@ module AssetTags
   end
   
   desc %{
-    Selects the first attached asset of the page and renders the tag's contents.
+    Renders the tag’s contents if the page has any assets attached.
+  }
+  tag 'if_attachments' do |tag|
+    tag.expand if tag.locals.page.attachments.any?
+  end
+
+  desc %{
+    Renders the tag’s contents if the page has no assets attached.
+  }
+  tag 'unless_attachments' do |tag|
+    tag.expand unless tag.locals.page.attachments.any?
+  end
+  
+  desc %{
+    Renders the tag‘s contents with the first attached asset of the current
+    page selected.
+    
     If there are no assets on the page, nothing is rendered.
   }
   tag 'attachments:first' do |tag|
     if attachment = tag.locals.page.attachments.first
+      tag.locals.attachment = attachment
       tag.locals.asset = attachment.asset
       tag.expand
     end
   end
   
+  
+  desc %{
+    Cycles through the attachments of the current page and renders the tag’s
+    contents for each of them.
+  }
+  # TODO: arbitrary ordering and limiting
   tag 'attachments:each' do |tag|
     tag.locals.page.attachments.collect do |attachment|
       tag.locals.attachment = attachment
@@ -121,20 +175,52 @@ module AssetTags
   end
   
 private
-  def find_asset(tag)
-    tag.locals.asset || Asset.find(tag.attr['id'])
-  rescue ActiveRecord::RecordNotFound
-    raise TagError, 'Please supply an id attribute'
+  def assign_asset_and_upload!(tag)
+    assign_asset!(tag)
+    assign_upload!(tag)
+  end
+  
+  def assign_asset!(tag)
+    if tag.attr['id']
+      tag.locals.asset = Asset.find(tag.attr['id'])
+    else
+      tag.locals.asset || raise(TagError, 'Please supply an id attribute')
+    end
+  end
+  
+  def fill_dimension_attributes!(tag)
+    # Can't use aspect_ratio here because it's not cached on the model
+    # Using it would require analysing the image which we want to postpone
+    # The original height/width are cached on upload though
+    aspect_ratio = tag.locals.asset.width.to_f / tag.locals.asset.height.to_f
+    if tag.attr['width'] && tag.attr['height']
+      return
+    elsif tag.attr['width']
+      tag.attr['height'] = (tag.attr['width'].to_i / aspect_ratio).to_i
+    elsif h = tag.attr['height']
+      tag.attr['width'] = (tag.attr['height'].to_i * aspect_ratio).to_i
+    end
+  end
+  
+  def assign_upload!(tag)
+    tag.attr['size'] ||= build_geometry_string(tag.attr['width'], tag.attr['height'])
+    tag.locals.asset_upload = if tag.attr['size']
+      tag.locals.asset.upload.process(:resize, tag.attr['size'])
+    end
   end
   
-  def resized_or_original_image(asset, size)
-    if asset.image?
-      size ? asset.upload.process(:resize, size) : asset.upload
+  def build_geometry_string(width, height)
+    if width && height
+      "#{width}x#{height}"
+    elsif width
+      "#{width}x"
+    elsif height
+      "x#{height}"
     end
   end
   
-  def html_attributes(options)
-    attributes = options.inject('') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
+  def html_attr_string(hash)
+    attributes = hash.inject('') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
     " #{attributes}" unless attributes.empty?
   end
 end

data/app/models/attachment.rb

@@ -1,10 +1,10 @@
 require 'acts_as_list'
 
 class Attachment < ActiveRecord::Base
-  belongs_to :asset, :autosave => true
-  belongs_to :page
+  belongs_to :attachable, :polymorphic => true, :autosave => true
+  belongs_to :parent, :polymorphic => true
   
-  acts_as_list :scope => :page_id
+  acts_as_list :scope => :parent_id
   
   def self.reorder(new_order)
     new_order.each_with_index do |id, index|
@@ -13,11 +13,19 @@ class Attachment < ActiveRecord::Base
     new_order
   end
   
+  def attached_to_page?
+    parent_type == 'Page'
+  end
+  
+  def asset
+    attachable if attachable_type == 'Asset'
+  end
+  
   def uploads=(new_uploads)
-    (asset || build_asset).uploads=new_uploads
+    (self.attachable ||= Asset.new).uploads=new_uploads
   end
   
   def uploads
-    (asset || build_asset).uploads
+    (self.attachable ||= Asset.new).uploads
   end
 end

data/app/views/admin/assets/_attachments.html.erb

@@ -1,23 +1,32 @@
-<h2>Attachments</h2>
-
-<%= render :partial => 'admin/assets/upload', :locals => {:record => @page.attachments.build, :url => admin_page_attachments_path(@page)} %>
-
-<ul id="assets">
-  <%= render :partial => 'admin/assets/attachment', :collection => @page.attachments.reject(&:new_record?) %> 
-</ul>
-
-<script type="text/javascript">
-  (function($) {
-    $(function() {
-      $('#assets').sortable({
-        update: function(event, ui) {
-          $.ajax({
-            type: "POST",
-            url: '<%= positions_admin_page_attachments_path(@page) %>',
-            data: '_method=PUT&'+$(this).sortable('serialize'),
-          });
-        }
-      }).disableSelection();
-    });
-  }(jQuery));
-</script>
+<%#
+HACK: when page isn't saved there isnt a way to associate uploaded images
+      saving uploads temporarily and associating them on save is messy, but
+      should be the way to go
+ %>
+<% unless @page.new_record? %>
+  <h2>Attachments</h2>
+  
+  <%= render :partial => 'admin/assets/upload', :locals => {:record => @page.attachments.build, :url => admin_page_attachments_path(@page)} %>
+  
+  <ul id="assets">
+    <%= render :partial => 'admin/assets/attachment', :collection => @page.attachments.reject(&:new_record?) %> 
+  </ul>
+  
+  <script type="text/javascript">
+    (function($) {
+      $(function() {
+        $('#assets').sortable({
+          update: function(event, ui) {
+            $.ajax({
+              type: "POST",
+              url: '<%= positions_admin_page_attachments_path(@page) %>',
+              data: '_method=PUT&'+$(this).sortable('serialize'),
+            });
+          }
+        }).disableSelection();
+      });
+    }(jQuery));
+  </script>
+<% else %>
+  <p>Please save page first before uploading attachments.</p>
+<% end %>

data/app/views/admin/assets/edit.html.erb

@@ -18,11 +18,11 @@
     </table>
     <%= f.file_field :upload %>
     <%= display(@asset) %>
-    <%- if @asset.attachments.any? -%>
-      <h2>Included on <%= pluralize(@asset.attachments.size, 'this page', 'these pages') %>:</h2>
+    <%- if @asset.page_attachments.any? -%>
+      <h2>Included on <%= pluralize(@asset.page_attachments.size, 'this page', 'these pages') %>:</h2>
       <ul>
-        <%- @asset.attachments.each do |attachment| -%>
-          <li><%= link_to attachment.page.title, edit_admin_page_path(attachment.page) %></li>
+        <%- @asset.page_attachments.each do |attachment| -%>
+          <li><%= link_to attachment.parent.title, edit_admin_page_path(attachment.parent) %></li>
         <%- end -%>
       </ul>
     <%- end -%>

data/app/views/admin/assets/remove.html.erb

@@ -8,16 +8,16 @@
 
 <table class="index" id="assets">
   <tr><td class="name"><%= asset_listing(@asset) %></td></tr>
-  <% if @asset.attachments.any? %>
+  <% if @asset.page_attachments.any? %>
     <tr>
       <th>
         It's being used on the following
-        <%= pluralize(@asset.attachments.size, 'page') %> and will be removed from
+        <%= pluralize(@asset.page_attachments.size, 'page') %> and will be removed from
         there as well:
         </th>
     </tr>
-    <% @asset.attachments.each do |attachment| %>
-      <tr><td><%= attachment.page.title %></td></tr>
+    <% @asset.page_attachments.each do |attachment| %>
+      <tr><td><%= attachment.parent.title %></td></tr>
     <% end %>
   <% end %>
 </table>

data/assets_extension.rb

@@ -1,6 +1,6 @@
 # Uncomment this if you reference any of your controllers in activate
 # require_dependency 'application_controller'
-require 'radiant-assets-extension/version'
+require 'radiant-assets-extension'
 require 'radiant-assets-extension/s3_store'
 
 class AssetsExtension < Radiant::Extension
@@ -10,11 +10,17 @@ class AssetsExtension < Radiant::Extension
   
   extension_config do |config|
     path = '/assets'
+    
     dragonfly = Dragonfly[:assets]
     dragonfly.configure_with(:imagemagick)
+    # Overriding command to strip metadata from resized/converted images
+    # see https://github.com/markevans/dragonfly/pull/61#issuecomment-1037694
+    Dragonfly::ImageMagickUtils.convert_command = 'convert -strip'
     dragonfly.configure_with(:rails)
-    dragonfly.define_macro(ActiveRecord::Base, :image_accessor)    
+    dragonfly.define_macro(ActiveRecord::Base, :image_accessor)
     dragonfly.url_path_prefix = path
+    # TODO: optional SSL support for url_host. could protocol-relative urls be used?
+    dragonfly.url_host = 'http://' + Radiant::Config['assets.host'] if Radiant::Config['assets.host']
     if RadiantAssetsExtension::S3Store.enabled?
       dragonfly.datastore = RadiantAssetsExtension::S3Store.new
       dragonfly.datastore.configure do |c|
@@ -33,7 +39,7 @@ class AssetsExtension < Radiant::Extension
     ApplicationController.helper(:assets)
     Page.class_eval do
       include AssetTags
-      has_many :attachments, :include => :asset, :order => :position
+      has_many :attachments, :as => :parent, :order => :position, :dependent => :destroy
     end
   end
 end

data/db/migrate/20110321005357_make_attachments_polymorphic.rb

@@ -0,0 +1,17 @@
+class MakeAttachmentsPolymorphic < ActiveRecord::Migration
+  def self.up
+    rename_column :attachments, :page_id, :parent_id
+    add_column :attachments, :parent_type, :string
+    Attachment.update_all 'parent_type = "Page"'
+
+    rename_column :attachments, :asset_id, :attachable_id
+    add_column :attachments, :attachable_type, :string
+    Attachment.update_all 'attachable_type = "Asset"'
+  end
+
+  def self.down
+    warn 'This will delete all Attachments that aren’t attached to pages'
+    remove_column :attachments, :parent_type
+    rename_column :attachments, :parent_id, :page_id
+  end
+end

data/lib/radiant-assets-extension.rb

@@ -1,2 +1,3 @@
 module RadiantAssetsExtension
-end
+  VERSION = '0.0.10'
+end

data/lib/radiant-assets-extension/s3_store.rb

@@ -23,7 +23,7 @@ module RadiantAssetsExtension
       # HACK: AWS::S3 doesn't support S3 international regions properly
       # https://github.com/marcel/aws-s3/issues#issue/4/comment/411302
       # we monkey-patch the default host
-      AWS::S3::DEFAULT_HOST.replace Radiant::Config['s3.host'] || self.class.s3_region_hosts['us-east-1']
+      AWS::S3::DEFAULT_HOST.replace Radiant::Config['s3.host'] if Radiant::Config['s3.host']
       super({
         :bucket_name => Radiant::Config['s3.bucket'] || DEFAULT_BUCKET_NAME,
         :access_key_id => Radiant::Config['s3.key'],

data/public/stylesheets/admin/extensions/assets/assets.css

@@ -62,6 +62,14 @@ ul#assets, #assets li {
   position: relative;
 }
 
+#assets li li {
+  margin-bottom: 0;
+}
+
+#assets li li:last-of-type {
+  margin-right: 0;
+}
+
 #assets li a {
   color: inherit;
   text-decoration: none;

data/radiant-assets-extension.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
-require 'radiant-assets-extension/version'
+require 'radiant-assets-extension'
 
 Gem::Specification.new do |s|
   s.name        = 'radiant-assets-extension'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: radiant-assets-extension
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Gerrit Kaiser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-20 00:00:00 +00:00
+date: 2011-04-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,11 +108,11 @@ files:
 - db/migrate/20110225210821_add_attachment_to_pages.rb
 - db/migrate/20110225210912_add_timestamps_and_locking_to_assets.rb
 - db/migrate/20110320152044_add_position_to_attachments.rb
+- db/migrate/20110321005357_make_attachments_polymorphic.rb
 - features/support/env.rb
 - features/support/paths.rb
 - lib/radiant-assets-extension.rb
 - lib/radiant-assets-extension/s3_store.rb
-- lib/radiant-assets-extension/version.rb
 - lib/tasks/assets_extension_tasks.rake
 - public/jquery.fileupload/.gitignore
 - public/jquery.fileupload/jquery.fileupload-ui.css
@@ -127,7 +127,7 @@ has_rdoc: true
 homepage: http://ext.radiantcms.org/extensions/269-assets
 licenses: []
 
-post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-assets-extension', :version => '0.0.7'\n  "
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-assets-extension', :version => '0.0.10'\n  "
 rdoc_options: []
 
 require_paths: 

data/lib/radiant-assets-extension/version.rb

@@ -1,3 +0,0 @@
-module RadiantAssetsExtension
-  VERSION = '0.0.7'
-end