jekyll_badge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 834bd7abc2419f6afdd57c028c2eb097809fd39fbde253ef024e51f6f010a772
+  data.tar.gz: 30b2431ae996917cc61cb722052636219b339840816cde4ff37b2698c66dbbb8
+SHA512:
+  metadata.gz: 20dc2fec246c3673b629a12a0f0ec3da9a759c05707147d0fd0aa9bb7d65761e5a0722acaad42d079a3f401dfed015e7100200220ae6a05ab29b4de045cf1f80
+  data.tar.gz: 8a7a751d2e39550e62e63d7b0198656b8dc1992d1cf2d83e625e4f666728f30f6372fe7a958ccfedd0f4a424681b5c5eb3d80ef5465cc403de52063c7884a676

data/.rubocop.yml

@@ -0,0 +1,71 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 3.1.3
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_badge.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/FilePath:
+  IgnoreMethods: true
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+* Initial release.

data/README.md

@@ -0,0 +1,89 @@
+# `Badge` [![Gem Version](https://jekyll_badge.fury.io/rb/jekyll_badge.svg)](https://jekyll_badge.fury.io/rb/jekyll_badge)
+
+Displays a badge on a Jekyll page for the package showing its version.
+
+
+## Installation
+
+Add the following to your Jekyll website's `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_badge'
+end
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+
+## Usage
+
+See [demo/index.html](demo/index.html) for examples.
+
+
+### Options
+
+- `align` – Float badge `left`, `center` or `right`.
+- `class` – Override default class for generated badge (`rounded shadow`).
+- `clear` – Ensure the badge is moved below (cleared) below floating elements that precede it.
+- `git_url_base` – Override the default value specified in
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to https://rubygems.org, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mslinn/jekyll_badge.
+
+
+## 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,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'jekyll_badge/version.rb'
+  system "gem push pkg/jekyll_badge-#{JekyllBadge::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/jekyll_badge.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/jekyll_badge/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/jekyll_badge'
+
+  spec.authors               = ['Mike Slinn']
+  spec.description           = <<~END_DESC
+    Displays a badge on a Jekyll page for the package showing its version
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://www.mslinn.com/jekyll_plugins/jekyll_badge.html'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'jekyll_badge'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 3.1.0'
+  spec.summary               = 'Displays a badge on a Jekyll page for the package showing its version'
+  spec.version               = JekyllBadge::VERSION
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
+  spec.add_dependency 'ruby-link-checker'
+end

data/lib/jekyll_badge/version.rb

@@ -0,0 +1,3 @@
+module JekyllBadge
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/jekyll_badge.rb

@@ -0,0 +1,104 @@
+require 'jekyll_plugin_support'
+require 'net/http'
+require 'ruby-link-checker'
+require 'uri'
+
+require_relative 'jekyll_badge/version'
+
+class String
+  def squish
+    strip.gsub(/\s+/, ' ')
+  end
+end
+
+module JekyllBadge
+  # This class implements the jekyll_badge functionality
+  # Assumes project is stored on GitHub
+  class JekyllBadge < JekyllSupport::JekyllTag
+    PLUGIN_NAME = 'jekyll_badge'.freeze
+    VERSION = ::JekyllBadge::VERSION
+
+    def render_impl
+      @align        = @helper.parameter_specified?('align') || 'right'
+      @clear        = @helper.parameter_specified?('clear') ? 'clear' : nil
+      @class        = @helper.parameter_specified?('class') || 'rounded shadow'
+      # TODO: put this into _config.yml
+      @git_url_base = @helper.parameter_specified?('git_url_base') || 'https://github.com/mslinn'
+      @image        = @helper.parameter_specified?('image') || '/blog/images/git/github-mark'
+      @name         = @helper.parameter_specified?('name')  || @page['name']
+      @label        = @helper.parameter_specified?('label') || @name
+      @style        = @helper.parameter_specified?('style') || ''
+      @git_url      = @helper.parameter_specified?('git_url') || "#{@git_url_base}/#{@name}"
+
+      unless %w[left center right].include? @align
+        @helper.logger.warn { "Ignoring invalid align value ('#{@align}') on line #{@line_number} (plus front matter) of #{@page['name']}." }
+        @align = 'right'
+      end
+
+      if @check_links
+        check_url
+      else
+        generate_output
+      end
+    end
+
+    private
+
+    # Calling this method can slow down startup time dramatically because of HTTP timeouts
+    # Better to use this functionality in parallel, the way it was designed, instead of this
+    def check_url
+      puts 'Checking links, please wait ...'
+      @link_checker.check @git_url
+      @link_checker.results.each_pair do |_bucket, result|
+        if result
+          generate_output
+        else
+          msg = "Error: #{@git_url} is broken"
+          @helper.logger.error { msg }
+          "<span style='color: red;'>#{msg}</span>"
+        end
+      end
+    end
+
+    def generate_output
+      classes = "gem_banner #{@align} #{@class} #{@clear}".squish
+      <<~END_CONTENT
+        <div class="#{classes}" style='#{@style}'>
+          <div class="center one_column">
+            <a href='https://rubygems.org/gems/#{@name}' target='_blank' class='imgImgUrl'>
+              #{"<code class='banner_label'>#{@label}</code>" unless @label.empty?}
+              <div class='imgWrapper imgFlex center' style='margin-bottom: 0;'>
+                  <picture class='imgPicture'>
+                    <source srcset="https://badge.fury.io/rb/#{@name}.svg" type="image/webp">
+                    <source srcset="https://badge.fury.io/rb/#{@name}.svg" type="image/png">
+                    <img alt='#{@name} version'
+                      class="imgImg"
+                      src="https://badge.fury.io/rb/#{@name}.svg"
+                      style='width: 100%;'
+                      title='#{@name} version'
+                    />
+                  </picture>
+                </a>
+              </div>
+              <div class='imgWrapper imgFlex center' style='width: 120px;'>
+                <a href='https://github.com/mslinn/#{@name}' target='_blank' class='imgImgUrl'>
+                  <picture class='imgPicture'>
+                    <source srcset="#{@image}.webp" type="image/webp">
+                    <source srcset="#{@image}.png" type="image/png">
+                    <img alt='GitHub project for #{@name}'
+                      class="imgImg"
+                      src="/blog/images/git/github-mark.png"
+                      style='width: 100%;'
+                      title='Git project for #{@name}'
+                    />
+                  </picture>
+              </div>
+            </a>
+          </div>
+        </div>
+      END_CONTENT
+    end
+
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/spec/badge/badge_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/jekyll_badge'
+
+RSpec.describe Badge::Badge do
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new }
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/<%= @gem_name %>'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  # config.order = 'random'
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = '../spec/status_persistence.txt'
+
+  config.filter_run_when_matching focus: true
+end
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load_file(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      'content'     => 'blah blah',
+      'description' => 'Jekyll plugin support demo',
+      'dir'         => '/',
+      'excerpt'     => nil,
+      'layout'      => 'default',
+      'name'        => 'index.html',
+      'path'        => 'index.html',
+      'title'       => 'Welcome',
+      'url'         => '/',
+    }
+
+    @content = 'Interior of the tag'
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_badge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: ruby-link-checker
+  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: 'Displays a badge on a Jekyll page for the package showing its version
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll_badge.gemspec
+- lib/jekyll_badge.rb
+- lib/jekyll_badge/version.rb
+- spec/badge/badge_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_badge.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_badge/issues
+  changelog_uri: https://github.com/mslinn/jekyll_badge/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_badge.html
+  source_code_uri: https://github.com/mslinn/jekyll_badge
+post_install_message: |2+
+
+  Thanks for installing jekyll_badge!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Displays a badge on a Jekyll page for the package showing its version
+test_files: []
+...