jekyll_badge 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dc433b6dce45efc5aaf8d7fa9b08af2297deb03df2fe4555e5447eb13dc619c
-  data.tar.gz: edc141bcddb90a6ddaa41c2d7665e558f9e274afa7e52c3a187b675384567622
+  metadata.gz: e81fc7035f9f6b553a5de7e442d6bc0993bffb2dfdd0680876f0fb02b460c7b9
+  data.tar.gz: 963f4b10da5e844ae15e91f3b1efa68efe06b426cdcdc5790e72dc62cfd67cbb
 SHA512:
-  metadata.gz: 4283ecec09af01e47366218fc0f76077b6b0ef3ed40effa5c034ad69c201d6a7a96239f22c6dfcf5f813a44896adfcda620305914fdf00ca552f53b5caf1f74b
-  data.tar.gz: 14a00c166c83cd464b26cbfe58d147394754b328f7479fd219293ffbcebce878a72c99db54c679f05cc2081addeb062f9ea0df8d9402b4b4062abe88b23bb48c
+  metadata.gz: 077b1d2c6671caff9b34b26ac18692d16b95284cfaeae146a632faa446f544da19a887c647e4eeed77d1efc9d4a5240931f0fd003aebec8feb4c6883ca79334b
+  data.tar.gz: db30ef57483278bb6319ec0b8a6e037bb7efefb458da0ddf05bb4959ccdfe88fd366b0c75615b976298f927e4905549f977661a8dced2be436cd5ce11c5f81bc

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   # - rubocop-jekyll
   - rubocop-md
   - rubocop-performance

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.1.3 / 2025-10-29
+
+* Added documentation for new options:
+  `alt`, `badge_svg`, `class`, `dist_url`, `git_url`, `image`, `name`, `label`,
+  `style`, `title` and `user_id`
+* Added `spec.platform` to `jekyll_badge.gemspec` because `RubyGems.org` now requires it
+* Long labels are now wrapped after underscores
+
+
 ## 0.1.2
 
 * Updated to `jekyll_plugin_support` v1.0.0

data/README.md

@@ -31,10 +31,43 @@ 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
+#### Keyword Options
+
+- `clear`    – Ensures the badge is rendered below preceding floating elements.
+- `debug`    – Display debugging information on the rendered page
+
+#### Primary Options
+
+Override these name/value options as required.
+
+- `align`    – Align badge `left`, `center` or `right`, defaults to `right`.
+- `alt`      – Alt text for badge image, also used as title for badge.
+  Defaults to `name`.
+- `class`    – Override classes for generated badge,
+  defaults to `rounded shadow`.
+- `dist_url` – Badge banner link target (download page),
+  defaults to `https://rubygems.org/gems/name`.
+- `image`    – Git repository image, without the filetype,
+  defaults to `/blog/images/git/github-mark`.
+- `name`     – name of component, defaults to the name of the enclosing page.
+- `label`    – displayed name of the badge, defaults to `name`.
+- `style`    – Additional CSS style for the badge container.
+- `title`    – Displayed text when the user hovers their mouse over the
+  badge. Defaults to the `alt` value.
+- `type`     – Type of badge to display.
+  Choices are `ruby_gem` (default) and `golang`.
+- `user_id`  – GitHub user id
+  (only required for type `golang`, defaults to `mslinn`.)
+
+#### Derived Options
+
+Derived options can be overridden, just like primary options.
+
+- `badge_svg`    – URL for badge image,
+  defaults to `https://badge.fury.io/rb/name.svg`.
+- `git_url_base` – GitHub User URL,
+  defaults to `https://github.com/mslinn`.
+- `git_url`      – Repository URL, defaults to `git_url_base/name`.
 
 
 ## Development

data/jekyll_badge.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
     'source_code_uri'   => host,
   }
   spec.name                 = 'jekyll_badge'
+  spec.platform             = Gem::Platform::RUBY
   spec.post_install_message = <<~END_MESSAGE
 
     Thanks for installing #{spec.name}!
@@ -28,6 +29,7 @@ Gem::Specification.new do |spec|
   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', '>= 1.0.0'
   spec.add_dependency 'ruby-link-checker'

data/lib/jekyll_badge/version.rb

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

data/lib/jekyll_badge.rb

@@ -19,17 +19,36 @@ module JekyllBadge
     VERSION = ::JekyllBadge::VERSION
 
     def render_impl
-      @align        = @helper.parameter_specified?('align') || 'right'
+      # Keyword options
       @clear        = @helper.parameter_specified?('clear') ? 'clear' : nil
+      @debug        = @helper.parameter_specified?('debug')
+
+      # Primary options
+      @align        = @helper.parameter_specified?('align') || 'right'
       @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'
+      @image        = @helper.parameter_specified?('image')        || '/blog/images/git/github-mark'
+      @style        = @helper.parameter_specified?('style')        || ''
+      @type         = @helper.parameter_specified?('type')         || 'ruby_gem'
+      @user_id      = @helper.parameter_specified?('user_id')      || 'mslinn'
+
+      # Derived options
       @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}"
+      @style        = "#{@style} width: 28em;".squish if @debug
 
+      # Further derived options
+      @alt          = @helper.parameter_specified?('alt')       || default_alt
+      @badge_svg    = @helper.parameter_specified?('badge_src') || default_badge_svg
+      @dist_url     = @helper.parameter_specified?('dist_url')  || default_dist_url
+      @git_url      = @helper.parameter_specified?('git_url')   || "#{@git_url_base}/#{@name}"
+
+      # Yet further derived options
+      @title        = " title='#{@alt}'" if @alt
+
+      # Tweaking
+      @label = @label.gsub('_', '_<wbr>')
       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'
@@ -38,67 +57,13 @@ module JekyllBadge
       if @check_links
         check_url
       else
-        generate_output
+        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
-      @helper.logger.info '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="#{@git_url}" 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
-
     ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
   end
 end
+
+require_relative 'jekyll_badge_private'
+require_relative 'jekyll_badge_generate'

data/lib/jekyll_badge_generate.rb

@@ -0,0 +1,61 @@
+module JekyllBadge
+  class JekyllBadge
+    private
+
+    def generate_banner
+      <<~END_CONTENT
+        <!-- Colorful badge banner with version info, links to release -->
+        #{"<code class='banner_label'>#{@label}</code>" unless @label.empty?}
+        <div class='imgWrapper imgFlex center' style='margin-bottom: 0;'>
+            <picture class='imgPicture'>
+              <source srcset="#{@badge_svg}" type="image/webp">
+              <source srcset="#{@badge_svg}" type="image/png">
+              <img alt='#{@alt}'
+                class="imgImg"
+                src="#{@badge_svg}"
+                style='width: 100%;'
+                title='#{@name}'
+              />
+            </picture>
+          </a>
+        </div>
+      END_CONTENT
+    end
+
+    def generate_remainder
+      <<~END_CONTENT
+        <!-- Remainder of badge content -->
+        <div class='imgWrapper imgFlex center' style='width: 120px;'>
+          <a class='imgImgUrl' href="#{@git_url}" target='_blank'>
+            <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>
+      END_CONTENT
+    end
+
+    def output
+      classes = "gem_banner #{@align} #{@class} #{@clear}".squish
+
+      <<~END_CONTENT
+        <div class="#{classes}" style='#{@style}'#{@title}>
+          <div class="center one_column">
+            <a class='imgImgUrl' href='#{@dist_url}' target='_blank'>
+              #{generate_banner}
+            </a>
+            <a class='imgImgUrl' href='#{@git_url}' target='_blank'>
+              #{generate_remainder}
+            </a>
+          </div>#{debug}
+        </div>#{@warning}
+      END_CONTENT
+    end
+  end
+end

data/lib/jekyll_badge_private.rb

@@ -0,0 +1,65 @@
+module JekyllBadge
+  class JekyllBadge
+    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 way
+    def check_url
+      @helper.logger.info 'Checking links, please wait ...'
+      @link_checker.check @git_url
+      @link_checker.results.each_pair do |_bucket, result|
+        if result
+          output
+        else
+          msg = "Error: #{@git_url} is broken"
+          @helper.logger.error { msg }
+          "<span style='color: red;'>#{msg}</span>"
+        end
+      end
+    end
+
+    def debug
+      return unless @debug
+
+      debug = "\n<pre>"
+      debug += "badge_svg=#{@badge_svg}\n"
+      debug += "dist_url=#{@dist_url}\n"
+      debug += "git_url_base=#{@git_url_base}\n"
+      debug += "git_url=#{@git_url}\n"
+      debug += "image=#{@image}"
+      debug += "</pre>\n"
+      debug
+    end
+
+    def default_alt
+      case @type
+      when 'ruby_gem'
+        'Latest Ruby gem'
+      when 'golang'
+        'GitHub newest release'
+      else
+        @name
+      end
+    end
+
+    def default_badge_svg
+      case @type
+      when 'ruby_gem'
+        "https://badge.fury.io/rb/#{@name}.svg"
+      when 'golang'
+        "https://img.shields.io/github/v/release/#{@user_id}/#{@name}"
+      else # This is the only place this check is made
+        @warning = "<span style='color: darkred'>Error: Type #{@type} is invalid; choices are golang and ruby_gem</span>"
+      end
+    end
+
+    def default_dist_url
+      case @type
+      when 'ruby_gem'
+        "https://rubygems.org/gems/#{@name}"
+      when 'golang'
+        "https://github.com/#{@user_id}/#{@name}/releases"
+      end
+    end
+  end
+end

data/spec/badge/badge_spec.rb

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

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'jekyll_plugin_logger'
 require 'liquid'
 require 'fileutils'
 require 'yaml'
-require_relative '../lib/<%= @gem_name %>'
+require_relative '../lib/jekyll_badge'
 
 RSpec.configure do |config|
   config.filter_run :focus

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_badge
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mike Slinn
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -68,6 +67,8 @@ files:
 - jekyll_badge.gemspec
 - lib/jekyll_badge.rb
 - lib/jekyll_badge/version.rb
+- lib/jekyll_badge_generate.rb
+- lib/jekyll_badge_private.rb
 - spec/badge/badge_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.mslinn.com/jekyll_plugins/jekyll_badge.html
@@ -97,8 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Displays a badge on a Jekyll page for the package showing its version
 test_files: []