hanami-settings-stores 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce06f133c66bd28ca84dc455d158dea1037aafd6b09d5a3234a0c46f7ea4d7b3
-  data.tar.gz: 6a1353b35214301a89a3a43ccd34b580733c7a92e61fc32b0e2303ba1f4ec3fc
+  metadata.gz: d683c61551360b47b9c1bdc99da1fa606f37be204668adc148d8b7a65d8ba97e
+  data.tar.gz: 62fc0ef126478624dd45a1bdd7b4aedb11f784cdbe6ea2700f0af0476e7cb60b
 SHA512:
-  metadata.gz: ba70b140ad251b828e18e1746e28bafedb8a40468b0fe49a0e80f40b1e7a27296880fabca5d6888d82928d801ed9788f7aa1846e9c3a61fcfbe975cb0e460ac4
-  data.tar.gz: '038e9c869bbff980f5eb563f412bf3c321ce61e216a2e269bf53e1e22eb58dd8180d2552b4dc1a3b9594cf3a0f691523dd443efb3c24d6c63920b3d7deba5afe'
+  metadata.gz: 4ef346c826fbfa6f303c723f4d63bcab1350e9de61e6b5a0bde75862194c25b1c747c81b9920c6831629a44147f3d84cdad76b6aaafde9b7f2129d0a5cb70e3f
+  data.tar.gz: 86f6bdfa99ae003eb16e0c08a44bdc19f18377afe54fc6e383629ea98ca1de8e7847ad0c4e1d4e758ad686b698053ad258b9f4d2e0b5213af0700a550f42ef22

data/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v0.1.2] - 2026-11-11
+
+### Added
+
+- `FileStore.new` accepts a block returning the path, resolved lazily on the first fetch
+- `FileStore#path`, which resolves and memoizes the path
+
+### Changed
+
+- Moved the project and CI to [Forgejo].
+- `FileStore` parses YAML with `Date`, `DateTime`, `Symbol`, and `Time` permitted, so files
+  containing dates, times, or symbols no longer raise `Psych::DisallowedClass`
+- **Breaking:** `FileStore` keys are now symbols, so nested values come back as hashes with symbol
+  keys rather than string keys
+- **Breaking:** `FileStore` reads the file on the first fetch rather than when the store is built
+- **Breaking:** `FileStore` treats a missing file as an empty store instead of raising
+  `Errno::ENOENT`, and raises `TypeError` when the file parses to something other than a mapping
+
 ## [v0.1.1] - 2026-08-20
 
 ### Added
@@ -21,6 +39,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Initial release.
 
-[Unreleased]: https://github.com/aaronmallen/hanami-settings-stores/compare/0.1.1...HEAD
-[v0.1.1]: https://github.com/aaronmallen/hanami-settings-stores/compare/0.1.0...0.1.1
-[v0.1.0]: https://github.com/aaronmallen/hanami-settings-stores/releases/tag/0.1.0
+[Forgejo]: https://aaronmallen.dev/aaron/hanami-settings-stores
+[Unreleased]: https://aaronmallen.dev/aaron/hanami-settings-stores/compare/0.1.2...HEAD
+[v0.1.2]: https://aaronmallen.dev/aaron/hanami-settings-stores/src/tag/0.1.2
+[v0.1.1]: https://aaronmallen.dev/github-archive/hanami-settings-stores/compare/0.1.0...0.1.1
+[v0.1.0]: https://aaronmallen.dev/github-archive/hanami-settings-stores/releases/tag/0.1.0

data/lib/hanami/settings/file_store.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
+require "date"
 require "erb"
 
 module Hanami
   class Settings
     # A settings store backed by a local JSON, TOML, or YAML file.
     #
-    # The file is read and parsed once, when the store is built. Its contents run through ERB
-    # first, so a file can interpolate Ruby.
+    # The file is read lazily, on the first fetch, and its contents are then memoized. Its contents
+    # run through ERB first, so a file can interpolate Ruby. A file that does not exist, or that is
+    # empty, results in an empty store.
     #
-    # Only top level keys resolve. Keys are compared as strings, so a setting named
-    # `:database_url` matches the `database_url` key in the file.
+    # Only top level keys resolve. Keys are compared as symbols, so a setting named `:database_url`
+    # matches the `database_url` key in the file.
     #
     # @example
     #   # config/settings.yml
@@ -23,14 +25,31 @@ module Hanami
     #     Hanami::Settings::FileStore.new("config/settings.yml")
     #   )
     #
+    # @example Resolving the path lazily
+    #   # Give a block to resolve the path when the settings are first fetched, rather than when the
+    #   # store is created.
+    #   config.settings_store = Hanami::Settings::FileStore.new { config.root.join("config/settings.yml") }
+    #
     # @api public
     # @since 0.1.1
     class FileStore
+      # @api private
+      # @since 0.2.0
+      EMPTY_SETTINGS = {}.freeze
+      private_constant :EMPTY_SETTINGS
+
       # @api private
       # @since 0.1.1
       JSON_EXTENSIONS = %w[.json].freeze
       private_constant :JSON_EXTENSIONS
 
+      # The classes permitted when parsing a YAML file.
+      #
+      # @api private
+      # @since 0.2.0
+      PERMITTED_CLASSES = [Date, DateTime, Symbol, Time].freeze
+      private_constant :PERMITTED_CLASSES
+
       # @api private
       # @since 0.1.1
       TOML_EXTENSIONS = %w[.toml].freeze
@@ -46,23 +65,25 @@ module Hanami
       EXTENSIONS = (JSON_EXTENSIONS + TOML_EXTENSIONS + YAML_EXTENSIONS).freeze
       private_constant :EXTENSIONS
 
-      # @param filepath [String, Pathname] path to the settings file
-      # @raise [Errno::ENOENT] if the file does not exist
-      # @raise [ArgumentError] if the store cannot parse the file extension
-      def initialize(filepath)
-        source = ERB.new(File.read(filepath)).result
-        @settings = case File.extname(filepath.to_s)
-                    when *JSON_EXTENSIONS
-                      require "json"
-                      JSON.parse(source)
-                    when *TOML_EXTENSIONS
-                      require "toml"
-                      TOML::Parser.new(source).parsed
-                    when *YAML_EXTENSIONS
-                      require "yaml"
-                      YAML.safe_load(source, aliases: true) || {}
-                    else raise ArgumentError, "cannot parse #{filepath}: expected one of #{EXTENSIONS.join(", ")}"
-                    end
+      # Returns a new instance of the store.
+      #
+      # Give either a path or a block returning a path. The block is called on the first fetch,
+      # which allows the path to depend on config (such as the root) that is not yet known when the
+      # store is created.
+      #
+      # @param path [Pathname, String, nil] path to the settings file
+      #
+      # @yieldreturn [Pathname, String] path to the settings file
+      #
+      # @raise [ArgumentError] if given neither a path nor a block, or both
+      #
+      # @api public
+      # @since 0.1.1
+      def initialize(path = nil, &block)
+        raise ArgumentError, "give either a path or a block returning a path" if path.nil? == block.nil?
+
+        @path = path
+        @path_resolver = block
       end
 
       # Fetches a setting value from the parsed file.
@@ -71,12 +92,69 @@ module Hanami
       # @param args [Array] optional default value
       # @yield [name] optional block for default value
       # @return [Object] the setting value
+      # @raise [ArgumentError] if the store cannot parse the file extension
       # @raise [KeyError] if the file has no such key and no default is given
+      # @raise [TypeError] if the file does not contain a mapping
       #
       # @api public
       # @since 0.1.1
       def fetch(name, *args, &block)
-        @settings.fetch(name.to_s, *args, &block)
+        settings.fetch(name.to_sym, *args, &block)
+      end
+
+      # Returns the path to the settings file, resolving it from the block given at initialize-time,
+      # if any.
+      #
+      # @return [Pathname, String]
+      #
+      # @api public
+      # @since 0.2.0
+      def path
+        @path ||= @path_resolver.call
+      end
+
+      private
+
+      def load_settings
+        return EMPTY_SETTINGS unless File.exist?(path)
+
+        contents = parse(ERB.new(File.read(path)).result)
+
+        # An empty file (or one containing only comments) parses as `nil`.
+        return EMPTY_SETTINGS if contents.nil?
+
+        unless contents.is_a?(Hash)
+          raise TypeError, "cannot parse #{path}: expected a mapping, got #{contents.class}"
+        end
+
+        contents.freeze
+      end
+
+      def parse(source)
+        case File.extname(path.to_s)
+        when *JSON_EXTENSIONS
+          require "json"
+          JSON.parse(source, symbolize_names: true)
+        when *TOML_EXTENSIONS
+          require "toml"
+          symbolize(TOML::Parser.new(source).parsed)
+        when *YAML_EXTENSIONS
+          require "yaml"
+          YAML.load(source, aliases: true, permitted_classes: PERMITTED_CLASSES, symbolize_names: true)
+        else raise ArgumentError, "cannot parse #{path}: expected one of #{EXTENSIONS.join(", ")}"
+        end
+      end
+
+      def settings
+        @settings ||= load_settings
+      end
+
+      def symbolize(value)
+        case value
+        when Hash then value.to_h { |key, val| [key.to_sym, symbolize(val)] }
+        when Array then value.map { |val| symbolize(val) }
+        else value
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-settings-stores
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-20 00:00:00.000000000 Z
+date: 2026-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml
@@ -53,15 +53,15 @@ files:
 - lib/hanami/settings/composite_store.rb
 - lib/hanami/settings/file_store.rb
 - lib/hanami/settings/one_password_store.rb
-homepage: https://github.com/aaronmallen/hanami-settings-stores
+homepage: https://aaronmallen.dev/aaron/hanami-settings-stores
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/aaronmallen/hanami-settings-stores/issues
-  changelog_uri: https://github.com/aaronmallen/hanami-settings-stores/blob/main/CHANGELOG.md
-  homepage_uri: https://github.com/aaronmallen/hanami-settings-stores
+  bug_tracker_uri: https://aaronmallen.dev/aaron/hanami-settings-stores/issues
+  changelog_uri: https://aaronmallen.dev/aaron/hanami-settings-stores/src/branch/main/CHANGELOG.md
+  homepage_uri: https://aaronmallen.dev/aaron/hanami-settings-stores
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/aaronmallen/hanami-settings-stores
+  source_code_uri: https://aaronmallen.dev/aaron/hanami-settings-stores
 post_install_message:
 rdoc_options: []
 require_paths: