Add avatars to ActiveRecord models
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
app
lib
vendor/assets/stylesheets
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DEPRECATIONS.md
Gemfile
LICENSE
README.md
Rakefile
avatari.gemspec
package.json

README.md

Avatari

Gem Version

Avatari extends CarrierWave to make adding avatars to ActiveRecord models super simple.


Table of Contents


Installation

Avatari works with Rails 5 onwards. You can add it to your Gemfile with:

gem 'avatari'

And then execute:

$ bundle

Or install it yourself as:

$ gem install avatari

If you always want to be up to date fetch the latest from GitHub in your Gemfile:

gem 'avatari', github: 'jonhue/avatari'

Now run the generator:

$ rails g avatari

Add the stylesheet to the asset pipeline:

/*
 *= require avatari
 */

Note: If you are using Webpack instead of Sprockets, import from the avatari NPM package.

Lastly, add Avatari to an ActiveRecord model:

class User < ApplicationRecord
    avatari
end

Usage

CarrierWave

To backup CarrierWave add an avatar column (string) to every ActiveRecord model's database table you are using Avatari on.

The avatar attribute can be used like any other CarrierWave instance.

Avatari makes some assumptions about your CarrierWave integration. For Avatari to work properly after installation, Fog and MiniMagick have to be set up. However they can be unrequired when configuring Avatari.

Avatari preprocesses uploaded avatars by default:

  • raw (800x800)
  • big (350x350)
  • medium (100x100)
  • small (75x75)
  • tiny (50x50)
  • mini (40x40)

Models

You can add Avatari to an ActiveRecord model:

class User < ApplicationRecord
    avatari
end

You can also pass an initials option, which specifies an attribute or instance method that returns initials used for placeholder avatars if no custom avatar has been uploaded yet:

class User < ApplicationRecord
    avatari :initials

    def initials
        [self.first_name, self.last_name].join(' ')
    end
end

By default Avatari manipulates the passed initials: only the first characters of the first two words will be used as initials:

'Jonas Hübotter'
=> 'JH'
'jonas hübotter'
=> 'JH'
'jonas hübotter and someone else'
=> 'JH'

Note: When rendering an avatar and you did not provide the initials option + no avatar has been uploaded yet, the helper method will return false.

To add custom background colors to your placeholder avatars, pass the colors option:

class User < ApplicationRecord
    avatari colors: ['#000000', '#333333']
end

For every instance of the class, Avatari will pick a sample of the array of provided background colors. The default for every instance is #000000.

To attach a picked color to a given record permanently, you will also have to add an avatar_color string column to your database tables.

There is a variety of other options you can pass to further configure Avatari. Here are the defaults:

class User < ApplicationRecord
    avatari colors: ['#000000'], versions: {
        mini: [40,40],
        tiny: [50,50],
        small: [75,75],
        medium: [100,100],
        big: [350,350],
        raw: [800,800]
    }, default_version: nil, process: [800,800], extension_whitelist: ['jpg','jpeg','png']
end

Views

To render an avatar in your view, utilize the avatari helper method:

= component 'avatari/avatar', object: current_user

You can also specify a size:

= component 'avatari/avatar', object: current_user, version: :tiny

You are able to check whether or not an avatar can be rendered:

- if avatari? current_user
    = component 'avatari/avatar', object: current_user

Configuration

You can configure Avatari by passing a block to configure. This can be done in config/initializers/avatari.rb:

Avatari.configure do |config|
    config.default_version = :medium
end

default_version Default version to be used when rendering avatars. Takes a symbol. Defaults to :medium.

mini_magick Whether or not to include MiniMagick. Required for processing file versions. Takes a boolean. Defaults to true.

storage Choose you default storage option for CarrierWave. Accepts :file or :fog. Defaults to :fog.


To Do

Here is the full list of current projects.

To propose your ideas, initiate the discussion by adding a new issue.


Contributing

We hope that you will consider contributing to Avatari. Please read this short overview for some information about how to get started:

Learn more about contributing to this repository, Code of Conduct

Contributors

Give the people some ❤️ who are working on this project. See them all at:

https://github.com/jonhue/avatari/graphs/contributors

Semantic Versioning

Avatari follows Semantic Versioning 2.0 as defined at http://semver.org.

License

MIT License

Copyright (c) 2017 Jonas Hübotter

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.