hanami-settings-stores 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2361fa59d804b5036ad6a843b9f38c75308554f786386ce2ec9acac2c3441f2
-  data.tar.gz: f608a5c736208e1be95995d9a083cff71e9c9af3e6d3dfcbfe4475d7f2fb0ecf
+  metadata.gz: ce06f133c66bd28ca84dc455d158dea1037aafd6b09d5a3234a0c46f7ea4d7b3
+  data.tar.gz: 6a1353b35214301a89a3a43ccd34b580733c7a92e61fc32b0e2303ba1f4ec3fc
 SHA512:
-  metadata.gz: 451b9a9796b6acec960d5542ee0359e4d761d7a20aab58452e9c927d66e05bffc37ea48660c45fbcc71176464785782607d2821540cf8af6a03d19e6cabf410e
-  data.tar.gz: c193fac8e097d8975a54dac1ae6c1fcda6f11c6c1297031e267eed8456e2451dda952075b26c233ddd0de69acaad2b2ff608bcac0d95a928265195309620e6b9
+  metadata.gz: ba70b140ad251b828e18e1746e28bafedb8a40468b0fe49a0e80f40b1e7a27296880fabca5d6888d82928d801ed9788f7aa1846e9c3a61fcfbe975cb0e460ac4
+  data.tar.gz: '038e9c869bbff980f5eb563f412bf3c321ce61e216a2e269bf53e1e22eb58dd8180d2552b4dc1a3b9594cf3a0f691523dd443efb3c24d6c63920b3d7deba5afe'

data/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v0.1.1] - 2026-08-20
+
 ### Added
 
-- `Hanami::Settings::Stores::CompositeStore` - chains multiple stores with fallback resolution
+- `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/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

data/lib/hanami/settings/bitwarden_store.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "json"
+require "open3"
+
+module Hanami
+  class Settings
+    # A settings store backed by Bitwarden.
+    #
+    # Uses mappings defined via {BitwardenStore::Mixin#bw_setting} on your Settings class to
+    # resolve setting values from Bitwarden items. Requires the `bw` CLI to be installed and
+    # authenticated.
+    #
+    # Item fields are cached in memory after the first fetch for each item.
+    #
+    # @example
+    #   # config/settings.rb
+    #   class Settings < Hanami::Settings
+    #     bw_setting :database_url, item: "MyApp", constructor: Types::String
+    #     bw_setting :api_key, item: "ExternalService", key: :secret_key, constructor: Types::String
+    #   end
+    #
+    #   # config/app.rb
+    #   config.settings_store = Hanami::Settings::CompositeStore.new(
+    #     Hanami::Settings::EnvStore.new,
+    #     Hanami::Settings::BitwardenStore.new
+    #   )
+    #
+    # @api public
+    # @since 0.1.0
+    class BitwardenStore
+      # DSL extension for {Hanami::Settings} that adds the {#bw_setting} method.
+      #
+      # Automatically included when this file is required.
+      #
+      # @api public
+      # @since 0.1.0
+      module Mixin
+        # @api private
+        module ClassMethods
+          # Returns the Bitwarden mappings for this settings class.
+          #
+          # @return [Hash{Symbol => Hash}]
+          # @api private
+          def bw_mappings
+            @bw_mappings ||= {}
+          end
+
+          # Defines a setting backed by a Bitwarden item field.
+          #
+          # @param name [Symbol] the setting name
+          # @param item [String] the Bitwarden item name or ID
+          # @param key [Symbol, String] the field name (defaults to the setting name)
+          # @param options [Hash] additional options passed to `Dry::Configurable#setting`
+          #
+          # @api public
+          # @since 0.1.0
+          def bw_setting(name, item:, key: name, **options)
+            bw_mappings[name] = {item: item.to_s, key: key.to_s}
+            setting(name, **options)
+          end
+        end
+
+        # @api private
+        def self.prepended(base)
+          base.extend(ClassMethods)
+        end
+
+        # @api private
+        def initialize(store = EMPTY_STORE)
+          store.bw_mappings = self.class.bw_mappings if store.respond_to?(:bw_mappings=)
+          super
+        end
+      end
+
+      def initialize
+        @bw_mappings = {}
+        @cache = {}
+      end
+
+      # Sets the Bitwarden mappings from the settings class.
+      #
+      # @param mappings [Hash{Symbol => Hash}]
+      # @api private
+      attr_writer :bw_mappings
+
+      # Fetches a setting value using its Bitwarden mapping.
+      #
+      # @param name [String, Symbol] the setting name
+      # @param args [Array] optional default value
+      # @yield [name] optional block for default value
+      # @return [String] the field value
+      # @raise [KeyError] if the field is not found and no default is given
+      #
+      # @api public
+      # @since 0.1.0
+      def fetch(name, *args, &block)
+        mapping = @bw_mappings[name.to_sym]
+
+        unless mapping
+          return args.first unless args.empty?
+          return yield(name) if block
+
+          raise KeyError, "key not found: #{name.inspect}"
+        end
+
+        item_fields(mapping[:item]).fetch(mapping[:key], *args, &block)
+      end
+
+      private
+
+      # @api private
+      def item_fields(item_name)
+        @cache[item_name] ||= load_item_fields(item_name)
+      end
+
+      # @api private
+      def load_item_fields(item_name)
+        stdout, stderr, status = Open3.capture3("bw", "get", "item", item_name)
+        raise "Bitwarden CLI error: #{stderr.strip}" unless status.success?
+
+        item = JSON.parse(stdout)
+        item.fetch("fields", []).each_with_object({}) do |field, hash|
+          name = field["name"]
+          hash[name] = field["value"] unless name.nil? || name.empty?
+        end
+      end
+    end
+  end
+end
+
+Hanami::Settings.prepend(Hanami::Settings::BitwardenStore::Mixin)

data/lib/hanami/settings/composite_store.rb

@@ -17,6 +17,10 @@ module Hanami
     # @api public
     # @since 0.1.0
     class CompositeStore
+      # @api private
+      NOT_SET = Object.new.freeze
+      private_constant :NOT_SET
+
       # @param stores [Array<#fetch>] ordered list of stores to query
       def initialize(*stores)
         @stores = stores
@@ -43,9 +47,6 @@ module Hanami
 
         raise KeyError, "key not found: #{name.inspect}"
       end
-
-      NOT_SET = Object.new.freeze
-      private_constant :NOT_SET
     end
   end
 end

data/lib/hanami/settings/file_store.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+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.
+    #
+    # Only top level keys resolve. Keys are compared as strings, 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")
+    #   )
+    #
+    # @api public
+    # @since 0.1.1
+    class FileStore
+      # @api private
+      # @since 0.1.1
+      JSON_EXTENSIONS = %w[.json].freeze
+      private_constant :JSON_EXTENSIONS
+
+      # @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
+
+      # @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
+      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 [KeyError] if the file has no such key and no default is given
+      #
+      # @api public
+      # @since 0.1.1
+      def fetch(name, *args, &block)
+        @settings.fetch(name.to_s, *args, &block)
+      end
+    end
+  end
+end

data/lib/hanami/settings/one_password_store.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "json"
+require "open3"
+
+module Hanami
+  class Settings
+    # A settings store backed by 1Password.
+    #
+    # Uses mappings defined via {OnePasswordStore::Mixin#op_setting} on your Settings class to
+    # resolve setting values from 1Password items. Requires the `op` CLI to be installed and
+    # authenticated.
+    #
+    # Item fields are cached in memory after the first fetch for each item.
+    #
+    # @example
+    #   # config/settings.rb
+    #   class Settings < Hanami::Settings
+    #     op_setting :database_url, item: "MyApp", constructor: Types::String
+    #     op_setting :api_key, item: "ExternalService", key: :secret_key, constructor: Types::String
+    #   end
+    #
+    #   # config/app.rb
+    #   config.settings_store = Hanami::Settings::CompositeStore.new(
+    #     Hanami::Settings::EnvStore.new,
+    #     Hanami::Settings::OnePasswordStore.new(vault: "Production")
+    #   )
+    #
+    # @api public
+    # @since 0.1.0
+    class OnePasswordStore
+      # DSL extension for {Hanami::Settings} that adds the {#op_setting} method.
+      #
+      # Automatically included when this file is required.
+      #
+      # @api public
+      # @since 0.1.0
+      module Mixin
+        # @api private
+        module ClassMethods
+          # Returns the 1Password mappings for this settings class.
+          #
+          # @return [Hash{Symbol => Hash}]
+          # @api private
+          def op_mappings
+            @op_mappings ||= {}
+          end
+
+          # Defines a setting backed by a 1Password item field.
+          #
+          # @param name [Symbol] the setting name
+          # @param item [String] the 1Password item name or ID
+          # @param key [Symbol, String] the field label (defaults to the setting name)
+          # @param options [Hash] additional options passed to `Dry::Configurable#setting`
+          #
+          # @api public
+          # @since 0.1.0
+          def op_setting(name, item:, key: name, **options)
+            op_mappings[name] = {item: item.to_s, key: key.to_s}
+            setting(name, **options)
+          end
+        end
+
+        # @api private
+        def self.prepended(base)
+          base.extend(ClassMethods)
+        end
+
+        # @api private
+        def initialize(store = EMPTY_STORE)
+          store.op_mappings = self.class.op_mappings if store.respond_to?(:op_mappings=)
+          super
+        end
+      end
+
+      # @param vault [String] the 1Password vault name or ID
+      def initialize(vault:)
+        @vault = vault
+        @op_mappings = {}
+        @cache = {}
+      end
+
+      # Sets the 1Password mappings from the settings class.
+      #
+      # @param mappings [Hash{Symbol => Hash}]
+      # @api private
+      attr_writer :op_mappings
+
+      # Fetches a setting value using its 1Password mapping.
+      #
+      # @param name [String, Symbol] the setting name
+      # @param args [Array] optional default value
+      # @yield [name] optional block for default value
+      # @return [String] the field value
+      # @raise [KeyError] if the field is not found and no default is given
+      #
+      # @api public
+      # @since 0.1.0
+      def fetch(name, *args, &block)
+        mapping = @op_mappings[name.to_sym]
+
+        unless mapping
+          return args.first unless args.empty?
+          return yield(name) if block
+
+          raise KeyError, "key not found: #{name.inspect}"
+        end
+
+        item_fields(mapping[:item]).fetch(mapping[:key], *args, &block)
+      end
+
+      private
+
+      # @api private
+      def item_fields(item_name)
+        @cache[item_name] ||= load_item_fields(item_name)
+      end
+
+      # @api private
+      def load_item_fields(item_name)
+        stdout, stderr, status = Open3.capture3("op", "item", "get", item_name, "--vault", @vault, "--format", "json")
+        raise "1Password CLI error: #{stderr.strip}" unless status.success?
+
+        item = JSON.parse(stdout)
+        item.fetch("fields", []).each_with_object({}) do |field, hash|
+          label = field["label"]
+          hash[label] = field["value"] unless label.nil? || label.empty?
+        end
+      end
+    end
+  end
+end
+
+Hanami::Settings.prepend(Hanami::Settings::OnePasswordStore::Mixin)

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: hanami-settings-stores
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-17 00:00:00.000000000 Z
+date: 2026-08-20 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.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-description: Pluggable settings stores that fetch secrets from password managers like
-  1Password and Bitwarden for use with Hanami::Settings.
+        version: '2'
+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: []
@@ -49,7 +49,10 @@ files:
 - CHANGELOG.md
 - LICENSE
 - 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
 licenses:
 - MIT
@@ -77,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: []