avatari 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58d6762f5d16be413ff91cf6cef2aed554b7e61d1123c3c0e916ec2b8c658b37
-  data.tar.gz: e51d50a4bd162966c840d6adf724b87957a8516751da32766936bb8d43e52646
+  metadata.gz: 60d011079934dc01108eefb33a033e31c01153c97415b9c229cb3998bb72de2f
+  data.tar.gz: 8949fd84c3d2408942560fa9b109e1b99b5a1a238f748a459ff6970c413f10d9
 SHA512:
-  metadata.gz: 74b7f808676b6115e4f25c94a247b4e98551f8a2191e02a3c5733a9bd26dd57f1f8a14d5673992325aa0612b2b5b96c72fb53230c37352d31c0396534fa9b583
-  data.tar.gz: d3050c08d7f3faf5ccba1adc8a823d9d7e7c7ddbe798985db0dab8acfe1830c9df3a6f8e6133001b8971187bc1878ab3a12be06a4bfe997b74c2f325aba9a2ec
+  metadata.gz: 60ca63d49fd416274b0ed2f4e1233211bab53a88df33138f3f475b443c6b88b3d874edaa6e640d33c81851c161d8129793e9a8111be62ca0d5d8e8162c588d77
+  data.tar.gz: 14509ef9c79be2c99ed575f590098330745337df56b57d4bd1b7bb237f1bb83d0c20c27866169f69ca141f82db2256d5b1ffbed569d197ddfd43bb594df6aa71

data/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 * nothing yet
 
-### 1.0.0 - 2018/01/06
+### 1.1.0 - 2018/01/08
+
+* features
+    * add generator with initializer to allow configuration of Avatari
+    * introduce `Avatari::Avatar` instances associated with ActiveRecord classes
+* enhancements
+    * automatically fetch first letters from passed initials accessor
+    * allow to override the default version for a specific class
+    * customize image formats and preprocessed versions
+    * unrequire Fog & MiniMagick
+* bugfixes
+    * fixed dependencies
+
+### 1.0.0 - 2018/01/07
 
 * initial release

data/README.md

@@ -14,6 +14,7 @@ Avatari extends [CarrierWave](https://github.com/carrierwaveuploader/carrierwave
     * [CarrierWave](#carrierwave)
     * [Models](#models)
     * [Views](#views)
+* [Configuration](#configuration)
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
@@ -44,6 +45,10 @@ If you always want to be up to date fetch the latest from GitHub in your `Gemfil
 gem 'avatari', github: 'jonhue/avatari'
 ```
 
+Now run the generator:
+
+    $ rails g avatari
+
 ## Usage
 
 ### Assets
@@ -60,7 +65,7 @@ To render Avatari avatars, you have to require the necessary assets to be added
  */
 ```
 
-**Note:** You can override the [styles](vendor/assets/stylesheets/avitari.sass) when you are looking for a custom integration.
+**Note:** You can override the [styles](vendor/assets/stylesheets/avatari.sass) when you are looking for a custom integration.
 
 ### CarrierWave
 
@@ -68,9 +73,9 @@ To backup CarrierWave add an `avatar` column (`string`) to every ActiveRecord mo
 
 The `avatar` attribute can be used like any other CarrierWave instance.
 
-Avatari makes some assumptions about your CarrierWave integration. For Avatari to work properly, [Fog](https://github.com/carrierwaveuploader/carrierwave#fog) and [MiniMagick](https://github.com/minimagick/minimagick) have to be set up.
+Avatari makes some assumptions about your CarrierWave integration. For Avatari to work properly after installation, [Fog](https://github.com/carrierwaveuploader/carrierwave#fog) and [MiniMagick](https://github.com/minimagick/minimagick) have to be set up. However they can be unrequired when [configuring](#configuration) Avatari.
 
-Avatari preprocesses uploaded avatars:
+Avatari preprocesses uploaded avatars by default:
 
 * `raw` (800x800)
 * `big` (350x350)
@@ -79,8 +84,6 @@ Avatari preprocesses uploaded avatars:
 * `tiny` (50x50)
 * `mini` (40x40)
 
-It accepts images in `jpg`, `jpeg` and `png` format.
-
 ### Models
 
 You can add Avatari to an ActiveRecord model:
@@ -98,11 +101,22 @@ class User < ApplicationRecord
     avatari :initials
 
     def initials
-        self.first_name[0] + self.last_name[0]
+        [self.first_name, self.last_name].join(' ')
     end
 end
 ```
 
+By default Avatari manipulates the passed initials: only the first characters of the first two word will be used as initials:
+
+```
+'Jonas Hübotter'
+=> 'JH'
+'jonas hübotter'
+=> 'JH'
+'jonas hübotter and someone else'
+=> 'JH'
+```
+
 **Note:** When [rendering](#views) 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:
@@ -117,6 +131,21 @@ For every instance of the class, Avatari will pick a sample of the array of prov
 
 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:
+
+```ruby
+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:
@@ -131,7 +160,23 @@ You can also specify a size:
 = avatari current_user, :tiny
 ```
 
-The `size` of the rendered avatar defaults to `:medium`.
+---
+
+## Configuration
+
+You can configure Avatari by passing a block to `configure`. This can be done in `config/initializers/avatari.rb`:
+
+```ruby
+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`.
 
 ---
 

data/app/helpers/avatari/avatar_helper.rb

@@ -1,11 +1,14 @@
 module Avatari
     module AvatarHelper
 
-        def avatari object, version = :medium
+        def avatari object, version = nil
+            version ||= object.class.avatari_instance.default_version || ::Avatari.configuration.default_version
+            version = version.to_s
+
             if object.avatar?
-                image_tag object.avatar.url, class: 'avatari avatari--' + version.to_s
-            elsif !object.class.avatari_initials.nil?
-                render partial: 'avatari/avatar', locals: { object: object, version: version.to_s }
+                image_tag object.avatar.url, class: 'avatari avatari--' + version
+            elsif !object.class.avatari_instance.initials(object).nil?
+                render partial: 'avatari/avatar', locals: { object: object, version: version }
             else
                 false
             end

data/app/models/concerns/avatari/model.rb

@@ -5,31 +5,20 @@ module Avatari
 
         def avatari_color
             if defined?(self.avatar_color)
-                self.update_attributes(avatar_color: self.class.avatari_colors.sample) if self.avatar_color.nil?
+                self.update_attributes(avatar_color: self.class.avatari_instance.colors.sample) if self.avatar_color.nil?
                 self.avatar_color
             else
-                self.class.avatari_colors.sample
+                self.class.avatari_instance.colors.sample
             end
         end
 
         module ClassMethods
+            attr_accessor :avatari_instance
 
-            attr_accessor :avatari_colors
-            attr_accessor :avatari_initials
-
-            def avatari initials = nil, options = {}
-                defaults = {
-                    colors: nil
-                }
-                defaults.merge! options
-
-                self.avatari_colors = options[:colors] || ['#000000']
-                self.avatari_initials = initials
-
-                serialize :avatar_color, Array
+            def avatari initials_method = nil, options = {}
+                self.avatari_instance = ::Avatari::Avatar.new initials_method, options
                 mount_uploader :avatar, ::Avatari::AvatarUploader
             end
-
         end
 
     end

data/app/uploaders/avatari/avatar_uploader.rb

@@ -1,48 +1,29 @@
 class Avatari::AvatarUploader < CarrierWave::Uploader::Base
 
-    # Include MiniMagick support:
-    include CarrierWave::MiniMagick
+    include CarrierWave::MiniMagick if ::Avatari.configuration&.mini_magick
 
-    # Choose AWS as file storage:
-    storage :fog
+    storage ::Avatari.configuration&.storage || :fog
 
-    # Override the directory where uploaded files will be stored.
-    # This is a sensible default for uploaders that are meant to be mounted:
     def store_dir
         "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
-
-    # Process files as they are uploaded:
-    process scale: [800, 800]
-
-    # Create different versions of your uploaded files:
-    version :raw do
-        process resize_to_fill: [800, 800]
-    end
-
-    version :big, from_version: :raw do
-        process resize_to_fill: [350, 350]
-    end
-
-    version :medium, from_version: :big do
-        process resize_to_fill: [100, 100]
-    end
-
-    version :small, from_version: :medium do
-        process resize_to_fill: [75, 75]
+    def extension_whitelist
+        model.class.avatari_instance.extension_whitelist
     end
 
-    version :tiny, from_version: :small do
-        process resize_to_fill: [50, 50]
-    end
+    process :avatari_processing
+    process :avatari_versioning
 
-    version :mini, from_version: :tiny do
-        process resize_to_fill: [40, 40]
+    def avatari_processing
+        process(scale: model.class.avatari_instance.process) unless model.class.avatari_instance.process.nil?
     end
-
-    # White list of extensions which are allowed to be uploaded:
-    def extension_whitelist
-        %w(jpg jpeg png)
+    def avatari_versioning
+        return if model.class.avatari_instance.versions.nil?
+        model.class.avatari_instance.versions.each do |name, size|
+            version name.to_sym do
+                process resize_to_fill: size.to_a
+            end
+        end
     end
 
 end

data/app/views/avatari/_avatar.html.erb

@@ -1,3 +1,3 @@
-<div class="<%= 'avatari avatari--' + version %>" style="background: <%= object.avatari_color %>;">
-    <span class="initials"><%= object.send(object.class.avatari_initials) %></span>
+<div class="<%= 'avatari avatari--' + version %>" style="width: <%= object.class.avatari_instance.versions[version.to_sym].first / 16 %>rem; height: <%= object.class.avatari_instance.versions[version.to_sym].last / 16 %>rem; background: <%= object.avatari_color %>;">
+    <span class="initials" style="font-size: <%= object.class.avatari_instance.versions[version.to_sym].first / 50 %>rem;"><%= object.class.avatari_instance.initials(object) %></span>
 </div>

data/lib/avatari/avatar.rb

@@ -0,0 +1,43 @@
+module Avatari
+    class Avatar
+
+        attr_accessor :initials_method
+        attr_accessor :colors
+        attr_accessor :versions
+        attr_accessor :default_version
+        attr_accessor :process
+        attr_accessor :extension_whitelist
+
+        def initialize initials_method = nil, options = {}
+            defaults = {
+                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']
+            }
+            options = defaults.merge! options
+
+            @initials_method = initials_method
+            @colors = options[:colors]
+            @versions = options[:versions]
+            @default_version = options[:default_version]
+            @process = options[:process]
+            @extension_whitelist = options[:extension_whitelist]
+        end
+
+        def initials object
+            raw = object.send(self.initials_method)
+            r = ''; raw.nil? ? nil : raw.split(' ').first(2).each { |n| r += n[0].upcase }
+            return r
+        end
+
+    end
+end

data/lib/avatari/configuration.rb

@@ -0,0 +1,26 @@
+module Avatari
+
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    class Configuration
+
+        attr_accessor :default_version
+        attr_accessor :mini_magick
+        attr_accessor :storage
+
+        def initialize
+            @default_version = :medium
+            @mini_magick = true
+            @storage = :fog
+        end
+
+    end
+
+end

data/lib/avatari/version.rb

@@ -1,5 +1,5 @@
 module Avatari
 
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
 
 end

data/lib/avatari.rb

@@ -2,6 +2,10 @@ require 'avatari/version'
 
 module Avatari
 
+    require 'avatari/configuration'
+
+    autoload :Avatar, 'avatari/avatar'
+
     require 'avatari/engine'
     require 'avatari/railtie'
 

data/lib/generators/avatari_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AvatariGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install avatari'
+
+    def create_initializer
+        template 'initializer.rb', 'config/initializers/avatari.rb'
+    end
+
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,12 @@
+Avatari.configure do |config|
+
+    # Default version to be used when rendering avatars. Takes a symbol.
+    # config.default_version = :medium
+
+    # Whether or not to include MiniMagick. Required for processing file versions. Takes a boolean.
+    # config.mini_magick = true
+
+    # Choose you default storage option for CarrierWave. Accepts `:file` or `:fog`.
+    # config.storage = :fog
+
+end

data/vendor/assets/stylesheets/avatari.min.css

@@ -1 +1 @@
-.avatari--mini{width:px(40);height:px(40);display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari--mini>.initials{font-size:px(16);line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}.avatari--tiny{width:px(50);height:px(50);display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari--tiny>.initials{font-size:px(16);line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}.avatari--small{width:px(75);height:px(75);display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari--small>.initials{font-size:px(24);line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}.avatari{width:px(100);height:px(100);display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari>.initials{font-size:px(32);line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}.avatari--big{width:px(350);height:px(350);display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari--big>.initials{font-size:px(74);line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}.avatari--raw{width:px(800);height:px(800);display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari--raw>.initials{font-size:px(160);line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}
+.avatari{display:flex;justify-content:center;align-items:center;border-radius:50%;-webkit-border-radius:50%;-moz-border-radius:50%}.avatari>.initials{line-height:1;color:white;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-weight:600}

data/vendor/assets/stylesheets/avatari.sass

@@ -1,6 +1,4 @@
-@mixin avatar($size, $font)
-    width: $size
-    height: $size
+.avatari
     display: flex
     justify-content: center
     align-items: center
@@ -8,21 +6,7 @@
     -webkit-border-radius: 50%
     -moz-border-radius: 50%
     & > .initials
-        font-size: $font
         line-height: 1
         color: white
         font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"
         font-weight: 600
-
-.avatari--mini
-    @include avatar(px(40), px(16))
-.avatari--tiny
-    @include avatar(px(50), px(16))
-.avatari--small
-    @include avatar(px(75), px(24))
-.avatari--medium
-    @include avatar(px(100), px(32))
-.avatari--big
-    @include avatar(px(350), px(74))
-.avatari--raw
-    @include avatar(px(800), px(160))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avatari
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonas Hübotter
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: carrierwave
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +94,13 @@ files:
 - app/uploaders/avatari/avatar_uploader.rb
 - app/views/avatari/_avatar.html.erb
 - lib/avatari.rb
+- lib/avatari/avatar.rb
+- lib/avatari/configuration.rb
 - lib/avatari/engine.rb
 - lib/avatari/railtie.rb
 - lib/avatari/version.rb
+- lib/generators/avatari_generator.rb
+- lib/generators/templates/initializer.rb
 - vendor/assets/stylesheets/avatari.min.css
 - vendor/assets/stylesheets/avatari.sass
 homepage: https://github.com/jonhue/avatari