ActiveStorageBase64
Gem used to add support for base64 images for Rails's ActiveStorage.
Getting Started
In order to get the gem working on your project you just need to add the gem to your project like this:
gem 'active_storage_base64'
Prerequisites
The only two prerequisites for using this gem are having Rails version 5.2.0 or higher installed on your project and having ActiveStorage setup properly (for more information on how to do this, check this Active Storage Overview)
gem 'rails', '5.2.0'
Installing
In order to use the gem's functionality, you'll need to include the module into your ActiveRecord inheriting class. For example:
class User < ActiveRecord::Base
include ActiveStorageSupport::SupportForBase64
end
Note: We highly recomment using an alternative class that inherits from ActiveRecord and includes the module so instead of including the module for each of your classes, you make them inherit from this new class, check below:
class ApplicationRecord < ActiveRecord::Base
include ActiveStorageSupport::SupportForBase64
end
class User < ApplicationRecord
has_one_base64_attached :avatar
end
After you have the module included in your class you'll be able to use the following two helper methods for working with base64 files: When you need a single image attached:
has_one_base64_attached
and when you need multiple files attached:
has_many_base64_attached
These helpers will work just like the has_one_attached
and has_many_attached
helper methods from ActiveStorage.
A working example for this, assuming we have a model User
with only an avatar
attached would be:
class User < ActiveRecord::Base
include ActiveStorageSupport::SupportForBase64
has_one_base64_attached :avatar
end
on your controller you could do something like this:
class UsersController < ApplicationController
def create
user = User.create(user_params)
user.avatar.attach(data: params[:avatar])
end
private
def user_params
params.require(:user).permit(:username, :email)
end
end
Here's another option to achieve the same:
class UsersController < ApplicationController
def create
user = User.create(user_params)
user.avatar = { data: params[:avatar] }
end
private
def user_params
params.require(:user).permit(:username, :email)
end
end
Specifying a filename or content_type
If you are willing to add a specific filename to your attachment, or send in a specific content_type for your file, you can use data:
to attach the base64 data and specify your filename:
, content_type:
and/or identify:
hash keys.
Check the following example:
class UsersController < ApplicationController
def create
user = User.create(user_params)
user.avatar.attach(data: params[:avatar], filename: 'your_filename', content_type: 'content/type', identify: 'false')
end
private
def user_params
params.require(:user).permit(:username, :email)
end
end
For more information on how to work with ActiveStorage, please check the Active Storage Overview mentioned above, all points in there apply to this gem as well.
Contributing
Please read our CONTRIBUTING and our CODE_OF_CONDUCT files for details on our code of conduct, and the process for submitting pull requests to us.
Author
Ricardo Cortio
License
This project is licensed under the MIT License - see the LICENSE file for details
Acknowledgments
Special thanks to the people who helped with guidance and ensuring code quality in this project: Santiago Bartesaghi, Santiago Vidal and Matias Mansilla.
Credits
Active Storage Base64 is maintained by Rootstrap with the help of our contributors.