jekyll-avatar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1ffaa6227e8d8af1956bd5fa211db46c0c9e18b
+  data.tar.gz: 6a27c7b962f4c7b9ab42020f74c7c2cb28bc13e0
+SHA512:
+  metadata.gz: e6b4b4b1b792cd6f0652531769e075d66f7aa281e155812f125260d7afff0e3521babd17ffe67dc986d3630784bce13e75cb08aebe1a2998c08d9460f299d2cf
+  data.tar.gz: ce5472feed3584cc3df9041728c1d9f9ea911ed8d14cec2deadf89f8bf3319d132838ba0946b6a8d1734af63cc22a1834008de2fc1a36a188b35360cd3c011fc

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,10 @@
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/Documentation:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true

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 jekyll-avatar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,54 @@
+# Jekyll Avatar
+
+*A Jekyll plugin for rendering GitHub avatars*
+
+Jekyll Avatar makes it easy to add GitHub avatars to your Jekyll site by specifying a username. If performance is a concern, Jekyll Avatar is deeply integrated with the GitHub avatar API, ensuring avatars are cached and load in parallel.
+
+## Installation
+
+Add the following to your site's `Gemfile`:
+
+```ruby
+gem 'jekyll-avatar'
+```
+
+And add the following to your site's `_config.yml` file:
+
+```yaml
+gems:
+  - jekyll-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" width="40" height="40" />
+```
+
+### Customizing
+
+You can customize the size of the resulting avatar by passing the size arugment:
+
+```
+{% avatar hubot size=25 %}
+```
+
+That will output:
+
+```html
+<img class="avatar avatar-small" src="https://avatars3.githubusercontent.com/hubot?v=3&amp;s=25" alt="hubot" width="25" height="25" />
+```

data/Rakefile

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

data/jekyll-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 'jekyll/avatar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-avatar'
+  spec.version       = Jekyll::Avatar::VERSION
+  spec.authors       = ['Ben Balter']
+  spec.email         = ['ben.balter@github.com']
+
+  spec.summary       = 'A Jekyll plugin for rendering GitHub avatars'
+  spec.homepage      = 'https://github.com/benbalter/jekyll-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 'jekyll', '>= 2.4'
+  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/jekyll/avatar.rb

@@ -0,0 +1,61 @@
+require 'jekyll/avatar/version'
+
+module Jekyll
+  class Avatar < Liquid::Tag
+    SERVERS = 4
+    DEFAULT_SIZE = 40
+    VERSION = 3
+
+    def initialize(tag_name, text, tokens)
+      super
+      @text = text
+    end
+
+    def render(_context)
+      tag = '<img '
+
+      # See http://primercss.io/avatars/#small-avatars
+      if size < 48
+        tag << 'class="avatar avatar-small" '
+      else
+        tag << 'class="avatar" '
+      end
+
+      tag << "src=\"#{url}\" alt=\"#{username}\" "
+      tag << "width=\"#{size}\" height=\"#{size}\" "
+      tag << '/>'
+      tag
+    end
+
+    private
+
+    def username
+      @username ||= @text.split(' ').first.sub('@', '')
+    end
+
+    def size
+      @size ||= begin
+        matches = @text.match(/\bsize=(\d+)\b/i)
+        matches ? matches[1].to_i : DEFAULT_SIZE
+      end
+    end
+
+    def path
+      @path ||= "#{username}?v=#{VERSION}&s=#{size}"
+    end
+
+    def server_number
+      @server_number ||= Zlib.crc32(path) % SERVERS
+    end
+
+    def host
+      @host ||= "avatars#{server_number}.githubusercontent.com"
+    end
+
+    def url
+      @url ||= "https://#{host}/#{path}"
+    end
+  end
+end
+
+Liquid::Template.register_tag('avatar', Jekyll::Avatar)

data/lib/jekyll/avatar/version.rb

@@ -0,0 +1,6 @@
+module Liquid; class Tag; end; end
+module Jekyll
+  class Avatar < Liquid::Tag
+    VERSION = '0.1.0'
+  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,128 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-avatar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-avatar.gemspec
+- lib/jekyll/avatar.rb
+- lib/jekyll/avatar/version.rb
+- script/bootstrap
+- script/cibuild
+homepage: https://github.com/benbalter/jekyll-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.5.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin for rendering GitHub avatars
+test_files: []