radiant-images-extension 0.3.3 → 0.3.4

data/README.md

@@ -4,48 +4,85 @@ Radiant Images is an IMAGE management tool, meant only to be useful to pages and
 
 ## Primary (only) Goals
 
-### Light Weight
+**Light Weight ::** We're not replacing paperclipped, we're just building a simple image manager extension.
 
-> We're not replacing paperclipped, we're just building a simple image manager extension.
+**Uncomplicated ::** People need to be able to look at the model and instantly know what it's doing, being able to do so means they can easily extend it
 
-### Uncomplicated
+**Flexible ::** Images works with the local filesystem or S3 cloud storage.
 
-> People need to be able to look at the model and instantly know what it's doing, being able to do so means they can easily extend it
+**Easily Extendable ::** Images is a base for things like galleries and shop, where they don't need additional assets
 
-### Easily Extendable
+**Migrate from paperclipped easily ::** Paperclipped is freakin' awesome, we use it and we need to be able to migrate the images over
 
-> Images is a base for things like galleries and shop, where they don't need additional assets
+    rake radiant:extensions:images:migrate_from_paperclipped
 
-### Strictly aws and paperclip
+## Installation
 
-> We don't work with images locally because we use Heroku. So we're not going to give you the option to start locally
+    gem install radiant-images-extension
+    
+Add the following line to your config/environment.rb: 
+`config.gem 'radiant-images-extension', :lib => false`
+    
+    rake radiant:extensions:images:update
+    rake radiant:extensions:images:migrate
 
-### Migrate from paperclipped easily
+## S3 Storage
 
-> paperclipped is freakin' awesome, we use it and we need to be able to migrate the images over
+By default images will use your local file storage. If you wish to use s3 to store your image, change the `images.storage` config key to `s3`.
 
-    rake radiant:extensions:images:migrate_from_paperclipped
+    Radiant::Config['images.storage'] = 's3'
 
-## Installation
+You will also need to set the related S3 config items to match your account:
 
-The recommended way to install the radiant images extension is by installing the gem and configuring it in your radiant app, here are the instructions:
+    Radiant::Config['s3.bucket']      = 'bucket'
+    Radiant::Config['s3.host_alias']  = 'alias' # Optional! Used for aliased hostnames
+    Radiant::Config['s3.key']         = 'key'
+    Radiant::Config['s3.secret']      = 'secret'
 
-    gem install radiant-images-extension
-    # add the following line to your config/environment.rb: config.gem 'radiant-images-extension', :lib => false
-    rake radiant:extensions:images:update
-    rake radiant:extensions:images:migrate
+The URL and path values will need to be altered from their default values to work correctly with S3 storage, see the section below for examples.
+
+## URL and Path Settings
+
+The URL and Path settings for images out of the box will work fine for local storage, if you are using S3 then checkout the examples below:
+
+You can find a list of symbols that can be used in the URL/Path [at the paperclip wiki](http://github.com/thoughtbot/paperclip/wiki/interpolations). There are more symbols which you may be able to find by searching online also.
+
+Here are some base values and their explanation of use:
+
+#### Local file storage
+
+produces a URL such as: /images/original_file-icon.png
+
+    Radiant::Config['images.path'] = ':rails_root/public/:class/:basename-:style.:extension'
+    Radiant::Config['images.url']  = '/:class/:basename-:style.:extension'
+
+#### Amazon S3 storage
+
+produces a URL such as: http://s3.amazonaws.com/bucketname/images/original_file-icon.png
+
+    Radiant::Config['images.path'] = ':class/:basename-:style.:extension'
+    Radiant::Config['images.url']  = ':s3_path_url'
+
+#### Amazon S3 with FQDN (Requires a CNAME pointing to s3.amazonaws.com)
+
+produces a URL such as: http://host.alias/images/original_file-icon.png
+
+    Radiant::Config['images.path'] = ':class/:basename-:style.:extension'
+    Radiant::Config['images.url']  = ':s3_alias_url'
 
-If you want to run a development copy of images simply clone a copy into radiant's vendor/extensions folder and then run a update/migrate on the extension.
+## Passenger and ImageMagick
 
-## Host Alias Settings
+They don't always play nicely, if you're having strange errors such as
 
-By default the images extension uses the following url for images:
+    /tmp/stream20101025-12485-nx6sdr-0 is not recognized by the 'identify' command.
+     
+Then ensure that you have set the config to match the location of imagemagick on your machine
 
-    http://s3.amazonaws.com/bucketname/images/name_of_image-style.(png|jpg|gif)
+    images.image_magick_path = /usr/local/bin
 
-There is a radiant configuration option called s3.host_alias. By default it is blank, if you give it a value, the images extension will use the FQDN method to access your images. Setting your host alias to domain.name.com for example would produce a URL like this:
+## Contributors
 
-    http://domain.name.com/images/name_of_image-style.(png|jpg|gif) 
+Dirk Kelly, Mario Visic
 
 ## License
 

data/Rakefile

@@ -7,7 +7,8 @@ begin
     gem.email = "info@squaretalent.com"
     gem.homepage = "http://github.com/squaretalent/radiant-images-extension"
     gem.authors = ['squaretalent']
-    gem.add_dependency 'paperclip',         '~> 2.3.1.1'
+    gem.add_dependency 'radiant',           '>= 0.9.1'
+    gem.add_dependency 'paperclip',         '~> 2.3.5'
     gem.add_dependency 'aws-s3',            '>= 0.6.2'
     gem.add_dependency 'acts_as_list',      '>= 0.1.2'
     gem.add_development_dependency 'rspec', '>= 1.3.0'

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/app/controllers/admin/images_controller.rb

@@ -1,34 +1,20 @@
 class Admin::ImagesController < Admin::ResourceController
   
-  before_filter :index_assets, :only => [ :index ]
-  before_filter :edit_assets, :only => [ :show, :edit ]
-  around_filter :rescue_s3_exceptions, :only => [:create, :edit, :destroy]
+  before_filter :index_assets,          :only => [ :index ]
+  before_filter :edit_assets,           :only => [ :show, :edit ]
+  around_filter :rescue_s3_exceptions,  :only => [ :create, :update, :destroy ]
   
   def index
-    @images = Image.paginate :page => params[:page], :per_page => 20
+    @images = Image.paginate :page => params[:page], :per_page => params[:pp] || 25
   end
   
-  
-  def search 
-    @images = Image.search params[:search], params[:p]
-
-    respond_to do |format|
-      format.html { render }
-      format.js { render @images }
-      format.xml { render :xml => @images.to_xml }
-      format.json { render :json => @images.to_json }
-    end
-  end
-  
-private
+  protected
 
   def index_assets
-    include_javascript 'admin/extensions/images/index'
     include_stylesheet 'admin/extensions/images/index'
   end
   
   def edit_assets
-    include_javascript 'admin/extensions/images/edit'
     include_stylesheet 'admin/extensions/images/edit'
   end
   

data/app/models/image.rb

@@ -14,15 +14,16 @@ class Image < ActiveRecord::Base
                     :styles           => lambda { Image.config_styles },
                     :whiny_thumbnails => false,
                     :default_url      => '/images/extensions/images/missing_:style.png',
-                    
-                    :storage          => :s3,
+                    :storage          => Radiant::Config['images.storage'] == 's3' ? :s3 : :filesystem, 
                     :s3_credentials   => {
                       :access_key_id      => Radiant::Config['s3.key'],
                       :secret_access_key  => Radiant::Config['s3.secret']
                     },
+                    :s3_host_alias    => Radiant::Config['s3.host_alias'],
                     :bucket           => Radiant::Config['s3.bucket'],
-                    :path             => Radiant::Config['s3.path']
-                                        
+                    :url              => Radiant::Config['images.url'],
+                    :path             => Radiant::Config['images.path']
+                                 
   validates_attachment_presence :asset
   validates_attachment_content_type :asset, :content_type => ['image/jpeg', 'image/png', 'image/gif']
   
@@ -30,65 +31,19 @@ class Image < ActiveRecord::Base
     self.title = self.asset_file_name if title.blank?
   end
   
-  def url(style = :original, include_updated_timestamp = true, secure = false)
-    self.asset.url(style, include_updated_timestamp, secure)
+  def url(style = Radiant::Config['images.default'], include_updated_timestamp = true)
+    self.asset.url(style, include_updated_timestamp)
   end
   
-  # We need to overide the url method for our attachment so 
-  # we can dynamically swap between aliased and non aliased domain names
-  module ::Paperclip
-    class Attachment
-      
-      def url(style = :original, include_updated_timestamp = true, secure = false)
-        style  = style.to_s
-        prefix = secure ? 'https://' : 'http://'
-        domain = Radiant::Config['s3.host_alias'].present? ? Radiant::Config['s3.host_alias'] : 's3.amazonaws.com'
-        bucket = Radiant::Config['s3.host_alias'].present? ? '' : "/#{Radiant::Config['s3.bucket']}"
-
-        url = prefix + domain + bucket + '/images/' + basename + '-' + style + '.' + extension
-        include_updated_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
-      end
-      
-      def basename
-        File.basename(instance.asset_file_name, ".*") if instance.asset_file_name
-      end
-
-      def extension
-        instance.asset_file_name.split('.').last.downcase if instance.asset_file_name
-      end
-      
-    end
-  end
+  private 
   
-private
-  
-  class << self
-    def search(search, page)
-      unless search.blank?
-        queries = []
-        queries << 'LOWER(title) LIKE (:term)'
-        queries << 'LOWER(caption) LIKE (:term)'
-        queries << 'LOWER(asset_file_name) LIKE (:term)'
-        
-        sql = queries.join(' OR ')
-        @conditions = [sql, {:term => "%#{search.downcase}%" }]
-      else
-        @conditions = []
-      end
-      
-      self.all :conditions => @conditions
-      
-    end
-    
-    def config_styles
-      styles = []
-      
-      if Radiant::Config['images.styles']
-        styles = Radiant::Config['images.styles'].gsub(/\s+/,'').split(',') 
-        styles = styles.collect{|s| s.split('=')}.inject({}) {|ha, (k, v)| ha[k.to_sym] = v; ha}
-      end
-      styles
+  def self.config_styles
+    styles = []
+    if Radiant::Config['images.styles']
+      styles = Radiant::Config['images.styles'].gsub(/\s+/,'').split(',') 
+      styles = styles.collect{|s| s.split('=')}.inject({}) {|ha, (k, v)| ha[k.to_sym] = v; ha}
     end
+    styles
   end
-    
+        
 end

data/app/views/admin/images/_bottom.haml

@@ -1,13 +1,8 @@
-%ul{ :style =>'float: left'}
+%ul
   - render_region :bottom do |bottom|
     - bottom.create do
       %li
         = link_to image('plus') + " " + t("new_image"), new_admin_image_path
-    - bottom.search do
-      %li
-        - form_tag nil, :method => 'get' do
-          = text_field_tag 'search', params[:search], :type => 'search'
-          = observe_field 'search', :frequency => 2, :update => 'images', :url =>  { :controller => 'images', :action=> 'index' }, :method => 'get', :with => "'search=' + escape(value)"
 - render_region :paginate do |paginate|
   - paginate.pagination do
     = pagination_for(@images)

data/config/routes.rb

@@ -1,7 +1,7 @@
 ActionController::Routing::Routes.draw do |map|
   
   map.namespace :admin, :member => { :remove => :get } do |admin|
-    admin.resources :images, :collection => { :search => :get }
+    admin.resources :images
   end
   
 end

data/images_extension.rb

@@ -10,7 +10,7 @@ class ImagesExtension < Radiant::Extension
   url "http://github.com/squaretalent/radiant-images-extension"
     
   extension_config do |config|
-    config.gem 'paperclip', :version => '~> 2.3.1.1'
+    config.gem 'paperclip', :version => '~> 2.3.5'
     config.gem 'aws-s3', :version => '>= 0.6.2', :lib => 'aws/s3'
     config.gem 'acts_as_list', :version => '>= 0.1.2'
     
@@ -22,18 +22,12 @@ class ImagesExtension < Radiant::Extension
   
   def activate
     
-    # require the settings extension to be loaded
-    unless Radiant::Extension.descendants.any? { |extension| extension.extension_name == 'Settings' }
-      warn 'Error: The Images extension requires the Settings extension to be installed.'
-      warn 'Either install the Settings extension or remove Images.'
-      exit(1)
-    end
-    
     unless defined? admin.image
       Radiant::AdminUI.send :include, Images::Interface::Admin::Images
       admin.image = Radiant::AdminUI.load_default_image_regions
     end
     
+    Paperclip::Railtie.insert
     
     Page.send :include, Images::Tags::Core
 
@@ -43,14 +37,16 @@ class ImagesExtension < Radiant::Extension
       add_item 'Images', '/admin/images', :after => 'Pages'
     end
     
-    Radiant::Config['images.styles']  ||= "icon=45x45#,preview=200x200#,normal=640x640#"
     Radiant::Config['images.default'] ||= "original"
+    Radiant::Config['images.path']    ||= ":rails_root/public/:class/:basename-:style.:extension"
+    Radiant::Config['images.storage'] ||= "local"
+    Radiant::Config['images.styles']  ||= "icon=45x45#,preview=200x200#,normal=640x640#"
+    Radiant::Config['images.url']     ||= "/:class/:basename-:style.:extension"
     
-    Radiant::Config['s3.host_alias']  ||= ""
+    Radiant::Config['s3.bucket']      ||= "set"
+    Radiant::Config['s3.host_alias']  ||= "set"
     Radiant::Config['s3.key']         ||= "set"
     Radiant::Config['s3.secret']      ||= "set"
-    Radiant::Config['s3.bucket']      ||= "fs.domain.com"
-    Radiant::Config['s3.path']        ||= ":class/:basename-:style.:extension"
     
 
     unless Radiant::Config["images.image_magick_path"].nil?

data/lib/images/interface/admin/images.rb

@@ -22,10 +22,9 @@ module Images
                 image.new = image.edit
                 image.index = Radiant::AdminUI::RegionSet.new do |index|
                   index.attributes.concat %w{thumbnail title modify }
-                  index.bottom.concat %w{ create search }
+                  index.bottom.concat %w{ create }
                   index.paginate.concat %w{ pagination }
                 end
-                image.searchearch = image.index
                 image.remove = image.index
               end
             end

data/lib/images/tags/core.rb

@@ -14,7 +14,6 @@ module Images
       }
       tag 'images' do |tag|
         tag.locals.images = Helpers.current_images(tag)
-        
         tag.expand
       end
       
@@ -42,279 +41,73 @@ module Images
       }
       tag 'images:each' do |tag|
         context = ''
-        
         tag.locals.images.each do |image|
           tag.locals.image = image
           context << tag.expand
         end
-        
-        content
+        context
       end
       
       desc %{
-        Expands the current image context
+        Expands the current image context. 
+        Images can be obtained by passing a ID, title or position attribute.
         
         *Usage:*
-        <pre><code><r:image>...</r:image></code></pre>
+        <pre><code><r:image [id=] [title=""] [position=]>...</r:image></code></pre>
       }
       tag 'image' do |tag|
         tag.locals.image = Helpers.current_image(tag)
-        
         tag.expand
       end
       
       desc %{
-        Outputs the full URL of the image including the filename. Specify the style
-        using the style option.
+        Outputs the full URL of the image including the filename. 
+        The style of the image can be specified by passing the style attribute.
         
         *Usage:*
         <pre><code><r:image title='image'><r:url [style="preview|original"] /></r:image></code></pre>
       }
       tag 'image:url' do |tag|
         result = nil
-        
         if tag.locals.image ||= Helpers.current_image(tag)
-          style = tag.attr['style'] || :original
+          style = tag.attr['style'] || Radiant::Config['images.default'].to_sym
           result = tag.locals.image.url(style, false)
         end
-        
         result
       end
       
       desc %{
-        Outputs a very simple image tag
+        Outputs a very simple image tag.
+        The style of the image can be specified by passing the style attribute.
+        
+        *Usage:*
+        <pre><code><r:image title='image'><r:tag [style="preview|original"] /></r:image></code></pre>
       }
       tag 'image:tag' do |tag|
         result = nil
-
         if tag.locals.image ||= Helpers.current_image(tag)
-          style = tag.attr['style'] || :original
+          style = tag.attr['style'] || Radiant::Config['images.default'].to_sym
           result = %{<img src="#{tag.locals.image.url(style, false)}" />}
         end
-        
         result
       end
       
-      [:id, :title].each do |method|
+      [:id, :title, :position].each do |method|
         desc %{
-          Outputs the title of the current image
+          Outputs the #{method} of the current image
           
           *Usage:*
           <pre><code><r:image title='image'><r:#{method} /></code></pre>
         }
         tag "image:#{method}" do |tag|
           result = nil
-          
           if tag.locals.image ||= Helpers.current_image(tag)
             result = tag.locals.image.send(method)
           end
-          
           result
         end
       end
       
     end
   end
-end
-
-
-
-# describe '<r:images:each>' do
-#   
-#   it 'should expand on all images' do
-#     content = '<r:images:each>test!</r:images:each>'
-#     expected = ''
-#     @images.length.times { expected += 'test!' }
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should be running through the image objects' do
-#     content = '<r:images:each><r:images:url/></r:images:each>'
-#     expected = ''
-#     @images.each { |image| expected += image.asset.url }
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should only run through however many images we specify with limit' do
-#     content = '<r:images:each limit="2"><r:images:url/></r:images:each>'
-#     expected = ''
-#     @images[0..1].each { |image| expected += image.asset.url }
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should start at the image number we give it using offset' do
-#     content = '<r:images:each limit="2" offset="1"><r:images:url/></r:images:each>'
-#     expected = ''
-#     @images[1..2].each { |image| expected += image.asset.url }
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should display images in the order we give' do
-#     # asc
-#     content = '<r:images:each order="asc" by="position"><r:images:url/></r:images:each>'
-#     expected = ''
-#     @images.each { |image| expected += image.asset.url }
-#     pages(:home).should render(content).as(expected)
-#     
-#     #desc
-#     content = '<r:images:each order="desc" by="position"><r:images:url/></r:images:each>'
-#     expected = ''
-#     @images.reverse.each { |image| expected += image.asset.url }
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should allow us to order images by title' do
-#     content = '<r:images:each order="asc" by="title"><r:images:url/></r:images:each>'
-#     expected = ''
-#     @images.sort! { |a,b| a.title <=> b.title }
-#     @images.each { |image| expected += image.asset.url }
-#     pages(:home).should render(content).as(expected)
-#   end
-#       
-# end
-# 
-# describe '<r:images:first>' do
-#   
-#   it 'should render the first image' do
-#     content   = '<r:images:first><r:images:url/></r:images:first>'
-#     expected  = @images.first.asset.url
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-# end
-# 
-# describe '<r:images:if_first>' do
-#   
-#   it 'should expand the tag if the image is the first' do
-#     content   = '<r:images><r:each><r:if_first><r:url /></r:if_first></r:each></r:images>'
-#     expected  = @images.first.asset.url
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-# end
-# 
-# describe '<r:images:unless_first>' do
-#   
-#   it 'should expand the tag if the image is not the first' do
-#     content   = '<r:images><r:each><r:unless_first><r:url /></r:unless_first></r:each></r:images>'
-#     expected  = ''
-#     
-#     @images.each do |image|
-#       expected += image.asset.url unless image == @images.first
-#     end
-#     
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-# end
-# 
-# describe '<r:if_images>' do
-#   
-#   it 'should expand the contents if there are images' do
-#     content = '<r:images:if_images>test text</r:images:if_images>'
-#     expected = 'test text'
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should not expand the contents if there are no images' do
-#     Image.delete_all
-#     content   = '<r:images:if_images>test text</r:images:if_images>'
-#     expected  = ''
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-#   it 'should expand if the min count is equal to the image count' do
-#     min_count = Image.count
-#     content   = '<r:images:if_images min_count="' + min_count.to_s + '">test text</r:images:if_images>'
-#     expected  = 'test text'
-#     pages(:home).should render(content).as(expected)      
-#   end
-#   
-#   it 'should not expand if the min count is greater than the image count' do
-#     min_count = Image.count + 1
-#     content   = '<r:images:if_images min_count="' + min_count.to_s + '">test text</r:images:if_images>'
-#     expected  = ''
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-# end
-# 
-# describe '<r:unless_images>' do
-#   
-#   it 'should not the contents if there are images' do
-#     content = '<r:images:unless_images>test text</r:images:unless_images>'
-#     expected = ''
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should expand the contents if there are no images' do
-#     Image.delete_all
-#     content   = '<r:images:unless_images>test text</r:images:unless_images>'
-#     expected  = 'test text'
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-#   it 'should not expand if the min count is equal to the image count' do
-#     min_count = Image.count
-#     content   = '<r:images:unless_images min_count="' + min_count.to_s + '">test text</r:images:unless_images>'
-#     expected  = ''
-#     pages(:home).should render(content).as(expected)      
-#   end
-#   
-#   it 'should expand if the min count is greater than the image count' do
-#     min_count = Image.count + 1
-#     content   = '<r:images:unless_images min_count="' + min_count.to_s + '">test text</r:images:unless_images>'
-#     expected  = 'test text'
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-# end
-# 
-# describe '<r:images:url/>' do
-#   
-#   it 'should output the url for a valid image' do
-#     content   = '<r:images title="' + @images.first.title + '"><r:images:url/></r:images>'
-#     expected  = @images.first.asset.url 
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-# end
-# 
-# describe '<r:images:title/>' do
-#   
-#   it 'should output the title for a valid image' do
-#     content   = '<r:images title="' + @images.first.title + '"><r:images:title/></r:images>'
-#     expected  = @images.first.title 
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-# end
-# 
-# describe '<r:images:tag/>' do
-#   
-#   it 'should output a valid image tag when given a valid image' do
-#     content   = '<r:images title="' + @images.first.title + '"><r:images:tag /></r:images>'
-#     expected  = '<img src="' + @images.first.asset.url + '"  alt="' + @images.first.title + '" />' 
-#     pages(:home).should render(content).as(expected)    
-#   end
-#   
-#   it 'should output a valid image tag when specifying an image by title' do
-#     content   = '<r:images:tag title="' + @images.first.title + '" />'
-#     expected  = '<img src="' + @images.first.asset.url + '"  alt="' + @images.first.title + '" />' 
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should output an image tag with the specified size' do
-#     content   = '<r:images:tag title="' + @images.first.title + '" size="icon" />'
-#     expected  = '<img src="' + @images.first.asset.url(:icon) + '"  alt="' + @images.first.title + '" />' 
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-#   it 'should use the given alt text specified' do
-#     content   = '<r:images:tag title="' + @images.first.title + '" alt="new alt text" />'
-#     expected  = '<img src="' + @images.first.asset.url + '" alt="new alt text" />' 
-#     pages(:home).should render(content).as(expected)
-#   end
-#   
-# end
-# 
+end