lifer 0.6.1 → 0.8.0

data/lib/lifer/selection.rb

@@ -48,13 +48,13 @@ class Lifer::Selection < Lifer::Collection
     raise NotImplementedError, I18n.t("selection.entries_not_implemented")
   end
 
-  # FIXME:
-  # Getting selection settings may actually need to be different than getting
-  # collection settings. But for now let's just inherit the superclass method.
-  #
   # A getter for selection settings. See `Lifer::Collection#setting` for more
   # information.
   #
+  # @fixme Getting selection settings may actually need to be different than
+  #   getting collection settings. But for now let's just inherit the
+  #   superclass method.
+  #
   # @return [String, Symbol, NilClass] The setting for the collection (or a
   #   fallback setting, or a default setting).
   def setting(...)

data/lib/lifer/shared/finder_methods.rb

@@ -1,8 +1,7 @@
 # This module provides simple finder methods to classes that need to keep track
 # of their descendant classes.
 #
-# Example usage:
-#
+# @example Usage
 #     class MyClass
 #       included Lifer::Shared::FinderMethods
 #       # ...

data/lib/lifer/tag.rb

@@ -0,0 +1,53 @@
+module Lifer
+  # A tag is a way to categorize entries. You've likely encountered tags in
+  # other software before. In Lifer, tags are sort of the inverse of
+  # collections. It's a nice way to associate entries across many collections.
+  #
+  # Because tags are used to link entries, we definitely do not want duplicate
+  # tags. So the only way to build or retrieve tags is via the
+  # `.build_or_update` class method, which helps us responsibly manage the
+  # global tag manifest.
+  #
+  class Tag
+    class << self
+      # Builds or updates a Lifer tag. On update, its list of entries gets
+      # freshened.
+      #
+      # @param name [String] The name of the tag.
+      # @param entries [Array<Lifer::Entry>] A list of entries that should be
+      #   associated with the tag. This parameter is not a true writer, in that
+      #   if the tag already exists, old entry associations won't be removed--
+      #   only appended to.
+      # @return [Lifer:Tag] The new or updated tag.
+      def build_or_update(name:, entries: [])
+        update(name:, entries:) || build(name:, entries:)
+      end
+
+      private
+
+      def build(name:, entries:)
+        if (new_tag = new(name:, entries:))
+          Lifer.tag_manifest << new_tag
+        end
+        new_tag || false
+      end
+
+      def update(name:, entries:)
+        if (tag = Lifer.tags.detect { _1.name == name })
+          tag.instance_variable_set :@entries,
+            (tag.instance_variable_get(:@entries) | entries)
+        end
+        tag || false
+      end
+    end
+
+    attr_accessor :name
+
+    attr_reader :entries
+
+    def initialize(name:, entries:)
+      @name = name
+      @entries = entries
+    end
+  end
+end

data/lib/lifer/templates/config.yaml

@@ -32,6 +32,13 @@ uri_strategy: simple
 ###   uri_strategy: pretty
 ###
 ###   layout_file: path/to/my_other_layout.html.erb
+###
+### my_with_fine_grained_rss_settings:
+###   rss
+###     count: 99
+###     format: rss
+###     managing_editor: editor@example.com (Managing Editor)
+###     url: custom.xml
 
 # Selections
 #

data/lib/lifer/utilities.rb

@@ -14,16 +14,15 @@ module Lifer::Utilities
     end
 
     # Given a string path, classify it into a namespaced Ruby constant. If the
-    # constant does not exist, we raise a helpful error. For example:
+    # constant does not exist, we raise a helpful error.
     #
-    #    Given:  my/class_name/that_exists
-    #    Result: My::ClassName::ThatExists
+    # @example Result
+    #    classify("my/class_name/that_exists") #=> My::ClassName::ThatExists
     #
-    # FIXME:
-    # Note that this method is currently a bit naive. It cannot politely
-    # transform classes with many caps in them (i.e. `URIStrategy`) without
-    # being given an exact match (`URIStrategy`) or a broken-looking one
-    # (`u_r_i_strategy`).
+    # @fixme Note that this method is currently a bit naive. It cannot politely
+    #   transform classes with many caps in them (i.e. `URIStrategy`) without
+    #   being given an exact match (`URIStrategy`) or a broken-looking one
+    #   (`u_r_i_strategy`).
     #
     # @param string_constant [String] A string that maps to a Ruby constant.
     # @return [Class, Module]

data/lib/lifer/version.rb

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

data/lib/lifer.rb

@@ -63,7 +63,7 @@ module Lifer
 
     # A set of all entries currently in the project.
     #
-    # FIXME: Do we need this as well as `Lifer.manifest`?
+    # @fixme Do we need this as well as `Lifer.manifest`?
     #
     # @return [Set] All entries.
     def entry_manifest = brain.entry_manifest
@@ -85,7 +85,7 @@ module Lifer
 
     # A set of all entries currently in the project.
     #
-    # FIXME: Do we need this as well as `Lifer.manifest`?
+    # @fixme Do we need this as well as `Lifer.manifest`?
     #
     # @return [Set] All entries.
     def manifest = brain.manifest
@@ -99,8 +99,7 @@ module Lifer
     # Register new settings so that they are "safe" and can be read from a Lifer
     # configuration file. Unregistered settings are ignored.
     #
-    # Example usage:
-    #
+    # @example Usage
     #    register_settings(
     #      :hidden,
     #      :birthday,
@@ -142,6 +141,17 @@ module Lifer
     #
     # @return [Hash] The `Lifer::Config#settings`.
     def settings = brain.config.settings
+
+    # All of the tags represented in Lifer entries for the current project.
+    #
+    # @return [Array<Lifer::Tag>] The complete list of tags.
+    def tags = brain.tags
+
+    # A set of all tags added to the project. Prefer using the `#tags` method
+    # for tag queries.
+    #
+    # @return [Set<Lifer::Tag>] The complete set of tags.
+    def tag_manifest = brain.tag_manifest
   end
 end
 
@@ -159,4 +169,5 @@ require_relative "lifer/builder"
 require_relative "lifer/collection"
 require_relative "lifer/entry"
 require_relative "lifer/message"
+require_relative "lifer/tag"
 require_relative "lifer/uri_strategy"

data/lifer.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] =
-    "%s/blob/%s/README.md" % [spec.homepage, Lifer::VERSION]
+    "%s/blob/%s/README.md" % [spec.homepage, "v#{Lifer::VERSION}"]
   spec.metadata["source_code_uri"] =
-    "%s/tree/%s" % [spec.homepage, Lifer::VERSION]
+    "%s/tree/%s" % [spec.homepage, "v#{Lifer::VERSION}"]
   spec.metadata["changelog_uri"] = "%s/blob/main/CHANGELOG.md" % spec.homepage
 
   # Specify which files should be added to the gem when it is released. The

data/locales/en.yml

@@ -30,11 +30,10 @@ en:
       content_type_not_implemented: no content type defined for files like %{path} yet
       four_oh_four: 404 Not Found
   entry:
+    date_error: "[%{filename}]: %{error}"
     feedable_error: >
       please set `%{entry_class}.include_in_feeds` to true or false
-    markdown:
-      date_error: "[%{filename}]: %{error}"
-      no_date_metadata: "[%{filename}]: no date metadata"
+    no_date_metadata: "[%{filename}]: no date 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.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-02 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -167,6 +167,8 @@ files:
 - lib/lifer/builder/html/from_liquid/drops/entry_drop.rb
 - lib/lifer/builder/html/from_liquid/drops/frontmatter_drop.rb
 - lib/lifer/builder/html/from_liquid/drops/settings_drop.rb
+- lib/lifer/builder/html/from_liquid/drops/tag_drop.rb
+- lib/lifer/builder/html/from_liquid/drops/tags_drop.rb
 - lib/lifer/builder/html/from_liquid/filters.rb
 - lib/lifer/builder/html/from_liquid/layout_tag.rb
 - lib/lifer/builder/html/from_liquid/liquid_env.rb
@@ -188,6 +190,7 @@ files:
 - lib/lifer/selection/included_in_feeds.rb
 - lib/lifer/shared.rb
 - lib/lifer/shared/finder_methods.rb
+- lib/lifer/tag.rb
 - lib/lifer/templates/cli.txt.erb
 - lib/lifer/templates/config.yaml
 - lib/lifer/templates/its-a-living.png
@@ -207,8 +210,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/benjaminwil/lifer/blob/0.6.1/README.md
-  source_code_uri: https://github.com/benjaminwil/lifer/tree/0.6.1
+  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
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []