jekyll_download_link 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad6f645b0095853aa2031c60d9a74475d671f45f717f9a26e1017e7f51ee476b
-  data.tar.gz: b381115b1bbf6d62b2face7b26f8ae10e547f25b8f97625c0f51f499b469b452
+  metadata.gz: f13f89151e4dd91b17954c09b2a414c90282d61a1ca4f9267c45552db16009a5
+  data.tar.gz: 6292c9602c4d765eebdf61ac6674b802f53b44c4a86092401da4c2555b4db715
 SHA512:
-  metadata.gz: 0bb16b7a80aa27d5bb9b6d4b4ebdba8880ee703e7848ddecdb5b3d7f118454e62847faf16557619076b4770af757ecd7dc48a3d76456f0841095951aa498f343
-  data.tar.gz: f8ae5f90324c41a832937d8cfb46ba8244d5907cf980ad8d5359018a50aa20b3206268d56f940725d29e56e557d201c83ffe5ce2194dcd6a98e42e88fede3dab
+  metadata.gz: 4d0dae22ede737128c304a47a7569bb78f8ce336e3d9b7f7d2a8f791870ceae8f5296eca7e302225a2e4b59d64482689e6aea2715773352311b0881bba465860
+  data.tar.gz: d01a17d406143c750470a929ff0a7d57e6eb62488cb1ee29cd6664e0cb8ed30b5e3db9acecc526584f3e63487441d53e95d0c6a84c5be04a01d423fe0bb86c9f

data/.rubocop.yml

@@ -1,17 +1,69 @@
-require: rubocop-jekyll
-inherit_gem:
- rubocop-jekyll: .rubocop.yml
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+# inherit_gem:
+#  rubocop-jekyll: .rubocop.yml
 
 AllCops:
   Exclude:
-      - vendor/**/*
-      - Gemfile*
-      - '*.gemspec' # This does nothing. Why?
+    - binstub/**/*
+    - vendor/**/*
+    - Gemfile*
+    - jekyll_download_link.gemspec
   NewCops: enable
-  TargetRubyVersion: 2.6
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  Exclude:
+    - jekyll_download_link.gemspec
 
 Layout/LineLength:
   Max: 150
 
-# Gemspec/RequireMFA:
-#   enable: false
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - jekyll_download_link.gemspec
+
+Lint/SymbolConversion:
+  Exclude:
+    - jekyll_download_link.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_download_link.gemspec
+    - spec/**/*
+  Max: 35
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,8 +1,22 @@
+# Change Log
+
+## 1.0.2 / 2023-12-02
+
+* Now depends on `jekyll_plugin_support`
+* Demo website added
+* Better Rubocop support
+* Pinned to `json` gem v3.6.2 because Jekyll 4.3.2 requires it
+
+
 ## 1.0.1 / 2022-04-05
-  * Updated to `jekyll_plugin_logger` v2.1.0
+
+* Updated to `jekyll_plugin_logger` v2.1.0
+
 
 ## 1.0.0 / 2022-03-16
-  * Published as a gem
+
+* Published as a gem
 
 ## 2020-10-03
-  * Initial version published at https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html
+
+* Initial version published at https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html

data/README.md

@@ -1,19 +1,19 @@
-`jekyll_download_link`
-[![Gem Version](https://badge.fury.io/rb/jekyll_download_link.svg)](https://badge.fury.io/rb/jekyll_download_link)
-===========
+# `jekyll_download_link` [![Gem Version](https://badge.fury.io/rb/jekyll_download_link.svg)](https://badge.fury.io/rb/jekyll_download_link)
 
-`jekyll_download_link` is a Jekyll tag plugin that generates a link to the given URI, which must be a file on the server.
-The file name can be absolute or relative to the top-level directory of the web site.
+`jekyll_download_link` is a Jekyll tag plugin that generates a link to the given URI,
+which must be a file on the server.
+The file name can be absolute or relative to the top-level directory of the website.
 
 
 ## Usage
-```
+
+```html
 {% download_link cloud9.tar %}
 ```
 
 Generates:
 
-```
+```html
 <a href="/cloud9.tar"><code>cloud9.tar</code></a> (4.5 KB)
 ```
 
@@ -31,16 +31,15 @@ gem 'jekyll_download_link'
 
 And then execute:
 
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install jekyll_download_link
+```shell
+$ bundle install
+```
 
 
 ## Additional Information
+
 More information is available on
-[Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+[Mike Slinn&rsquo;s website](https://mslinn.com/jekyll/3000-jekyll-plugins.html#download_link).
 
 
 ## Development
@@ -51,12 +50,9 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 
 ### Build and Install Locally
-To build and install this gem onto your local machine, run:
-```shell
-$ rake install:local
-```
 
-The following also does the same thing:
+To build and install this gem onto your local machine, type:
+
 ```shell
 $ bundle exec rake install
 jekyll_download_link 1.0.0 built to pkg/jekyll_download_link-0.1.0.gem.
@@ -64,6 +60,7 @@ jekyll_download_link (1.0.0) installed.
 ```
 
 Examine the newly built gem:
+
 ```shell
 $ gem info jekyll_download_link
 
@@ -80,14 +77,56 @@ jekyll_download_link (1.0.0)
 ```
 
 
+## Demo Website
+
+A test/demo website is provided in the `demo` directory.
+You can run it under a debugger, or let it run free.
+
+The `demo/_bin/debug` script can set various parameters for the demo.
+View the help information with the `-h` option:
+
+```shell
+$ demo/_bin/debug -h
+
+debug - Run the demo Jekyll website.
+
+By default the demo Jekyll website runs without restriction under ruby-debug-ide and debase.
+View it at http://localhost:4444
+
+Options:
+  -h  Show this error message
+
+  -r  Run freely, without a debugger
+```
+
+
+### Debugging the Demo
+
+To run under a debugger, for example Visual Studio Code:
+
+1. Set breakpoints.
+2. Initiate a debug session from the command line:
+
+   ```shell
+   $ demo/bin/debug
+   ```
+
+3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch configuration called `Attach rdebug-ide`.
+4. View the generated website at [`http://localhost:4444`](http://localhost:4444).
+
+
 ### Build and Push to RubyGems
+
 To release a new version,
+
   1. Update the version number in `version.rb`.
   2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
   3. Run the following:
+
      ```shell
      $ bundle exec rake release
      ```
+
      The above creates a git tag for the version, commits the created tag,
      and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
 

data/Rakefile

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

data/jekyll_download_link.gemspec

@@ -1,10 +1,7 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_download_link/version'
 
-require_relative "lib/jekyll_download_link/version"
-
-# rubocop:disable Metrics/BlockLength, Style/StringLiterals
-Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_download_link"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  github = 'https://github.com/mslinn/jekyll_download_link'
 
   spec.authors = ['Mike Slinn']
   spec.bindir = 'exe'
@@ -12,15 +9,15 @@ Gem::Specification.new do |spec|
     Provides a Jekyll tag that generates an href to a file for the user to download, plus human-friendly filesize.
   END_OF_DESC
   spec.email = ['mslinn@mslinn.com']
-  spec.files = Dir[".rubocop.yml", "LICENSE.*", "Rakefile", "{lib,spec}/**/*", "*.gemspec", "*.md"]
-  spec.homepage = "https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#download"
+  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_download_link.html'
   spec.license = 'MIT'
   spec.metadata = {
-    "allowed_push_host" => "https://rubygems.org",
-    "bug_tracker_uri"   => "#{github}/issues",
-    "changelog_uri"     => "#{github}/CHANGELOG.md",
-    "homepage_uri"      => spec.homepage,
-    "source_code_uri"   => github,
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{github}/issues",
+    'changelog_uri'     => "#{github}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => github,
   }
   spec.name = 'jekyll_download_link'
   spec.post_install_message = <<~END_MESSAGE
@@ -34,13 +31,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
   spec.version = JekyllDownloadLinkVersion::VERSION
 
-  spec.add_dependency "jekyll", ">= 3.5.0"
-  spec.add_dependency "jekyll_plugin_logger"
-
-  spec.add_development_dependency "debase"
-  # spec.add_development_dependency "rubocop-jekyll"
-  # spec.add_development_dependency "rubocop-rake"
-  # spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "ruby-debug-ide"
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'json', '= 2.6.3'
+  spec.add_dependency 'jekyll_plugin_support'
 end
-# rubocop:enable Metrics/BlockLength, Style/StringLiterals

data/lib/jekyll_download_link/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllDownloadLinkVersion
-  VERSION = "1.0.1"
+  VERSION = '1.0.2'.freeze
 end

data/lib/jekyll_download_link.rb

@@ -1,48 +1,36 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require "jekyll_plugin_logger"
-require_relative "jekyll_download_link/version"
+require 'jekyll_plugin_support'
+require_relative 'jekyll_download_link/version'
 
 module JekyllPluginDownloadLinkName
-  PLUGIN_NAME = "download_link"
+  PLUGIN_NAME = 'download_link'.freeze
 end
 
 # Generates an href to a file for the user to download from the site.
 # Also shows the file size in a human-readable format.
-class DownloadLink < Liquid::Tag
-  # Constructor.
-  # @param tag_name [String] is the name of the tag, which we already know.
-  #   Contains the name of the file, relative to the website top level directory
-  # @param text [Hash, String, Liquid::Tag::Parser] the arguments from the web page.
-  # @param tokens [Liquid::ParseContext] tokenized command line
-  # @return [void]
-  def initialize(tag_name, text, tokens)
-    super
-    @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-    @filename = text.delete('"').delete("'").strip
-  end
+class DownloadLink < JekyllSupport::JekyllTagNoArgParsing
+  include JekyllDownloadLinkVersion
 
-  # Method prescribed by the Jekyll plugin lifecycle.
-  # @return [String]
-  def render(context)
-    source = context.registers[:site].config["source"]
-    file_fq = File.join(source, @filename)
-    abort "Error: '#{file_fq}' not found. See the link tag in" unless File.exist?(file_fq)
+  def self.as_size(string)
+    units = %w[B KB MB GB TB]
+
+    size, unit = units.reduce(string.to_f) do |(fsize, _), utype|
+      fsize > 512 ? [fsize / 1024, utype] : (break [fsize, utype])
+    end
 
-    "<a href='/#{@filename}'><code>#{@filename}</code></a> (#{as_size(File.size(file_fq))})"
+    fmt_str = "#{size > 9 || size.modulo(1) < 0.1 ? '%d' : '%.1f'} %s"
+    format(fmt_str, size, unit)
   end
 
-  def as_size(s)
-    units = %w(B KB MB GB TB)
+  def render_impl
+    @filename = @argument_string.delete('"').delete("'").strip
 
-    size, unit = units.reduce(s.to_f) do |(fsize, _), utype|
-      fsize > 512 ? [fsize / 1024, utype] : (break [fsize, utype])
-    end
+    source = @config['source']
+    file_fq = File.join(source, @filename)
+    abort "Error: '#{file_fq}' not found. See the link tag in" unless File.exist?(file_fq)
 
-    "#{size > 9 || size.modulo(1) < 0.1 ? "%d" : "%.1f"} %s" % [size, unit]
+    size_str = self.class.as_size(File.size(file_fq))
+    "<a href='/#{@filename}'><code>#{@filename}</code></a> (#{size_str})"
   end
-end
 
-PluginMetaLogger.instance.info { "Loaded #{JekyllPluginDownloadLinkName::PLUGIN_NAME} v#{JekyllDownloadLinkVersion::VERSION} plugin." }
-Liquid::Template.register_tag(JekyllPluginDownloadLinkName::PLUGIN_NAME, DownloadLink)
+  JekyllPluginHelper.register(self, JekyllPluginDownloadLinkName::PLUGIN_NAME)
+end

data/spec/download_link_spec.rb

@@ -0,0 +1,19 @@
+require 'jekyll_plugin_support'
+require_relative '../lib/jekyll_download_link'
+
+RSpec.describe(DownloadLink) do
+  let(:config) { instance_double(Configuration) }
+  let(:context) do
+    context_ = instance_double(Liquid::Context)
+    context_.config = config
+    context_
+  end
+
+  it 'generates proper size comment' do
+    expect(described_class.as_size('123')).to             eq('123 B')
+    expect(described_class.as_size('123456')).to          eq('120 KB')
+    expect(described_class.as_size('123456789')).to       eq('117 MB')
+    expect(described_class.as_size('123456789012')).to    eq('114 GB')
+    expect(described_class.as_size('123456789012345')).to eq('112 TB')
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,10 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require_relative "../lib/jekyll_download_link"
+require 'jekyll'
+require_relative '../lib/jekyll_download_link'
 
 RSpec.configure do |config|
-  config.filter_run :focus
-  config.order = "random"
-  config.run_all_when_everything_filtered = true
+  config.filter_run_when_matching focus: true
+  # config.order = 'random'
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
-  config.example_status_persistence_file_path = "spec/status_persistence.txt"
+  config.example_status_persistence_file_path = 'spec/status_persistence.txt'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_download_link
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Slinn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2023-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,41 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: jekyll_plugin_logger
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
-  name: debase
+  name: jekyll_plugin_support
   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: ruby-debug-ide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -69,7 +55,7 @@ dependencies:
 description: 'Provides a Jekyll tag that generates an href to a file for the user
   to download, plus human-friendly filesize.
 
-'
+  '
 email:
 - mslinn@mslinn.com
 executables: []
@@ -84,16 +70,16 @@ files:
 - jekyll_download_link.gemspec
 - lib/jekyll_download_link.rb
 - lib/jekyll_download_link/version.rb
-- spec/jekyll_download_link_spec.rb
+- spec/download_link_spec.rb
 - spec/spec_helper.rb
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#download
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_download_link.html
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_download_link/issues
   changelog_uri: https://github.com/mslinn/jekyll_download_link/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#download
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_download_link.html
   source_code_uri: https://github.com/mslinn/jekyll_download_link
 post_install_message: |2+
 
@@ -113,11 +99,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Provides a Jekyll tag that generates an href to a file for the user to download,
   plus human-friendly filesize.
 test_files:
-- spec/jekyll_download_link_spec.rb
+- spec/download_link_spec.rb
 - spec/spec_helper.rb
+...

data/spec/jekyll_download_link_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require_relative "../lib/jekyll_download_link"
-
-RSpec.describe(Jekyll) do
-  include Jekyll
-
-  let(:config) { instance_double("Configuration") }
-  let(:context) {
-    context_ = instance_double("Liquid::Context")
-    context_.config = config
-    context_
-  }
-
-  it "is created properly" do
-    # run_tag = RunTag.new("run", "echo asdf")
-    # output = run_tag.render(context)
-    # expect(output).to eq("asdf")
-  end
-end