RubyGems - lifer - Versions diffs - 0.13.0 → 0.14.0 - Mend

lifer 0.13.0 → 0.14.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 (17) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +19 -0
data/Gemfile.lock +1 -1
data/lib/lifer/brain.rb +2 -7
data/lib/lifer/builder/html/from_any.rb +1 -1
data/lib/lifer/builder/html/from_erb.rb +18 -12
data/lib/lifer/builder/html.rb +1 -1
data/lib/lifer/builder/txt.rb +1 -1
data/lib/lifer/collection.rb +3 -2
data/lib/lifer/entry.rb +6 -0
data/lib/lifer/selection.rb +4 -2
data/lib/lifer/tag.rb +13 -2
data/lib/lifer/templates/config.yaml +1 -0
data/lib/lifer/uri_strategy.rb +1 -1
data/lib/lifer/version.rb +1 -1
data/lib/lifer.rb +15 -10
metadata +4 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e8681438caf9356526a0af22c91ec3470c3ccba625c7d6602adab532d89a4b2
-  data.tar.gz: 9c2eefb99f760d50aac163f2dff6e0d06d3710d2a0682426ff45d75733be3640
+  metadata.gz: b4416a9edb890d8d98adc06d1baf7e58b695d85da827b48005d7285b6f5a1dbe
+  data.tar.gz: 0c45a40304601d473c946315ddea56860041339e029467f8bcecb603ca70a58a
 SHA512:
-  metadata.gz: e4411e369a5fab2ec20c0a9c6835279ecc3b0a9c8d522c8ad9b2f5e06223b60ccd3604f576bc9a06f051a6a6e1d33d2990e6e601b1046488ef6812c9ca27182b
-  data.tar.gz: 45697944e8bb0c378083db6b4ec2c5fe0df67c70a51a5dad87cb6d57fade3f58a98d5dbc07086bd231126f49802c47930490febc85aa1b313bbe372b1a70e13c
+  metadata.gz: b8aa3c53f350191b59ff5105ac1130c62c4a2f690aca83794877b933e7d7bfa23e501d2c91bd90dfc4954a4db9edf57b5db8ea4c4bf75fe78aa3e3e3e7e20e0c
+  data.tar.gz: f9b729936ec8ef025d9bc6dc8b6deab6d4d63c1d281da50e99df5932cd1f245c581c911378a703f1ddb7e6a5167f21fa746a780ac9e9ad72f29721d93bf34215

data/CHANGELOG.md CHANGED Viewed

@@ -1,4 +1,23 @@
 ## Next
+## v0.14.0
+This release includes some really nice improvements and bug fixes:
+- When returning a list of entries belonging to a `Lifer::Collection` or a
+  `Lifer::Tag`, the entries are now returned in reverse chronological order
+  by default. (But you can pass the argument `order: :oldest` to get them
+  in reverse, if you want.)
+- We fixed a bug where entries in `.html.erb` format that attempted to render
+  view partials would error out due to the `render` method not having been
+  defined with the context of the entry being built yet. This bug was a bit
+  unpleasant to reason about, but it resolves a major defect with ERB building.
+- The included Lifer configuration file template now enables the
+  JSON Feed builder by default.
+- Every `Lifer::Selection` name is now automatically registered as a setting so
+  that you can configure it like you configure any other collection of entries.
+- Lastly, this release removes `Lifer.manifest`. (A collection of absolute
+  paths to every entry file ended up not being incredibly useful. We get
+  the same-ish functionality from `Lifer.entry_manifest`.)
 ## v0.13.0

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifer (0.13.0)
+    lifer (0.14.0)
       base64
       i18n (< 2)
       kramdown (~> 2.4)

data/lib/lifer/brain.rb CHANGED Viewed

@@ -94,17 +94,12 @@ class Lifer::Brain
   # @return [Lifer::Config] The Lifer configuration object.
   def config = (@config ||= Lifer::Config.build file: config_file_location)
-  # Returns all entries that have been added to the manifest. If all is working
-  # as intended, this should be every entry ever generated.
+  # Allows for getting the entry manifest or shovelling new entries to the
+  # entry manifest.
   #
   # @return [Set<Lifer::Entry>] All entries that currently exist.
   def entry_manifest = (@entry_manifest ||= Set.new)
-  # A manifest of all Lifer project entries.
-  #
-  # @return [Set<Lifer::Entry>] A set of all entries.
-  def manifest = (@manifest ||= Set.new)
   # Returns the build directory for the Lifer project's build output.
   #
   # @return [String] The Lifer build directory.

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

@@ -18,7 +18,7 @@ class Lifer::Builder
       # should be expected to.
       #
       # @raise [NotImplementedError]
-      def render
+      def render(_path, _locals, _context)
         raise NotImplementedError,
           "subclasses must implement a custom `#render` method"
       end

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

@@ -11,7 +11,7 @@ class Lifer::Builder::HTML
   #       </head>
   #
   #       <body>
-  #         <%= partial "_layouts/header.html.erb" %>
+  #         <%= render "_layouts/header.html.erb" %>
   #
   #         <h1><%= my_collection.name %></h1>
   #
@@ -23,7 +23,7 @@ class Lifer::Builder::HTML
   #           </section>
   #         <% end %>
   #
-  #         <%= partial "_layouts/footer.html.erb" %>
+  #         <%= render "_layouts/footer.html.erb" %>
   #       </body>
   #     </html>
   #
@@ -101,16 +101,20 @@ class Lifer::Builder::HTML
         collections = collection_context_class.new Lifer.collections
         tags = tag_context_class.new Lifer.tags
-        binding.local_variable_set :collections, collections
-        binding.local_variable_set :settings, Lifer.settings
-        binding.local_variable_set :tags, tags
-        binding.local_variable_set :content,
-          ERB.new(entry.to_html).result(binding)
+        current_binding = binding
+        current_binding.local_variable_set :collections, collections
+        current_binding.local_variable_set :settings, Lifer.settings
+        current_binding.local_variable_set :tags, tags
         define_singleton_method :render,
           -> (relative_path_to_template, locals = {}) {
-            partial_render_method relative_path_to_template, locals
+            partial_render_method relative_path_to_template,
+              locals,
+              current_binding
           }
+        current_binding.local_variable_set :content,
+          ERB.new(entry.to_html).result(binding)
       }
     end
@@ -130,21 +134,23 @@ class Lifer::Builder::HTML
     # available from entry and layout templates.
     #
     # @example Usage
-    #    <%= partial "_layouts/my_partial.html.erb", id: "123" %>
+    #    <%= render "_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.
+    # @param source_binding [Binding] A binding object carrying context
+    #   required to render the current partial layout.
     # @return [String] The rendered partial document.
-    def partial_render_method(relative_path_to_template, locals)
+    def partial_render_method(relative_path_to_template, locals, source_binding)
       template_path = File.join(Lifer.root, relative_path_to_template)
       partial_binding = binding.tap { |binding|
-        context.local_variables.each do |variable|
+        source_binding.local_variables.each do |variable|
           next if variable == :content
           binding.local_variable_set variable,
-            context.local_variable_get(variable)
+            source_binding.local_variable_get(variable)
         end
         locals.each do |key, value|

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

@@ -116,7 +116,7 @@ class Lifer::Builder::HTML < Lifer::Builder
   #   entry cannot be output to HTML.  We should not care about this return
   #   value.
   def generate_output_file_for(entry)
-    return unless entry.class.output_extension == :html
+    return unless entry.output_extension == :html
     relative_path = output_file entry
     absolute_path = File.join(Lifer.output_directory, relative_path)

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

@@ -56,7 +56,7 @@ class Lifer::Builder::TXT < Lifer::Builder
   end
   def generate_output_file_for(entry)
-    return unless entry.class.output_extension == :txt
+    return unless entry.output_extension == :txt
     relative_path = output_file entry
     absolute_path = File.join(Lifer.output_directory, relative_path)

data/lib/lifer/collection.rb CHANGED Viewed

@@ -32,12 +32,13 @@ class Lifer::Collection
         .select { |candidate| Lifer::Entry.supported? candidate }
       entries = entry_glob.select { |entry|
-        if Lifer.manifest.include? entry
+        filenames = Lifer.entry_manifest.map(&:file)
+        if filenames.include? entry
           false
         elsif Lifer.ignoreable? entry.gsub("#{directory}/", "")
           false
         else
-          Lifer.manifest << entry
           true
         end
       }.map { |entry| Lifer::Entry.generate file: entry, collection: }

data/lib/lifer/entry.rb CHANGED Viewed

@@ -205,6 +205,12 @@ module Lifer
       @full_text ||= File.readlines(file).join if file
     end
+    # The file extension to be used when at the entry's build time. For
+    # example, a Markdown file should be built to HTML.
+    #
+    # @return [String]
+    def output_extension = self.class.output_extension
     # Using the current Lifer configuration, we can calculate the expected
     # permalink for the entry. For example:
     #

data/lib/lifer/selection.rb CHANGED Viewed

@@ -6,7 +6,7 @@
 # detected Ruby files are dynamically loaded when `Lifer::Brain` is initialized.
 #
 # Implementing a selection is simple. Just implement the `#entries` method and
-# rovide a name. The `#entries` method can be used to filter down
+# provide a name. The `#entries` method can be used to filter down
 # `Lifer.entry_manifest` in whichever way one needs. To see examples of this,
 # check out the source code of any of the included selections.
 #
@@ -25,7 +25,9 @@ class Lifer::Selection < Lifer::Collection
     #
     # @return [Lifer::Selection]
     def generate
-      new(name: name, directory: nil)
+      selection = new(name: name, directory: nil)
+      Lifer.register_settings name
+      selection
     end
     private

data/lib/lifer/tag.rb CHANGED Viewed

@@ -43,11 +43,22 @@ module Lifer
     attr_accessor :name
-    attr_reader :entries
     def initialize(name:, entries:)
       @name = name
       @entries = entries
     end
+    # Returns the tag's associated entries in order.
+    #
+    # @param order [Symbol] Either :latest (descending) or :oldest (ascending).
+    # @return [Array<Lifer::Entry>] The entries for the current tag.
+    def entries(order: :latest)
+      case order
+      when :latest
+        @entries.sort_by { |entry| entry.published_at }.reverse
+      when :oldest
+        @entries.sort_by { |entry| entry.published_at }
+      end
+    end
   end
 end

data/lib/lifer/templates/config.yaml CHANGED Viewed

@@ -92,6 +92,7 @@ global:
   build:
     - html
     - rss
+    - json_feed
     - txt
   host: https://example.com
   output_directory: _build

data/lib/lifer/uri_strategy.rb CHANGED Viewed

@@ -59,7 +59,7 @@ class Lifer::URIStrategy
   private
-  def file_extension(entry) = entry.class.output_extension
+  def file_extension(entry) = entry.output_extension
   self.name = :uri_strategy
 end

data/lib/lifer/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Lifer
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/lib/lifer.rb CHANGED Viewed

@@ -81,9 +81,21 @@ module Lifer
     # @return [Pathname] The path to the current Lifer config file.
     def config_file = brain.config.file
-    # A set of all entries currently in the project.
-    #
-    # @fixme Do we need this as well as `Lifer.manifest`?
+    # Uses the entry manifest to return entries in the specified order.
+    #
+    # @param order [Symbol] Either :latest (descending) or :oldest (ascending).
+    # @return [Set] All entries in the specified order.
+    def entries(order: :latest)
+      case order
+      when :latest
+        entry_manifest.sort_by { |entry| entry.published_at }.reverse
+      when :oldest
+        entry_manifest.sort_by { |entry| entry.published_at }
+      end
+    end
+    # Allows for getting the entry manifest or shovelling new entries to the
+    # entry manifest.
     #
     # @return [Set] All entries.
     def entry_manifest = brain.entry_manifest
@@ -103,13 +115,6 @@ module Lifer
       directory_or_file.match?(/#{IGNORE_PATTERNS.join("|")}/)
     end
-    # A set of all entries currently in the project.
-    #
-    # @fixme Do we need this as well as `Lifer.manifest`?
-    #
-    # @return [Set] All entries.
-    def manifest = brain.manifest
     # The build directory for the Lifer project.
     #
     # @return [Pathname] The absolute path to the directory where the Lifer

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-30 00:00:00.000000000 Z
+date: 2026-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -229,8 +229,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.13.0/README.md
-  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.13.0
+  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.14.0/README.md
+  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.14.0
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []