bridgetown-avatar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b6b01033705ed1fc334ae96ff1532a12ba38e283696eeebc570a0e691d1ec20
+  data.tar.gz: 683cbffcfb5a32b87be632c068d0c7760a0fdf6daadc80154e120b6905e8e3b8
+SHA512:
+  metadata.gz: fcf015c1a23eb1a6556c4aaa7df803a8bee347b7550e9c8faf2a8f14bae135561d6c04c9bb13f356274b292ad4c155481651c265f151ff1a92380b4438bd7ea3
+  data.tar.gz: e4180b1851ebc08b515e187d77ab8147d40a09888e7aba8c278b72e04862a3a99125de7f15eb6eb04ee401cf53ba39eab2a3dad745bda3b9fad0232b2766bd08

data/.gitignore

@@ -0,0 +1,38 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# master
+
+* Use this file to keep track of plugin updates
+
+# 0.1.0 / 2020-05-01
+
+* First version

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,57 @@
+# Bridgetown-Avatar
+
+very simple port of [Jekyll Avatar](https://github.com/benbalter/jekyll-avatar)
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgetown-avatar -g bridgetown_plugins
+```
+
+## Usage
+
+```liquid
+{% avatar github %}
+```
+
+or assign the user in a variable:
+
+```liquid
+{% assign user=github %}
+{% avatar %}
+```
+
+Specify a size:
+
+```liquid
+{% avatar github size=128 %}
+```
+
+## Testing
+
+* Run `bundle exec rspec` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and test with rspec together.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+----
+
+## Releasing (you can delete this section in your own plugin repo)
+
+To release a new version of the plugin, simply bump up the version number in both `version.rb` and
+`package.json`, and then run `script/release`. This will require you to have a registered account
+with both the [RubyGems.org](https://rubygems.org) and [NPM](https://www.npmjs.com) registries.
+You can optionally remove the `package.json` and `frontend` folder if you don't need to package frontend
+assets for Webpack.
+
+If you run into any problems or need further guidance, please check out our [Bridgetown community resources](https://www.bridgetownrb.com/docs/community)
+where friendly folks are standing by to help you build and release your plugin or theme.

data/Rakefile

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

data/bridgetown-avatar.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-avatar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-avatar"
+  spec.version       = BridgetownAvatar::VERSION
+  spec.author        = "Julian Rubisch"
+  spec.email         = "julian.rubisch@hey.com"
+  spec.summary       = "Liquid tag to insert a Github avatar"
+  spec.homepage      = "https://github.com/username/bridgetown-avatar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+  spec.metadata      = { "yarn-add" => "bridgetown-avatar@#{BridgetownAvatar::VERSION}" }
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.15", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/components/bridgetown_avatar/layout_help.liquid

@@ -0,0 +1 @@
+<p>Just use <code>layout: bridgetown_avatar/layout</code> in your page's front matter.</p>

data/content/bridgetown_avatar/example_page.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Example Page
+---
+
+If all goes well, this page will be accessible as [`{{ page.url }}`]({{ page.url }}), and you will see a photo of a train:
+
+![Train on Rails]({{ "/bridgetown_avatar/train-on-rails.jpeg" | relative_url }})

data/layouts/bridgetown_avatar/layout.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+<p>You can include this layout in your site! 🥳</p>
+
+{% render "bridgetown_avatar/layout_help" %}
+
+{{ content }}

data/lib/bridgetown-avatar.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-avatar/builder"
+
+Bridgetown::PluginManager.new_source_manifest(
+  origin: BridgetownAvatar,
+  components: File.expand_path("../components", __dir__),
+  content: File.expand_path("../content", __dir__),
+  layouts: File.expand_path("../layouts", __dir__)
+)

data/lib/bridgetown-avatar/builder.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+module BridgetownAvatar
+  class Builder < Bridgetown::Builder
+    DEFAULT_SIZE = "40"
+    API_VERSION  = "3"
+    SERVERS      = 4
+
+    attr_reader :size
+
+    def build
+      liquid_tag "avatar" do |attributes, tag|
+        @attributes = attributes # .split(",").map(&:strip)
+        @size = compute_size
+        @context = tag.context
+
+        "<img src=\"#{url}\" class=\"#{classes}\"/>"
+      end
+    end
+
+    private
+
+    def compute_size
+      matches = @attributes.match(%r!\bsize=(\d+)\b!i)
+      matches ? matches[1] : DEFAULT_SIZE
+    end
+
+    def username
+      return @context["user"] if @context["user"]
+
+      result = @attributes.include?(" ") ? @attributes.split(" ")[0] : @attributes
+      result.start_with?("@") ? result.sub("@", "") : result
+    end
+
+    def path(scale = 1)
+      "#{username}?v=#{API_VERSION}&s=#{scale == 1 ? size : (size.to_i * scale)}"
+    end
+
+    def url(scale = 1)
+      "#{host}/#{path(scale)}"
+    end
+
+    def server_number
+      Zlib.crc32(path) % SERVERS
+    end
+
+    def host
+      "https://avatars#{server_number}.githubusercontent.com"
+    end
+
+    SCALES = %w(1 2 3 4).freeze
+    private_constant :SCALES
+
+    def srcset
+      SCALES.map { |scale| "#{url(scale.to_i)} #{scale}x" }.join(", ")
+    end
+
+    # See http://primercss.io/avatars/#small-avatars
+    def classes
+      size.to_i < 48 ? "avatar avatar-small" : "avatar"
+    end
+  end
+end
+
+BridgetownAvatar::Builder.register

data/lib/bridgetown-avatar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownAvatar
+  VERSION = "0.1.0"
+end

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "bridgetown-avatar",
+  "version": "0.1.0",
+  "main": "frontend/javascript/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/username/bridgetown-avatar.git"
+  },
+  "author": "Bridgetown Maintainers <maintainers@bridgetownrb.com>",
+  "homepage": "https://www.bridgetownrb.com",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "frontend"
+  ]
+}

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-avatar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Rubisch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description:
+email: julian.rubisch@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-avatar.gemspec
+- components/bridgetown_avatar/layout_help.liquid
+- content/bridgetown_avatar/example_page.md
+- content/bridgetown_avatar/train-on-rails.jpeg
+- layouts/bridgetown_avatar/layout.html
+- lib/bridgetown-avatar.rb
+- lib/bridgetown-avatar/builder.rb
+- lib/bridgetown-avatar/version.rb
+- package.json
+homepage: https://github.com/username/bridgetown-avatar
+licenses:
+- MIT
+metadata:
+  yarn-add: bridgetown-avatar@0.1.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Liquid tag to insert a Github avatar
+test_files: []