lifer 0.11.0 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a63fea0c89c87889fa7aab9fc17e53385a562d2bf5bbca5aa552076acc31ed10
-  data.tar.gz: d158cad653234c27d4f17291f2a4511e3896684e148e5aa12206ffdef4403603
+  metadata.gz: 71407123cb005d99c9ffc1cde0c263921d0c45c22936c95b0ccced6bc189cb54
+  data.tar.gz: 2b4a5ba58c99283e8df136e492c653bd04761c0b07ea643e7de7ed00216bfb37
 SHA512:
-  metadata.gz: 59974cefd0e30b280ff61b6e2d624aea02ddeb099afc97eff50796f208f09f1a8327a91004441b87f5e7b5ea1d66908f8ebd56c467d1e2bdddf7f4ed8d1faafe
-  data.tar.gz: b4b288d0a7dd6e1766bdd8dc6ea72b7851aabaaaf16eb6eaf3a1c11f6d14ef2a3d2f4f859c38f6c4ed6127afedb1655cf9b5f705ade2d22683eb3f27224f8589
+  metadata.gz: 4dfed0a714043b38b861c0dbdae8f12d22c0b3fb4dda11f494dfed56cb346e6abcdfb87ce270dd9b17b2259751ef99b05516eee039c933b2d4b53c45897c9456
+  data.tar.gz: 42a12372430de5c6a2e96ddeb211b82e9c82fde78be316d4cc4b5fbbdfaa87877fce7940e32dfb49bbc69ceb0e64a4b57f228a6a53ba536c017e3c92aa06a83e

data/.github/workflows/main.yml

@@ -7,11 +7,11 @@ jobs:
     name: Run RSpec test suite
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3.4
+        ruby-version: 3.4
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 ## Next
 
+## v0.12.3
+
+This release just resolves some issues I was having with the platform in
+the gem specification being set wrong. Unfortunately, it was set wrong for
+both the 0.12.1 and 0.12.2 releases. So, this release is just a resolution
+to this little issue.
+
+## v0.12.2
+
+This release makes minor improvements to the development server by adding
+additional servable MIME types. That's all.
+
+## v0.12.1
+
+This patch release resolves a couple of issues that may affect users:
+
+- This release makes the implicit dependency on `base64` explicit. This
+  is necessary because as of Ruby 3.4, `base64` is no longer part of Ruby's
+  standard library.
+- Resolves errors when `Lifer::Utilities#stringify_keys` or `#symbolize_keys`
+  are passed `nil` or an empty hash.
+
+## 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
@@ -36,7 +70,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

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    lifer (0.11.0)
+    lifer (0.12.3)
+      base64
       i18n (< 2)
       kramdown (~> 2.4)
       liquid (~> 5.6, < 6)
@@ -14,9 +15,10 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
-    bigdecimal (3.1.9)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
     bump (0.10.0)
     capybara (3.40.0)
       addressable
@@ -27,96 +29,99 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
-    concurrent-ruby (1.3.5)
-    debug (1.9.2)
+    concurrent-ruby (1.3.6)
+    date (3.5.1)
+    debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.5.1)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
-    i18n (1.14.7)
+    diff-lcs (1.6.2)
+    erb (6.0.1)
+    ffi (1.17.3)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.14.0)
+    io-console (0.8.2)
+    irb (1.16.0)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    kramdown (2.5.1)
-      rexml (>= 3.3.9)
-    language_server-protocol (3.17.0.3)
-    liquid (5.8.6)
+    kramdown (2.5.2)
+      rexml (>= 3.4.4)
+    language_server-protocol (3.17.0.5)
+    liquid (5.11.0)
       bigdecimal
       strscan (>= 3.1.1)
-    listen (3.9.0)
+    listen (3.10.0)
+      logger
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.1)
-    matrix (0.4.2)
+    logger (1.7.0)
+    matrix (0.4.3)
     mini_mime (1.1.5)
-    nio4r (2.7.4)
-    nokogiri (1.16.7-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
+    mini_portile2 (2.8.9)
+    nio4r (2.7.5)
+    nokogiri (1.19.0)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.26.3)
-    parallel_tests (4.7.2)
+    parallel (1.27.0)
+    parallel_tests (5.5.0)
       parallel
-    prism (1.0.0)
-    psych (5.1.2)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.3.1)
+      date
       stringio
-    public_suffix (6.0.1)
-    puma (6.6.0)
+    public_suffix (7.0.2)
+    puma (6.6.1)
       nio4r (~> 2.0)
     racc (1.8.1)
-    rack (3.1.7)
-    rack-test (2.1.0)
+    rack (3.2.4)
+    rack-test (2.2.0)
       rack (>= 1.3)
-    rake (13.2.1)
+    rake (13.3.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rbs (3.5.3)
+    rbs (3.10.3)
       logger
-    rdoc (6.7.0)
+      tsort
+    rdoc (7.1.0)
+      erb
       psych (>= 4.0.0)
-    regexp_parser (2.9.2)
-    reline (0.5.10)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.3)
       io-console (~> 0.5)
-    rexml (3.4.1)
-    rspec (3.13.0)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rss (0.3.1)
+    rspec-support (3.13.7)
+    rss (0.3.2)
       rexml
-    ruby-lsp (0.17.17)
+    ruby-lsp (0.26.5)
       language_server-protocol (~> 3.17.0)
-      prism (~> 1.0)
-      rbs (>= 3, < 4)
-      sorbet-runtime (>= 0.5.10782)
-    sorbet-runtime (0.5.11558)
-    stringio (3.1.1)
-    strscan (3.1.5)
+      prism (>= 1.2, < 2.0)
+      rbs (>= 3, < 5)
+    stringio (3.2.0)
+    strscan (3.1.7)
+    tsort (0.2.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    yard (0.9.37)
+    yard (0.9.38)
 
 PLATFORMS
-  arm64-darwin-22
-  x86_64-darwin-21
-  x86_64-darwin-22
-  x86_64-linux
+  ruby
 
 DEPENDENCIES
   bump
@@ -131,4 +136,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.21
+   2.6.9

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

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

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

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

@@ -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/dev/response.rb

@@ -21,9 +21,7 @@ module Lifer::Dev
     #   3. The HTTP body response.
     #
     # @return [Array] A Rack-compatible response.
-    def build
-      [status, {"Content-Type": content_type}, contents]
-    end
+    def build = [status, {"Content-Type": content_type}, contents]
 
     private
 
@@ -33,28 +31,78 @@ module Lifer::Dev
       [File.read(path)]
     end
 
-    # @fixme  It would be very nice to not manually manage this list of
+
+    # The MIME type for the current path. Because Lifer only offers a server
+    # for development mode, this is just a simple map based on common known
+    # MIME types. We recommend submitting a patch or monkey-patching this
+    # method if it does not suit your needs in development. For more
+    # information:
+    #
+    # https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types/Common_types
+    #
+    # @fixme It would be very nice to not manually manage this list of
     #   content types. Is there a nice, dependency-free way to do this?
     #
+    # @return [String] The MIME type for the current  path's file extension.
     def content_type
       case File.extname(path)
+      when ".aac" then "audio/aac"
+      when ".apng" then "image/apng"
+      when ".avi" then "video/x-msvideo"
+      when ".avif" then "image/avif"
+      when ".bin" then "application/octet-stream"
+      when ".bmp" then "image/bmp"
       when ".css" then "text/css"
+      when ".csv" then "text/csv"
+      when ".epub" then "application/epub+zip"
+      when ".gz" then "application/gzip"
+      when ".gif" then "image/gif"
       when ".html" then "text/html"
       when ".ico" then "image/ico"
+      when ".ics" then "text/calendar"
+      when ".jpeg", ".jpg" then "image/jpg"
       when ".js" then "text/javascript"
+      when ".json" then "application/json"
+      when ".jsonld" then "application/ld+json"
+      when ".mid", ".midi" then "audio/midi"
       when ".map" then "application/json"
+      when ".mpkg" then "application/vnd.apple.installer+xml"
+      when ".mp3" then "audio/mpeg"
+      when ".mp4" then "video/mp4"
+      when ".mpeg" then "video/mpeg"
+      when ".oga" then "audio/ogg"
+      when ".ogv" then "video/ogg"
+      when ".ogx" then "application/ogg"
+      when ".opus" then "audio/ogg"
+      when ".otf" then "font/otf"
+      when ".pdf" then "application/pdf"
+      when ".png" then "image/png"
+      when ".rar" then "application/vnd.rar"
+      when ".rtf" then "application/rtf"
+      when ".sh" then "application/x-sh"
+      when ".svg" then "image/svg+xml"
+      when ".tar" then "application/x-tar"
+      when ".tif", ".tiff" then "image/tiff"
+      when ".ttf" then "font/tff"
       when ".txt" then "text/plain"
-      when ".woff" then "application/font-woff2"
-      when ".woff2" then "application/font-woff2"
+      when ".wav" then "audio/wav"
+      when ".weba" then "audio/webm"
+      when ".webm" then "video/webm"
+      when ".webmanifest" then "application/manifest+json"
+      when ".webp" then "image/webp"
+      when ".woff", ".woff2" then "application/font-woff2"
+      when ".xml" then "application/xml"
+      when ".xhtml" then "application/xhtml+xml"
       when ".xml" then "application/xml"
+      when ".xul" then "application/vnd.mozilla.xul+xml"
+      when ".zip" then "application/zip"
+      when ".7z" then "application/x-7z-compressed"
       else
         raise NotImplementedError,
           I18n.t("dev.router.content_type_not_implemented", path:)
       end
     end
 
-    def status
-      File.exist?(path) ? 200 : 404
-    end
+    def status = File.exist?(path) ? 200 : 404
   end
 end

data/lib/lifer/utilities.rb

@@ -101,7 +101,7 @@ module Lifer::Utilities
     def stringify_keys(hash)
       stringified_hash = {}
 
-      hash.each do |key, value|
+      hash&.each do |key, value|
         stringified_hash[(key.to_s rescue key) || key] =
           value.is_a?(Hash) ? stringify_keys(value) : value
 
@@ -119,7 +119,7 @@ module Lifer::Utilities
     def symbolize_keys(hash)
       symbolized_hash = {}
 
-      hash.each do |key, value|
+      hash&.each do |key, value|
         symbolized_hash[(key.to_sym rescue key) || key] =
           value.is_a?(Hash) ? symbolize_keys(value) : value
 

data/lib/lifer/version.rb

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

data/lifer.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
     spec.files.grep(%r{\Abin/}) { |bin_file| File.basename(bin_file) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "base64"
   spec.add_dependency "i18n", "< 2"
   spec.add_dependency "kramdown", "~> 2.4"
   spec.add_dependency "liquid", ["~> 5.6", "< 6"]

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.3
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-11 00:00:00.000000000 Z
+date: 2026-02-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -210,8 +224,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  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
+  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.12.3/README.md
+  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.12.3
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
@@ -228,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Minimal static weblog generator.