radiant-images-extension 0.1.0

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

@@ -0,0 +1,12 @@
+- @page_title = 'New Image - ' + default_page_title
+
+- render_region :top do |top|
+  - top.title do
+    %h1 New Image
+  
+- form_for :image, @image, :url => admin_images_path, :html => {:multipart => true, :id => 'new_image', 'data-onsubmit_status'=>"Creating Image…"} do |fields|
+  #fields
+    = render :partial => 'fields', :locals => { :fields => fields }
+
+  #fields_bottom
+    = render :partial => 'fields_bottom'

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

@@ -0,0 +1,12 @@
+%h1
+  = t('remove_image')
+
+%p
+  = t('text.remove_image.warning')
+
+- form_for [:admin, @image.becomes(Image)], :html => {:method => :delete, 'data-onsubmit_status'=>"Removing Image…"} do
+  
+  %p.buttons
+    %input.button{:type=>"submit", :value => t('delete_image') }/
+    = t('or')    
+    = link_to t('cancel'), admin_images_path

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+---
+en:
+  images: Images
+  new_image: 'New Image'
+  remove_image: 'Remove Image'
+  delete_image: 'Delete Image'
+  text.remove_image.warning: 'Are you sure you want to permanently remove the following Images?'
+  

data/config/routes.rb

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

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/db/migrate/20100601042237_create_images.rb

@@ -0,0 +1,22 @@
+class CreateImages < ActiveRecord::Migration
+  def self.up
+    create_table :images do |t|
+      t.string  :title
+      t.string  :caption
+      
+      t.string  :asset_file_name
+      t.string  :asset_content_type
+      t.string  :asset_file_size
+      
+      t.integer :created_by
+      t.integer :updated_by
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+  
+  end
+
+  def self.down
+    drop_table :images
+  end
+end

data/db/migrate/20100602044124_add_position_to_images.rb

@@ -0,0 +1,13 @@
+class AddPositionToImages < ActiveRecord::Migration
+  def self.up
+    add_column :images, :position, :integer
+    
+    Image.all.each_with_index do |image, i|
+      image.update_attribute('position', i+1)
+    end
+  end
+
+  def self.down
+    remove_column :images, :position
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :images
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/images_extension.rb

@@ -0,0 +1,53 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+
+class ImagesExtension < Radiant::Extension
+  version "0.1"
+  description "Images stores images on s3"
+  url "http://github.com/squaretalent/radiant-images-extension"
+    
+  extension_config do |config|
+    config.gem 'paperclip', :version => '~> 2.3.1.1'
+    config.gem 'aws-s3', :version => '>= 0.6.2', :lib => 'aws/s3'
+    config.gem 'acts_as_list', :version => '>= 0.1.2'
+    
+    if RAILS_ENV == :test
+      config.gem 'rr', :version => '>= 1.0.0'
+    end
+    
+  end
+  
+  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
+    
+    
+    Page.send :include, Images::Tags::Image
+
+    UserActionObserver.instance.send :add_observer!, Image 
+    
+    tab 'Content' do
+      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['s3.host_alias']  ||= ""
+    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"
+    
+  end
+end

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

@@ -0,0 +1,37 @@
+module Images
+  module Interface
+    module Admin
+      module Images
+
+        def self.included(base)
+          base.class_eval do
+
+          attr_accessor :image
+          alias_method :images, :image
+      
+          protected
+
+            def load_default_image_regions
+              returning OpenStruct.new do |image|
+                image.edit = Radiant::AdminUI::RegionSet.new do |edit|
+                  edit.top.concat %w{ title }
+                  edit.form_top.concat %w{ asset_image }
+                  edit.form.concat %w{ title drawer upload popups }
+                  edit.form_bottom.concat %w{ buttons timestamps }
+                end
+                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.paginate.concat %w{ pagination }
+                end
+                image.searchearch = image.index
+                image.remove = image.index
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/images/tags/image.rb

@@ -0,0 +1,171 @@
+module Images
+  module Tags
+    module Image
+      include Radiant::Taggable
+    
+      class TagError < StandardError; end
+
+      desc %{
+        The namespace for referencing images. You may specify the title
+        attribute for this tag to use only images with the specified title.
+      
+        *Usage:* 
+        <pre><code><r:images [title="image_title"]>...</r:images></code></pre>
+      }
+      tag 'images' do |tag|
+        tag.locals.image = ::Image.find_by_title(tag.attr['title']) || ::Image.find(tag.attr['id']) unless tag.attr.empty?
+        tag.expand
+      end
+    
+      desc %{
+        Goes through each of the available images.
+        Use the limit and offset attributes to render a specific number of images.
+        Use the by and order attributes to control the order of images.
+      
+        *Usage:* 
+        <pre><code><r:images:each [limit=0] [offset=0] [order="asc|desc"] [by="position|title|..."]>...</r:images:each></code></pre>
+      }
+      tag 'images:each' do |tag|
+        options = tag.attr.dup
+        result = []
+        images = ::Image.find(:all, images_find_options(tag))
+        tag.locals.images = images
+        images.each do |image|
+          tag.locals.image = image
+          result << tag.expand
+        end
+        result
+      end
+    
+      desc %{
+        Renders the first image.
+      
+        *Usage:* 
+        <pre><code><r:images:first>...</r:images:first></code></pre>
+      }
+      tag 'images:first' do |tag|
+        if first = ::Image.first
+          tag.locals.image = first
+          tag.expand
+        end
+      end
+    
+      desc %{
+        Renders the contained elements only if the current image is the first.
+
+        *Usage:*
+        <pre><code><r:if_first>...</r:if_first></code></pre>
+      }
+      tag 'images:if_first' do |tag|
+        images = tag.locals.images
+        image = tag.locals.image
+        if image == images.first
+          tag.expand
+        end
+      end
+      
+      desc %{
+        Renders the contained elements only if the current image is not the first.
+
+        *Usage:*
+        <pre><code><r:unless_first>...</r:unless_first></code></pre>
+      }
+      tag 'images:unless_first' do |tag|
+        images = tag.locals.images
+        image = tag.locals.image
+        if image != images.first
+          tag.expand
+        end
+      end
+      
+      desc %{
+        Renders the contained elements only if the current contextual page has one or
+        more image. The min_count attribute specifies the minimum number of required
+        images.
+
+        *Usage:*
+        <pre><code><r:if_images [min_count="n"]>...</r:if_images></code></pre>
+      }
+      tag 'if_images' do |tag|
+        count = tag.attr['min_count'] && tag.attr['min_count'].to_i || 1
+        images = ::Image.count
+        tag.expand if images >= count
+      end
+      
+      desc %{
+        Renders the contained elements only if the current contextual page does not
+        have one or more image. The min_count attribute specifies the minimum number 
+        of required images.
+
+        *Usage:*
+        <pre><code><r:if_images [min_count="n"]>...</r:if_images></code></pre>
+      }
+      tag 'unless_images' do |tag|
+        count = tag.attr['min_count'] && tag.attr['min_count'].to_i || 1
+        images = ::Image.count
+        tag.expand unless images >= count
+      end
+
+      desc %{
+        Outputs the full URL of the image including the filename. Specify the style
+        using the style option.
+      }
+      tag 'images:url' do |tag|
+        style = tag.attr['style'] || :original
+        image, options = image_and_options(tag)
+        image.asset.url(style, false) rescue nil
+      end
+    
+      desc %{
+        Outputs the title of the current image
+      }
+      tag 'images:title' do |tag|
+        image, option = image_and_options(tag)
+        image.title rescue nil
+      end
+
+      desc %{
+        Outputs the image tag for the current image. Use the size option to 
+        specify which size version of the image is to be used. Use alt to
+        specify alt text.
+      
+        *Usage:*
+        <pre><code><r:images:tag [title="image_title"] [size="icon|original"] [alt="alt_text"]></code></pre>
+      }
+      tag 'images:tag' do |tag|
+        image, options = image_and_options(tag)
+        size = options['size'] ? options.delete('size') : 'original'
+        alt = " alt=\"#{image.title}\"" unless tag.attr['alt'] rescue nil
+        attributes = options.inject('') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
+        attributes << alt unless alt.nil?
+        url = image.asset.url size
+        %{<img src=\"#{url}\" #{attributes unless attributes.empty?} />} rescue nil
+      end
+    
+    
+      private
+        def image_and_options(tag)
+          options = tag.attr.dup
+          [find_image(tag, options), options]
+        end
+
+        def find_image(tag, options)
+          raise TagError, "'title' attribute required" unless title = options.delete('title') or id = options.delete('id') or tag.locals.image
+          tag.locals.image || ::Image.find_by_title(title) || ::Image.find(id)
+        end
+
+        def images_find_options(tag)
+          attr = tag.attr.symbolize_keys
+          by = attr[:by] || 'position'
+          order = attr[:order] || 'asc'
+
+          options = {
+            :order => "#{by} #{order}",
+            :limit => attr[:limit] || nil,
+            :offset => attr[:offset] || nil
+          }
+        end
+      
+    end
+  end
+end

data/lib/tasks/images_extension_tasks.rake

@@ -0,0 +1,77 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :images do
+      
+      desc "Runs the migration of the Images extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          ImagesExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          ImagesExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Migrates from Paperclipped to Images"
+      task :migrate_from_paperclipped => :environment do
+        Asset.all.each do |asset|
+          if asset.asset_type.name == :image
+            Image.create({
+              :title              => asset.title,
+              :asset_file_name    => asset.asset_file_name,
+              :asset_content_type => asset.asset_content_type,
+              :asset_file_size    => asset.asset_file_size
+            })
+          end
+        end
+
+        Radiant::Config['s3.bucket']  = Radiant::Config['assets.s3.bucket']
+        Radiant::Config['s3.key']     = Radiant::Config['assets.s3.key']
+        Radiant::Config['s3.secret']  = Radiant::Config['assets.s3.secret']
+        Radiant::Config['s3.path']    = Radiant::Config['assets.s3.path'].gsub(':class', 'assets')
+        
+        ENV['CLASS'] = 'Image'
+        Rake::Task['paperclip:refresh:thumbnails'].invoke
+      end
+      
+      desc "Copies public assets of the Images to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from ImagesExtension"
+        Dir[ImagesExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(ImagesExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless ImagesExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from ImagesExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join ImagesExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = ImagesExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end