lifer 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea41a2cd1a058f5a103121b6b7641ce5857ec74300ecad4bb36ec33578170650
-  data.tar.gz: f752dc7498a0457945d895fc591eefc7a27a296e01a5b547264a13fd8113c3b5
+  metadata.gz: 1b6414082e8f6f1d9b18034f2f227890b85ac73b22ab50c25cb2e350812c1a90
+  data.tar.gz: 5891afc57d102fd67422bf581edc4de839b05efbe10d104529a817391c0e7cad
 SHA512:
-  metadata.gz: 4665579521538df261c0839f6c1a7ee6b24362ca75c03cc6d8fbf42dfffa028ad0bc39c1fe01ef2407459cb1be6bdf9d08e60cd5abacd1e233b0819bbcab6186
-  data.tar.gz: e1bfbd9fa63bd2de10022f2b5810cfcf518acc5112f51bb843c19c936bc269436807a606c335ab90693bafac53569315b0bfcbe245b9c8570a56ff6ab60af6f0
+  metadata.gz: 7adb1041c558a2d60ef525bf1d12af4dd3d587a26f8ae0ef4e2f4c8fb9e04e14c648cf4bd72717aba143e747ccabe970ec1c859cd0c69b5259847887c0f99361
+  data.tar.gz: a9ec79fce82554f69ba1634ce414b7b63014c8545f8f8c5a6201c194d375d57d09a36128db4f6b242c279bfe0fe419f3b333034268415379c1b9138d372d352f

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## Next
 
+## v0.9.0
+
+Atom feeds now support entries with both `#published_at` and `#updated_at`
+timestamp. There is no standard equivalent way to provide this functonality for
+RSS-format feeds, unfortunately. As part of this change, we removed all
+`Entry#date` methods in favour of `Entry#published_at` onces. In Atom feeds, if
+an article has no last updated date, the publication date is used instead.
+
+Additionally, this release includes a new environment variable:
+`LIFER_UNPARALLELIZED`. You can use this environment variable to run `lifer
+build` or `lifer serve` without any parallelization turned on. This could be
+useful for reproducing bugs and so on. Example usage:
+
+    LIFER_UNPARALLELIZED=1 lifer build
+
 ## v0.8.0
 
 ### Tags

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifer (0.8.0)
+    lifer (0.9.0)
       i18n (< 2)
       kramdown (~> 2.4)
       liquid (~> 5.6, < 6)
@@ -44,7 +44,7 @@ GEM
     kramdown (2.5.1)
       rexml (>= 3.3.9)
     language_server-protocol (3.17.0.3)
-    liquid (5.8.1)
+    liquid (5.8.2)
       bigdecimal
       strscan (>= 3.1.1)
     listen (3.9.0)

data/lib/lifer/builder/html/from_liquid/drops/entry_drop.rb

@@ -4,7 +4,9 @@ module Lifer::Builder::HTML::FromLiquid::Drops
   #
   # @example Usage
   #     <h1>{{ entry.title }}</h1>
-  #     <small>Published on <datetime>{{ entry.date }}</datetime></small>
+  #     <small>
+  #       Published on <datetime>{{ entry.published_at }}</datetime>
+  #     </small>
   #
   class EntryDrop < Liquid::Drop
     attr_accessor :lifer_entry, :collection
@@ -30,11 +32,6 @@ module Lifer::Builder::HTML::FromLiquid::Drops
     # @return [String]
     def content = (@content ||= lifer_entry.to_html)
 
-    # The entry date (as a string).
-    #
-    # @return [String]
-    def date = (@date ||= lifer_entry.date)
-
     # The entry frontmatter data.
     #
     # @return [FrontmatterDrop]
@@ -50,6 +47,11 @@ module Lifer::Builder::HTML::FromLiquid::Drops
     # @return [String] The entry permalink.
     def permalink = (@permalink ||= lifer_entry.permalink)
 
+    # The entry publication date (as a string).
+    #
+    # @return [String]
+    def published_at = (@published_at ||= lifer_entry.published_at)
+
     # The summary of the entry.
     #
     # @return [String] The summary of the entry.
@@ -59,5 +61,10 @@ module Lifer::Builder::HTML::FromLiquid::Drops
     #
     # @return [String] The entry title.
     def title = (@title ||= lifer_entry.title)
+
+    # The entry's last updated date (as a string).
+    #
+    # @return [String]
+    def updated_at = (@updated_at ||= lifer_entry.updated_at)
   end
 end

data/lib/lifer/builder/html/from_liquid/filters.rb

@@ -2,7 +2,7 @@
 # In many cases these utilities exist to be pseudo-compatible with Jekyll.
 #
 # @example A filter in a Liquid template.
-#     {{ entry.date | date_to_xmlschema }}
+#     {{ entry.published_at | date_to_xmlschema }}
 #
 module Lifer::Builder::HTML::FromLiquid::Filters
   # @!visibility private

data/lib/lifer/builder/rss.rb

@@ -65,8 +65,7 @@ class Lifer::Builder::RSS < Lifer::Builder
   # The name of the format type, as needed by `RSS::Maker`, used by default by
   # this feed builder.
   #
-  DEFAULT_MAkER_FORMAT_NAME = FORMATS[:rss]
-
+  DEFAULT_MAKER_FORMAT_NAME = FORMATS[:rss]
 
   self.name = :rss
   self.settings = [
@@ -96,7 +95,7 @@ class Lifer::Builder::RSS < Lifer::Builder
 
     return FORMATS[format] if FORMATS.keys.include? format
 
-    DEFAULT_MAkER_FORMAT_NAME
+    DEFAULT_MAKER_FORMAT_NAME
   end
 
   # Traverses and renders an RSS feed for feedable collection.
@@ -220,8 +219,21 @@ class Lifer::Builder::RSS < Lifer::Builder
       rss_feed_item.link = lifer_entry.permalink
       rss_feed_item.title = lifer_entry.title
       rss_feed_item.summary = lifer_entry.summary
-      rss_feed_item.updated = Time.now.to_s
-      rss_feed_item.content_encoded = lifer_entry.to_html
+
+      if feed_format(lifer_entry.collection) == "atom"
+        rss_feed_item.content.content = lifer_entry.to_html
+        rss_feed_item.published = lifer_entry.published_at
+
+        # Note: RSS does not provide a standard way to share last updated
+        # timestamps at all, while Atom does. This is the reason there is no
+        # equivalent call in the condition for RSS feeds.
+        #
+        rss_feed_item.updated =
+          lifer_entry.updated_at(fallback: lifer_entry.published_at)
+      else
+        rss_feed_item.content_encoded = lifer_entry.to_html
+        rss_feed_item.pubDate = lifer_entry.published_at.to_time.rfc2822
+      end
     end
   end
 

data/lib/lifer/collection.rb

@@ -57,9 +57,9 @@ class Lifer::Collection
         cached_entries_variable,
         case order
         when :latest
-          @entries_collection.sort_by { |entry| entry.date }.reverse
+          @entries_collection.sort_by { |entry| entry.published_at }.reverse
         when :oldest
-          @entries_collection.sort_by { |entry| entry.date }
+          @entries_collection.sort_by { |entry| entry.published_at }
         end
       )
   end

data/lib/lifer/entry.rb

@@ -150,26 +150,6 @@ module Lifer
       full_text.gsub(FRONTMATTER_REGEX, "").strip
     end
 
-    # Since text files would only store dates as simple strings, it's nice to
-    # attempt to convert those into Ruby date or datetime objects.
-    #
-    # @return [Time] A Ruby representation of the date and time provided by the
-    #   entry frontmatter or filename.
-    def date
-      date_data = frontmatter[:date] || filename_date
-
-      case date_data
-      when Time then date_data
-      when String then DateTime.parse(date_data).to_time
-      else
-        Lifer::Message.log("entry.no_date_metadata", filename: file)
-        Lifer::Entry::DEFAULT_DATE
-      end
-    rescue ArgumentError => error
-      Lifer::Message.error("entry.date_error", filename: file, error:)
-      Lifer::Entry::DEFAULT_DATE
-    end
-
     def feedable?
       if (setting = self.class.include_in_feeds).nil?
         raise NotImplementedError,
@@ -232,6 +212,27 @@ module Lifer
     # @return [String] The absolute URI path to the entry.
     def path = permalink(host: "/")
 
+    # The entry's publication date. The published date can be inferred in a few
+    # ways. The priority is:
+    #
+    #    1. the frontmatter's `published_at` field
+    #    2. the frontmatter's `published` field
+    #    3. the frontamtter's `date` field
+    #    4. The date in the filename.
+    #
+    # Since text files would only store dates as simple strings, it's nice to
+    # attempt to convert those into Ruby date or datetime objects.
+    #
+    # @return [Time] A Ruby representation of the date and time provided by the
+    #   entry frontmatter or filename.
+    def published_at
+      date_for frontmatter[:published_at],
+        frontmatter[:published],
+        frontmatter[:date],
+        filename_date,
+        missing_metadata_translation_key: "entry.no_published_at_metadata"
+    end
+
     # If given a summary in the frontmatter of the entry, we can use this to
     # provide a summary.
     #
@@ -263,6 +264,26 @@ module Lifer
       raise NotImplementedError, I18n.t("shared.not_implemented_method")
     end
 
+    # The entry's last updated date. In the frontmatter, the last updated date
+    # can be specified using one of two fields. In priority order:
+    #
+    #    1. the `updated_at` field
+    #    2. the `updated` field
+    #
+    # The developer could set a fallback value as a fallback. For example, when
+    # building RSS feeds one might want the value of `#published_at` if there is
+    # no last updated date.
+    #
+    # @param fallback [Time, String, NilClass] Provide datetime data, a string
+    #   that parses to a datetime object, or nil.
+    # @return [Time] A Ruby representation of the date and time provided by the
+    #   entry frontmatter.
+    def updated_at(fallback: nil)
+      date_for frontmatter[:updated_at],
+        frontmatter[:updated],
+        default_date: fallback
+    end
+
     private
 
     # It is conventional for users to use spaces or commas to delimit tags in
@@ -278,6 +299,27 @@ module Lifer
       end.uniq
     end
 
+    def date_for(
+      *candidate_date_fields,
+      default_date: Lifer::Entry::DEFAULT_DATE,
+      missing_metadata_translation_key: nil
+    )
+      date_data = candidate_date_fields.detect(&:itself)
+
+      case date_data
+      when Time then date_data
+      when String then DateTime.parse(date_data).to_time
+      else
+        if (translation_string = missing_metadata_translation_key)
+          Lifer::Message.log(translation_string, filename: file)
+        end
+        default_date
+      end
+    rescue ArgumentError => error
+      Lifer::Message.error("entry.date_error", filename: file, error:)
+      default_date
+    end
+
     def filename_date
       return unless file && File.basename(file).match?(FILENAME_DATE_FORMAT)
 

data/lib/lifer/utilities.rb

@@ -76,7 +76,10 @@ module Lifer::Utilities
     # @raise [Exception] Any exception thrown by a child process.
     # @return [Array] The mapped results of the operation.
     def parallelized(collection, &block)
-      results = Parallel.map(collection) do |collection_item|
+      options = {}
+      options[:in_threads] = 0 if Lifer.parallelism_disabled?
+
+      results = Parallel.map(collection, **options) do |collection_item|
         begin
           yield collection_item
         rescue => error

data/lib/lifer/version.rb

@@ -1,3 +1,3 @@
 module Lifer
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/lifer.rb

@@ -96,6 +96,16 @@ module Lifer
     #   project would be built to.
     def output_directory = brain.output_directory
 
+    # Returns false if the Lifer project will be built with parallelism. This
+    # should return false almost always--unless you've explicitly set the
+    # `LIFER_UNPARALLELIZED` environment variable before running the program.
+    #
+    # This method is used internally by Lifer to determine whether features that
+    # would normally run in parallel should *not* run in parallel for some reason.
+    #
+    # @return [boolean] Returns whether parallelism is disabled.
+    def parallelism_disabled? = ENV["LIFER_UNPARALLELIZED"].is_a?(String)
+
     # Register new settings so that they are "safe" and can be read from a Lifer
     # configuration file. Unregistered settings are ignored.
     #

data/locales/en.yml

@@ -33,7 +33,7 @@ en:
     date_error: "[%{filename}]: %{error}"
     feedable_error: >
       please set `%{entry_class}.include_in_feeds` to true or false
-    no_date_metadata: "[%{filename}]: no date metadata"
+    no_published_at_metadata: "[%{filename}]: no `published_at` metadata"
     not_found: >
       file "%{file}" does not exist
   config:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-30 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.8.0/README.md
-  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.8.0
+  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.9.0/README.md
+  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.9.0
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []