refile 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32c960945a6e5eb20121a3eb7d4838574dd3b946
-  data.tar.gz: 4ae9bd94ff29d3db2f74655d6db4f9e4379f25fd
+  metadata.gz: 66457e73d63efd2eafa3b150152d7615fc4c940a
+  data.tar.gz: e7e6744055b448670fd328a29fa97d122a332b4a
 SHA512:
-  metadata.gz: ba04479216634a21b37f455e2d88184e9f3e0095110aa49b3f2ec7c72f6aa0b95c96077e94e4eda7aaf5c31d2fc9630f3a2dc5ad134d1ae099dceb044404f31b
-  data.tar.gz: 1c58cc57c1eb4a7b5d42b229bb375071709d105ac5b405f999e6bcfb97500cb538e412f845d84f00df253177c7fb7de9f2c9d355bb0bc8bf4442185ea45d4e1e
+  metadata.gz: bf353ab538163c2716a2114f887855e87b083493186911dc61ca064a971d96b1b72a7282ec3531530da66187964f15243243d8b027655c5a192336e61e0a50c6
+  data.tar.gz: ebd0c248bdccaa5ad714764df5fc2dcac65922a0148019a9a897fc676bf1cabde9cb74794a7a5620c23d238e2f56f697d8b3ee4ebc163395deaf01ba3ab80fea

data/.rspec

@@ -1 +1,2 @@
 -r refile/spec_helper
+-r pry

data/History.md

@@ -1,3 +1,12 @@
+# 0.2.5
+
+Release date: 2014-12-12
+
+- [ADDED] CarrierWave style `remove_` attribute
+- [ADDED] Files are deleted after model is destroyed
+- [FIXED] Spec files can be required by external gems
+- [FIXED] Refile should work inside other Rails engines
+
 # 0.2.4
 
 Release date: 2014-12-08

data/README.md

@@ -1,5 +1,5 @@
 # Refile
-
+[![Gem Version](https://badge.fury.io/rb/refile.svg)](http://badge.fury.io/rb/refile)
 [![Build Status](https://travis-ci.org/elabs/refile.svg?branch=master)](https://travis-ci.org/elabs/refile)
 
 Refile is a modern file upload library for Ruby applications. It is simple, yet
@@ -139,6 +139,16 @@ For example:
 Refile.cache = Refile::Backend::S3.new(max_size: 10.megabytes, ...)
 ```
 
+The Refile gem ships with [S3](lib/refile/backends/s3.rb) and
+[FileSystem](lib/refile/backends/file_system.rb) backends. Additional backends
+are provided by other gems.
+
+- [Fog](https://github.com/elabs/refile-fog) provides support for a ton of
+  different cloud storage providers, including Google Storage and Rackspace
+  CloudFiles.
+- [Postgresql](https://github.com/krists/refile-postgres)
+- [In Memory](https://github.com/jnicklas/refile-memory)
+
 ### Uploadable
 
 The `upload` method on backends can be called with a variety of objects. It
@@ -212,7 +222,7 @@ Refile includes a Rack application (an endpoint, not a middleware). This applica
 streams files from backends and can even accept file uploads and upload them to
 backends.
 
-**Important:** Unlike other file upload solutions, Refile always streams your files thorugh your
+**Important:** Unlike other file upload solutions, Refile always streams your files through your
 application. It cannot generate URLs to your files. This means that you should
 **always** put a CDN or other HTTP cache in front of your application. Serving
 files through your app takes a lot of resources and you want it to happen rarely.
@@ -226,7 +236,7 @@ up, simply configure Refile to use your CDN:
 Refile.host = "//your-dist-url.cloudfront.net"
 ```
 
-Using a [procol-relative URL](http://www.paulirish.com/2010/the-protocol-relative-url/) for `Refile.host` is recommended.
+Using a [protocol-relative URL](http://www.paulirish.com/2010/the-protocol-relative-url/) for `Refile.host` is recommended.
 
 ### Mounting
 
@@ -312,13 +322,26 @@ The `attachment_url` helper can then be used for generating URLs for the uploade
 files:
 
 ``` erb
-<%= image_tag attachment_url(@user, :profile_image) %>
+<%= link_to "Image", attachment_url(@user, :profile_image) %>
 ```
 
 Any additional arguments to it are included in the URL as processor arguments:
 
 ``` erb
-<%= image_tag attachment_url(@user, :profile_image, :fill, 300, 300) %>
+<%= link_to "Image", attachment_url(@user, :profile_image, :fill, 300, 300) %>
+```
+
+There's also a helper for generating image tags:
+
+``` erb
+<%= attachment_image_tag(@user, :profile_image, :fill, 300, 300) %>
+```
+
+With this helper you can specify an image which is used as a fallback in case
+no file has been uploaded:
+
+``` erb
+<%= attachment_image_tag(@user, :profile_image, :fill, 300, 300, fallback: "defaul.png") %>
 ```
 
 ## 5. JavaScript library
@@ -454,6 +477,35 @@ Refile's JavaScript library requires HTML5 features which are unavailable on
 IE9 and earlier versions. All other major browsers are supported. Note though
 that it has not yet been extensively tested.
 
+## Removing attached files
+
+File input fields unfortunately do not have the option of removing an already
+uploaded file. This is problematic when editing a model which has a file attached
+and the user wants to remove this file. To work around this, Refile automatically
+adds an attribute to your model when you use the `attachment` method, which is
+designed to be used with a checkbox in a form.
+
+``` erb
+<%= form_for @user do |form| %>
+  <%= form.label :profile_image %>
+  <%= form.attachment_field :profile_image %>
+
+  <%= form.check_box :remove_profile_image %>
+  <%= form.label :remove_profile_image %>
+<% end %>
+```
+
+Don't forget to permit this attribute in your controller:
+
+``` ruby
+def user_params
+  params.require(:user).permit(:profile_image, :profile_image_cache_id, :remove_profile_image)
+end
+```
+
+Now when you check this checkbox and submit the form, the previously attached
+file will be removed.
+
 ## Cache expiry
 
 Files will accumulate in your cache, and you'll probably want to remove them

data/lib/refile/attachment.rb

@@ -4,6 +4,7 @@ module Refile
 
     class Attachment
       attr_reader :record, :name, :cache, :store, :cache_id, :options
+      attr_accessor :remove
 
       def initialize(record, name, **options)
         @record = record
@@ -44,19 +45,38 @@ module Refile
       end
 
       def store!
-        if cache_id and not cache_id == ""
+        if remove?
+          delete!
+        elsif cached?
           file = store.upload(cache.get(cache_id))
-          cache.delete(cache_id)
-          store.delete(id) if id
+          delete!
           self.id = file.id
+        end
+      end
+
+      def delete!
+        if cached?
+          cache.delete(cache_id)
           @cache_id = nil
           @cache_file = nil
         end
+        store.delete(id) if id
+        self.id = nil
+      end
+
+      def remove?
+        remove.present? and remove !~ /\A0|false$\z/
       end
 
       def errors
         @errors
       end
+
+      private
+
+      def cached?
+        cache_id and not cache_id == ""
+      end
     end
 
     def attachment(name, cache: :cache, store: :store, raise_errors: true)
@@ -84,6 +104,14 @@ module Refile
       define_method "#{name}_cache_id" do
         send(attachment).cache_id
       end
+
+      define_method "remove_#{name}=" do |remove|
+        send(attachment).remove = remove
+      end
+
+      define_method "remove_#{name}" do
+        send(attachment).remove
+      end
     end
   end
 end

data/lib/refile/attachment/active_record.rb

@@ -16,6 +16,10 @@ module Refile
         before_save do
           send(attachment).store!
         end
+
+        after_destroy do
+          send(attachment).delete!
+        end
       end
     end
   end

data/lib/refile/rails.rb

@@ -1,4 +1,5 @@
 require "refile"
+require "refile/rails/attachment_helper"
 
 module Refile
   module Controller
@@ -28,6 +29,7 @@ module Refile
         require "refile/attachment/active_record"
       end
 
+      ActionView::Base.send(:include, Refile::AttachmentHelper)
       ActionView::Helpers::FormBuilder.send(:include, AttachmentFieldHelper)
     end
 

data/lib/refile/rails/attachment_helper.rb

@@ -0,0 +1,57 @@
+module Refile
+  module AttachmentHelper
+    def attachment_url(record, name, *args, filename: nil, format: nil)
+      file = record.send(name)
+
+      filename ||= name.to_s
+
+      backend_name = Refile.backends.key(file.backend)
+      host = Refile.host || request.base_url
+
+      filename = filename.parameterize("_")
+      filename << "." << format.to_s if format
+
+      ::File.join(host, main_app.refile_app_path, backend_name, *args.map(&:to_s), file.id, filename)
+    end
+
+    def attachment_image_tag(record, name, *args, fallback: nil, format: nil, **options)
+      file = record.send(name)
+      classes = ["attachment", record.class.model_name.singular, name, *options[:class]]
+
+      if file
+        image_tag(attachment_url(record, name, *args, format: format), options.merge(class: classes))
+      elsif fallback
+        classes << "fallback"
+        image_tag(fallback, options.merge(class: classes))
+      end
+    end
+
+    def attachment_field(object_name, method, options = {})
+      if options[:object]
+        cache = options[:object].send(:"#{method}_attachment").cache
+
+        if options[:direct]
+          host = Refile.host || request.base_url
+          backend_name = Refile.backends.key(cache)
+
+          options[:data] ||= {}
+          options[:data][:direct] = true
+          options[:data][:as] = "file"
+          options[:data][:url] = ::File.join(host, main_app.refile_app_path, backend_name)
+        end
+
+        if options[:presigned] and cache.respond_to?(:presign)
+          signature = cache.presign
+          options[:data] ||= {}
+          options[:data][:direct] = true
+          options[:data][:id] = signature.id
+          options[:data][:url] = signature.url
+          options[:data][:fields] = signature.fields
+          options[:data][:as] = signature.as
+        end
+      end
+      hidden_field(object_name, :"#{method}_cache_id", options.slice(:object)) +
+      file_field(object_name, method, options)
+    end
+  end
+end

data/lib/refile/version.rb

@@ -1,3 +1,3 @@
 module Refile
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/refile.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ["lib", "spec"]
 
   spec.required_ruby_version = ">= 2.1.0"
 

data/spec/refile/attachment_spec.rb

@@ -80,6 +80,67 @@ describe Refile::Attachment do
       expect(Refile.cache.get(cache.id).exists?).to be_falsy
       expect(Refile.store.get(file.id).exists?).to be_falsy
     end
+
+    it "removes an uploaded file when remove? returns true" do
+      file = Refile.store.upload(Refile::FileDouble.new("hello"))
+      instance.document_id = file.id
+
+      instance.document_attachment.remove = true
+      instance.document_attachment.store!
+
+      expect(instance.document_id).to be_nil
+      expect(Refile.store.exists?(file.id)).to be_falsy
+    end
+  end
+
+  describe ":name_attachment.delete!" do
+    it "deletes a stored file" do
+      file = Refile.store.upload(Refile::FileDouble.new("hello"))
+      instance.document_id = file.id
+
+      instance.document_attachment.delete!
+
+      expect(instance.document_id).to be_nil
+      expect(Refile.store.exists?(file.id)).to be_falsy
+    end
+
+    it "deletes a cached file" do
+      file = Refile.cache.upload(Refile::FileDouble.new("hello"))
+      instance.document_cache_id = file.id
+
+      instance.document_attachment.delete!
+
+      expect(instance.document_id).to be_nil
+      expect(instance.document_cache_id).to be_nil
+      expect(Refile.cache.exists?(file.id)).to be_falsy
+    end
+  end
+
+  describe ":name_attachment.remove?" do
+    it "should be true when the value is truthy" do
+      instance.document_attachment.remove = true
+      expect(instance.document_attachment.remove?).to be_truthy
+    end
+
+    it "should be false when the value is falsey" do
+      instance.document_attachment.remove = false
+      expect(instance.document_attachment.remove?).to be_falsy
+    end
+
+    it "should be false when the value is ''" do
+      instance.document_attachment.remove = ''
+      expect(instance.document_attachment.remove?).to be_falsy
+    end
+
+    it "should be false when the value is '0'" do
+      instance.document_attachment.remove = '0'
+      expect(instance.document_attachment.remove?).to be_falsy
+    end
+
+    it "should be false when the value is 'false'" do
+      instance.document_attachment.remove = 'false'
+      expect(instance.document_attachment.remove?).to be_falsy
+    end
   end
 
   describe ":name_attachment.error" do

data/spec/refile/features/normal_upload_spec.rb

@@ -44,4 +44,20 @@ feature "Normal HTTP Post file uploads" do
     click_link("Convert to Upper")
     expect(page.source.chomp).to eq("HELLO")
   end
+
+  scenario "Successfully remove an uploaded file" do
+    visit "/normal/posts/new"
+    fill_in "Title", with: "A cool post"
+    attach_file "Document", path("hello.txt")
+    click_button "Create"
+
+    expect(page).to have_selector("h1", text: "A cool post")
+    expect(page).to have_selector(:link, "Document")
+    click_link("Edit")
+
+    check "Remove document"
+    click_button "Update"
+    expect(page).to have_selector("h1", text: "A cool post")
+    expect(page).to_not have_selector(:link, "Document")
+  end
 end

data/spec/refile/spec_helper.rb

@@ -1,4 +1,3 @@
-require "pry"
 require "refile"
 require "refile/backend_examples"
 

data/spec/refile/test_app/app/controllers/normal_posts_controller.rb

@@ -1,14 +1,18 @@
 class NormalPostsController < ApplicationController
+  def show
+    @post = Post.find(params[:id])
+  end
+
   def new
     @post = Post.new
   end
 
-  def show
+  def edit
     @post = Post.find(params[:id])
   end
 
   def create
-    @post = Post.new(params.require(:post).permit(:title, :image, :image_cache_id, :document, :document_cache_id))
+    @post = Post.new(post_params)
 
     if @post.save
       redirect_to [:normal, @post]
@@ -16,4 +20,20 @@ class NormalPostsController < ApplicationController
       render :new
     end
   end
+
+  def update
+    @post = Post.find(params[:id])
+
+    if @post.update_attributes(post_params)
+      redirect_to [:normal, @post]
+    else
+      render :edit
+    end
+  end
+
+  private
+
+  def post_params
+    params.require(:post).permit(:title, :image, :image_cache_id, :document, :document_cache_id, :remove_document)
+  end
 end

data/spec/refile/test_app/app/views/normal_posts/_form.html.erb

@@ -0,0 +1,24 @@
+<%= form_for [:normal, @post] do |form| %>
+  <p>
+    <%= @post.errors.full_messages.to_sentence %>
+  </p>
+  <p>
+    <%= form.label :title %>
+    <%= form.text_field :title %>
+  </p>
+  <p>
+    <%= form.label :image %>
+    <%= form.attachment_field :image %>
+  </p>
+  <p>
+    <%= form.label :document %>
+    <%= form.attachment_field :document %>
+  </p>
+  <p>
+    <%= form.label :remove_document %>
+    <%= form.check_box :remove_document %>
+  </p>
+  <p>
+    <%= form.submit %>
+  </p>
+<% end %>

data/spec/refile/test_app/app/views/normal_posts/edit.html.erb

@@ -0,0 +1 @@
+<%= render "form" %>

data/spec/refile/test_app/app/views/normal_posts/new.html.erb

@@ -1,20 +1 @@
-<%= form_for [:normal, @post] do |form| %>
-  <p>
-    <%= @post.errors.full_messages.to_sentence %>
-  </p>
-  <p>
-    <%= form.label :title %>
-    <%= form.text_field :title %>
-  </p>
-  <p>
-    <%= form.label :image %>
-    <%= form.attachment_field :image %>
-  </p>
-  <p>
-    <%= form.label :document %>
-    <%= form.attachment_field :document %>
-  </p>
-  <p>
-    <%= form.submit "Create" %>
-  </p>
-<% end %>
+<%= render "form" %>

data/spec/refile/test_app/app/views/normal_posts/show.html.erb

@@ -11,3 +11,5 @@
 <% if @post.document %>
   <%= link_to "Convert to Upper", attachment_url(@post, :document, :convert_case, format: "up") %>
 <% end %>
+
+<%= link_to "Edit", edit_normal_post_url(@post) %>

data/spec/refile/test_app/config/routes.rb

@@ -2,7 +2,7 @@ Refile::TestApp.routes.draw do
   root to: "home#index"
 
   scope path: "normal", as: "normal" do
-    resources :posts, only: [:new, :create, :show], controller: "normal_posts"
+    resources :posts, only: [:show, :new, :edit, :create, :update], controller: "normal_posts"
   end
 
   scope path: "direct", as: "direct" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refile
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Jonas Nicklas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,7 +194,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/refile.js
-- app/helpers/attachment_helper.rb
 - config.ru
 - config/locales/en.yml
 - config/routes.rb
@@ -207,6 +206,7 @@ files:
 - lib/refile/file.rb
 - lib/refile/image_processing.rb
 - lib/refile/rails.rb
+- lib/refile/rails/attachment_helper.rb
 - lib/refile/random_hasher.rb
 - lib/refile/version.rb
 - refile.gemspec
@@ -232,6 +232,8 @@ files:
 - spec/refile/test_app/app/views/direct_posts/new.html.erb
 - spec/refile/test_app/app/views/home/index.html.erb
 - spec/refile/test_app/app/views/layouts/application.html.erb
+- spec/refile/test_app/app/views/normal_posts/_form.html.erb
+- spec/refile/test_app/app/views/normal_posts/edit.html.erb
 - spec/refile/test_app/app/views/normal_posts/new.html.erb
 - spec/refile/test_app/app/views/normal_posts/show.html.erb
 - spec/refile/test_app/app/views/presigned_posts/new.html.erb
@@ -247,6 +249,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- spec
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -286,6 +289,8 @@ test_files:
 - spec/refile/test_app/app/views/direct_posts/new.html.erb
 - spec/refile/test_app/app/views/home/index.html.erb
 - spec/refile/test_app/app/views/layouts/application.html.erb
+- spec/refile/test_app/app/views/normal_posts/_form.html.erb
+- spec/refile/test_app/app/views/normal_posts/edit.html.erb
 - spec/refile/test_app/app/views/normal_posts/new.html.erb
 - spec/refile/test_app/app/views/normal_posts/show.html.erb
 - spec/refile/test_app/app/views/presigned_posts/new.html.erb

data/app/helpers/attachment_helper.rb

@@ -1,55 +0,0 @@
-module AttachmentHelper
-  def attachment_url(record, name, *args, filename: nil, format: nil)
-    file = record.send(name)
-
-    filename ||= name.to_s
-
-    backend_name = Refile.backends.key(file.backend)
-    host = Refile.host || request.base_url
-
-    filename = filename.parameterize("_")
-    filename << "." << format.to_s if format
-
-    File.join(host, refile_app_path, backend_name, *args.map(&:to_s), file.id, filename)
-  end
-
-  def attachment_image_tag(record, name, *args, fallback: nil, format: nil, **options)
-    file = record.send(name)
-    classes = ["attachment", record.class.model_name.singular, name, *options[:class]]
-
-    if file
-      image_tag(attachment_url(record, name, *args, format: format), options.merge(class: classes))
-    elsif fallback
-      classes << "fallback"
-      image_tag(fallback, options.merge(class: classes))
-    end
-  end
-
-  def attachment_field(object_name, method, options = {})
-    if options[:object]
-      cache = options[:object].send(:"#{method}_attachment").cache
-
-      if options[:direct]
-        host = Refile.host || request.base_url
-        backend_name = Refile.backends.key(cache)
-
-        options[:data] ||= {}
-        options[:data][:direct] = true
-        options[:data][:as] = "file"
-        options[:data][:url] = File.join(host, refile_app_path, backend_name)
-      end
-
-      if options[:presigned] and cache.respond_to?(:presign)
-        signature = cache.presign
-        options[:data] ||= {}
-        options[:data][:direct] = true
-        options[:data][:id] = signature.id
-        options[:data][:url] = signature.url
-        options[:data][:fields] = signature.fields
-        options[:data][:as] = signature.as
-      end
-    end
-    hidden_field(object_name, :"#{method}_cache_id", options.slice(:object)) +
-    file_field(object_name, method, options)
-  end
-end