radiant-clipped-extension 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+== MIT License
+
+Copyright (c) 2011 Keith Bingman, Benny Degezelle, William Ross, and John W. Long
+Copyright (c) 2008-2010, Keith Bingman
+ 
+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,230 @@
+Radiant Clipped Extension
+------------------------
+
+This is a new core extension intended for use with Radiant version 1.0 or higher. 
+It is based on Keith Bingman's excellent Paperclipped extension, for which it is a drop-in replacement. 
+It should also be an easy upgrade from `page_attachments`, but I haven't tested that yet.
+
+## Changes
+
+* video files frame-grabbed (automatically disabled if FFmpeg is not found)
+* pdfs thumbnailed
+* new asset-retrieval and page-attachment interface (by John Long)
+* new inline upload mechanism that allows several concurrent uploads and attachment to new pages
+* easily extended with new asset types and processors
+* helpful insert buttons that do the right thing.
+
+## Still to do
+
+* progress bars on uploading assets
+* warning if you try and save a page while assets are still uploading
+* html5 video and audio tags in radius (with sensible flash fallbacks)
+
+Video transcoding support will be in an optional extension with `delayed_job` support.
+
+# Known bugs
+
+At the moment I think uploads probably don't work in IE7. See github for more issues.
+
+## Requirements
+
+The `paperclip`, `uuidtools` and `acts_as_list` gems are required. For S3 storage you need the `aws-s3` gem.
+
+Paperclip's post-processors require ImageMagick. PDF-thumbnailing also requires ghostscript, which is usually 
+installed with ImageMagick anyway, and if you want to generate thumbnails from video clips then you also need FFmpeg. 
+
+On unixy systems there should be packages available to satisfy all these requirements. You don't need to 
+install development libraries, but you will get a lot of little file-type utilities if you don't have them already.
+
+On OS X, with macports:
+
+    port install ghostscript imagemagick ffmpeg
+
+On debian-like systems:
+
+    apt-get install ghostscript imagemagick ffmpeg
+
+And I expect it's very similar with yum.
+
+On Windows, you can get binary installers of all the required pieces and apparently these days they're simple 
+to install and connect:
+
+* ImageMagick: http://www.imagemagick.org/script/binary-releases.php
+* Ghostscript: http://sourceforge.net/projects/ghostscript/
+* FFMpeg: http://ffmpeg.zeranoe.com/builds/
+
+If your paths are strange, or you're running under passenger, you may need to set `Paperclip.options[:command_path]` 
+to the location of these binaries for each of your environments. On OS X that's usually `/opt/local/bin`.
+
+## Installation
+
+This extension is not currently compatible with versions of radiant earlier than 1.0rc. The incompatibilities 
+are fairly minor and it may be backported, but for now if you're running a version of radiant which with the assets 
+extension will work, you will find it is already installed. If you don't have it in your radiant distribution, it 
+probably wouldn't work anyway.
+
+## Upgrading from paperclipped
+
+No special steps are required. Paperclipped migrations are respected. The /images/assets directory is no longer needed. 
+and can be deleted. See below for some radius tag changes that won't affect you yet but should be borne in mind.
+
+## Upgrading from page_attachments
+
+This is supposed to be straightforward too. In theory once the clipped extension has been migrated all you need is:
+
+    rake radiant:extensions:clipped:migrate_from_page_attachments
+
+But I haven't tested that theory recently.
+
+## Radius tag changes
+
+The full radius tag set of paperclipped is still supported, so your pages should just work. If they worked before. 
+
+The preferred syntax is slightly different, though. Where paperlipped used the `r:assets` namespace for everything, the 
+assets extension has adopted a readable system of singular and plural tags that will be familiar from other bits of radiant:
+
+    <r:assets:each>
+      <a href="<r:asset:url size="download" />">
+        <r:asset:image size="thumbnail" />
+      </a>
+      <span class="caption"><r:asset:caption /></span>
+    </r:assets:each>
+
+Anything to do with the collection of assets is plural. Anything to do with a particular asset is singular. The old plural 
+forms still work but they are deprecated and (as the log messages will keep telling you) likely to removed in version 2.
+
+## Configuration
+
+The clipped extension is configured in the usual way, but only its minor settings are exposed in the admin interface. The
+more architectural settings shouldn't be changed at runtime and some of them will require a lot of sorting out if they're 
+changed at all, so those are only accessible through the console or by editing the database. Eventually they will be made 
+part of the initial radiant installation process.
+
+### Structural settings
+
+* `clipped.url` sets the url scheme for attached files. Paperclip interpolations are applied. You probably don't want to change this.
+* `clipped.path` sets the path scheme for attached files. Paperclip interpolations are applied. You might conceivably want to change this.
+* `clipped.additional_thumbnails` is a string of comma-separated style definitions that is passed to paperclip for any asset type that has a post-processor (that is, currently, images, pdfs and video clips). The definitions are in the format name=geometry and when assembled the string will look something like `preview=640x640>,square=#260x260`. Thumbnail and icon styles are already defined and don't need to be configured this way.
+* `clipped.storage` can be 'filesystem' (the default) or 's3' for amazon's cloud service.
+* `clipped.skip_filetype_validation` is true by default and allows uploads of any mime type.
+
+If the storage option is set to 's3' then these settings are also required:
+
+* `clipped.s3.bucket`
+* `clipped.s3.key`
+* `clipped.s3.secret`
+
+And optionally:
+
+* `clipped.s3.host_alias`
+
+### Configurable settings
+
+If you want to disable a whole category of post-processing, set one of these options to false:
+
+* `clipped.create_image_thumbnails?`
+* `clipped.create_video_thumbnails?`
+* `clipped.create_pdf_thumbnails?`
+
+If we can't find ffmpeg on initialization, video thumbnailing will be disabled automatically by setting `clipped.create_video_thumbnails?` to false.
+
+To set a threshold for the size of uploads permitted:
+
+* `assets.max_asset_size` which should be an integer number of MB
+
+And you can set some defaults:
+
+* `assets.insertion_size` is the name of the style that's used when you click on 'insert' to add a radius asset tag to your text. You can edit it after insertion, of course.
+* `assets.display_size` is the name of the style that's shows when you edit a single asset in the admin interface.
+
+## Usage
+
+For most purposes you will probably work with assets while you're working on pages. Click on one of the 'assets' links and a panel will pop up allowing you to find, insert and attach existing assets or upload new ones. 
+
+For tidying up, replacing files and other admin, click on the 'assets' tab to get a larger version of the same list. Here again you can search for assets and filter the results by type, but the options are 'edit' and 'remove' and on editing you can change name, file and caption while keeping page associations intact.
+
+## Radius Tags
+
+The asset manager has its own family of radius tags. The basic tag is <code><r:asset /></code>, 
+which can be used either alone or as a double tag. This tag requires a `name` or `id` attribute, 
+which references the asset. The <code><r:asset /></code> tag can be combined with other tags for a
+variety of uses:
+
+    <r:asset:image name="image.png" />  #=>  <img src="/path/to/image.png" />
+    <r:asset:link name="image.png" />   #=>  <a href="/path/to/image.png">image.png</a>
+
+You could also use: 
+
+    <r:asset:link name="bar.pdf">Download PDF</r:asset:link>
+
+Asset links are also available, such as content_type, file_size, and url. 
+
+Another important tag is the <code><r:assets:each>...</r:assets:each></code>.
+(Note the plural namespace tag "assets".) If a page has attached assets, the
+assets:each tag will cycle through each asset. You can then use an image,
+link or url tag to display and connect your assets. Usage:
+
+    <r:assets:each [limit=0] [offset=0] [order="asc|desc"] [by="position|title|..."]>
+      ...
+    </r:assets:each>
+
+This tag uses the following parameters:
+
+* `limit` and `offset` let you specify a range of assets
+* `order` and `by` lets you control sorting
+
+The conditional tags <code><r:if_assets [min_count="0"]></code> and
+<code><r:unless_assets [min_count="0"]></code> allow you to optionally render
+content based on the existence of tags. They accept the same options as
+`<r:assets:each>`.
+
+Thumbnails are automatically generated for images when the images are
+uploaded. By default, two sizes are made for use within the extension itself.
+These are "icon" 42px by 42px and "thumbnail" which is 100px square.
+
+You can access sizes of image assets for various versions with tags like
+`<r:asset:width [size="original"]/>` and <code><r:asset:height
+[size="original"]/></code>.
+
+Also, for vertical centering of images, you have the handy
+`<r:asset:top_padding container="<container height>" [size="icon"]/>` tag.
+Working example:
+
+    <ul>
+      <r:assets:each>
+        <li style="height:140px">
+          <img style="padding-top:<r:top_padding size='category' container='140' />px" 
+               src="<r:url />" alt="<r:title />" />
+        </li>
+      </r:assets:each>
+    </ul>
+
+## Contributions
+
+This extension is a work in progress. If you would like to
+contribute, please fork the project and submit a pull request:
+
+<https://github.com/radiant/radiant-clipped-extension>
+
+Pull requests with working tests are preferred and have a greater chance of
+being merged.
+
+## Support
+
+If you have questions about this extension please post a message to the
+Radiant-Dev mailing list:
+
+<http://groups.google.com/group/radiantcms-dev>
+
+If you would like to file a bug report or feature request, please create a
+GitHub issue here:
+
+<https://github.com/radiant/radiant-clipped-extension/issues>
+
+## Authors
+
+* Keith Bingman
+* John Long
+* William Ross
+
+Copyright 2011 the radiant team. Released under the same terms as radiant.

data/Rakefile

@@ -0,0 +1,109 @@
+# 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, :features]
+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 clipped extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ClippedExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/controllers/admin/assets_controller.rb

@@ -0,0 +1,60 @@
+class Admin::AssetsController < Admin::ResourceController
+  paginate_models(:per_page => 50)
+  
+  def index
+    assets = Asset.scoped({:order => "created_at DESC"})
+    
+    @term = params[:search] || ''
+    assets = assets.matching(@term) if @term && !@term.blank?
+    
+    @types = params[:filter] || []
+    if @types.include?('all')
+      params[:filter] = nil
+    elsif @types.any?
+      assets = assets.of_types(@types)
+    end
+    
+    @assets = paginated? ? assets.paginate(pagination_parameters) : assets.all
+    respond_to do |format|
+      format.html { render }
+      format.js { 
+        @page = Page.find_by_id(params[:page_id])
+        render :partial => 'asset_table', :locals => {:with_pagination => !!@page}
+      }
+    end
+  end
+  
+  def create
+    @asset.update_attributes!(params[:asset])
+    if params[:for_attachment]
+      @page = Page.find_by_id(params[:page_id]) || Page.new
+      @page_attachment = @asset.page_attachments.build(:page => @page)
+      render :partial => 'admin/page_attachments/attachment', :object => @page_attachment
+    else 
+      response_for :create
+    end
+  end
+  
+  def refresh
+    if params[:id]
+      @asset = Asset.find(params[:id])
+      @asset.asset.reprocess!
+      flash[:notice] = t('clipped_extension.thumbnails_refreshed')
+      redirect_to edit_admin_asset_path(@asset)
+    else
+      render
+    end
+  end
+  
+  only_allow_access_to :regenerate,
+    :when => [:admin],
+    :denied_url => { :controller => 'admin/assets', :action => 'index' },
+    :denied_message => 'You must have admin privileges to refresh the whole asset set.'
+
+  def regenerate
+    Asset.all.each { |asset| asset.asset.reprocess! }
+    flash[:notice] = t('clipped_extension.all_thumbnails_refreshed')
+    redirect_to admin_assets_path
+  end
+  
+end

data/app/controllers/admin/page_attachments_controller.rb

@@ -0,0 +1,18 @@
+class Admin::PageAttachmentsController < Admin::ResourceController
+  helper 'admin/assets'
+    
+  def new
+    render :partial => 'attachment', :object => model
+  end
+  
+  def load_model
+    begin
+      @asset = Asset.find(params[:asset_id])
+      @page = params[:page_id].blank? ? Page.new : Page.find_by_id(params[:page_id])
+    rescue ActiveRecord::RecordNotFound
+      render :nothing => true, :layout => false
+    end
+    self.model = PageAttachment.new(:asset => @asset, :page => @page)
+  end
+  
+end

data/app/helpers/admin/assets_helper.rb

@@ -0,0 +1,16 @@
+module Admin::AssetsHelper
+  
+  def automatic_size_descriptions
+    Asset.thumbnail_sizes.collect{|k,v| "#{k} (#{(v.to_s).match(/\d+x\d+/)})"}.join(', ')
+  end
+  
+  def asset_insertion_link(asset)
+    radius_tag = asset.asset_type.default_radius_tag || 'link';
+    link_to t('clipped_extension.insert'), '#', :class => 'insert_asset', :rel => "#{radius_tag}_#{Radiant.config['assets.insertion_size']}_#{asset.id}"
+  end
+  
+  def asset_attachment_link(asset)
+    link_to t("clipped_extension.attach"), new_admin_page_attachment_path(:asset_id => asset.id), :class => 'attach_asset', :rel => "attach_#{asset.id}"
+  end
+  
+end