jekyll-shorts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3d8759f41c495c08a1001975d9a43dcf139f03355b21a9e9d79f698e7ab1877
+  data.tar.gz: 6fb9f3a3ec31d2c485d03d8def545b2b73c0008b18a121033add28cbbe7a4f20
+SHA512:
+  metadata.gz: 33b528a89955c8c9a4b4dae4f5daa07fd926881128dd697805036dbaa0273f20630e8f672d7d13c143ee089c4b1e34cfa6165d1437465230a04dac137ca7fc4f
+  data.tar.gz: 9e30d54dbc5fbe3d5314bcf60af37e04516acd9b5a491eec163b070e6f438f0044d5b8b05a17edaf3229512db292ae0e98b1d12a53c7f090471ba2f7e44238a9

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.github/workflows/codecov.yml

@@ -0,0 +1,22 @@
+---
+name: codecov
+on:
+  push:
+    branches:
+      - master
+jobs:
+  codecov:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - run: sudo apt-get -y install plantuml
+      - run: bundle update
+      - run: bundle exec rake
+      - uses: codecov/codecov-action@v4.0.0-beta.3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: coverage/.resultset.json
+          fail_ci_if_error: true

data/.github/workflows/pdd.yml

@@ -0,0 +1,15 @@
+---
+name: pdd
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  pdd:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -0,0 +1,24 @@
+---
+name: rake
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    name: test
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, macos-12, windows-2022]
+        ruby: [3.1]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle update
+      - run: bundle exec rake

data/.github/workflows/xcop.yml

@@ -0,0 +1,11 @@
+---
+name: xcop
+on:
+  push:
+  pull_request:
+jobs:
+  xcop:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: g4s8/xcop-action@master

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+*.gem
+.bundle/
+.DS_Store
+coverage/
+_chatgpt-translate/

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude src/main/resources/images/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'assets/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 100
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 40
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+Layout/ElseAlignment:
+  Enabled: false
+Layout/EndAlignment:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 200
+Style/ClassVars:
+  Enabled: false

data/.rultor.yml

@@ -0,0 +1,23 @@
+docker:
+  image: yegor256/rultor-image:1.22.0
+assets:
+  rubygems.yml: yegor256/home#assets/rubygems.yml
+install: |
+  pdd -f /dev/null
+  bundle install --no-color
+release:
+  pre: false
+  script: |-
+    bundle exec rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" jekyll-shorts.gemspec
+    sed -i "s/0\.0\.0/${tag}/g" lib/jekyll-shorts/version.rb
+    git add jekyll-shorts.gemspec
+    git add lib/jekyll-shorts/version.rb
+    git commit -m "version set to ${tag}"
+    gem build jekyll-shorts.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+merge:
+  script: |-
+    bundle exec rake

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'cucumber', '9.1.0', require: false
+gem 'minitest', '5.21.1', require: false
+gem 'rake', '13.1.0', require: false
+gem 'rubocop', '1.59.0', require: false
+gem 'rubocop-rspec', '2.26.1', require: false
+gem 'simplecov', '0.22.0', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2024 Yegor Bugayenko
+
+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,45 @@
+[![rake](https://github.com/yegor256/jekyll-shorts/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/jekyll-shorts/actions/workflows/rake.yml)
+[![Gem Version](https://badge.fury.io/rb/jekyll-shorts.svg)](http://badge.fury.io/rb/jekyll-shorts)
+
+If you have a [Jekyll](https://jekyllrb.com/) static site, this plugin may help you automatically
+generate short links for every page. I'm using this plugin for 
+[my blog](https://github.com/yegor256/blog).
+
+Install it first (you need [Ruby 3+](https://www.ruby-lang.org/en/news/2020/12/25/ruby-3-0-0-released/) 
+and [Jekyll 3+](https://jekyllrb.com/)):
+
+```
+$ gem install jekyll-shorts
+```
+
+Then, add this to `_config.yml`:
+
+```yaml
+plugins:
+  - ... your other plugins here ...
+  - jekyll-shorts
+shorts:
+  permalink: :year:month:day.html
+```
+
+Here, every page in the site will get a sibling with the name 
+`:year:month:day.html`, which will redirect to the page itself. You can use:
+
+  * `:year` - the year of the post
+  * `:month` - the year of the post
+  * `:day` - the year of the post
+  * `:position` - the unique position of the post in the entire list of them
+
+Be careful with the `:position`, since it may change when you add a new post
+somewhere in the middle of existing flow of posts.
+
+## How to Contribute
+
+Make a fork and then test it locally like this:
+
+```bash
+$ bundle update
+$ bundle exec rake
+```
+
+If it works, make changes, test again, and then submit a pull request.

data/Rakefile

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+require 'rubygems'
+require 'rake'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+require 'rake/clean'
+task default: %i[clean test features rubocop copyright]
+
+require 'rake/testtask'
+desc 'Run all unit tests'
+Rake::TestTask.new(:test) do |test|
+  Rake::Cleaner.cleanup_files(['coverage'])
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.warning = true
+  test.verbose = false
+end
+
+require 'rdoc'
+require 'rdoc/task'
+desc 'Build RDoc documentation'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do
+  Rake::Cleaner.cleanup_files(['coverage'])
+end
+Cucumber::Rake::Task.new(:'features:html') do |t|
+  t.profile = 'html_report'
+end
+
+task :copyright do
+  sh "grep -q -r '#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/features/cli.feature

@@ -0,0 +1,27 @@
+Feature: Simple site building
+  I want to be able to build a site
+
+  Scenario: Simple site
+    Given I have a "_config.yml" file with content:
+    """
+    markdown: kramdown
+    plugins:
+      - jekyll-shorts
+    shorts:
+      permalink: :day.html
+    """
+    And I have a "_layouts/default.html" file with content:
+    """
+    {{ content }}
+    """
+    And I have a "_posts/2023-01-01-hello.md" file with content:
+    """
+    ---
+    title: Hello, world!
+    layout: default
+    ---
+    Hello, world!
+    """
+    Then I build Jekyll site
+    And Exit code is zero
+    And File "_site/01.html" exists

data/features/gem_package.feature

@@ -0,0 +1,24 @@
+Feature: Gem Package
+  As a source code writer I want to be able to
+  package the Gem into .gem file
+
+  Scenario: Gem can be packaged
+    When It is Unix
+    Given I have a "execs.rb" file with content:
+    """
+    #!/usr/bin/env ruby
+    require 'rubygems'
+    spec = Gem::Specification::load('./spec.rb')
+    """
+    And I copy this gem into temp dir
+    When I run bash with:
+    """
+    set -x
+    set -e
+    cd jekyll-shorts
+    gem build jekyll-shorts.gemspec
+    gem specification --ruby jekyll-shorts-*.gem > ../spec.rb
+    cd ..
+    ruby execs.rb
+    """
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'tmpdir'
+require 'English'
+
+Before do
+  @cwd = Dir.pwd
+  @dir = Dir.mktmpdir('test')
+  FileUtils.mkdir_p(@dir)
+  Dir.chdir(@dir)
+end
+
+After do
+  Dir.chdir(@cwd)
+  FileUtils.rm_rf(@dir)
+end
+
+Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
+  FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
+  File.write(file, text.gsub('\\xFF', 0xFF.chr))
+end
+
+When('I build Jekyll site') do
+  @stdout = `jekyll build`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+Then('Stdout contains {string}') do |string|
+  raise "STDOUT doesn't contain '#{string}':\n#{@stdout}" unless @stdout.include?(string)
+end
+
+Then('File {string} exists') do |string|
+  raise "The file \"#{string}\" is absent:\n#{`tree -s`}" unless File.exist?(string)
+end
+
+Then('File {string} contains {string}') do |string, string2|
+  raise "The file \"#{string}\" is absent" unless File.exist?(string)
+  content = File.read(string)
+  raise "The file \"#{string}\" doesn't contain \"#{string2}\":\n#{content}" unless content.include?(string2)
+end
+
+Then('Exit code is zero') do
+  raise "Non-zero exit #{@exitstatus}:\n#{@stdout}" unless @exitstatus.zero?
+end
+
+Then('Exit code is not zero') do
+  raise 'Zero exit code' if @exitstatus.zero?
+end
+
+When('I run bash with {string}') do |string|
+  @stdout = `#{string}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+When(/^I run bash with:$/) do |text|
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+When('I copy this gem into temp dir') do
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'jekyll-shorts'))
+end
+
+Given('It is Unix') do
+  pending if Gem.win_platform?
+end
+
+Given('It is Windows') do
+  pending unless Gem.win_platform?
+end

data/features/support/env.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'simplecov'

data/jekyll-shorts.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+require 'English'
+
+Gem::Specification.new do |s|
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = '>= 2.6'
+  s.name = 'jekyll-shorts'
+  s.version = '0.0.1'
+  s.license = 'MIT'
+  s.summary = 'Automatically generates short links for Jekyll website'
+  s.description = [
+    'Add this plugin to your Jekyll site and all posts will automatically',
+    'get short links (similar to what URL shorteners may provide)'
+  ].join(' ')
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'https://github.com/yegor256/jekyll-shorts'
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = %w[README.md LICENSE.txt]
+  s.add_runtime_dependency 'jekyll', '>= 3'
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/jekyll-shorts/generator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+require 'jekyll'
+require 'fileutils'
+require 'json'
+require_relative 'version'
+
+# The module we are in.
+module JekyllShorts; end
+
+# Pages generator.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::Generator < Jekyll::Generator
+  safe true
+  priority :lowest
+
+  # Main plugin action, called by Jekyll-core
+  def generate(site)
+    Jekyll.logger.info("jekyll-shorts #{JekyllShorts::VERSION} starting...")
+    config ||= site.config['shorts'] || {}
+    permalink ||= config['permalink'] || ':year:month:day'
+    start = Time.now
+    total = 0
+    site.posts.docs.sort_by(&:url).each_with_index do |doc, pos|
+      long = doc.url
+      short = Jekyll::URL.new(
+        template: permalink,
+        placeholders: {
+          'year' => doc.date.year.to_s,
+          'month' => doc.date.month.to_s.rjust(2, '0'),
+          'day' => doc.date.day.to_s.rjust(2, '0'),
+          'position' => pos.to_s
+        }
+      ).to_s
+      site.static_files << ShortFile.new(site, short, long)
+      doc.data['short-url'] = short
+      total += 1
+    end
+    Jekyll.logger.info("jekyll-shorts #{JekyllShorts::VERSION}: \
+#{total} link(s) generated in #{(Time.now - start).round(2)}s")
+  end
+
+  # The HTML file with a redirect.
+  class ShortFile < Jekyll::StaticFile
+    def initialize(site, short, long)
+      super(site, site.dest, '', short)
+      @long = long
+    end
+
+    def write(_dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      html = "<html> redirect to #{@long}</html>"
+      File.write(path, html)
+      Jekyll.logger.info("HTML #{path.inspect} -> #{@long.inspect}")
+      true
+    end
+  end
+end

data/lib/jekyll-shorts/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+module JekyllShorts
+  VERSION = '0.0.1'
+end

data/lib/jekyll-shorts.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+require 'jekyll-shorts/generator'

data/renovate.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ],
+  "ignorePaths": [
+    "jekyll-tests/jekyll-3/Gemfile",
+    "jekyll-tests/jekyll-4/Gemfile"
+  ]
+}

data/test/test__helper.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+$stdout.sync = true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'jekyll'
+Jekyll.logger.adjust_verbosity(verbose: true)
+
+# The module we are in.
+module JekyllShorts; end
+
+# Fake.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::FakeSite
+  attr_reader :config, :pages, :static_files
+
+  def initialize(config, docs = [])
+    @config = config
+    @docs = docs
+    @pages = []
+    @static_files = []
+  end
+
+  def posts
+    JekyllShorts::FakePosts.new(@docs)
+  end
+
+  def permalink_style
+    ''
+  end
+
+  def frontmatter_defaults
+    Jekyll::FrontmatterDefaults.new(self)
+  end
+
+  def converters
+    [Jekyll::Converters::Markdown.new({ 'markdown_ext' => 'md' })]
+  end
+
+  def source
+    ''
+  end
+
+  def dest
+    return '' if @docs.empty?
+    File.dirname(@docs[0])
+  end
+
+  def in_theme_dir(base, _foo = nil, _bar = nil)
+    base
+  end
+
+  def in_dest_dir(*paths)
+    paths[0].dup
+  end
+end
+
+# Fake.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::FakeDocument
+  attr_reader :data
+
+  def initialize(path)
+    @path = path
+    @data = { 'date' => Time.now, 'title' => 'Hello!' }
+  end
+
+  def content
+    'Hello, world!'
+  end
+
+  def date
+    Time.now
+  end
+
+  def []=(key, value)
+    @data[key] = value
+  end
+
+  def [](key)
+    @data[key] || ''
+  end
+
+  def relative_path
+    @path
+  end
+
+  def url
+    '2023-01-01-hello.html'
+  end
+
+  def basename
+    '2023-01-01-hello.md'
+  end
+end
+
+# Fake.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::FakePosts
+  attr_reader :config
+
+  def initialize(docs)
+    @docs = docs
+  end
+
+  def docs
+    @docs.map { |d| JekyllShorts::FakeDocument.new(d) }
+  end
+end

data/test/test_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# 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.
+
+require 'minitest/autorun'
+require 'tmpdir'
+require_relative 'test__helper'
+require_relative '../lib/jekyll-shorts/generator'
+
+# Generator test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::GeneratorTest < Minitest::Test
+  def test_simple_scenario
+    Dir.mktmpdir do |home|
+      post = File.join(home, '2023-01-01-hello.md')
+      File.write(post, "---\ntitle: Hello\n---\n\nHello, world!")
+      site = JekyllShorts::FakeSite.new(
+        {
+          'url' => 'https://www.yegor256.com/',
+          'shorts' => {
+            'permalink' => ':year:month.html'
+          }
+        },
+        [post]
+      )
+      gen = JekyllShorts::Generator.new
+      gen.generate(site)
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-shorts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Add this plugin to your Jekyll site and all posts will automatically
+  get short links (similar to what URL shorteners may provide)
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".0pdd.yml"
+- ".github/workflows/codecov.yml"
+- ".github/workflows/pdd.yml"
+- ".github/workflows/rake.yml"
+- ".github/workflows/xcop.yml"
+- ".gitignore"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/cli.feature
+- features/gem_package.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- jekyll-shorts.gemspec
+- lib/jekyll-shorts.rb
+- lib/jekyll-shorts/generator.rb
+- lib/jekyll-shorts/version.rb
+- renovate.json
+- test/test__helper.rb
+- test/test_generator.rb
+homepage: https://github.com/yegor256/jekyll-shorts
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Automatically generates short links for Jekyll website
+test_files: []