rails-uploader 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Aimbulance http://www.aimbulance.com/
+
+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.rdoc

@@ -0,0 +1,75 @@
+= HTML5 File uploader for rails
+
+This gem use https://github.com/blueimp/jQuery-File-Upload for upload files.
+
+== Install
+
+In Gemfile:
+
+  gem "rails-uploader"
+
+In routes:  
+
+  mount Uploader::Engine => '/uploader'
+
+== Usage
+
+Architecture to store uploaded files:
+
+  class Asset < ActiveRecord::Base
+    include Uploader::Asset
+    
+    def upload(params, request = nil)
+      self.user = request.env['warden'].user
+      super
+    end
+    
+    def uploader_destroy(params, request = nil)
+      ability = Ability.new(request.env['warden'].user)
+      if ability.can? :delete, self
+        super
+      else
+        errors.add(:id, :access_denied)
+      end
+    end
+  end
+  
+  class Picture < Asset
+    mount_uploader :data, PictureUploader
+    
+    validates_integrity_of :data
+    validates_filesize_of :data, :maximum => 2.megabytes.to_i
+  end
+
+For example user has one picture:
+
+  class User < ActiveRecord::Base
+    has_one :picture, :as => :assetable, :dependent => :destroy
+    
+    fileuploads :picture
+  end
+
+Find asset by foreign key or guid:
+
+  @user.fileupload_asset(:picture)
+
+=== Include assets
+
+Javascripts:
+
+  //= require uploader/application
+
+Stylesheets:
+
+  *= require uploader/application  
+  
+=== Views
+
+  
+
+=== Formtastic
+
+  <%= f.input :picture, :as => :uploader %>
+  
+
+Copyright (c) 2012 Aimbulance, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the rails-uploader plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the rails-uploader plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Uploader'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/assets/javascripts/uploader/application.js

@@ -0,0 +1,8 @@
+//= require uploader/locales/en
+//= require uploader/tmpl.min
+//= require uploader/load-image.min
+//= require uploader/jquery.ui.widget
+//= require uploader/jquery.iframe-transport
+//= require uploader/jquery.fileupload
+//= require uploader/jquery.fileupload-ui
+

data/app/assets/stylesheets/uploader/application.css

@@ -0,0 +1,6 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require uploader/jquery.fileupload-ui
+*/

data/app/controllers/uploader/attachments_controller.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module Uploader
+  class AttachmentsController < ActionController::Metal
+    include AbstractController::Callbacks
+  
+    before_filter :find_klass
+    
+    def create
+      @asset = @klass.new(params[:asset])
+      @asset.uploader_create(params, request)
+      render_resourse(@asset, 201)
+    end
+    
+    def destroy
+      @asset = @klass.find(params[:id])
+      @asset.uploader_destroy(params, request)
+      render_resourse(@asset, 200)
+    end
+    
+    protected
+    
+      def find_klass
+        @klass = params[:klass].blank? ? nil : params[:klass].safe_constantize
+        raise ActiveRecord::RecordNotFound.new("Class not found #{params[:klass]}") if @klass.nil?
+      end
+      
+      def render_resourse(record, status = 200)
+        if record.errors.empty?
+          render_json(record.to_json, status)
+        else
+          render_json(record.errors.to_json, 422)
+        end
+      end
+      
+      def render_json(body, status = 200)
+        self.status = status
+        self.content_type = "application/json"
+        self.response_body = body
+      end
+  end
+end

data/app/views/uploader/default/_container.html.erb

@@ -0,0 +1,29 @@
+<%= content_tag(:div, :id => field.id, :class => "dnd-area") do %>
+  <%= hidden_field(object_name, :fileupload_guid) if object.new_record? %>
+  
+	<div class="dnd-hints">
+	  <%= fields_for object do |f| %>
+	    <%= f.fields_for method_name, field.value do |m| %>
+        <%= m.file_field(:data, input_html) %>
+	    <% end -%>
+	  <% end -%>
+	  
+		<input type="button" class="button gray" value="Выберите файл на компьютере">
+		или<span>Перетащите фотографию сюда</span>
+	</div>
+	
+	<script type="text/javascript">
+    $(function() {
+      $('#<%= field.id %> input[type="file"]').fileupload({
+        dataType: 'json',
+        dropZone: $("#<%= field.id %>"),
+        autoUpload: true,
+        paramName: "asset[data]",
+        formData: function(form){ return []; }
+      });
+    });
+  </script>
+<% end -%>
+
+<%= render :partial => "uploader/#{field.theme}/upload" %>
+<%= render :partial => "uploader/#{field.theme}/download" %>

data/app/views/uploader/default/_download.html.erb

@@ -0,0 +1,29 @@
+<!-- The template to display files available for download -->
+<script id="template-download" type="text/x-tmpl">
+{% for (var i=0, file; file=o.files[i]; i++) { %}
+    <tr class="template-download fade">
+        {% if (file.error) { %}
+            <td></td>
+            <td class="name"><span>{%=file.name%}</span></td>
+            <td class="size"><span>{%=o.formatFileSize(file.size)%}</span></td>
+            <td class="error" colspan="2"><span class="label label-important">{%=locale.fileupload.error%}</span> {%=locale.fileupload.errors[file.error] || file.error%}</td>
+        {% } else { %}
+            <td class="preview">{% if (file.thumbnail_url) { %}
+                <a href="{%=file.url%}" title="{%=file.name%}" rel="gallery" download="{%=file.name%}"><img src="{%=file.thumbnail_url%}"></a>
+            {% } %}</td>
+            <td class="name">
+                <a href="{%=file.url%}" title="{%=file.name%}" rel="{%=file.thumbnail_url&&'gallery'%}" download="{%=file.name%}">{%=file.name%}</a>
+            </td>
+            <td class="size"><span>{%=o.formatFileSize(file.size)%}</span></td>
+            <td colspan="2"></td>
+        {% } %}
+        <td class="delete">
+            <button class="btn btn-danger" data-type="{%=file.delete_type%}" data-url="{%=file.delete_url%}">
+                <i class="icon-trash icon-white"></i>
+                <span>{%=locale.fileupload.destroy%}</span>
+            </button>
+            <input type="checkbox" name="delete" value="1">
+        </td>
+    </tr>
+{% } %}
+</script>

data/app/views/uploader/default/_upload.html.erb

@@ -0,0 +1,31 @@
+<!-- The template to display files available for upload -->
+<script id="template-upload" type="text/x-tmpl">
+{% for (var i=0, file; file=o.files[i]; i++) { %}
+    <tr class="template-upload fade">
+        <td class="preview"><span class="fade"></span></td>
+        <td class="name"><span>{%=file.name%}</span></td>
+        <td class="size"><span>{%=o.formatFileSize(file.size)%}</span></td>
+        {% if (file.error) { %}
+            <td class="error" colspan="2"><span class="label label-important">{%=locale.fileupload.error%}</span> {%=locale.fileupload.errors[file.error] || file.error%}</td>
+        {% } else if (o.files.valid && !i) { %}
+            <td>
+                <div class="progress progress-success progress-striped active"><div class="bar" style="width:0%;"></div></div>
+            </td>
+            <td class="start">{% if (!o.options.autoUpload) { %}
+                <button class="btn btn-primary">
+                    <i class="icon-upload icon-white"></i>
+                    <span>{%=locale.fileupload.start%}</span>
+                </button>
+            {% } %}</td>
+        {% } else { %}
+            <td colspan="2"></td>
+        {% } %}
+        <td class="cancel">{% if (!i) { %}
+            <button class="btn btn-warning">
+                <i class="icon-ban-circle icon-white"></i>
+                <span>{%=locale.fileupload.cancel%}</span>
+            </button>
+        {% } %}</td>
+    </tr>
+{% } %}
+</script>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Uploader::Engine.routes.draw do
+  resources :attachments, :only => [:create, :destroy]
+end

data/lib/rails-uploader.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'uploader'

data/lib/uploader/asset.rb

@@ -0,0 +1,42 @@
+module Uploader
+  module Asset
+    # Save asset
+    # Usage:
+    #
+    #   class Asset < ActiveRecord::Base
+    #     include Uploader::Asset
+    #     
+    #     def uploader_create(params, request = nil)
+    #       self.user = request.env['warden'].user
+    #       super
+    #     end
+    #   end
+    #
+    def uploader_create(params, request = nil)
+      self.guid = params[:guid]
+      self.assetable_type = params[:assetable_type]
+      self.assetable_id = params[:assetable_id]
+      save
+    end
+    
+    # Destroy asset
+    # Usage (cancan example):
+    #
+    #   class Asset < ActiveRecord::Base
+    #     include Uploader::Asset
+    #     
+    #     def uploader_destroy(params, request = nil)
+    #       ability = Ability.new(request.env['warden'].user)
+    #       if ability.can? :delete, self
+    #         super
+    #       else
+    #         errors.add(:id, :access_denied)
+    #       end
+    #     end
+    #   end
+    #
+    def uploader_destroy(params, request)
+      destroy
+    end
+  end
+end

data/lib/uploader/engine.rb

@@ -0,0 +1,24 @@
+require 'rails'
+require 'uploader'
+
+module Uploader
+  class Engine < ::Rails::Engine
+    isolate_namespace Uploader
+    
+    initializer "uploader.assets_precompile" do |app|
+      app.config.assets.precompile += Uploader.assets
+    end
+    
+    initializer "uploader.helpers" do    
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send(:include, Uploader::Helpers::FormTagHelper)
+        ActionView::Helpers::FormBuilder.send(:include, Uploader::Helpers::FormBuilder)
+      end
+    end
+   
+    initializer "uploader.hooks" do
+      require "uploader/hooks/active_record" if Object.const_defined?("ActiveRecord")
+      require "uploader/hooks/formtastic"    if Object.const_defined?("Formtastic")
+    end
+  end
+end

data/lib/uploader/fileuploads.rb

@@ -0,0 +1,100 @@
+module Uploader
+  module Fileuploads
+    def self.included(base)
+      base.send :extend, SingletonMethods
+    end
+    
+    module SingletonMethods
+      # Join ActiveRecord object with uploaded file
+      # Usage:
+      # 
+      #   class Article < ActiveRecord::Base
+      #     has_one :picture, :as => :assetable, :dependent => :destroy
+      #
+      #     fileuploads :picture
+      #   end
+      #
+      #
+      def fileuploads(*args)
+        options = args.extract_options!
+        
+        class_attribute :fileuploads_options, :instance_writer => false
+        self.fileuploads_options = options
+        
+        class_attribute :fileuploads_columns, :instance_writer => false
+        self.fileuploads_columns = args.map(&:to_sym)
+        
+        unless self.is_a?(ClassMethods)
+          include InstanceMethods
+          extend ClassMethods
+          
+          attr_accessible :fileupload_guid
+          after_save :fileuploads_update, :if => :fileupload_changed?
+          
+          fileuploads_columns.each { |asset| accepts_nested_attributes_for asset, :allow_destroy => true }
+        end
+      end
+    end
+    
+    module ClassMethods
+      # Update reflection klass by guid
+      def fileupload_update(record_id, guid, method)
+        klass = fileupload_klass(method)
+        klass.where(:assetable_type => name, :guid => guid).update_all(["assetable_id = ?, guid = ?", record_id, nil])
+      end
+      
+      # Find asset by guid
+      def fileupload_find(method, guid)
+        klass = fileupload_klass(method)
+        klass.where(:guid => guid).first
+      end
+      
+      # Find class by reflection
+      def fileupload_klass(method)
+        reflections[method.to_sym].klass
+      end
+    end
+    
+    module InstanceMethods
+      # Generate unique key
+      def fileupload_guid
+        @fileupload_guid ||= Uploader.guid
+      end
+      
+      def fileupload_guid=(value)
+        @fileupload_changed = true unless value.blank?
+        @fileupload_guid = value.blank? ? nil : value
+      end
+      
+      def fileupload_changed?
+        @fileupload_changed === true
+      end
+      
+      def fileupload_multiple?(method)
+        association = self.class.reflect_on_association(method)
+        association && association.collection? 
+      end
+      
+      # Find or build new asset object
+      def fileupload_asset(method)
+        if fileuploads_columns.include?(method.to_sym)
+          asset = new_record? ? self.class.fileupload_find(method, fileupload_guid) : send(method)
+          asset ||= send("build_#{method}") if respond_to?("build_#{method}")
+          asset
+        end
+      end
+      
+      def fileuploads_columns
+        self.class.fileuploads_columns
+      end
+      
+      protected
+      
+        def fileuploads_update
+          fileuploads_columns.each do |method|
+            self.class.fileupload_update(id, fileupload_guid, method)
+          end
+        end
+    end
+  end
+end

data/lib/uploader/helpers/field_tag.rb

@@ -0,0 +1,68 @@
+module Uploader
+  module Helpers
+    class FieldTag
+      attr_reader :template, :object, :theme
+
+      delegate :uploader, :to => :template      
+      
+      # Wrapper for render uploader field
+      # Usage:
+      #
+      #   uploader = FieldTag.new(object_name, method_name, template, options)
+      #   uploader.to_s
+      #
+      def initialize(object_name, method_name, template, options = {}) #:nodoc:
+        options = { :object_name => object_name, :method_name => method_name }.merge(options)
+        
+        @template, @options = template, options.dup
+        @theme = (@options.delete(:theme) || "default")
+        @value = @options.delete(:value) if @options.key?(:value)
+        @object = @template.instance_variable_get("@#{object_name}")
+        
+        @options[:object] ||= @object
+        @options[:input_html] = input_html.merge(@options[:input_html] || {})
+      end
+
+      def to_s(locals = {}) #:nodoc:
+        locals = { :field => self }.merge(locals)
+        @template.render :partial => "uploader/#{@theme}/container", :locals => @options.merge(locals)
+      end
+      
+      def id
+        @id ||= @template.dom_id(@object, [method_name, 'uploader'].join('_'))
+      end
+      
+      def method_name
+        @options[:method_name]
+      end
+      
+      def object_name
+        @options[:object_name]
+      end
+      
+      def multiple?
+        @object.fileupload_multiple?(method_name)
+      end
+      
+      def value
+        @value ||= @object.fileupload_asset(method_name)
+      end
+      
+      def attachments_path(options = {})
+        options = {
+          :guid => @object.fileupload_guid, 
+          :assetable_type => @object.class.name,
+          :klass => @object.class.fileupload_klass(method_name)
+        }.merge(options)
+        
+        options[:assetable_id] = @object.id if @object.persisted?
+        
+        uploader.attachments_path(options)
+      end
+      
+      def input_html
+        {:"data-url" => attachments_path, :multiple => multiple?}
+      end
+    end
+  end
+end

data/lib/uploader/helpers/form_builder.rb

@@ -0,0 +1,16 @@
+module Uploader
+  module Helpers
+    module FormBuilder
+      # Render uploader field
+      # Usage:
+      #   
+      #   <%= form_for @article do |f| %>
+      #     <%= f.uploader_field :picture %>
+      #   <%= end %>
+      #
+      def uploader_field(method, options = {})
+        @template.send("uploader_field_tag", @object_name, method, objectify_options(options))
+      end
+    end
+  end
+end

data/lib/uploader/helpers/form_tag_helper.rb

@@ -0,0 +1,16 @@
+module Uploader
+  module Helpers
+    module FormTagHelper
+      include ActionView::Helpers::JavaScriptHelper
+      
+      # A helper that renders file upload container
+      #
+      #   <%= uploader_field_tag :article, :photo %>
+      #
+      def uploader_field_tag(object_name, method_name, options = {})
+        uploader = FieldTag.new(object_name, method_name, self, options)
+        uploader.to_s
+      end
+    end
+  end
+end

data/lib/uploader/hooks/active_record.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send :include, Uploader::Fileuploads
+end

data/lib/uploader/hooks/formtastic.rb

@@ -0,0 +1,12 @@
+require 'formtastic'
+
+class UploaderInput
+  include Formtastic::Inputs::Base
+  
+  def to_html
+    input_wrapping do
+      label_html <<
+      builder.uploader_field(method, input_html_options)
+    end
+  end
+end

data/lib/uploader/version.rb

@@ -0,0 +1,3 @@
+module Uploader
+  VERSION = "0.0.1".freeze
+end

data/lib/uploader.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'securerandom'
+
+module Uploader
+  autoload :Fileuploads, 'uploader/fileuploads'
+  autoload :Asset, 'uploader/asset'
+  
+  module Helpers
+    autoload :FormTagHelper, 'uploader/helpers/form_tag_helper'
+    autoload :FormBuilder, 'uploader/helpers/form_builder'
+    autoload :FieldTag, 'uploader/helpers/field_tag'
+  end
+  
+  def self.guid
+    SecureRandom.base64(15).tr('+/=', 'xyz').slice(0, 10)
+  end
+  
+  def self.root_path
+    @root_path ||= Pathname.new( File.dirname(File.expand_path('../', __FILE__)) )
+  end
+  
+  def self.assets
+    Dir[root_path.join('vendor/assets/javascripts/uploader/**', '*.{js,css}')].inject([]) do |list, path|
+      list << Pathname.new(path).relative_path_from(root_path.join('vendor/assets/javascripts')).to_s
+      list
+    end
+  end
+end
+
+require 'uploader/engine'