simple_form_attachments 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6846d1ae3b38593e331a395b4bb3b84bab6fc01a
+  data.tar.gz: 6b1f4dd4442340d93bf762b91cf93375b00294e0
+SHA512:
+  metadata.gz: 76f6ff5de9efcd7a4a649ae2549b90e262304bb5fa6bb61e4ba4cb2ad4f6f292c7f5bd8e57c6de68a9e117009f62d63f6886d532036d55b5d5ea2ef28d3d2ccb
+  data.tar.gz: 19f47944e84cc2cf02568e19606f57f7b4a717602bd8c4f2f2933138c7a5e1f16a62a33069bb0f37a9685f4f4b923238dc50897b497826386cc969667dcca804

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1 @@
+test/dummy/log/*

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 2.1.2
+services:
+  - mongodb
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+      - asger@8kilo.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'https://rails-assets.org'
+
+# Specify your gem's dependencies in simple_form_epic_editor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,239 @@
+PATH
+  remote: .
+  specs:
+    simple_form_attachments (0.0.1)
+      handlebars
+      jquery-ui-rails
+      rails (>= 4.2)
+      rails-assets-blueimp-file-upload (>= 9.6.0)
+      rails-assets-handlebars
+      simple_form (>= 3.0.2)
+      slim
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://rails-assets.org/
+  specs:
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    arel (6.0.0)
+    bson (2.3.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    connection_pool (2.2.0)
+    coveralls (0.8.1)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    database_cleaner (1.4.1)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    dragonfly (1.0.7)
+      addressable (~> 2.3)
+      multi_json (~> 1.0)
+      rack
+    erubis (2.7.0)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.4)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    handlebars (0.7.0)
+      handlebars-source (~> 3.0.0)
+      therubyracer (~> 0.12.1)
+    handlebars-source (3.0.2)
+    hitimes (1.2.2)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    jquery-ui-rails (5.0.3)
+      railties (>= 3.2.16)
+    json (1.8.2)
+    libv8 (3.16.14.7)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.6.0)
+    minitest-rails (2.1.1)
+      minitest (~> 5.4)
+      railties (~> 4.1)
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    moped (2.0.4)
+      bson (~> 2.2)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    multi_json (1.11.0)
+    nenv (0.2.0)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    optionable (0.2.0)
+    origin (2.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.1)
+      actionmailer (= 4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      activemodel (= 4.2.1)
+      activerecord (= 4.2.1)
+      activesupport (= 4.2.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.1)
+      sprockets-rails
+    rails-assets-blueimp-canvas-to-blob (2.1.1)
+    rails-assets-blueimp-file-upload (9.9.3)
+      rails-assets-blueimp-canvas-to-blob (>= 2.1.1)
+      rails-assets-blueimp-load-image (>= 1.13.0)
+      rails-assets-blueimp-tmpl (>= 2.5.4)
+      rails-assets-jquery (>= 1.6)
+    rails-assets-blueimp-load-image (1.13.0)
+    rails-assets-blueimp-tmpl (2.5.4)
+    rails-assets-handlebars (3.0.2)
+    rails-assets-jquery (2.1.3)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    ref (1.0.5)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    shellany (0.0.1)
+    simple_form (3.1.0)
+      actionpack (~> 4.0)
+      activemodel (~> 4.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slim (3.0.3)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    slop (3.6.0)
+    sprockets (3.0.2)
+      rack (~> 1.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    temple (0.7.5)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    therubyracer (0.12.2)
+      libv8 (~> 3.16.14.0)
+      ref
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    timers (4.0.1)
+      hitimes
+    tins (1.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  coveralls
+  database_cleaner
+  dragonfly
+  guard
+  guard-minitest
+  minitest-rails
+  mongoid (~> 4.0)
+  rake
+  simple_form_attachments!

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Celizna
+
+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.md

@@ -0,0 +1,207 @@
+# SimpleFormAttachments
+
+[![Build Status](https://travis-ci.org/tomasc/simple_form_attachments.svg)](https://travis-ci.org/tomasc/simple_form_attachments) [![Gem Version](https://badge.fury.io/rb/simple_form_attachments.svg)](http://badge.fury.io/rb/simple_form_attachments) [![Coverage Status](https://img.shields.io/coveralls/tomasc/simple_form_attachments.svg)](https://coveralls.io/r/tomasc/simple_form_attachments)
+
+A Rails engine for creating Attachments using the [jQuery File Upload](https://github.com/blueimp/jQuery-File-Upload) plugin.
+
+Dependencies:
+* [Mongoid](http://mongoid.org)
+* [Simple Form](https://github.com/plataformatec/simple_form)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_form_attachments'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_form_attachments
+
+Add `simple_form_attachments following to `application.js`:
+
+    //= require simple_form_attachments
+
+## Usage
+
+### Attachment model
+
+Create a model for your attachments that includes the `SimpleFormAttachments::Attachment` concern:
+
+```ruby
+class AttachmentImage
+  include SimpleFormAttachments::Attachment
+end
+```
+
+This adds a `:temporary` Boolean field and two scopes: `temporary` and `permanent` to the model.
+
+Note that the concern does not include any specific accessors (ie Dragonfly). You need to define those yourself in your model.
+
+#### Validations
+
+Standard Rails validation errors are displayed in the uploader, should the uploaded file not pass the validations defined on the attachment model.
+
+### Owner model
+
+Add the `SimpleFormAttachments::HasAttachments` concern to the attachment owner. This includes the mongoid relation macros `has_one_attachment` and `has_many_attachments`:
+
+```ruby
+class Parent
+  include Mongoid::Document
+  include SimpleFormAttachments::HasAttachments
+
+  has_one_attachment :attachment_pdf, class_name: 'AttachmentPdf'
+  has_many_attachments :attachment_images, class_name: 'AttachmentImage'
+end
+```
+
+Relations between the parent and Attachment are referenced, not embedded. The gem uses `belongs_to` for 1–1 relations and `has_and_belongs_to_many` for 1–n relations. This is to ensure that relations work with embedded parents, since the relations need to be stored on the owner's side.
+
+You could use for example the `before_save` callback to embed the attachments yourself.
+
+#### Callbacks
+
+Since attachments can be added/removed dynamically in the form, we need to indicate which ones are actually submitted in the end, so that we can – immediately or later – delete the temporary ones.
+
+For that each relation defines a method named after the relation name, which can be called for example via a callback:
+
+```ruby
+after_save :mark_attachment_pdf_permanent
+after_save :mark_attachment_images_permanent
+```
+
+These methods (atomically) set the attachment's `:temporary` attribute to `false`.
+
+Alternatively the `mark_all_attachments_permanent` method can be used to loop through all attachment relations, triggering individual abovementioned methods. This means the two `after_save` callbacks above can be replaced with:
+
+```ruby
+after_save :mark_all_attachments_permanent
+```
+
+#### Validations
+
+If you want to validate the number of attachments allowed on the owner, you can use for example the following validation. Eventual validation errors will be displayed to the user when submitting the parent form.
+
+```ruby
+validates :attachment_pdfs, length: { maximum: 2 }
+```
+
+### Routes
+
+Mount the engine in your routes:
+
+```ruby
+  mount SimpleFormAttachments::Engine => "/"
+```
+
+This will include a default `/attachments` route.
+
+### Forms
+
+Now you can use the attachment input in your SimpleForm forms:
+
+```ruby
+= form.input :attachment_images, as: :attachment
+```
+
+## Configuration
+
+### Sorting
+
+Sorting of attachments is turned on by default for `has_many_attachments` relations. But it's possible to disable sorting on a field:
+
+```slim
+= f.input :attachment_images, as: :attachment, sortable: false
+```
+
+### Views
+
+Uploaded attachments are displayed in a `table`. The gem will look for a partial using the normal rails partial lookup (with a fallback to the default partial), this makes it easy to define a partial for each of your attachment models.
+
+Here is an example partial for a model called `AttachmentImage`:
+```slim
+/ app/views/simple_form_attachments/attachment_images/_attachment_image.html.slim
+/ Note the simple_form_attachments prefix!
+
+td.thumb
+  div.thumb
+    = image_tag attachment.thumb_url, alt: attachment.file_name
+
+td.file_info
+  = link_to attachment.file_name, attachment.file.url
+  span.mime_type = attachment.file_mime_type
+  span.size = attachment.file_size
+
+- if attachment.errors.to_a.any?
+  td.errors = render 'simple_form_attachments/errors', errors: attachment.errors.to_a
+
+- else
+  td.fields
+    = fields.input :caption
+```
+
+
+#### Validation errors
+
+If you want to show validation errors in your partial, simply include the `simple_form_attachments/errors` partial as shown above.
+
+### Route
+
+You can customize the engine to use a different controller and route, for example should you want to preprocess the uploaded files or determine the attachment model based on file mime/extension/format, ….
+
+Setup a controller for your attachments:
+
+```ruby
+class AttachmentsController < SimpleFormAttachments::UploadController
+  # The default controller uses the attachment type passed from the form input
+  # to determine which Attachment class to create.
+  #
+  # This can be easily overriden, for instance if you want to determine
+  # the class from the `mime type` of the file:
+  #
+  def attachment_class
+    mime_type = params[:attachment][:file].content_type
+    # TODO: very smart code to determine the class from the mime_type
+  end
+end
+```
+
+Add route as usual:
+
+```ruby
+resources :attachments, only: [:create]
+```
+
+Specify the route either app wide in an initializer:
+
+```ruby
+require 'simple_form_attachments'
+# Configuration
+
+SimpleFormAttachments::AttachmentInput.configure do |c|
+  c.route = attachments_path
+end
+```
+
+Or per input:
+
+```slim
+= f.input :attachment_images, as: :attachment, route: attachments_path
+```
+
+## Testing
+
+Besides a `MiniTest` test suite, the gem has a dummy app located at `test/dummy`. Simply `cd` into the directory and run `bin rails s` to test the uploader.
+
+## Contributing
+
+1. Fork it ( https://github.com/tomasc/simple_form_attachments/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request