bunto-avatar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8385ed18d90fe2378f0f5f2b3a006f4a44dfa4e5
+  data.tar.gz: 4af75a556a285c310bd06abc224fc1ddcf1b8afb
+SHA512:
+  metadata.gz: 2244566729cb5c19382cfcb22ea6eb2ae9eb675df6ba86b7fd1d0657f770809cde3d76a74dc5b9f9824b1d5a552c4f35d3af13c748fc20fd214efbbecd7c079c
+  data.tar.gz: 26679f334829bb073d1c6b43f93ee32ecaf5f6a510baf40b99d906758f8cdb5cfb91307be634b53a2914d0009d308cbca53596456942dd601902b21f012d29e1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/Documentation:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Style/FileName:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - spec/*/**
+
+Style/DeprecatedHashMethods:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+sudo: false
+cache: bundler
+script: script/cibuild

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bunto-avatar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-present Ben Balter
+
+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,74 @@
+# Bunto Avatar
+
+*A Bunto plugin for rendering GitHub avatars*
+
+[![Build Status](https://travis-ci.org/benbalter/bunto-avatar.svg)](https://travis-ci.org/benbalter/bunto-avatar)
+
+Bunto Avatar makes it easy to add GitHub avatars to your Bunto site by specifying a username. If performance is a concern, Bunto Avatar is deeply integrated with the GitHub avatar API, ensuring avatars are cached and load in parallel. It even automatically upgrades users to Retina images, when supported.
+
+## Installation
+
+Add the following to your site's `Gemfile`:
+
+```ruby
+gem 'bunto-avatar'
+```
+
+And add the following to your site's `_config.yml` file:
+
+```yaml
+gems:
+  - bunto-avatar
+```
+
+## Usage
+
+Simply add the following, anywhere you'd like a user's avatar to appear:
+
+```
+{% avatar [USERNAME] %}
+```
+
+With `[USERNAME]` being the user's GitHub username:
+
+```
+{% avatar hubot %}
+```
+
+That will output:
+
+```html
+<img class="avatar avatar-small" src="https://avatars3.githubusercontent.com/hubot?v=3&amp;s=40" alt="hubot" srcset="https://avatars3.githubusercontent.com/hubot?v=3&amp;s=40 1x, https://avatars3.githubusercontent.com/hubot?v=3&amp;s=80 2x, https://avatars3.githubusercontent.com/hubot?v=3&amp;s=120 3x, https://avatars3.githubusercontent.com/hubot?v=3&amp;s=160 4x" width="40" height="40" />
+```
+
+### Customizing
+
+You can customize the size of the resulting avatar by passing the size argument:
+
+```
+{% avatar hubot size=50 %}
+```
+
+That will output:
+
+```html
+<img class="avatar" src="https://avatars3.githubusercontent.com/hubot?v=3&amp;s=50" alt="hubot" srcset="https://avatars3.githubusercontent.com/hubot?v=3&amp;s=50 1x, https://avatars3.githubusercontent.com/hubot?v=3&amp;s=100 2x, https://avatars3.githubusercontent.com/hubot?v=3&amp;s=150 3x, https://avatars3.githubusercontent.com/hubot?v=3&amp;s=200 4x" width="50" height="50" />
+```
+
+### Passing the username as variable
+
+You can also pass the username as a variable, like this:
+
+```
+{% assign username="hubot" %}
+{% avatar {{ username }} %}
+```
+
+Or, if the variable is someplace a bit more complex, like a loop:
+
+```
+{% assign employees = "alice|bob" | split:"|" %}
+{% for employee in employees %}
+  {% avatar user=employee %}
+{% endfor %}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bunto-avatar.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bunto-avatar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bunto-avatar'
+  spec.version       = Bunto::Avatar::VERSION
+  spec.authors       = ['Ben Balter', 'Suriyaa Kudo']
+  spec.email         = ['ben.balter@github.com', 'SuriyaaKudoIsc@users.noreply.github.com']
+
+  spec.summary       = 'A Bunto plugin for rendering GitHub avatars'
+  spec.homepage      = 'https://github.com/benbalter/bunto-avatar'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bunto', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/bunto-avatar.rb

@@ -0,0 +1,76 @@
+require 'zlib'
+
+module Bunto
+  class Avatar < Liquid::Tag
+    SERVERS      = 4
+    DEFAULT_SIZE = 40
+    API_VERSION  = 3
+
+    def initialize(_tag_name, text, _tokens)
+      super
+      @text = text
+    end
+
+    def render(context)
+      @context = context
+      @text    = Liquid::Template.parse(@text).render(@context)
+      attrs    = attributes.map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
+      "<img #{attrs} />"
+    end
+
+    private
+
+    def attributes
+      {
+        :class                 => classes,
+        :src                   => url,
+        :alt                   => username,
+        :srcset                => srcset,
+        :width                 => size,
+        :height                => size,
+        :'data-proofer-ignore' => true
+      }
+    end
+
+    def username
+      matches = @text.match(/\buser=(\w+)\b/)
+      if matches && @context.has_key?(matches[1])
+        @context[matches[1]]
+      else
+        @text.split(' ').first.sub('@', '')
+      end
+    end
+
+    def size
+      matches = @text.match(/\bsize=(\d+)\b/i)
+      matches ? matches[1].to_i : DEFAULT_SIZE
+    end
+
+    def path(scale = 1)
+      "#{username}?v=#{API_VERSION}&s=#{size * scale}"
+    end
+
+    def server_number
+      Zlib.crc32(path) % SERVERS
+    end
+
+    def host
+      "avatars#{server_number}.githubusercontent.com"
+    end
+
+    def url(scale = 1)
+      "https://#{host}/#{path(scale)}"
+    end
+
+    def srcset
+      (1..4).map { |scale| "#{url(scale)} #{scale}x" }.join(', ')
+    end
+
+    # See http://primercss.io/avatars/#small-avatars
+    def classes
+      size < 48 ? 'avatar avatar-small' : 'avatar'
+    end
+  end
+end
+
+Liquid::Template.register_tag('avatar', Bunto::Avatar)

data/lib/bunto-avatar/version.rb

@@ -0,0 +1,6 @@
+module Liquid; class Tag; end; end
+module Bunto
+  class Avatar < Liquid::Tag
+    VERSION = '1.0.0'.freeze
+  end
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle install

data/script/cibuild

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rake spec
+bundle exec rubocop

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: bunto-avatar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Balter
+- Suriyaa Kudo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben.balter@github.com
+- SuriyaaKudoIsc@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bunto-avatar.gemspec
+- lib/bunto-avatar.rb
+- lib/bunto-avatar/version.rb
+- script/bootstrap
+- script/cibuild
+homepage: https://github.com/benbalter/bunto-avatar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Bunto plugin for rendering GitHub avatars
+test_files: []