jekyll-avatar 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a22ab2c587db15659207e8bda5a6f1b26f5040516a865023e56e7de08b79564
-  data.tar.gz: 9e96126073cb90638e4d7222d754a137736117a63af230b50e9f9e778f5e66e3
+  metadata.gz: 59a9a3637415d5b08eab35b0c56c43282eb55d0d068ecbcee79e7aefb38af288
+  data.tar.gz: ae037ea80d6f45c2443a7cfa560633cd32dd6de06476083e48abf898e41e5cb8
 SHA512:
-  metadata.gz: 5627bdf38d43d0c59764fd15d807eae1fdadf27c5b8eaf744adf49f46ab18f47b961c91ada518e02d4344a0e8e39ee79a0f9b457eeeb703549e11f6e00e30172
-  data.tar.gz: 2ce4d723bec13ff6386d2d773efad6c039f6ab73bfd44f3797184bf53fefad6fd0ab71839a3407e8400e79ab57f1eb51b8ac71265600b8ea07422ac3f2c943d4
+  metadata.gz: 3a3d603193c1c92e9b98a78f58899b4c2d6ae39666509a87f4ab43028ae993c4901246a644b45406955b19acbab58072d2e26cf6973b44988c269659a717101e
+  data.tar.gz: 7f1a6ca837d81f451acf8a86d4ee6560734978e5b2071163424ad8a9f1ec2babae36678aef9e421eb50245276814b22ece3434e653f8f9f7e43b49e65a5082d6

data/README.md

@@ -2,7 +2,7 @@
 
 *A Jekyll plugin for rendering GitHub avatars*
 
-[![Build Status](https://travis-ci.org/benbalter/jekyll-avatar.svg)](https://travis-ci.org/benbalter/jekyll-avatar)
+[![CI](https://github.com/jekyll/jekyll-avatar/actions/workflows/ci.yml/badge.svg)](https://github.com/jekyll/jekyll-avatar/actions/workflows/ci.yml)
 
 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. It even automatically upgrades users to Retina images, when supported.
 
@@ -62,7 +62,7 @@ You can also pass the username as a variable, like this:
 
 ```
 {% assign user="hubot" %}
-{% avatar {{ username }} %}
+{% avatar {{ user }} %}
 ```
 
 Or, if the variable is someplace a bit more complex, like a loop:

data/lib/jekyll-avatar/version.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Liquid; class Tag; end; end
+
 module Jekyll
   class Avatar < Liquid::Tag
-    VERSION = "0.7.0".freeze
+    VERSION = "0.8.0"
   end
 end

data/lib/jekyll-avatar.rb

@@ -4,39 +4,61 @@ require "zlib"
 
 module Jekyll
   class Avatar < Liquid::Tag
-    include Jekyll::LiquidExtensions
+    def self.generate_template_with(keys)
+      attrs = (BASE_ATTRIBUTES + keys).map! { |key| %(#{key}="%<#{key}>s") }.join(" ")
+      "<img #{attrs} />"
+    end
+    private_class_method :generate_template_with
+
+    #
 
     SERVERS      = 4
-    DEFAULT_SIZE = 40
-    API_VERSION  = 3
+    DEFAULT_SIZE = "40"
+    API_VERSION  = "3"
+
+    BASE_ATTRIBUTES = %w(
+      class alt width height data-proofer-ignore src
+    ).freeze
+
+    BASE_TEMPLATE = generate_template_with %w(srcset)
+    LAZY_TEMPLATE = generate_template_with %w(data-src data-srcset)
+
+    private_constant :BASE_ATTRIBUTES, :BASE_TEMPLATE, :LAZY_TEMPLATE
 
     def initialize(_tag_name, text, _tokens)
       super
-      @text = text
+      @text = text.strip
+      @markup = Liquid::Template.parse(@text)
+
+      @size = compute_size
+      @user_variable = extract_user_variable
+
+      @custom_host = ENV["PAGES_AVATARS_URL"]
+      @custom_host = "" unless @custom_host.is_a?(String)
     end
 
     def render(context)
       @context = context
-      @text    = Liquid::Template.parse(@text).render(@context)
-      attrs    = attributes.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")
-      "<img #{attrs} />"
+      @text    = @markup.render(@context)
+      template = lazy_load? ? LAZY_TEMPLATE : BASE_TEMPLATE
+      format(template, attributes)
     end
 
     private
 
     def attributes
       result = {
-        :class                => classes,
-        :alt                  => username,
-        :width                => size,
-        :height               => size,
-        "data-proofer-ignore" => true
+        :class                 => classes,
+        :alt                   => username,
+        :width                 => size,
+        :height                => size,
+        :"data-proofer-ignore" => "true",
       }
 
       if lazy_load?
         result[:src] = ""
-        result["data-src"] = url
-        result["data-srcset"] = srcset
+        result[:"data-src"] = url
+        result[:"data-srcset"] = srcset
       else
         result[:src] = url
         result[:srcset] = srcset
@@ -49,22 +71,45 @@ module Jekyll
       @text.include?("lazy=true")
     end
 
+    def extract_user_variable
+      matches = @text.match(%r!\buser=([\w.]+)\b!)
+      matches[1] if matches
+    end
+
     def username
-      matches = @text.match(%r!\buser=([\w\.]+)\b!)
-      if matches
-        lookup_variable(@context, matches[1])
+      return lookup_variable(@user_variable) if @user_variable
+
+      result = @text.include?(" ") ? @text.split(" ")[0] : @text
+      result.start_with?("@") ? result.sub("@", "") : result
+    end
+
+    # Lookup a Liquid variable in the current context.
+    #
+    # variable - the variable name, as a string.
+    #
+    # Returns the value of the variable in the context or the variable name if not found.
+    def lookup_variable(variable)
+      lookup = @context
+      if variable.include?(".")
+        variable.split(".").each do |value|
+          lookup = lookup[value]
+        end
       else
-        @text.split(" ").first.sub("@", "")
+        lookup = lookup[variable]
       end
+
+      lookup || variable
     end
 
-    def size
+    # Returns a string value
+    def compute_size
       matches = @text.match(%r!\bsize=(\d+)\b!i)
-      matches ? matches[1].to_i : DEFAULT_SIZE
+      matches ? matches[1] : DEFAULT_SIZE
     end
+    attr_reader :size
 
     def path(scale = 1)
-      "#{username}?v=#{API_VERSION}&s=#{size * scale}"
+      "#{username}?v=#{API_VERSION}&s=#{scale == 1 ? size : (size.to_i * scale)}"
     end
 
     def server_number
@@ -72,10 +117,10 @@ module Jekyll
     end
 
     def host
-      if ENV["PAGES_AVATARS_URL"].is_a?(String) && !ENV["PAGES_AVATARS_URL"].empty?
-        ENV["PAGES_AVATARS_URL"]
-      else
+      if @custom_host.empty?
         "https://avatars#{server_number}.githubusercontent.com"
+      else
+        @custom_host
       end
     end
 
@@ -84,20 +129,29 @@ module Jekyll
       @parsed_host[host] ||= Addressable::URI.parse(host)
     end
 
-    def url(scale = 1)
+    def url_with_custom_host(scale = 1)
       uri = parsed_host
       uri.path << "/" unless uri.path.end_with?("/")
       uri = uri.join path(scale)
       uri.to_s
     end
 
+    def url(scale = 1)
+      return url_with_custom_host(scale) unless @custom_host.empty?
+
+      "#{host}/#{path(scale)}"
+    end
+
+    SCALES = %w(1 2 3 4).freeze
+    private_constant :SCALES
+
     def srcset
-      (1..4).map { |scale| "#{url(scale)} #{scale}x" }.join(", ")
+      SCALES.map { |scale| "#{url(scale.to_i)} #{scale}x" }.join(", ")
     end
 
     # See http://primercss.io/avatars/#small-avatars
     def classes
-      size < 48 ? "avatar avatar-small" : "avatar"
+      size.to_i < 48 ? "avatar avatar-small" : "avatar"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-avatar
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -51,19 +51,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +98,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.0'
 description: 
 email:
 - ben.balter@github.com
@@ -113,34 +127,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/config.yml"
-- ".github/funding.yml"
-- ".github/no-response.yml"
-- ".github/release-drafter.yml"
-- ".github/settings.yml"
-- ".github/stale.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- docs/CODE_OF_CONDUCT.md
-- docs/CONTRIBUTING.md
-- docs/SECURITY.md
-- jekyll-avatar.gemspec
 - lib/jekyll-avatar.rb
 - lib/jekyll-avatar/version.rb
-- script/bootstrap
-- script/cibuild
-homepage: https://github.com/benbalter/jekyll-avatar
+homepage: https://github.com/jekyll/jekyll-avatar
 licenses:
 - MIT
 metadata: {}
@@ -152,14 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin for rendering GitHub avatars

data/.github/CODEOWNERS

@@ -1,3 +0,0 @@
-# Require @benbalter's :+1: for changes to the .github repo-config files
-# mainly due to https://github.com/probot/settings privilege escalation
-.github/* @benbalter

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-### Describe the bug
-
-A clear and concise description of what the bug is.
-
-### Steps to reproduce the behavior
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-### Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-### Screenshots
-
-If applicable, add screenshots to help explain your problem.
-
-### Additional context
-
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,21 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-### Is your feature request related to a problem? Please describe the problem you're trying to solve.
-
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-### Describe the solution you'd like
-
-A clear and concise description of what you want to happen.
-
-### Describe alternatives you've considered
-
-A clear and concise description of any alternative solutions or features you've considered.
-
-### Additional context
-
-Add any other context or screenshots about the feature request here.

data/.github/config.yml

@@ -1,23 +0,0 @@
-# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-# Configuration for update-docs - https://github.com/behaviorbot/update-docs
-updateDocsComment: "Thanks for the pull request! If you are making any changes to the user-facing functionality, please be sure to update the documentation in the `README` or `docs/` folder alongside your change. :heart:"
-
-# Configuration for request-info - https://github.com/behaviorbot/request-info
-requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
-requestInfoLabelToAdd: more-information-needed
-
-# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
-#newIssueWelcomeComment: >
-#  Welcome!
-
-# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
-newPRWelcomeComment: Welcome! Congrats on your first pull request to Jekyll Avatar. If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/benbalter/jekyll-avatar/blob/master/docs/CONTRIBUTING.md).
-
-# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
-firstPRMergeComment: "Congrats on getting your first pull request to Jekyll Avatar merged! Without amazing humans like you submitting pull requests, we couldn’t run this project. You rock! :tada:<br /><br />If you're interested in tackling another bug or feature, take a look at [the open issues](https://github.com/benbalter/jekyll-avatar/issues), especially those [labeled `help wanted`](https://github.com/benbalter/jekyll-avatar/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)."
-
-# Bug workaround
-contact_links: []

data/.github/funding.yml

@@ -1 +0,0 @@
-patreon: benbalter

data/.github/no-response.yml

@@ -1,15 +0,0 @@
-# Configuration for probot-no-response - https://github.com/probot/no-response
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-# Number of days of inactivity before an Issue is closed for lack of response
-daysUntilClose: 14
-# Label requiring a response
-responseRequiredLabel: more-information-needed
-# Comment to post when closing an Issue for lack of response. Set to `false` to disable
-closeComment: >
-  This issue has been automatically closed because there has been no response
-  to our request for more information from the original author. With only the
-  information that is currently in the issue, we don't have enough information
-  to take action. Please reach out if you have or find the answers we need so
-  that we can investigate further.

data/.github/release-drafter.yml

@@ -1,4 +0,0 @@
-template: |
-  ## What's Changed
-
-  $CHANGES

data/.github/settings.yml

@@ -1,33 +0,0 @@
-# Repository settings set via https://github.com/probot/settings
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-repository:
-  has_issues: true
-  has_wiki: false
-  has_projects: false
-  has_downloads: false
-
-labels:
-  - name: help wanted
-    oldname: help-wanted
-    color: 0e8a16
-  - name: more-information-needed
-    color: d93f0b
-  - name: bug
-    color: b60205
-  - name: feature
-    color: 1d76db
-  - name: good first issue
-    color: "5319e7"
-
-# Not currently implemented by probot/settings, but manually implemented in script/deploy
-branch_protection:
-  restrictions: null
-  enforce_admins: false
-  required_status_checks:
-    strict: true
-    contexts:
-      - "continuous-integration/travis-ci"
-  required_pull_request_reviews:
-    require_code_owner_reviews: true

data/.github/stale.yml

@@ -1,29 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-# Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 60
-
-# Number of days of inactivity before a stale Issue or Pull Request is closed
-daysUntilClose: 7
-
-# Issues or Pull Requests with these labels will never be considered stale
-exemptLabels:
-  - pinned
-  - security
-
-# Label to use when marking as stale
-staleLabel: wontfix
-
-# Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-
-# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
-closeComment: false
-
-# Limit to only `issues` or `pulls`
-# only: issues

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -1,19 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-require: rubocop-jekyll
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
-
-Naming/FileName:
-  Enabled: false
-
-Metrics/LineLength:
-  Exclude:
-    - spec/*/**
-
-Metrics/BlockLength:
-  Enabled: false
-
-AllCops:
-  Exclude:
-    - vendor/**/*

data/.rubocop_todo.yml

@@ -1,46 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-04-18 23:25:25 +0530 using RuboCop version 0.66.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'spec/jekyll/avatar_spec.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: braces, no_braces, context_dependent
-Style/BracesAroundHashParameters:
-  Exclude:
-    - 'spec/jekyll/avatar_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-    - 'jekyll-avatar.gemspec'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantFreeze:
-  Exclude:
-    - 'lib/jekyll-avatar/version.rb'
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/jekyll-avatar.rb'
-    - 'spec/jekyll/avatar_spec.rb'

data/.ruby-version

@@ -1 +0,0 @@
-2.5.3

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-cache: bundler
-script: script/cibuild
-env:
-  matrix:
-    - JEKYLL_VERSION="~> 3.0"
-    - JEKYLL_VERSION=">= 4.0.0.pre.alpha1"

data/Gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]

data/Rakefile

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

data/docs/CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ben@balter.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/docs/CONTRIBUTING.md

@@ -1,85 +0,0 @@
-# Contributing to Jekyll Avatar
-
-Hi there! We're thrilled that you'd like to contribute to Jekyll Avatar. Your help is essential for keeping it great.
-
-Jekyll Avatar is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into Jekyll Avatar itself.
-
-Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
-
-
-
-## How to report a bug
-
-Think you found a bug? Please check [the list of open issues](https://github.com/benbalter/jekyll-avatar/issues) to see if your bug has already been reported. If it hasn't please [submit a new issue](https://github.com/benbalter/jekyll-avatar/issues/new).
-
-Here are a few tips for writing *great* bug reports:
-
-* Describe the specific problem (e.g., "widget doesn't turn clockwise" versus "getting an error")
-* Include the steps to reproduce the bug, what you expected to happen, and what happened instead
-* Check that you are using the latest version of the project and its dependencies
-* Include what version of the project your using, as well as any relevant dependencies
-* Only include one bug per issue. If you have discovered two bugs, please file two issues
-* Include screenshots or screencasts whenever possible
-* Even if you don't know how to fix the bug, including a failing test may help others track it down
-
-**If you find a security vulnerability, do not open an issue. Please email ben@balter.com instead.**
-
-## How to suggest a feature or enhancement
-
-If you find yourself wishing for a feature that doesn't exist in Jekyll Avatar, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Jekyll Avatar has today have been added because our users saw the need.
-
-Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you're trying to solve.
-
-[Open an issue](https://github.com/benbalter/jekyll-avatar/issues/new) which describes the feature you would like to see, why you want it, how it should work, etc.
-
-
-
-## Your first contribution
-
-We'd love for you to contribute to the project. Unsure where to begin contributing to Jekyll Avatar? You can start by looking through these "good first issue" and "help wanted" issues:
-
-* [Good first issues](https://github.com/benbalter/jekyll-avatar/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two
-* [Help wanted issues](https://github.com/benbalter/jekyll-avatar/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions
-
-*p.s. Feel free to ask for help; everyone is a beginner at first* :smiley_cat:
-
-## How to propose changes
-
-Here's a few general guidelines for proposing changes:
-
-* If you are changing any user-facing functionality, please be sure to update the documentation
-* If you are adding a new behavior or changing an existing behavior, please be sure to update the corresponding test(s)
-* Each pull request should implement **one** feature or bug fix. If you want to add or fix more than one thing, submit more than one pull request
-* Do not commit changes to files that are irrelevant to your feature or bug fix
-* Don't bump the version number in your pull request (it will be bumped prior to release)
-* Write [a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
-
-At a high level, [the process for proposing changes](https://guides.github.com/introduction/flow/) is:
-
-1. [Fork](https://github.com/benbalter/jekyll-avatar/fork) and clone the project
-2. Configure and install the dependencies: `script/bootstrap`
-3. Make sure the tests pass on your machine: `script/cibuild`
-4. Create a descriptively named branch: `git checkout -b my-branch-name`
-5. Make your change, add tests and documentation, and make sure the tests still pass
-6. Push to your fork and [submit a pull request](https://github.com/benbalter/jekyll-avatar/compare) describing your change
-7. Pat your self on the back and wait for your pull request to be reviewed and merged
-
-**Interesting in submitting your first Pull Request?** It's easy! You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
-
-## Bootstrapping your local development environment
-
-`script/bootstrap`
-
-## Running tests
-
-`script/cibuild`
-
-## Code of conduct
-
-This project is governed by [the Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
-
-## Additional Resources
-
-* [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
-* [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
-* [GitHub Help](https://help.github.com)

data/docs/SECURITY.md

@@ -1,3 +0,0 @@
-# Security Policy
-
-To report a security vulnerability, please email [ben@balter.com](mailto:ben@balter.com).

data/jekyll-avatar.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-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", ">= 3.0", "< 5.0"
-  spec.add_development_dependency "bundler", "> 1.0", "< 3.0"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-html-matchers", "~> 0.9"
-  spec.add_development_dependency "rubocop-jekyll", "~> 0.10.0"
-end

data/script/bootstrap

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

data/script/cibuild

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