hanami-settings-stores 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c8228cf550f63d29462cb128f2949d9fa9a744aac843fbac90a811a5d550ec4
-  data.tar.gz: f4abd1d91b57a4946712d602f1f37d1274d5ac89dc2e2e18eeb5f756877e4875
+  metadata.gz: d683c61551360b47b9c1bdc99da1fa606f37be204668adc148d8b7a65d8ba97e
+  data.tar.gz: 62fc0ef126478624dd45a1bdd7b4aedb11f784cdbe6ea2700f0af0476e7cb60b
 SHA512:
-  metadata.gz: 6986d005390d907eadd3342e78da83016f495c91c48dbd7c53ecdb84d0aa3979ed459d2f5307445ae2e358fdae9db1ffa8cda6ddc02813cd199c61f39a81440f
-  data.tar.gz: bf07691cc6721383c34c095f4c8122ee0fc6724e970c2084db25cea20e3fa93d579f751d19a81bfbd299642e28cb4d8b2fa9fc7cf849c0fd6db6ff716b795c6e
+  metadata.gz: 4ef346c826fbfa6f303c723f4d63bcab1350e9de61e6b5a0bde75862194c25b1c747c81b9920c6831629a44147f3d84cdad76b6aaafde9b7f2129d0a5cb70e3f
+  data.tar.gz: 86f6bdfa99ae003eb16e0c08a44bdc19f18377afe54fc6e383629ea98ca1de8e7847ad0c4e1d4e758ad686b698053ad258b9f4d2e0b5213af0700a550f42ef22

data/CHANGELOG.md

@@ -7,8 +7,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## v0.1.0 - 2026-03-17
+## [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
+
+- `FileStore` with json, toml, and yaml support
+
+### Removed
+
+- removed unnecessary `hanami` gem as a runtime dependency
+
+## [v0.1.0] - 2026-03-17
 
 Initial release.
 
-[Unreleased]: https://github.com/aaronmallen/hanami-settings-stores/compare/v0.1.0...HEAD
+[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

@@ -0,0 +1,161 @@
+# 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 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 symbols, so a setting named `:database_url`
+    # matches the `database_url` key in the file.
+    #
+    # @example
+    #   # config/settings.yml
+    #   database_url: postgres://localhost/myapp
+    #   session_secret: <%= ENV.fetch("SESSION_SECRET") %>
+    #
+    #   # config/app.rb
+    #   config.settings_store = Hanami::Settings::CompositeStore.new(
+    #     Hanami::Settings::EnvStore.new,
+    #     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
+      private_constant :TOML_EXTENSIONS
+
+      # @api private
+      # @since 0.1.1
+      YAML_EXTENSIONS = %w[.yaml .yml].freeze
+      private_constant :YAML_EXTENSIONS
+
+      # @api private
+      # @since 0.1.1
+      EXTENSIONS = (JSON_EXTENSIONS + TOML_EXTENSIONS + YAML_EXTENSIONS).freeze
+      private_constant :EXTENSIONS
+
+      # 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.
+      #
+      # @param name [String, Symbol] the setting name
+      # @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_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
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hanami-settings-stores
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-17 00:00:00.000000000 Z
+date: 2026-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hanami
+  name: toml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description: Pluggable settings stores that fetch secrets from password managers like
-  1Password and Bitwarden for use with Hanami::Settings.
+description: Settings stores that fetch values from password managers like 1Password
+  and Bitwarden, or from a local JSON, TOML, or YAML file, for use with Hanami::Settings.
 email:
 - hello@aaronmallen.me
 executables: []
@@ -51,16 +51,17 @@ files:
 - lib/hanami-settings-stores.rb
 - lib/hanami/settings/bitwarden_store.rb
 - 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:
@@ -79,5 +80,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Password manager-backed settings stores for Hanami
+summary: Pluggable settings stores for Hanami
 test_files: []