lifer 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0628d28de38f509eb51cc2d2dd65cb794fe3e4e46239bbf11c82decfd28f1d5d'
-  data.tar.gz: dcb12aba6fa318f57c3224fed97a6a28233b847ca7399f321c855a739a44543b
+  metadata.gz: a63fea0c89c87889fa7aab9fc17e53385a562d2bf5bbca5aa552076acc31ed10
+  data.tar.gz: d158cad653234c27d4f17291f2a4511e3896684e148e5aa12206ffdef4403603
 SHA512:
-  metadata.gz: 0d74bf3c194492fec78a17ca70045dd107a40ddf33cf154243b33bb0a9d13876b1b0bdc4ea6bbf40c15984bf6a2a86dc898ed55939c9e222cf86d4cadd73b8d3
-  data.tar.gz: af6d75bd7b875807c8fc74c69b04c5849d0d5e787a4ae6516f8af5189eb22e668d249660f741802b90209d9c2697909ae69400f364fc80a7dfe703a69490bb78
+  metadata.gz: 59974cefd0e30b280ff61b6e2d624aea02ddeb099afc97eff50796f208f09f1a8327a91004441b87f5e7b5ea1d66908f8ebd56c467d1e2bdddf7f4ed8d1faafe
+  data.tar.gz: b4b288d0a7dd6e1766bdd8dc6ea72b7851aabaaaf16eb6eaf3a1c11f6d14ef2a3d2f4f859c38f6c4ed6127afedb1655cf9b5f705ade2d22683eb3f27224f8589

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## Next
 
+## v0.11.0
+
+This release adds new functionality to our URI strategies, adding
+`URIStrategy#permalink`, to make support for pretty URI strategies (i.e. where
+entries all end in `/index.ext`) better and more compatible with web servers
+where `foo` is the "same thing" as `foo/index.html`.
+
+Example output filename:
+
+    /my/filename/index.html
+
+Expected permalink for this file using a pretty URI strategy:
+
+    /my/filename
+
 ## v0.10.2
 
 This release resolves another bug in `Entry#summary` causing entries without

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifer (0.10.2)
+    lifer (0.11.0)
       i18n (< 2)
       kramdown (~> 2.4)
       liquid (~> 5.6, < 6)

data/lib/lifer/entry.rb

@@ -194,9 +194,10 @@ module Lifer
           cached_permalink_variable,
           File.join(
             host,
-            Lifer::URIStrategy.find(collection.setting :uri_strategy)
+            Lifer::URIStrategy
+              .find(collection.setting :uri_strategy)
               .new(root: Lifer.root)
-              .output_file(self)
+              .permalink(self)
           )
         )
     end

data/lib/lifer/uri_strategy/pretty.rb

@@ -14,8 +14,15 @@ class Lifer::URIStrategy::Pretty < Lifer::URIStrategy
     basename = File.basename entry.file,
       Lifer::Utilities.file_extension(entry.file)
 
-    Pathname entry.file.to_s
+    entry.file.to_s
       .gsub(/#{root}[\/]{0,1}/, "")
-      .gsub(/#{basename}(\..+)/, "#{basename}/index.#{file_extension(entry)}")
+      .gsub(/#{basename}(\..+)/, "#{basename}#{pretty_part entry}")
   end
+
+  # @see Lifer::UriStrategy#permalink
+  def permalink(entry) = output_file(entry).gsub pretty_part(entry), ""
+
+  private
+
+  def pretty_part(entry) = "/index.#{file_extension(entry)}"
 end

data/lib/lifer/uri_strategy/pretty_root.rb

@@ -11,14 +11,28 @@ class Lifer::URIStrategy
 
     # @see Lifer::URIStrategy#output_file
     def output_file(entry)
-      basename = File.basename entry.file,
-        Lifer::Utilities.file_extension(entry.file)
+      if basename(entry) == "index"
+        "index.html"
+      else
+        "#{basename entry}#{pretty_part entry}"
+      end
+    end
 
-      if basename == "index"
-        Pathname "index.html"
+    # @see Lifer::UriStrategy#permalink
+    def permalink(entry)
+      if basename(entry) == "index"
+        "/"
       else
-        Pathname "#{basename}/index.#{file_extension(entry)}"
+        output_file(entry).gsub pretty_part(entry), ""
       end
     end
+
+    private
+
+    def basename(entry)
+      File.basename entry.file, Lifer::Utilities.file_extension(entry.file)
+    end
+
+    def pretty_part(entry) = "/index.#{file_extension(entry)}"
   end
 end

data/lib/lifer/uri_strategy/pretty_yyyy_mm_dd.rb

@@ -24,9 +24,16 @@
     basename = File.basename entry.file,
       Lifer::Utilities.file_extension(entry.file)
 
-    Pathname entry.file.to_s
+    entry.file.to_s
       .gsub(/#{root}[\/]{0,1}/, "")
-      .gsub(/#{basename}(\..+)/, "#{basename}/index.#{file_extension(entry)}")
+      .gsub(/#{basename}(\..+)/, "#{basename}#{pretty_part entry}")
       .gsub(DATE_REGEXP, "")
   end
+
+  # @see Lifer::UriStrategy#permalink
+  def permalink(entry) = output_file(entry).gsub pretty_part(entry), ""
+
+  private
+
+  def pretty_part(entry) = "/index.#{file_extension(entry)}"
 end

data/lib/lifer/uri_strategy/root.rb

@@ -11,7 +11,10 @@ class Lifer::URIStrategy
       basename = File.basename entry.file,
         Lifer::Utilities.file_extension(entry.file)
 
-      Pathname "#{basename}.#{file_extension(entry)}"
+      "#{basename}.#{file_extension(entry)}"
     end
+
+    # @see Lifer::UriStrategy#permalink
+    def permalink(entry) = output_file(entry)
   end
 end

data/lib/lifer/uri_strategy/simple.rb

@@ -10,8 +10,11 @@ class Lifer::URIStrategy::Simple < Lifer::URIStrategy
     basename = File.basename entry.file,
       Lifer::Utilities.file_extension(entry.file)
 
-    Pathname entry.file.to_s
+    entry.file.to_s
       .gsub(/#{root}[\/]{0,1}/, "")
       .gsub(/#{basename}(\..+)/, "#{basename}.#{file_extension(entry)}")
   end
+
+  # @see Lifer::UriStrategy#permalink
+  def permalink(entry) = output_file(entry)
 end

data/lib/lifer/uri_strategy.rb

@@ -39,6 +39,24 @@ class Lifer::URIStrategy
     raise NotImplementedError, I18n.t("shared.not_implemented_method")
   end
 
+  # This method should sometimes return the path to the file in the format
+  # specified by the current URI strategy. Of course, this depends on what the URI
+  # stategy is. For "pretty" strategies, the permalink may differ from the output
+  # filename. For example, the output file may point to
+  #
+  #    entry-name/index.html
+  #
+  # While the permalink like points to:
+  #
+  #    entry-name
+  #
+  # @raise [NotImplementedError] This method must be implemented on each
+  #   subclass.
+  # @return [String] The permalink to the built output file.
+  def permalink(entry)
+    raise NotImplementedError, I18n.t("shared.not_implemented_error")
+  end
+
   private
 
   def file_extension(entry) = entry.class.output_extension

data/lib/lifer/version.rb

@@ -1,3 +1,3 @@
 module Lifer
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-10 00:00:00.000000000 Z
+date: 2025-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -210,8 +210,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.10.2/README.md
-  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.10.2
+  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.11.0/README.md
+  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.11.0
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []