jekyll-github-chart 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a840c77c3fef9bcd0750a1548b45f97a9846099ec0515e0fb1d67c9115f9377
+  data.tar.gz: 452d5bc74e7b1857007804f1bf48db21ebfceb07292f3a4529da3f2a397cb633
+SHA512:
+  metadata.gz: 2788316e37f107dbcbb5ede8eceb9cf265bc06f294d0219f55dd599c61efba92522a8b0bf0072d2a7e681c5c43599a4e9d41e5a8f64b3968094230d73c544916
+  data.tar.gz: 8f0943bf01dd3a4bc0c97ec897c3e282997cffca51f20ddb00dc9eeb3bdbd617b794326c80070a6c00d875fad7194cfdc177ab3e116e6b6f547f79a1711ecb2b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll_github_chart.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    jekyll_github_chart (0.1.0)
+      githubchart (~> 3.1.0)
+      jekyll
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    basiccache (1.0.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.6)
+    curb (0.9.10)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.13.1)
+    forwardable-extended (2.6.0)
+    githubchart (3.1.0)
+      githubstats (~> 2.0.0)
+      svgplot (~> 1.0.0)
+    githubstats (2.0.0)
+      basiccache (~> 1.0.0)
+      curb (~> 0.9.0)
+      nokogiri (~> 1.8.0)
+    http_parser.rb (0.6.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.1.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 1.8)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.5)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rouge (3.21.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    svgplot (1.0.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll_github_chart!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 kinduff
+
+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,73 @@
+# Jekyll Github Chart
+
+[![Gem Version](https://img.shields.io/gem/v/jekyll-github-chart.svg)](https://rubygems.org/gems/jekyll-github-chart)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
+
+This Jekyll plugin provides a tag that takes a Github user and returns either an image or a raw SVG of the contribution graph.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_github_chart'
+end
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install jekyll_github_chart
+```
+
+Finally, call the plugin in your `_config.yml` file.
+
+```yaml
+plugins:
+  - jekyll-github-chart
+```
+
+## Usage
+
+You can call the tag with a the defaults like this.
+
+```
+{% github_chart username %}
+```
+
+This will generate an HTML `img` tag with an SVG encoded as a data URI. For example:
+
+```
+<img src='data:image/svg+xml;charset=utf-8,...' class='github-contributions' alt='username\'s Github contributions' />
+```
+
+There are 3 color schemes available: `default`, `old`, and `halloween`.
+
+```
+{% github_chart username halloween %}
+```
+
+Finally, if you don't want an `img` tag, you can pass a format argument to have a raw SVG output.
+
+```
+{% github_chart username halloween raw %}
+```
+
+## Special thanks
+Thanks to [@akerl](https://github.com/akerl) for creating the [githubchart](https://github.com/akerl/githubchart) gem which is the foundation of this plugin.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kinduff/jekyll-github-chart.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll-github-chart.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/jekyll-github-chart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-github-chart"
+  spec.version       = JekyllGithubChart::VERSION
+  spec.authors       = ["kinduff"]
+  spec.email         = ["abarcadabra@gmail.com"]
+
+  spec.summary       = %q{Generate an SVG of Github contributions data for Jekyll}
+  spec.description   = %q{Uses GithubChart to convert a liquid tag into a Github contribution SVG}
+  spec.homepage      = "https://github.com/kinduff/jekyll-github-chart"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kinduff/jekyll-github-chart"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_runtime_dependency 'githubchart', '~> 3.1.0'
+  spec.add_runtime_dependency 'jekyll'
+end

data/lib/jekyll-github-chart.rb

@@ -0,0 +1,31 @@
+require "jekyll"
+require "githubchart"
+require "jekyll-github-chart/version"
+
+module Jekyll
+  module JekyllGithubChart
+    class JekyllGithubChartTag < Liquid::Tag
+      def initialize(tag_name, text, tokens)
+        super
+        opts = text.split(' ').map(&:strip)
+        @user = opts[0]
+        @scheme = opts[1] || 'default' # old, halloween
+        @format = opts[2] || 'image' # raw
+      end
+
+      def render(context)
+        raw_svg = GithubChart.new({ user: @user, colors: @scheme.to_sym }).render(:svg)
+
+        return raw_svg if @format == 'raw'
+
+        content_type = 'image/svg+xml'
+        encoding = 'charset=utf-8'
+        data = CGI::escape(raw_svg).gsub('+', '%20')
+
+        "<img src='data:#{content_type};#{encoding},#{data}' class='github-contributions' alt='#{@user}\'s Github contributions' />"
+      end
+
+      Liquid::Template.register_tag('github_chart', self)
+    end
+  end
+end

data/lib/jekyll-github-chart/version.rb

@@ -0,0 +1,3 @@
+module JekyllGithubChart
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-github-chart
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kinduff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: githubchart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses GithubChart to convert a liquid tag into a Github contribution SVG
+email:
+- abarcadabra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-github-chart.gemspec
+- lib/jekyll-github-chart.rb
+- lib/jekyll-github-chart/version.rb
+homepage: https://github.com/kinduff/jekyll-github-chart
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kinduff/jekyll-github-chart
+  source_code_uri: https://github.com/kinduff/jekyll-github-chart
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Generate an SVG of Github contributions data for Jekyll
+test_files: []