refile 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3a2b57d57c5951f0c24c51726efb70cce7d81ff
-  data.tar.gz: 39063e4b10ac86030aa75ab30463b1798b02b91a
+  metadata.gz: efeeacf3670d33b7a4c22cdb6f55cdddba524a0b
+  data.tar.gz: 8e4f7bc973f1347606a251d9a15a7f3983f04e13
 SHA512:
-  metadata.gz: 091a57dc29f9fc7cef0f9aa240446f48076a6a321d60cfdb9491104a91ec196a105ed3476a74f8f05f3fee7fdc1c796807710dd9b7eb3b642d961493ee505bbe
-  data.tar.gz: 9fb6d682ea8fc32b0a5a3321912e5315f5ac836b88d14636731fd2e068917f32a4621a02f2759acf4fc9d52ddebfe90235b7b46abda11bc502c62b23591f315f
+  metadata.gz: 01f6f2eb954e55add137dc351da2829295a7de8a6e5290bbad27f70b05c039f3b3db4e84adf6b9c44a415d305b2fbb28a74f6c8eec55fb09c386a9e270ba7708
+  data.tar.gz: f20d8cc03bbced04056c291cb06620af4a257e1ad582b9e4a594a14137e0d9abbeb2b9b2c7109a76f0bc4c99dd4385530c43074fce728cafb7530a6bd2f81c74

data/.rubocop.yml

@@ -11,10 +11,13 @@ Metrics/ParameterLists:
   Max: 8
 
 Metrics/AbcSize:
-  Max: 20
+  Enabled: false
 
 Metrics/CyclomaticComplexity:
-  Max: 7 # TODO: reduce
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
 
 Style/AlignParameters:
   EnforcedStyle: with_fixed_indentation
@@ -54,3 +57,6 @@ Style/SignalException:
 
 Lint/EndAlignment:
   AlignWith: variable
+
+Lint/HandleExceptions:
+  Enabled: false

data/.travis.yml

@@ -8,6 +8,8 @@ rvm:
 gemfile:
   - Gemfile
 
+cache: bundler
+
 sudo: false
 
 before_script:

data/.yardopts

@@ -0,0 +1 @@
+--hide-api private --hide-void-return --markup markdown

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Security issues
+
+If you have found a security related issue, please do not file an issue on
+GitHub or send a PR addressing the issue. Contact
+[Jonas](mailto:jonas.nicklas@gmail.com) directly. You will be given public
+credit for your disclosure.
+
+## Reporting issues
+
+Please try to answer the following questions in your bug report:
+
+- What did you do?
+- What did you expect to happen?
+- What happened instead?
+
+Make sure to include as much relevant information as possible. Ruby version,
+Refile version, OS and any stack traces you have are very valuable.
+
+## Pull Requests
+
+- **Add tests!** Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour**. Make sure the README and any other
+  relevant documentation are kept up-to-date.
+
+- **Create topic branches**. Please don't ask us to pull from your master branch.
+
+- **One pull request per feature**. If you want to do more than one thing, send
+  multiple pull requests.
+
+- **Send coherent history**. Make sure each individual commit in your pull
+  request is meaningful. If you had to make multiple intermediate commits while
+  developing, please squash them before sending them to us.

data/History.md

@@ -1,3 +1,12 @@
+# 0.5.0
+
+Release date: 2015-01-09
+
+- [ADDED] Can add custom types for easier content type validations
+- [ADDED] Can persist filename, size and content type
+- [CHANGED] The `cache_id` field is no longer necessary and no longer need to be permitted in the controller
+- [CHANGED] Improved logging
+
 # 0.4.2
 
 Release date: 2014-12-27

data/README.md

@@ -1,11 +1,17 @@
 # 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)
 [![Code Climate](https://codeclimate.com/github/elabs/refile/badges/gpa.svg)](https://codeclimate.com/github/elabs/refile)
+[![Inline docs](http://inch-ci.org/github/elabs/refile.svg?branch=master)](http://inch-ci.org/github/elabs/refile)
 
 Refile is a modern file upload library for Ruby applications. It is simple, yet
-powerful. Refile is an attempt by CarrierWave's original author to fix the
-design mistakes and overengineering in CarrierWave.
+powerful.
+
+Links:
+
+- [API documentation](http://www.rubydoc.info/gems/refile)
+- [Source Code](https://github.com/elabs/refile)
 
 Features:
 
@@ -25,6 +31,16 @@ gem "mini_magick"
 gem "refile", require: ["refile/rails", "refile/image_processing"]
 ```
 
+We're requiring both Refile's Rails integration and image processing via the
+[MiniMagick](https://github.com/minimagick/minimagick) gem, which requires
+[ImageMagick](http://imagemagick.org/) to be installed. To install it simply
+run:
+
+``` sh
+brew install imagemagick # OS X
+sudo apt-get install imagemagick # Ubuntu
+```
+
 Use the `attachment` method to use Refile in a model:
 
 ``` ruby
@@ -52,7 +68,7 @@ Set up strong parameters:
 
 ``` ruby
 def user_params
-  params.require(:user).permit(:profile_image, :profile_image_cache_id)
+  params.require(:user).permit(:profile_image)
 end
 ```
 
@@ -70,7 +86,7 @@ Refile consists of several parts:
 2. Model attachments: map files to model columns
 3. A Rack application: streams files and accepts uploads
 4. Rails helpers: conveniently generate markup in your views
-4. A JavaScript library: facilitates direct uploads
+5. A JavaScript library: facilitates direct uploads
 
 Let's look at each of these in more detail!
 
@@ -140,8 +156,8 @@ 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
+The Refile gem ships with [S3](lib/refile/backend/s3.rb) and
+[FileSystem](lib/refile/backend/file_system.rb) backends. Additional backends
 are provided by other gems.
 
 - [Fog](https://github.com/elabs/refile-fog) provides support for a ton of
@@ -299,10 +315,10 @@ example.
 ## 4. Rails helpers
 
 Refile provides the `attachment_field` form helper which generates a file field
-as well as a hidden field, suffixed with `cache_id`. This field keeps track of
-the file in case it is not yet permanently stored, for example if validations
-fail. It is also used for direct and presigned uploads. For this reason it is
-highly recommended to use `attachment_field` instead of `file_field`.
+as well as a hidden field. This field keeps track of the file in case it is not
+yet permanently stored, for example if validations fail. It is also used for
+direct and presigned uploads. For this reason it is highly recommended to use
+`attachment_field` instead of `file_field`.
 
 ``` erb
 <%= form_for @user do |form| %>
@@ -314,7 +330,7 @@ Will generate something like:
 
 ``` html
 <form action="/users" enctype="multipart/form-data" method="post">
-  <input name="user[profile_image_cache_id]" type="hidden">
+  <input name="user[profile_image]" type="hidden">
   <input name="user[profile_image]" type="file">
 </form>
 ```
@@ -363,6 +379,8 @@ simply include it like this:
 ```
 
 Otherwise you can grab a copy [here](https://raw.githubusercontent.com/elabs/refile/master/app/assets/javascripts/refile.js).
+Be sure to always update your copy of this file when you upgrade to the latest
+Refile version.
 
 Now mark the field for direct upload:
 
@@ -476,8 +494,26 @@ production mode.
 ### Browser compatibility
 
 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.
+IE9 and earlier versions. All other major browsers are supported.
+
+## Additional metadata
+
+In the quick start example above, we chose to only store the file id, but often
+it is useful to store the file's filename, size and content type as well.
+Refile makes it easy to extract this data and store it alongside the id. All you
+need to do is add columns for these:
+
+``` ruby
+class StoreMetadata < ActiveRecord::Migration
+  def change
+    add_column :profile_image_filename
+    add_column :profile_image_size
+    add_column :profile_image_content_type
+  end
+end
+```
+
+These columns will now be filled automatically.
 
 ## File type validations
 
@@ -496,7 +532,7 @@ attachment :cv, extension: "pdf"
 attachment :profile_image, content_type: "image/jpeg"
 ```
 
-You can also provide a list of content type or extensions:
+You can also provide a list of content types or extensions:
 
 ``` ruby
 attachment :cv, extension: ["pdf", "doc"]
@@ -513,6 +549,21 @@ attachment :profile_image, type: :image
 When a user uploads a file with an invalid extension or content type and
 submits the form, they'll be presented with a validation error.
 
+If you use a particular content type or set of content types frequently
+you can define your own types like this:
+
+``` ruby
+Refile.types[:document] = Refile::Type.new(:document,
+  content_type: %w[text/plain application/pdf]
+)
+```
+
+Now you can use them like this:
+
+``` ruby
+attachment :profile_image, type: :document
+```
+
 ## Removing attached files
 
 File input fields unfortunately do not have the option of removing an already
@@ -535,7 +586,7 @@ 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)
+  params.require(:user).permit(:profile_image, :remove_profile_image)
 end
 ```
 
@@ -563,7 +614,7 @@ Then permit this field in your controller:
 
 ``` ruby
 def user_params
-  params.require(:user).permit(:profile_image, :profile_image_cache_id, :remote_profile_image_url)
+  params.require(:user).permit(:profile_image, :remote_profile_image_url)
 end
 ```
 

data/app/assets/javascripts/refile.js

@@ -1,25 +1,25 @@
 (function() {
   "use strict";
 
-  if(!document.addEventListener) { return }; // IE8
+  if(!document.addEventListener) { return; } // IE8
 
-  document.addEventListener("change", function(e) {
-    if(e.target.tagName === "INPUT" && e.target.type === "file" && e.target.getAttribute("data-direct")) {
-      var input = e.target;
+  document.addEventListener("change", function(changeEvent) {
+    var input = changeEvent.target;
+    if(input.tagName === "INPUT" && input.type === "file" && input.getAttribute("data-direct")) {
       if(!input.files) { return; } // IE9, bail out if file API is not supported.
+
       var file = input.files[0];
+      var metadataField = input.previousSibling;
 
       var dispatchEvent = function(name, detail) {
         var ev = document.createEvent('CustomEvent');
         ev.initCustomEvent(name, true, false, detail);
         input.dispatchEvent(ev);
-      }
+      };
 
       if(file) {
-        var url = e.target.getAttribute("data-url");
-        if(e.target.getAttribute("data-fields")) {
-          var fields = JSON.parse(e.target.getAttribute("data-fields"));
-        }
+        var url = input.getAttribute("data-url");
+        var fields = JSON.parse(input.getAttribute("data-fields") || "null");
 
         var data = new FormData();
 
@@ -31,12 +31,14 @@
         data.append(input.getAttribute("data-as"), file);
 
         var xhr = new XMLHttpRequest();
-        xhr.addEventListener("load", function(e) {
-          input.classList.remove("uploading")
+        xhr.addEventListener("load", function() {
+          input.classList.remove("uploading");
           dispatchEvent("upload:complete", xhr.responseText);
           if((xhr.status >= 200 && xhr.status < 300) || xhr.status === 304) {
             var id = input.getAttribute("data-id") || JSON.parse(xhr.responseText).id;
-            input.previousSibling.value = id;
+            if(metadataField) {
+              metadataField.value = JSON.stringify({ id: id, filename: file.name, content_type: file.type, size: file.size });
+            }
             input.removeAttribute("name");
             dispatchEvent("upload:success", xhr.responseText);
           } else {
@@ -44,17 +46,17 @@
           }
         });
 
-        xhr.upload.addEventListener("progress", function(e) {
-          if (e.lengthComputable) {
-            dispatchEvent("upload:progress", e);
+        xhr.upload.addEventListener("progress", function(progressEvent) {
+          if (progressEvent.lengthComputable) {
+            dispatchEvent("upload:progress", progressEvent);
           }
         });
 
         xhr.open("POST", url, true);
         xhr.send(data);
 
-        input.classList.add("uploading")
-        dispatchEvent("upload:start");
+        input.classList.add("uploading");
+        dispatchEvent("upload:start", xhr);
       }
     }
   });

data/lib/refile.rb

@@ -1,19 +1,20 @@
 require "uri"
 require "fileutils"
 require "tempfile"
-require "rest_client"
 require "logger"
 require "mime/types"
 
 module Refile
+  # @api private
   class Invalid < StandardError; end
+
+  # @api private
   class Confirm < StandardError
     def message
       "are you sure? this will remove all files in the backend, call as \
       `clear!(:confirm)` if you're sure you want to do this"
     end
   end
-  ONE_YEAR_IN_SECONDS = 31_557_600
 
   class << self
     # A shortcut to the instance of the Rack application. This should be
@@ -51,16 +52,23 @@ module Refile
     attr_accessor :allow_origin
 
     # Value for Cache-Control: max-age=<value in seconds> header
+    #
+    # @return [Integer]
     attr_accessor :content_max_age
 
-    # Where should the rack application be mounted?
-    # The default is 'attachments'
+    # Where should the rack application be mounted? The default is 'attachments'.
+    #
+    # @return [String]
     attr_accessor :mount_point
 
     # Should the rack application be automounted in a Rails app?
-    # The default is true.
+    #
     # If set to false then Refile.app should be mounted in the Rails application
     # routes.rb with the options `at: Refile.mount_point, as: :refile_app`
+    #
+    # The default is true.
+    #
+    # @return [Boolean]
     attr_accessor :automount
 
     # A global registry of backends.
@@ -80,6 +88,14 @@ module Refile
       @processors ||= {}
     end
 
+    # A global registry of types. Currently, types are simply aliases for a set
+    # of content types, but their functionality may expand in the future.
+    #
+    # @return [Hash{Symbol => Refile::Type}]
+    def types
+      @types ||= {}
+    end
+
     # Adds a processor. The processor must respond to `call`, both receiving
     # and returning an IO-like object. Alternatively a block can be given to
     # this method which also receives and returns an IO-like object.
@@ -106,6 +122,7 @@ module Refile
     # @param [Proc, nil] processor  The processor, must respond to `call` and.
     # @yield [Refile::File]         The file to modify
     # @yieldreturn [IO]             An IO-like object representing the processed file
+    # @return [void]
     def processor(name, processor = nil, &block)
       processor ||= block
       processors[name.to_s] = processor
@@ -170,6 +187,11 @@ module Refile
       true
     end
 
+    # Extract the filename from an uploadable object. If the filename cannot be
+    # determined, this method will return `nil`.
+    #
+    # @param [IO] uploadable    The uploadable object to extract the filename from
+    # @return [String, nil]     The extracted filename
     def extract_filename(uploadable)
       path = if uploadable.respond_to?(:original_filename)
         uploadable.original_filename
@@ -179,6 +201,11 @@ module Refile
       ::File.basename(path) if path
     end
 
+    # Extract the content type from an uploadable object. If the content type
+    # cannot be determined, this method will return `nil`.
+    #
+    # @param [IO] uploadable    The uploadable object to extract the content type from
+    # @return [String, nil]     The extracted content type
     def extract_content_type(uploadable)
       if uploadable.respond_to?(:content_type)
         uploadable.content_type
@@ -194,10 +221,12 @@ module Refile
 
   require "refile/version"
   require "refile/signature"
+  require "refile/type"
   require "refile/attacher"
   require "refile/attachment"
   require "refile/random_hasher"
   require "refile/file"
+  require "refile/custom_logger"
   require "refile/app"
   require "refile/backend/file_system"
 end
@@ -208,5 +237,6 @@ Refile.configure do |config|
   config.logger = Logger.new(STDOUT)
   config.mount_point = "attachments"
   config.automount = true
-  config.content_max_age = Refile::ONE_YEAR_IN_SECONDS
+  config.content_max_age = 60 * 60 * 24 * 365
+  config.types[:image] = Refile::Type.new(:image, content_type: %w[image/jpeg image/gif image/png])
 end