ultra_settings 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9fddef64ed0564d8ead06ae79465a37fdb50a55407139cacc121714475ac6f
-  data.tar.gz: a26020c7d81154d3e000bba327e3a6cb53ab00ae9847ed2f96999ff18d431241
+  metadata.gz: 90728a492b4f4d48193caf10b5a963160b9ff01e6e084541eb571ac3776ddf72
+  data.tar.gz: 98d035433486540669bd8a68d64e1c1f236a35a09567c77bfb59322ae538d94d
 SHA512:
-  metadata.gz: 066b922fcc7232a33eee6e6b52924d1efc51d3a4e500f4680f8e03a1feb7a6414a22b55f9b5672e35db7aeb958566fc1685ba39fed8a9f568840af2b60a7b3e2
-  data.tar.gz: b95942f92c5010decb55da413fdd2c9f070ebafef2815ab5bd4f781f803b744c502b98598fc14b4e5338ec7026fd7a1c5b11011136afe4507a0eeb436dac632b
+  metadata.gz: 154b003680b751f2137696ed7b7e489c8cd8c205f002c89a45f61ad25dd7c2c44151cd3e67bb64df4438b0cb08056b295f25da4ad4333340bbd6e5817bba64dc
+  data.tar.gz: 558fd5cbbf34f9dda4b9ec93d49bb13b1123291a1bdea625fdb4e314c76d28b0b8f63c12655ab86afbe77a63c72349c719c5d547ace4e5d927093876f4938607

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.4.0
+
+### Added
+
+- Added the `UltraSettings::ConfigHelper` module to add convenience methods `config` on the class and instance.
+
 ## 2.3.0
 
 ### Added

data/README.md

@@ -324,24 +324,40 @@ end
 Rails.application.settings.my_service.host
 ```
 
-#### Using a Helper Method
-
-To keep your codebase clean, especially if most configurations are accessed from within a specific class, you can encapsulate the configuration access in a helper method.
+#### Using Helper Methods
 
+To streamline configuration access and keep your codebase clean, especially when configurations are frequently accessed within specific classes, you can encapsulate configuration access in a helper method:
 
 ```ruby
 class MyService
-
-  # Reference the value as `settings.host`
+  def api_key
+    config.api_key
+  end
 
   private
 
-  def settings
+  def config
     MyServiceConfiguration.instance
   end
 end
 ```
 
+#### Leveraging UltraSettings::ConfigHelper
+
+For added convenience, you can use the UltraSettings::ConfigHelper module to automatically generate helper methods for accessing configurations at both the class and instance levels:
+
+```ruby
+class MyService
+
+  extend UltraSettings::ConfigHelper
+  configuration_class MyServiceConfiguration
+
+  # Adds these helper methods:
+  # - MyService.config
+  # - MyService.new.config
+end
+```
+
 ### Web UI
 
 UltraSettings provides a web UI via a mountable Rack application. You can use this to view the settings values and documentation. The UI will not display the value of any setting marked as secret.

data/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.0

data/lib/ultra_settings/config_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UltraSettings
+  # Helper module for setting up a class to use the config methods
+  #
+  # Usage:
+  # class TestClass
+  #   extend UltraSettings::ConfigHelper
+  #   configuration_class TestConfiguration
+  # end
+  # TestClass.config => TestConfiguration.instance
+  # TestClass.new.config => TestConfiguration.instance
+  module ConfigHelper
+    def configuration_class(config_class)
+      define_singleton_method :config do
+        config_class.instance
+      end
+
+      define_method :config do
+        self.class.config
+      end
+    end
+  end
+end

data/lib/ultra_settings.rb

@@ -10,6 +10,7 @@ require "uri"
 
 require_relative "ultra_settings/configuration"
 require_relative "ultra_settings/coerce"
+require_relative "ultra_settings/config_helper"
 require_relative "ultra_settings/field"
 require_relative "ultra_settings/rack_app"
 require_relative "ultra_settings/web_view"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ files:
 - lib/ultra_settings.rb
 - lib/ultra_settings/application_view.rb
 - lib/ultra_settings/coerce.rb
+- lib/ultra_settings/config_helper.rb
 - lib/ultra_settings/configuration.rb
 - lib/ultra_settings/configuration_view.rb
 - lib/ultra_settings/field.rb