pretty_file_input 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e57d9efb1610be2863391f09c934f208c3a5f2e
-  data.tar.gz: d46c59fca21ff1b76fa3c1bf37304b9de6eb721e
+  metadata.gz: c168ebe781c32c83a16d009e59fd6ba47248986c
+  data.tar.gz: b23a8b2cce2676ba4a0ce1f20492cbdbc1b99993
 SHA512:
-  metadata.gz: 30f013d6bcc509c9a77bf227291e4e5a522add470edc1ccff78e059821fd24cd550fc0f577ba6347489de04caeefef8bcbb9c97c369e8ea426cddf323660ef3e
-  data.tar.gz: 5707ec9e0e91111b18da1d53b024d4bcd9bb7cc33264749883f5bc4c45703b466dc4d9a2068ce8ee48570cf53fbabb795fb92b720e0d89f9349b4669dcba434a
+  metadata.gz: 14fca40aa7f82597774a3a66114501a5a48354b0f5ad7af34e98088f0e963f955efc1745c256aabd2d23e5d105160d8289648200d777f5f9fe8cec3a02970b4d
+  data.tar.gz: 88cf5c3de4533a042946b5d7643b55b2f478aa401851d38b99d3e3a57cede42eb033660f5b5ba70771d6e06e48dbce8a3593d3b034bd1fd57a9808b835928bb7

data/.gitignore

@@ -4,4 +4,8 @@ tmp/*
 coverage/*
 *.gem
 Gemfile.lock
-.ruby-gemset
+.ruby-gemset
+spec/dummy/tmp/*
+spec/dummy/log/*
+spec/dummy/public/uploads/*
+spec/dummy/db/test.sqlite

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+before_script:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+  - "cd spec/dummy && RAILS_ENV=test bundle exec rake db:create && RAILS_ENV=test bundle exec rake db:migrate && cd ../../"
+script:
+  - bundle exec rspec
+notifications:
+  email: false

data/README.md

@@ -1,6 +1,71 @@
-pretty_file_input
+pretty_file_input [![version]](http://rubygems.org/gems/pretty_file_input) [![build]](https://travis-ci.org/dobtco/pretty_file_input)
 =======
 
+pretty_file_input is an attempt to standardize the always-problematic file input in our Rails apps.
+
+## Benefits
+
+- Immediate uploads via AJAX for `persisted?` records
+- Upload percentage displayed while uploading
+- Identical user interface (without AJAX uploads) for non-`persisted?` records
+- Use your existing models and controllers, no changes necessary
+
+## Requirements
+
+- [carrierwave](https://github.com/carrierwaveuploader/carrierwave)
+- [simple_form](https://github.com/plataformatec/simple_form) (if using the "Automatic" implementation below)
+- jQuery
+- [jquery.form](https://github.com/malsup/form/)
+
+## Installation
+
+```sh
+# Gemfile
+gem 'dvl-core'
+
+# application.css
+*= require pretty_file_input
+
+# application.js
+//= require pretty_file_input
+```
+
+## Implementation
+
+There are a couple of ways to use this gem:
+
+### Automatic
+
+By taking advantage of the included simple_form input class, you can start using pretty_file_input with as little as one line of code:
+
+```rb
+f.input :avatar, as: :pretty_file_input
+```
+
+The resulting behavior will depend on whether or not the parent object is already persisted in the database.
+
+**For existing records**, pretty_file_input will upload and remove files immediately, displaying some nice UI feedback along the way:
+
+![gif](https://s3.amazonaws.com/quickcast/3785/60141/quickcast.gif)
+
+**For new records**, pretty_file_input will not perform any AJAX requests. (Carrierwave stores files alongside your database records, so it's impossible to upload a file _before_ its associated record has been created.)
+
+### Manual
+
+If your use case doesn't fit the patterns above, you can use the "Manual" integration with pretty_file_input. `PrettyFileInput::Component` is an Erector widget that can be customized with the following options:
+
+```rb
+:name,                # input name that will be sent to the server
+persisted: false,     # is parent object is not persisted, no AJAX calls will be made
+filename: nil,        # pre-populate the filename span
+method: nil,          # override the parent form's method
+action: nil,          # override the parent form's action
+additional_params: {} # additional parameters to be sent to server with each request
+```
+
 ## License
 
 [MIT](http://dobtco.mit-license.org/)
+
+[version]: https://img.shields.io/gem/v/pretty_file_input.svg
+[build]: http://img.shields.io/travis/dobtco/pretty_file_input.svg

data/app/inputs/pretty_file_input_input.rb

@@ -3,7 +3,7 @@ class PrettyFileInputInput < SimpleForm::Inputs::Base
     @builder.multipart = true
     PrettyFileInput::Component.new(
       name: tag_name,
-      persisted: object.persisted?,
+      persisted: object.try(:persisted?),
       filename: object.try(:send, attribute_name).try(:file).try(:filename)
     ).to_html
   end

data/lib/pretty_file_input/component.rb

@@ -1,12 +1,12 @@
 require 'erector'
 
 class PrettyFileInput::Component < Erector::Widget
-  needs :name,                # input name that will be sent to the server
-        persisted: false,     # is parent object is not persisted, no AJAX calls will be made
-        filename: nil,        # pre-populate the filename span
-        method: nil,          # override the parent form's method
-        action: nil,          # override the parent form's action
-        additional_params: {} # additional parameters to be sent to server with each request
+  needs :name,
+        persisted: false,
+        filename: nil,
+        method: nil,
+        action: nil,
+        additional_params: {}
 
   def content
     div(

data/lib/pretty_file_input/version.rb

@@ -1,3 +1,3 @@
 module PrettyFileInput
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/pretty_file_input.gemspec

@@ -19,4 +19,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'coffee-script'
   s.add_dependency 'erector-rails4'
   s.add_dependency 'sass'
+
+  s.add_development_dependency 'capybara', '2.4.4'
+  s.add_development_dependency 'carrierwave'
+  s.add_development_dependency 'rails', '4.1.7'
+  s.add_development_dependency 'rspec-rails', '3.1.0'
+  s.add_development_dependency 'selenium-webdriver', '2.43.0'
+  s.add_development_dependency 'simple_form'
+  s.add_development_dependency 'sqlite3', '1.3.9'
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .
+//= require pretty_file_input