jekyll-shorts 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f5bac761a44799decc825865e2358b45fece80d82d5b42d42f5e0afd86e48d9
-  data.tar.gz: 31c24b5d3621b716cfb9963eb27c90e0c761c45c122db3342f81755dcab9fcf4
+  metadata.gz: 20adc0bf33af94142a5e41d7a337b032373f6e1b9705ca4ac1e1628969b77c17
+  data.tar.gz: 9e8e2ce95972da6bb11f46d4348fbf6581c6de2d27929ef40a466b25a5182852
 SHA512:
-  metadata.gz: 7014fb51fdf53ac29797a39c785c88d4784fc911d82104f76d931a5d66b011f56bc54fa2d283ce6104c8b3925e06faf7fa93d62c30086f502382d34e19bffd53
-  data.tar.gz: cb2381f5f637fdbbc6f572e1ea72f277c94eb26344e8124ab03d4b92730e22c26f2adaa4ff98923a7f5afd1a053e6733f92db01c051e8b1ba1b060474ab2a15b
+  metadata.gz: e81e6ddeba6737fb4c2e4f0acd00ce00cb38f552c64c664e8fa52b96bbea720524e9f641f1a5d3e6d6c6b21f6d4aa360821c3aaebd423145d6651867a894b7be
+  data.tar.gz: 8b1a9f9a6b22dbae82dad7b4453f175f285b96e950bf295dcb47a31acda39b69d550c4169557ab4421862480892d578a996eb4ddf4650a568e4c931c779996fb

data/Gemfile

@@ -26,7 +26,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '9.1.0', require: false
-gem 'minitest', '5.22.1', require: false
+gem 'minitest', '5.22.2', require: false
 gem 'rake', '13.1.0', require: false
 gem 'rubocop', '1.60.2', require: false
 gem 'rubocop-rspec', '2.26.1', require: false

data/README.md

@@ -19,7 +19,7 @@ plugins:
   - ... your other plugins here ...
   - jekyll-shorts
 shorts:
-  permalink: :year:month:day.html
+  permalink: :year:month:day:letter.html
 ```
 
 Here, every page in the site will get a sibling with the name 
@@ -28,11 +28,14 @@ Here, every page in the site will get a sibling with the name
   * `:year` - the short form of the year of the post, like `23` or `76`
   * `:month` - the month of the post, like `01` or `12`
   * `:day` - the day of the post, like `07` or `29`
-  * `:position` - the unique position of the post in the entire list of them, like `42` or `256`
-  * `:letter` - one English letter inside a month (empty instead of `a`)
+  * `:letter` - a unique English letter for a short URL, like `a`, `b`, etc.
 
-Be careful with the `:position`, since it may change when you add a new post
-somewhere in the middle of existing flow of posts.
+If you don't use the `:letter`, you may end up with duplicated URLs. For example,
+you have two pages written in 2023-11-23. Their URLs will be the same, if the 
+`permalink` is `:year:month:day.html`, as in the example above. With the help of the `:letter`,
+two URLs become different.
+
+Inside the Jekyll page, you can use `{{ page.short-url }}` for the value of the short URL.
 
 ## How to Contribute
 

data/features/cli.feature

@@ -97,4 +97,4 @@ Feature: Simple site building
     And I build Jekyll site
     And Exit code is zero
     And File "_site/2301.html" exists
-    And File "_site/2301b.html" exists
+    And File "_site/2301a.html" exists

data/jekyll-shorts.gemspec

@@ -28,7 +28,7 @@ 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.8'
+  s.version = '0.0.10'
   s.license = 'MIT'
   s.summary = 'Automatically generates short links for Jekyll website'
   s.description = [

data/lib/jekyll-shorts/generator.rb

@@ -25,10 +25,9 @@
 require 'jekyll'
 require 'fileutils'
 require 'json'
+require 'securerandom'
 require_relative 'version'
-
-# The module we are in.
-module JekyllShorts; end
+require_relative 'letters'
 
 # Pages generator.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -40,30 +39,26 @@ class JekyllShorts::Generator < Jekyll::Generator
 
   # 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'
+    permalink ||= config['permalink'] || ':year:month:day:letter.html'
     start = Time.now
     total = 0
-    months = {}
-    site.posts.docs.sort_by(&:url).each_with_index do |doc, pos|
+    letters = JekyllShorts::Letters.new
+    site.posts.docs.each do |doc|
       long = doc.url
-      month = doc.date.strftime('%Y%m')
-      months[month] = 0 if months[month].nil?
-      raise 'Too many letters' if months[month] >= 26
+      re = SecureRandom.hex(64)
       short = Jekyll::URL.new(
         template: permalink,
         placeholders: {
           'year' => doc.date.year.to_s[2..],
           'month' => doc.date.month.to_s.rjust(2, '0'),
           'day' => doc.date.day.to_s.rjust(2, '0'),
-          'letter' => months[month].zero? ? '' : (months[month] + 'a'.ord).chr,
-          'position' => pos.to_s
+          'letter' => re
         }
       ).to_s
+      short.sub!(re, letters.next(short.sub(re, '')))
       site.static_files << ShortFile.new(site, short, long)
       doc.data['short-url'] = short
-      months[month] += 1
       total += 1
     end
     Jekyll.logger.info("jekyll-shorts #{JekyllShorts::VERSION}: \
@@ -81,12 +76,26 @@ class JekyllShorts::Generator < Jekyll::Generator
       true
     end
 
+    def modified_time
+      Time.now
+    end
+
     def write(_dest)
       FileUtils.mkdir_p(File.dirname(path))
-      html = "<html><head><meta charset='utf-8'/>\
-<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>\
-<meta http-equiv='refresh' content='#{@long}'/></head>\
-<body></body></html>"
+      re = "#{@site.config['url']}#{@long}"
+      html = [
+        '<!DOCTYPE html>',
+        '<html lang="en-US">',
+        '<meta charset="utf-8">',
+        '<title>Redirecting&hellip;</title>',
+        "<link rel='canonical' href='#{re}'>",
+        "<script>location='#{re}'</script>",
+        "<meta http-equiv='refresh' content='0; url=#{re}'>",
+        '<meta name="robots" content="noindex">',
+        '<h1>Redirecting&hellip;</h1>',
+        "<a href='#{re}'>Click here if you are not redirected.</a>",
+        '</html>'
+      ].join
       if File.exist?(path)
         before = File.read(path)
         if before != html

data/lib/jekyll-shorts/letters.rb

@@ -0,0 +1,44 @@
+# 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_relative 'version'
+
+# Letters
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::Letters
+  def initialize
+    @mnemos = {}
+  end
+
+  # Next one for this mnemo.
+  def next(mnemo)
+    @mnemos[mnemo] = 0 if @mnemos[mnemo].nil?
+    raise 'Too many letters' if @mnemos[mnemo] >= 26
+    letter = @mnemos[mnemo].zero? ? '' : (@mnemos[mnemo] + 'a'.ord - 1).chr
+    @mnemos[mnemo] += 1
+    letter
+  end
+end

data/lib/jekyll-shorts/version.rb

@@ -22,6 +22,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+# Our module.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
 module JekyllShorts
-  VERSION = '0.0.8'
+  VERSION = '0.0.10'
 end

data/test/test_letters.rb

@@ -0,0 +1,42 @@
+# 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_relative 'test__helper'
+require_relative '../lib/jekyll-shorts/letters'
+
+# Letters test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class JekyllShorts::LettersTest < Minitest::Test
+  def test_simple_scenario
+    letters = JekyllShorts::Letters.new
+    mnemo = 'hey'
+    assert_equal('', letters.next(mnemo))
+    assert_equal('a', letters.next(mnemo))
+    assert_equal('b', letters.next(mnemo))
+    assert_equal('', letters.next("#{mnemo}!"))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-shorts
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -53,10 +53,12 @@ files:
 - jekyll-shorts.gemspec
 - lib/jekyll-shorts.rb
 - lib/jekyll-shorts/generator.rb
+- lib/jekyll-shorts/letters.rb
 - lib/jekyll-shorts/version.rb
 - renovate.json
 - test/test__helper.rb
 - test/test_generator.rb
+- test/test_letters.rb
 homepage: https://github.com/yegor256/jekyll-shorts
 licenses:
 - MIT