Simple Images
Add simple one-click image uploading to active record models.
Requires ruby >= 1.9.3
Requires rails >= 4.0.0
Installation
Add this line to your application’s Gemfile:
ruby
gem 'simple_images'
And then execute:
$ bundle
Or install it yourself as:
$ gem install simple_images
Run the generator to create the migration, initializer and simple_image model files:
$ rails g simple_images
Migrate the database:
$ rake db:migrate
Usage
Image Model
This will be generated and placed in your app/models folder:
ruby
class SimpleImage
include SimpleImages::ImageAdditions
end
You can add any custom functionality to the Message model here.
Imageable Model
Add the appropriate line to the top of your activerecord model:
ruby
class Article
has_simple_images
end
Add the routes for the resource as well:
ruby
resources :articles
resources :simple_images, shallow: true, only: [:create, :update, :destroy]
end
The class is not restricted to Article, it can be any class you add has_simple_images to.
Configuration
In the created initializer:
config/initializers/simple_images.rb
You will find some configuration options availible. Edit this file and restart you server to have the changes take effect.
User and CanCan Integration
If you have a current_user it will assign the created image to that user.
Otherwise it will be nil.
If you are using cancan it will pick that up for the 3 controller methods and check authorization respectively
ruby
authorize! :create, @simple_image
authorize! :update, @simple_image
authorize! :destroy, @simple_image
Helpers
The point of this gem is to have dead simple image uploading anywhere in your app.
An image must be associated to an active record model. If you want all images to be availible to all things just pick an arbitrary object that you are not going to destroy (such as first user) and associate all images with that record.
Include the javascript file in your application.js manifest. If you want the basic, page reloading functionality:
//= require simple_images/uploader
Or the AJAX uploader using jquery.fileupload:
//= require simple_images/ajax_uploader
If you are using the AJAX uploader, you MUST have a file in views/simple_images/create.js.erb
and views/simple_images/update.js.erb with what to do after the form is submitted.
An example of create:
<% if @simple_image.new_record? %>
alert("Failed to upload simple image: <%= j @simple_image.errors.full_messages.join(', ').html_safe %>");
<% else %>
$("#simple_images").append("<%= j render(@simple_image) %>");
<% end %>
Include the stylesheet in your application.css manifest:
/*
*= require simple_images/uploader
*/
You can omit the stylesheet if you want to style your own upload button from scratch
In your views you can call the following methods:
<%= render_simple_images_edit_link_for(image) %>
<%= render_simple_images_destroy_link_for(image) %>
<%= render_simple_images_actions_for(image) %>
<%= render_simple_images_form_for(imageable) %>
which should be pretty straight forward.
Creating Images
Simply click on the ‘Add Image’ Button and select a file to upload.
If your controller responds to current_user then it will be assigned to the image.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request