refinerycms-imajax 2.0.0.beta2

data/README.md

@@ -0,0 +1,56 @@
+# refinerycms-imajax: extension for Refinery CMS.
+---
+This is a small and simple extension that replaces the default behavior for image uploading. By default, all images are uploaded on a single form post. That can lead to timeouts on Heroku (to name one) if you upload too many files at once. What refinerycms-imajax does is simply uploading the files one by one. It will only work with modern browsers that supports FileList and FormData (Chrome is one that supports those) but fallbacks to default behavior. 
+
+## Requirements
+---
+
+You should have a Rails project with Refinery (>= 2.0.0 but only tested with 2.0.2).
+
+## Install
+---
+Add refinerycms-imajax to your `Gemfile`:
+
+	gem 'refinerycms-imajax', "~> 2.0.0.beta1"
+	
+run
+
+	$ bundle install
+	$ rails s
+	
+It should now work!
+
+
+## TODO
+---
+ - Set valid file types based on image model validation (images.js.coffee.erb)
+ - Manage locales and remove hard coded ones
+ - Add a progress bar for each file maybe?
+ - Setup TravisCI to test over multiple Ruby, Rails and Refinery versions
+ - Fix Capybara so that it can test multiple file uploads
+ 
+
+## Tests
+---
+There is only one request spec actually which is a copy of the refinerycms-images gem. Why? It is not currently possible to test multiple file uploads with Capybara: [https://github.com/jnicklas/capybara/issues/37](https://github.com/jnicklas/capybara/issues/37).
+
+### Run tests
+
+ 1. You need a dummy app first:
+	
+		$ bundle exec rake refinery:testing:dummy_app
+		
+ 2. Run tests:
+
+ 		$ bundle exec rake
+
+
+
+### How to build this extension as a gem
+
+    cd [imajax directory]
+    gem build refinerycms-imajax.gemspec
+    gem install refinerycms-imajax.gem
+
+    # Sign up for a http://rubygems.org/ account and publish the gem
+    gem push refinerycms-imajax.gem

data/app/assets/javascripts/refinery/images.js.coffee.erb

@@ -0,0 +1,118 @@
+$(document).ready ->
+  images = new Images
+  $("#new_image").submit (e) ->
+    if window.FileList && FormData
+      e.preventDefault()
+      images.upload_all()
+  $("#image_image").change (e) ->
+    images.file_list  = e.target.files
+  parent.$(".ui-icon-closethick").click (e) ->
+    e.preventDefault()
+    parent.window.location.href = parent.window.location.href
+
+
+class Images
+  # TODO:
+  #   - add a progress bar for each file maybe?
+  #   - refresh images index after closing the dialog box...
+  constructor: ->
+    @authenticity_token = $("meta[name=\"csrf-token\"]").attr("content")
+    @form_action = "/refinery/images/ajax_create"
+    @cache_dom()
+    
+  cache_dom: ->
+    @error_list = $("#error_list")
+    @success_list = $("#flash")
+    @error_explanation = $("#errorExplanation")
+    @upload_progress = $("#upload_progress")
+  
+  before_upload_all: ->
+    @files = []
+    @errors = []
+    @total_files = @file_list.length
+    @uploaded = 0
+    @error_explanation.hide()
+  
+  upload_all: ->
+    @before_upload_all()
+    for file in @file_list
+      @validate(file)
+      @files.push file
+    return @render_errors() if @errors.length > 0
+    $("#submit_button").hide()
+    $(".field").hide()
+    @progress "Uploading..."
+    @upload_next()
+  
+  after_upload_all: ->
+    $(".save-loader").hide()
+    @upload_progress.hide()
+    if @errors.length > 0
+      @progress "There was #{@errors.length} error#{(if @errors.length > 1 then "s" else "")}"
+      @render_errors()
+    @success_list.show()
+
+  validate: (file) ->
+    max_file_size = <%= Refinery::Images.max_image_size %>
+    if file.size > max_file_size
+      @errors.push "#{file.name} should be smaller than #{max_file_size} bytes in size"
+    # TODO: set valid file types based on image model validation
+    valid_file_types = ["image/jpeg", "image/png", "image/gif", "image/tiff"]
+    if valid_file_types.indexOf(file.type) == -1
+      @errors.push "#{file.name} should be either a JPG, PNG or GIF"
+
+  upload_next: ->
+    @do_upload(@files[0]) unless @files.length == 0
+    if @total_files > 0 && @files.length == 0
+      @after_upload_all()
+  
+  do_upload: (file) =>
+    form = new FormData();
+    form.append "image", file
+    form.append "authenticity_token", @authenticity_token
+    _this = @
+    $.ajax
+      type: 'POST'
+      url: @form_action
+      data: form
+      contentType: false
+      processData: false
+      success: (data) ->
+        _this.post_success(file)
+      error: (data) ->
+        _this.post_error(file, data.responseText)
+  
+  after_do_upload: (file) ->
+    @files.remove file
+    @upload_next()
+
+  post_success: (file) ->
+    @progress file.name + " uploaded"
+    @success_list.append("#{file.name} <br />")
+    @update_progress file
+    @after_do_upload file
+  
+  post_error: (file, errors) ->
+    errors = JSON.parse(errors).image
+    @update_progress file, errors
+    for e in errors
+      @errors.push "#{file.name}: #{e}"
+    @after_do_upload file
+
+  render_errors: ->
+    $(".save-loader").hide()
+    @error_list.html("")
+    for error in @errors
+      @error_list.append("<li>#{error}</li>")
+    @error_explanation.show()
+
+  update_progress: (file, error = null) -> 
+    @uploaded++
+    message = error || "Last upload complete: #{file.name}"
+    @progress "#{@uploaded}/#{@total_files} uploaded | #{message}"
+  
+  progress: (text) ->
+    @upload_progress.html(text);
+
+# adds a remove method to Array
+Array::remove = (e) -> @[t..t] = [] if (t = @indexOf(e)) > -1

data/app/decorators/controllers/refinery/images_controller_decorator.rb

@@ -0,0 +1,15 @@
+::Refinery::Admin::ImagesController.class_eval do
+
+  def ajax_create
+    params[:image] = images = {image: params[:image]}
+    params[:image].each do  |image|
+      @image = ::Refinery::Image.create(params[:image])
+    end
+    unless @image.errors.any?
+      render :json => { redirect_to: refinery.admin_images_path }
+    else
+      render :json => @image.errors, status: 406
+    end
+  end
+
+end

data/app/views/refinery/admin/images/_form.html.erb

@@ -0,0 +1,76 @@
+<%### imajax specific do %>
+  <% content_for :after_javascript_libraries, javascript_include_tag('refinery/images') %>
+<%### END imajax specific %>
+
+<%= form_for @image, :url => (@url_override or @image.persisted? ? refinery.admin_image_path(@image) : refinery.admin_images_path),
+             :html => { :multipart => true } do |f| %>
+
+  <%= render '/refinery/admin/error_messages',
+             :object => @image,
+             :include_object_name => false %>
+
+<%########################%>
+<%### imajax specific do %>
+  <% unless @image.errors.any? %>
+    <div id="upload_progress"></div>
+
+    <div class="errorExplanation" id="errorExplanation" style="display:none;">
+      <p><%= t("refinery.admin.error_messages.problems_in_following_fields")%></p>
+      <ul id="error_list">
+          
+      </ul>
+    </div>
+
+    <div id="flash_container">
+      <div id="flash" class="flash flash_notice" style="width: auto; display:none;">
+        <h3><%= t("refinery.imajax.uploaded_successfully") %>:</h3>
+
+      </div>
+    </div>
+  <% end %>
+<%### END imajax specific %>
+<%########################%>
+
+  <div class='field'>
+    <% if action_name =~ /(edit)|(update)/ %>
+      <p>
+        <%= t('.use_current_image') %>
+        <em><%= t('.or') %></em><%= t('.replace_image') %>
+      </p>
+      <p>
+        <%= f.file_field :image %>
+      </p>
+    <% else %>
+      <% # we must only hint at multiple when it's a new record otherwise update fails. %>
+      <%= f.file_field :image, :multiple => true %>
+    <% end %>
+  </div>
+
+  <div class='field'>
+    <label><%= t('.maximum_image_size', :bytes => number_to_human_size(Refinery::Images.max_image_size)) %></label>
+  </div>
+
+  <input type='hidden' name='wymeditor' value='<%= params[:wymeditor] %>'>
+
+  <%= render '/refinery/admin/form_actions', :f => f,
+             :continue_editing => false,
+             :hide_cancel => (@app_dialog or action_name == "insert" or from_dialog?),
+             :delete_title => t('delete', :scope => 'refinery.admin.images'),
+             :delete_confirmation => t('message', :scope => 'refinery.admin.delete', :title => @image.image_name) -%>
+
+  <% if @app_dialog %>
+    <input type='hidden' name='app_dialog' value='<%= @app_dialog %>' />
+    <input type='hidden' name='field' value='<%= @field %>' />
+    <input type='hidden' name='update_image' value='<%= @update_image %>' />
+    <input type='hidden' name='thumbnail' value='<%= @thumbnail %>' />
+    <input type='hidden' name='callback' value='<%= @callback %>' />
+    <input type='hidden' name='conditions' value='<%= @conditions %>' />
+  <% end %>
+<% end %>
+
+<% if action_name =~ /(edit)|(update)/ %>
+  <div id='existing_image'>
+    <label><%=t('.current_image') %></label>
+    <%= image_fu @image, '225x255>', :class => "brown_border" %>
+  </div>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,21 @@
+en:
+  refinery:
+    imajax:
+      uploading:
+        "Uploading..."
+      there_was:
+        "There was"
+      error:
+        "error"
+      should_be_smaller:
+        "should be smaller than"
+      bytes_in_size:
+        "bytes in size"
+      image_type:
+        "should be either a JPG, PNG or GIF"
+      uploaded:
+        "uploaded"
+      last_complete:
+        "Last upload complete"
+      uploaded_successfully:
+        "Uploaded successfully"

data/config/locales/fr.yml

@@ -0,0 +1,21 @@
+fr:
+  refinery:
+    imajax:
+      uploading:
+        "Transfert en cours..."
+      there_was:
+        "Il y a"
+      error:
+        "erreur"
+      should_be_smaller:
+        "devrait être plus petit que"
+      bytes_in_size:
+        "octets"
+      image_type:
+        "devrait être un fichier JPG, PNG ou GIF"
+      uploaded:
+        "transféré"
+      last_complete:
+        "Dernier transfert complété"
+      uploaded_successfully:
+        "Transféré avec succès"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Refinery::Core::Engine.routes.append do
+  namespace :admin, :path => 'refinery' do
+    post "images/ajax_create", to: "images#ajax_create"
+  end
+end

data/lib/refinery/imajax.rb

@@ -0,0 +1,21 @@
+require 'refinerycms-core'
+
+module Refinery
+  autoload :ImajaxGenerator, 'generators/refinery/imajax_generator'
+
+  module Imajax
+    require 'refinery/imajax/engine'
+
+    class << self
+      attr_writer :root
+
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+
+      def factory_paths
+        @factory_paths ||= [ root.join('spec', 'factories').to_s ]
+      end
+    end
+  end
+end

data/lib/refinery/imajax/engine.rb

@@ -0,0 +1,18 @@
+module Refinery
+  module Imajax
+    class Engine < Rails::Engine
+      include Refinery::Engine
+      isolate_namespace Refinery::Imajax
+
+      engine_name :refinery_imajax
+
+      config.to_prepare do
+        #loads the decorators
+        Dir.glob(File.join(File.dirname(__FILE__), "../../../app/decorators/**/*_decorator*.rb")) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+
+    end
+  end
+end

data/lib/refinerycms-imajax.rb

@@ -0,0 +1 @@
+require 'refinery/imajax'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: refinerycms-imajax
+version: !ruby/object:Gem::Version
+  version: 2.0.0.beta2
+  prerelease: 6
+platform: ruby
+authors:
+- Jean-Philippe Boily | @jipiboily
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinerycms-core
+  requirement: &70223676441800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70223676441800
+- !ruby/object:Gem::Dependency
+  name: refinerycms-testing
+  requirement: &70223676440380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70223676440380
+description: Replacing default bulk image uploading with an Ajaxy, one by one, upload
+  method to prevent timeouts
+email:
+- j@jipi.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/refinery/images.js.coffee.erb
+- app/decorators/controllers/refinery/images_controller_decorator.rb
+- app/views/refinery/admin/images/_form.html.erb
+- config/locales/en.yml
+- config/locales/fr.yml
+- config/routes.rb
+- lib/refinery/imajax/engine.rb
+- lib/refinery/imajax.rb
+- lib/refinerycms-imajax.rb
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Ajax image uploading for Refinery CMS
+test_files: []