jekyll_download_link 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c97ab0a7c2a3b68247bcb8bd288accad95d2f4bbf4ac7d6cf680524d176f9f4
+  data.tar.gz: 1e9f9d02f2c249f8d59ac7a787c539c5746ba340b080beb0c6050d1bb760c4ef
+SHA512:
+  metadata.gz: 84be7f74f4a327b86f947d6da1a36ebea948e245635e89ee7f9a5b86d1365c579c18f895171e4bfbccdb4694cebdc823bae31b1d39b29398537cc8b01ad0959e
+  data.tar.gz: 35d5f22d4b6b60bb6917039bab880a509b40ea4c00d15567723f34e19d16def19f1de894a5c86c0ffe05252ae508fd324125d5379efc391c0829d51445eb1170

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require: rubocop-jekyll
+inherit_gem:
+ rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+# Gemspec/RequireMFA:
+#   enable: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0 / 2022-03-16
+  * Published as a gem
+
+## 2020-10-03
+  * Initial version published at https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+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,105 @@
+`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.
+
+
+## Usage
+```
+{% download_link cloud9.tar %}
+```
+
+Generates:
+
+```
+<a href="/cloud9.tar"><code>cloud9.tar</code></a> (4.5 KB)
+```
+
+Which renders as:<br>
+<a href="/cloud9.tar">`cloud9.tar`</a> (4.5 KB)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_download_link'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_download_link
+
+
+## Additional Information
+More information is available on
+[Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+### 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:
+```shell
+$ bundle exec rake install
+jekyll_download_link 1.0.0 built to pkg/jekyll_download_link-0.1.0.gem.
+jekyll_download_link (1.0.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_download_link
+
+*** LOCAL GEMS ***
+
+jekyll_download_link (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_download_link
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+
+### 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).
+
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request
+
+
+## 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,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jekyll_download_link.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+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"
+
+  spec.authors = ['Mike Slinn']
+  spec.bindir = 'exe'
+  spec.description = <<~END_OF_DESC
+    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.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,
+  }
+  spec.name = 'jekyll_download_link'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'Provides a Jekyll tag that generates an href to a file for the user to download, plus human-friendly filesize.'
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllDownloadLink::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"
+end
+# rubocop:enable Metrics/BlockLength, Style/StringLiterals

data/lib/jekyll_download_link/version.rb

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

data/lib/jekyll_download_link.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll_plugin_logger"
+require_relative "jekyll_download_link/version"
+
+module JekyllPluginDownloadLinkName
+  PLUGIN_NAME = "download_link"
+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)
+    @filename = text.delete('"').delete("'").strip
+  end
+
+  # 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)
+
+    "<a href='/#{@filename}'><code>#{@filename}</code></a> (#{as_size(File.size(file_fq))})"
+  end
+
+  def as_size(s)
+    units = %w(B KB MB GB TB)
+
+    size, unit = units.reduce(s.to_f) do |(fsize, _), utype|
+      fsize > 512 ? [fsize / 1024, utype] : (break [fsize, utype])
+    end
+
+    "#{size > 9 || size.modulo(1) < 0.1 ? "%d" : "%.1f"} %s" % [size, unit]
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded #{JekyllPluginDownloadLinkName::PLUGIN_NAME} v#{JekyllDownloadLink::VERSION} plugin." }
+Liquid::Template.register_tag(JekyllPluginDownloadLinkName::PLUGIN_NAME, DownloadLink)

data/spec/jekyll_download_link.rb

@@ -0,0 +1,21 @@
+# 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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_download_link"
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_download_link
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-25 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_logger
+  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'
+- !ruby/object:Gem::Dependency
+  name: debase
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_download_link.gemspec
+- lib/jekyll_download_link.rb
+- lib/jekyll_download_link/version.rb
+- spec/jekyll_download_link.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#download
+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
+  source_code_uri: https://github.com/mslinn/jekyll_download_link
+post_install_message: |2+
+
+  Thanks for installing jekyll_download_link!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+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.rb
+- spec/spec_helper.rb