RubyGems - lifer - Versions diffs - 0.10.2 → 0.12.0 - Mend

lifer 0.10.2 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +27 -1
data/Gemfile.lock +3 -3
data/lib/lifer/builder/html/from_any.rb +1 -1
data/lib/lifer/builder/html/from_erb.rb +52 -3
data/lib/lifer/builder/html/from_liquid.rb +4 -4
data/lib/lifer/builder/html.rb +16 -3
data/lib/lifer/entry.rb +3 -2
data/lib/lifer/uri_strategy/pretty.rb +9 -2
data/lib/lifer/uri_strategy/pretty_root.rb +19 -5
data/lib/lifer/uri_strategy/pretty_yyyy_mm_dd.rb +9 -2
data/lib/lifer/uri_strategy/root.rb +4 -1
data/lib/lifer/uri_strategy/simple.rb +4 -1
data/lib/lifer/uri_strategy.rb +18 -0
data/lib/lifer/version.rb +1 -1
metadata +4 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0628d28de38f509eb51cc2d2dd65cb794fe3e4e46239bbf11c82decfd28f1d5d'
-  data.tar.gz: dcb12aba6fa318f57c3224fed97a6a28233b847ca7399f321c855a739a44543b
+  metadata.gz: 5f018de3a46e9674b5d0da11bb7d0dd5e111c7f8119d4c901fa2fb5d2458a9ab
+  data.tar.gz: a17f6d9a91115594caa0f786f4bbecb01b4f3afc2925864ed62cf8ead11de457
 SHA512:
-  metadata.gz: 0d74bf3c194492fec78a17ca70045dd107a40ddf33cf154243b33bb0a9d13876b1b0bdc4ea6bbf40c15984bf6a2a86dc898ed55939c9e222cf86d4cadd73b8d3
-  data.tar.gz: af6d75bd7b875807c8fc74c69b04c5849d0d5e787a4ae6516f8af5189eb22e668d249660f741802b90209d9c2697909ae69400f364fc80a7dfe703a69490bb78
+  metadata.gz: 5d2f01b4f70b947cba613f7bf23be66d777f23d9188d055a453586b1bca8ef46ef818faccb108d909ce2d809c9a4e15a162c0822f6a6e0d340682bbd525e436e
+  data.tar.gz: d3cfc16e8436ff73cfc0c01deb2e5f78574f202b8160b2dca64288980f1ea0c75699176150c87acaf24010cdedaddfa7f98871dadacad5fa2f16293ecdfe3e7c

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,32 @@
 ## Next
+## v0.12.0
+This release adds a new `#render` method that can be used in any ERB files being
+built into HTML documents. It matches the functionality of Liquid's builtiin
+`render` functionality. So:
+    {% render "my_partial.html.liquid" with local_variable: "some-value" %}
+is equivalent to:
+    <%= render "my_partial.html.erb", local_variable: "some-value" %>
+## 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
@@ -21,7 +48,6 @@ trash.
 The summary is meant to be ideal for things like `<meta>` description tags,
 which should only contain plain text.
 ## v0.10.0
 This release lets all layout files (either Liquid or ERB files) provide a

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifer (0.10.2)
+    lifer (0.12.0)
       i18n (< 2)
       kramdown (~> 2.4)
       liquid (~> 5.6, < 6)
@@ -16,7 +16,7 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    bigdecimal (3.1.9)
+    bigdecimal (3.2.2)
     bump (0.10.0)
     capybara (3.40.0)
       addressable
@@ -44,7 +44,7 @@ GEM
     kramdown (2.5.1)
       rexml (>= 3.3.9)
     language_server-protocol (3.17.0.3)
-    liquid (5.8.6)
+    liquid (5.8.7)
       bigdecimal
       strscan (>= 3.1.1)
     listen (3.9.0)

data/lib/lifer/builder/html/from_any.rb CHANGED Viewed

@@ -10,7 +10,7 @@ class Lifer::Builder
         # @param entry [Lifer::Entry] The entry to be rendered.
         # @return [String] The rendered entry.
         def build(entry:)
-          new(entry: entry).render
+          new(entry: entry).build
         end
       end

data/lib/lifer/builder/html/from_erb.rb CHANGED Viewed

@@ -11,6 +11,8 @@ class Lifer::Builder::HTML
   #       </head>
   #
   #       <body>
+  #         <%= partial "_layouts/header.html.erb" %>
+  #
   #         <h1><%= my_collection.name %></h1>
   #
   #         <% my_collection.entries.each do |entry| %>
@@ -20,22 +22,31 @@ class Lifer::Builder::HTML
   #             <a href="<%= entry.permalink %>">Read more</a>
   #           </section>
   #         <% end %>
+  #
+  #         <%= partial "_layouts/footer.html.erb" %>
   #       </body>
   #     </html>
   #
   class FromERB < FromAny
     # Reads the entry as ERB, given our renderer context (see the documentation
-    # for `#build_binding_context`) and renders the production-ready entry.
+    # for `#build_binding_context`) and builds the production-ready entry.
     #
-    # @return [String] The rendered entry.
-    def render
+    # @return [String] The resulting HTML entry.
+    def build
       document = ERB.new(layout_file_contents).result context
       return document unless (relative_layout_path = frontmatter[:layout])
       document_binding = binding.tap { |binding|
+        context.local_variables.each do |variable|
+          next if variable == :content
+          binding.local_variable_set variable,
+            context.local_variable_get(variable)
+        end
         binding.local_variable_set :content, document
       }
       layout_path = "%s/%s" % [Lifer.root, relative_layout_path]
       ERB.new(File.read layout_path).result(document_binding)
     end
@@ -95,6 +106,11 @@ class Lifer::Builder::HTML
         binding.local_variable_set :tags, tags
         binding.local_variable_set :content,
           ERB.new(entry.to_html).result(binding)
+        define_singleton_method :render,
+          -> (relative_path_to_template, locals = {}) {
+            partial_render_method relative_path_to_template, locals
+          }
       }
     end
@@ -105,5 +121,38 @@ class Lifer::Builder::HTML
     def tag_context_class
       @tag_context_class ||= Class.new(Array) do end
     end
+    # @private
+    # If the end user should want to render a partial from an entry or a layout
+    # file, this method provides the functionality for the `#partial` method
+    # provided to the ERB template context, complete with all of the information
+    # one might want want about the entry, project collections, and so on, that's
+    # available from entry and layout templates.
+    #
+    # @example Usage
+    #    <%= partial "_layouts/my_partial.html.erb", id: "123" %>
+    # @param relative_path_to_template [String] The path, from the Lifer root,
+    #   to the partial layout file.
+    # @param locals [Hash] Additional data that should be passed along for
+    #   rendering the partial.
+    # @return [String] The rendered partial document.
+    def partial_render_method(relative_path_to_template, locals)
+      template_path = File.join(Lifer.root, relative_path_to_template)
+      partial_binding = binding.tap { |binding|
+        context.local_variables.each do |variable|
+          next if variable == :content
+          binding.local_variable_set variable,
+            context.local_variable_get(variable)
+        end
+        locals.each do |key, value|
+          binding.local_variable_set key.to_sym, value
+        end
+      }
+      ERB.new(File.read template_path).result(partial_binding)
+    end
   end
 end

data/lib/lifer/builder/html/from_liquid.rb CHANGED Viewed

@@ -28,11 +28,11 @@ class Lifer::Builder::HTML
     require_relative "from_liquid/filters"
     require_relative "from_liquid/liquid_env"
-    # Reads the entry as Liquid, given our document context, and renders
-    # an entry.
+    # Reads the Liquid entry, given our document context, and builds an HTML
+    # document.
     #
-    # @return [String] The rendered entry.
-    def render
+    # @return [String] The resulting HTML entry.
+    def build
       document_context = context.merge!(
         "content" => Liquid::Template
           .parse(entry.to_html, **parse_options)

data/lib/lifer/builder/html.rb CHANGED Viewed

@@ -7,9 +7,22 @@ require "fileutils"
 # ERB[1] or Liquid[2] template files. The layout file yields entry contents
 # via a `content` call that is parsed by ERB or Liquid.
 #
-# Layout files can also include other contextual information about the current
-# Lifer project to provide "normal website features" like navigation links,
-# indexes, and so on. Context is provided via:
+# It is normal to have templates that render other templates. So normal, in
+# fact, that Liquid provides a built-in `render` function that allows us to render
+# partials from other Liquid files:
+#
+#     {% render "path/to/my/partial.html.liquid" with local_variable: "value" %}
+#
+# And we've ensured a similar `render` function exists for our ERB HTML builder:
+#
+#     <%= render "path/to/my/partial.html.erb", local_variable: "value" %>
+#
+# The entry being built will include contextual data about the current project,
+# so that the user can build out normal website features like navigation links,
+# indexes, and so on. Note that with the current Liquid implementation, you may
+# need to explicitly pass context from layouts to the partials that require it via
+# `with`. Meanwhile, the ERB implementation provides a bunch of context globally.
+# Context includes:
 #
 #  - `my_collection_name`: Or, any collection by name.
 #

data/lib/lifer/entry.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.12.0
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-10 00:00:00.000000000 Z
+date: 2025-07-01 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.12.0/README.md
+  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.12.0
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []