radiant-images-extension 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 SquareTalent
+
+ 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:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 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/README.md

@@ -0,0 +1,41 @@
+# Radiant Images
+
+Radiant Images is an IMAGE management tool, meant only to be useful to pages and extensions that need to require images.
+
+## Primary (only) Goals
+
+### Light Weight
+
+> 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
+
+### Easily Extendable
+
+> Images is a base for things like galleries and shop, where they don't need additional assets
+
+### Strictly aws and paperclip
+
+> We don't work with images locally because we use Heroku. So we're not going to give you the option to start locally
+
+### Migrate from paperclipped easily
+
+> paperclipped is freakin' awesome, we use it and we need to be able to migrate the images over
+
+    rake radiant:extensions:images:migrate_from_paperclipped
+
+## Host Alias Settings
+
+By default the images extension uses the following url for images:
+
+    http://s3.amazonaws.com/bucketname/images/name_of_image-style.(png|jpg|gif)
+
+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:
+
+    http://domain.name.com/images/name_of_image-style.(png|jpg|gif) 
+
+## License
+
+Radiant Images is licensed under the MIT standard license. See LICENSE for further information.

data/Rakefile

@@ -0,0 +1,141 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-images-extension"
+    gem.summary = 'Images Extension for Radiant CMS'
+    gem.description = 'Image Radiant Extension management tool, meant only to be useful to pages and extensions that need to require images.'
+    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 'aws-s3',            '>= 0.6.2'
+    gem.add_dependency 'acts_as_list',      '>= 0.1.2'
+    gem.add_development_dependency 'rspec', '>= 1.3.0'
+    gem.add_development_dependency 'rr',    '>= 1.0.0'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package images as a gem."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the images extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ImagesExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the images extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/admin/images_controller.rb

@@ -0,0 +1,50 @@
+class Admin::ImagesController < Admin::ResourceController
+  
+  before_filter :index_assets, :only => [ :index ]
+  before_filter :edit_assets, :only => [ :show, :edit ]
+  around_filter :rescue_exceptions, :only => [:create, :edit, :destroy]
+  
+  # GET /admin/images
+  # GET /admin/images.js
+  # GET /admin/images.xml
+  # GET /admin/images.json                                        AJAX and HTML
+  #----------------------------------------------------------------------------
+  
+  def index
+    @images = Image.paginate :page => params[:page], :per_page => 20
+  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
+
+  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
+  
+  def rescue_exceptions
+    begin
+      yield
+    rescue AWS::S3::ResponseError => e
+      flash[:error] = e.to_s
+      redirect_to admin_images_url
+    end
+  end
+  
+end

data/app/models/image.rb

@@ -0,0 +1,91 @@
+class Image < ActiveRecord::Base
+
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  
+  before_save :assign_title
+  validates_uniqueness_of :asset_file_name, :message => 'This file already exists', :allow_nil => true
+  validates_uniqueness_of :title
+  
+  default_scope :order => 'position ASC'
+  acts_as_list
+
+  has_attached_file :asset,
+                    :styles           => lambda { Image.config_styles },
+                    :whiny_thumbnails => false,
+                    :default_url      => '/images/extensions/images/missing_:style.png',
+                    
+                    :storage          => :s3,
+                    :s3_credentials   => {
+                      :access_key_id      => Radiant::Config['s3.key'],
+                      :secret_access_key  => Radiant::Config['s3.secret']
+                    },
+                    :bucket           => Radiant::Config['s3.bucket'],
+                    :path             => Radiant::Config['s3.path']
+                                        
+  validates_attachment_presence :asset
+  validates_attachment_content_type :asset, :content_type => ['image/jpeg', 'image/png', 'image/gif']
+
+  def assign_title
+    self.title = self.asset_file_name if title.blank?
+  end
+
+  
+  # We need to ovveried 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'].empty? ? 's3.amazonaws.com' : Radiant::Config['s3.host_alias']
+        bucket = Radiant::Config['s3.host_alias'].empty? ? '/' + 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
+
+  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
+    end
+  end
+    
+end

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

@@ -0,0 +1,13 @@
+%ul{ :style =>'float: left'}
+  - 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=> 'search' }, :method => 'get', :with => "'search=' + escape(value)"
+- render_region :paginate do |paginate|
+  - paginate.pagination do
+    = will_paginate(@images)

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

@@ -0,0 +1,22 @@
+- render_region :form do |form|
+  - form.title do
+    %p.title
+      = fields.label :title
+      = fields.text_field :title, :class => 'textbox'
+  - form.drawer do
+    .drawer
+      .drawer_contents#attributes
+        %table.fieldset
+          %tr
+            %th.label
+              = fields.label :caption
+            %td.field
+              = fields.text_field :caption, :class => 'textbox'
+      .drawer_handle
+        = link_to 'More', '#attributes', { :class => 'more toggle', :rel => 'toggle[attributes]' }
+  - form.upload do
+    %p.update
+      = fields.label :asset
+      = fields.file_field :asset
+  - form.popups do
+    - nil

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

@@ -0,0 +1,10 @@
+- render_region :form_bottom do |form_bottom|
+  - form_bottom.buttons do
+    %p.buttons
+      = save_model_button(@image)
+      = save_model_and_continue_editing_button(@image)
+      = t('or')
+      = link_to t('cancel'), admin_images_url
+
+  - form_bottom.timestamps do
+    = updated_stamp @image

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

@@ -0,0 +1,7 @@
+- render_region :form_top do |form_top|
+  - form_top.asset_image do
+    - unless @image.new_record?
+      = link_to image_tag(@image.asset.url(:preview)), @image.asset.url(:original)
+      - @image.asset.styles.each do |style, attrs|
+        - unless style.to_sym == :preview
+          = link_to style.to_s, @image.asset.url(style.to_sym)

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

@@ -0,0 +1,12 @@
+%li.image{:id => "image#{image.id}", :'data-id' => image.id}
+  .attributes   
+    - render_region :attributes do |attributes|
+      - attributes.thumbnail do
+        .image.attribute
+          %a{ :href => edit_admin_image_path(image), :title => image.title }
+            %img.icon{ :src => image.asset.url(:icon) }
+      - attributes.title do
+        %span.title.attribute= link_to image.title, edit_admin_image_path(image)
+      - attributes.modify do
+        .modify.attribute
+          %span.remove= link_to t('remove'), remove_admin_image_path(image)

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

@@ -0,0 +1,14 @@
+- @page_title = @image.title.titleize + ' - ' + default_page_title
+
+- render_region :top do |top|
+  - top.title do
+    %h1 Edit Image
+
+- form_for :image, @image, :url => admin_image_path(@image), :html => {:method => :put, :multipart => true, :id => 'edit_image', 'data-onsubmit_status'=>"Saving Changes…"} do |fields|
+  #asset
+    = render :partial => 'fields_top', :locals => { :fields => fields }
+  #fields
+    = render :partial => 'fields', :locals => { :fields => fields }
+
+  #fields_bottom
+    = render :partial => 'fields_bottom'

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

@@ -0,0 +1,16 @@
+- @page_title = t('images') + ' - ' + default_page_title
+
+.outset
+  
+  #images_map
+    
+    #images_headings
+      %h2.images Image
+
+      %h2.modify Modify
+  
+    %ul#images
+      = render @images
+
+#actions
+  = render 'bottom'