avatari 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58d6762f5d16be413ff91cf6cef2aed554b7e61d1123c3c0e916ec2b8c658b37
+  data.tar.gz: e51d50a4bd162966c840d6adf724b87957a8516751da32766936bb8d43e52646
+SHA512:
+  metadata.gz: 74b7f808676b6115e4f25c94a247b4e98551f8a2191e02a3c5733a9bd26dd57f1f8a14d5673992325aa0612b2b5b96c72fb53230c37352d31c0396534fa9b583
+  data.tar.gz: d3050c08d7f3faf5ccba1adc8a823d9d7e7c7ddbe798985db0dab8acfe1830c9df3a6f8e6133001b8971187bc1878ab3a12be06a4bfe997b74c2f325aba9a2ec

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/06
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 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.

data/README.md

@@ -0,0 +1,184 @@
+# Avatari
+
+[![Gem Version](https://badge.fury.io/rb/avatari.svg)](https://badge.fury.io/rb/avatari) <img src="https://travis-ci.org/jonhue/avatari.svg?branch=master" />
+
+Avatari extends [CarrierWave](https://github.com/carrierwaveuploader/carrierwave) to make adding avatars to ActiveRecord models super simple.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Assets](#assets)
+    * [CarrierWave](#carrierwave)
+    * [Models](#models)
+    * [Views](#views)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+Avatari works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+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`:
+
+```ruby
+gem 'avatari', github: 'jonhue/avatari'
+```
+
+## Usage
+
+### Assets
+
+To render Avatari avatars, you have to require the necessary assets to be added to your asset pipeline:
+
+```js
+//= require avitari
+```
+
+```css
+/*
+ *= require avitari.min
+ */
+```
+
+**Note:** You can override the [styles](vendor/assets/stylesheets/avitari.sass) when you are looking for a custom integration.
+
+### 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, [Fog](https://github.com/carrierwaveuploader/carrierwave#fog) and [MiniMagick](https://github.com/minimagick/minimagick) have to be set up.
+
+Avatari preprocesses uploaded avatars:
+
+* `raw` (800x800)
+* `big` (350x350)
+* `medium` (100x100)
+* `small` (75x75)
+* `tiny` (50x50)
+* `mini` (40x40)
+
+It accepts images in `jpg`, `jpeg` and `png` format.
+
+### Models
+
+You can add Avatari to an ActiveRecord model:
+
+```ruby
+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:
+
+```ruby
+class User < ApplicationRecord
+    avatari :initials
+
+    def initials
+        self.first_name[0] + self.last_name[0]
+    end
+end
+```
+
+**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:
+
+```ruby
+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.
+
+### Views
+
+To render an avatar in your view, utilize the `avatari` helper method:
+
+```haml
+= avatari current_user
+```
+
+You can also specify a size:
+
+```haml
+= avatari current_user, :tiny
+```
+
+The `size` of the rendered avatar defaults to `:medium`.
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/avatari/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/avatari/issues/new).
+
+---
+
+## 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](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: 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.

data/app/helpers/avatari/avatar_helper.rb

@@ -0,0 +1,15 @@
+module Avatari
+    module AvatarHelper
+
+        def avatari object, version = :medium
+            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 }
+            else
+                false
+            end
+        end
+
+    end
+end

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

@@ -0,0 +1,36 @@
+module Avatari
+    module Model
+
+        extend ActiveSupport::Concern
+
+        def avatari_color
+            if defined?(self.avatar_color)
+                self.update_attributes(avatar_color: self.class.avatari_colors.sample) if self.avatar_color.nil?
+                self.avatar_color
+            else
+                self.class.avatari_colors.sample
+            end
+        end
+
+        module ClassMethods
+
+            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
+                mount_uploader :avatar, ::Avatari::AvatarUploader
+            end
+
+        end
+
+    end
+end

data/app/uploaders/avatari/avatar_uploader.rb

@@ -0,0 +1,48 @@
+class Avatari::AvatarUploader < CarrierWave::Uploader::Base
+
+    # Include MiniMagick support:
+    include CarrierWave::MiniMagick
+
+    # Choose AWS as file storage:
+    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]
+    end
+
+    version :tiny, from_version: :small do
+        process resize_to_fill: [50, 50]
+    end
+
+    version :mini, from_version: :tiny do
+        process resize_to_fill: [40, 40]
+    end
+
+    # White list of extensions which are allowed to be uploaded:
+    def extension_whitelist
+        %w(jpg jpeg png)
+    end
+
+end

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

@@ -0,0 +1,3 @@
+<div class="<%= 'avatari avatari--' + version %>" style="background: <%= object.avatari_color %>;">
+    <span class="initials"><%= object.send(object.class.avatari_initials) %></span>
+</div>

data/lib/avatari.rb

@@ -0,0 +1,8 @@
+require 'avatari/version'
+
+module Avatari
+
+    require 'avatari/engine'
+    require 'avatari/railtie'
+
+end

data/lib/avatari/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/railtie'
+
+module Avatari
+    class Engine < ::Rails::Engine
+    end
+end

data/lib/avatari/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module Avatari
+    class Railtie < Rails::Railtie
+
+        initializer 'avatari.active_record' do
+            ActiveSupport.on_load :active_record do
+                include Avatari::Model
+            end
+        end
+
+    end
+end

data/lib/avatari/version.rb

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

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

@@ -0,0 +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}

data/vendor/assets/stylesheets/avatari.sass

@@ -0,0 +1,28 @@
+@mixin avatar($size, $font)
+    width: $size
+    height: $size
+    display: flex
+    justify-content: center
+    align-items: center
+    border-radius: 50%
+    -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

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: avatari
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Add avatars to ActiveRecord models.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/helpers/avatari/avatar_helper.rb
+- app/models/concerns/avatari/model.rb
+- app/uploaders/avatari/avatar_uploader.rb
+- app/views/avatari/_avatar.html.erb
+- lib/avatari.rb
+- lib/avatari/engine.rb
+- lib/avatari/railtie.rb
+- lib/avatari/version.rb
+- vendor/assets/stylesheets/avatari.min.css
+- vendor/assets/stylesheets/avatari.sass
+homepage: https://github.com/jonhue/avatari
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Add avatars to ActiveRecord models
+test_files: []