Merge pull request #13 from benbalter/enterprise-support

Add support for GitHub Enterprise

Author: benbalter

.rubocop.yml

@@ -7,3 +7,10 @@ Style/FileName:
 Metrics/LineLength:
   Exclude:
     - spec/*/**
+
+Metrics/BlockLength:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - vendor/**/*

Gemfile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in jekyll-avatar.gemspec
 gemspec

README.md

@@ -72,3 +72,12 @@ Or, if the variable is someplace a bit more complex, like a loop:
   {% avatar user=employee %}
 {% endfor %}
 ```
+
+### Using with GitHub Enterprise
+
+To use Jekyll Avatars with GitHub Enterprise, you must set the `PAGES_AVATARS_URL` environmental variable.
+
+This should be the full URL to the avatars subdomain or subpath. For example:
+
+* With subdomain isolation: `PAGES_AVATARS_URL="https://avatars.github.example.com"`
+* Without subdomain isolation: `PAGES_AVATARS_URL="https://github.example.com/avatars"` 

Rakefile

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :default => :spec

jekyll-avatar.gemspec

@@ -1,28 +1,29 @@
 # coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll-avatar/version'
+require "jekyll-avatar/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'jekyll-avatar'
+  spec.name          = "jekyll-avatar"
   spec.version       = Jekyll::Avatar::VERSION
-  spec.authors       = ['Ben Balter']
-  spec.email         = ['[email protected]']
+  spec.authors       = ["Ben Balter"]
+  spec.email         = ["[email protected]"]
 
-  spec.summary       = 'A Jekyll plugin for rendering GitHub avatars'
-  spec.homepage      = 'https://github.com/benbalter/jekyll-avatar'
-  spec.license       = 'MIT'
+  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)/})
+    file.match(%r!^(test|spec|features)/!)
   end
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'jekyll', '~> 3.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'
+  spec.add_dependency "jekyll", "~> 3.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

lib/jekyll-avatar.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "zlib"
 
 module Jekyll
@@ -31,7 +32,7 @@ def attributes
         :srcset               => srcset,
         :width                => size,
         :height               => size,
-        "data-proofer-ignore" => true
+        "data-proofer-ignore" => true,
       }
     end
 
@@ -58,11 +59,17 @@ def server_number
     end
 
     def host
-      "avatars#{server_number}.githubusercontent.com"
+      if ENV["PAGES_AVATARS_URL"].to_s.empty?
+        "https://avatars#{server_number}.githubusercontent.com"
+      else
+        ENV["PAGES_AVATARS_URL"]
+      end
     end
 
     def url(scale = 1)
-      "https://#{host}/#{path(scale)}"
+      uri = Addressable::URI.parse host
+      uri.path << "/" unless uri.path.end_with?("/")
+      uri.join path(scale)
     end
 
     def srcset

lib/jekyll-avatar/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Liquid; class Tag; end; end
 module Jekyll
   class Avatar < Liquid::Tag

spec/jekyll/avatar_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 describe Jekyll::Avatar do
@@ -8,11 +9,13 @@
   let(:text) { "#{username} #{args}".squeeze(" ") }
   let(:content) { "{% avatar #{text} %}" }
   let(:rendered) { subject.render(nil) }
+  let(:tokenizer) { Liquid::Tokenizer.new("") }
+  let(:parse_context) { Liquid::ParseContext.new }
   let(:output) do
     doc.content = content
     doc.output  = Jekyll::Renderer.new(doc.site, doc).run
   end
-  subject { Jekyll::Avatar.send(:new, "avatar", text, nil) }
+  subject { described_class.parse "avatar", text, tokenizer, parse_context }
 
   it "has a version number" do
     expect(Jekyll::Avatar::VERSION).not_to be nil
@@ -40,7 +43,32 @@
   end
 
   it "builds the host" do
-    expect(subject.send(:host)).to eql("avatars3.githubusercontent.com")
+    expect(subject.send(:host)).to eql("https://avatars3.githubusercontent.com")
+  end
+
+  context "with a custom host" do
+    context "with subdomain isolation" do
+      it "builds the host" do
+        with_env("PAGES_AVATARS_URL", "http://avatars.example.com") do
+          expect(subject.send(:host)).to eql("http://avatars.example.com")
+        end
+      end
+
+      it "builds the URL" do
+        with_env("PAGES_AVATARS_URL", "http://avatars.example.com") do
+          expect(subject.send(:url).to_s).to eql("http://avatars.example.com/hubot?v=3&s=40")
+        end
+      end
+    end
+
+    context "without subdomain isolation" do
+      it "builds the URL" do
+        with_env("PAGES_AVATARS_URL", "http://github.example.com/avatars/") do
+          expected = "http://github.example.com/avatars/hubot?v=3&s=40"
+          expect(subject.send(:url).to_s).to eql(expected)
+        end
+      end
+    end
   end
 
   it "builds the path" do
@@ -53,14 +81,14 @@
 
   it "builds the URL" do
     expected = "https://avatars3.githubusercontent.com/hubot?v=3&s=40"
-    expect(subject.send(:url)).to eql(expected)
+    expect(subject.send(:url).to_s).to eql(expected)
   end
 
   it "builds the params" do
     attrs = subject.send(:attributes)
     expect(attrs[:class]).to eql("avatar avatar-small")
     expect(attrs[:alt]).to eql("hubot")
-    expect(attrs[:src]).to eql("https://avatars3.githubusercontent.com/hubot?v=3&s=40")
+    expect(attrs[:src].to_s).to eql("https://avatars3.githubusercontent.com/hubot?v=3&s=40")
     expect(attrs[:width]).to eql(40)
     expect(attrs[:height]).to eql(40)
   end
@@ -76,7 +104,7 @@
 
     it "builds the URL with a scale" do
       expected = "https://avatars3.githubusercontent.com/hubot?v=3&s=80"
-      expect(subject.send(:url, 2)).to eql(expected)
+      expect(subject.send(:url, 2).to_s).to eql(expected)
     end
 
     it "builds the srcset" do

spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "jekyll"
@@ -45,3 +46,11 @@ def fixture(name)
   path = File.expand_path "./fixtures/#{name}.json", File.dirname(__FILE__)
   File.open(path).read
 end
+
+def with_env(key, value)
+  old_value = ENV[key]
+  ENV[key] = value
+  yield
+ensure
+  ENV[key] = old_value
+end