nxt_config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99bdd425a2f8fad0172fcb0abed1b1a0c4c4b6c73f689020bd980018f6c9b405
-  data.tar.gz: 3a61b5deacd727ee4e932b0b82abdc6e31d1bbad3bc29623721f97d33f237996
+  metadata.gz: 1b54a945863c828c3a6f04f8c7e2c220b6fb877b42ffb3e7011ad1af98bdbb5c
+  data.tar.gz: 858083ef8180ca162cebf589f6eddfe58b41828702a8373677f9f707dd759720
 SHA512:
-  metadata.gz: d863dac54820171a4211ef9540510486dbcd5f95a792d0315d50db65a943c9e59b1248c1aac7e5111a73d068440d03049cf60e8773eed47b00c6304f8aab1578
-  data.tar.gz: '0832012a16cc951d9da8edb459c3d513414718121487df658150e384f87575d925e12e1dd3b83f3fa61a8243776d94282ce85922d7d55de4b52208667af3f656'
+  metadata.gz: cfeafb100eb0585ca72806a956f5edd7894faa78a9f924debb2b2aae891bab40ee620be470ce9e87393c7ebdbb033b88c82f39b51711d0509686ec65c1d8bc10
+  data.tar.gz: 749ac16ca1fe736f6208eb9a37670c08ba2b51b0c8b6370c2ddaa343b481e9d22c9a4c8699ea2c1853dffdeb33577b1fb8a11b6ca9ff3cb8d4f7d27a3d15970e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_config (0.1.0)
+    nxt_config (0.2.0)
       activesupport
 
 GEM
@@ -15,7 +15,7 @@ GEM
       zeitwerk (~> 2.2)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    i18n (1.7.0)
+    i18n (1.7.1)
       concurrent-ruby (~> 1.0)
     minitest (5.13.0)
     rake (12.3.3)

data/README.md

@@ -27,17 +27,15 @@ Or install it yourself as:
 
 ## Usage
 
-You can load YAML files and populate their content into a configuration object using `NxtConfig.load_and_constantize`. If you are in a rails application, you can do this in an initializer (e.g. `config/initializers/nxt_config.rb`).
+You can load YAML files and populate their content into a configuration object using `NxtConfig.load`. If you are in a rails application, you can do this in an initializer (e.g. `config/initializers/nxt_config.rb`).
 
 ```ruby
-NxtConfig.load_and_constantize(
-	source: Rails.root.join('config', 'external_api.yml.erb'),
-	constant_name: :ExternalApiConfig,
-	namespace: MyRailsApp
-)
+module MyRailsApp
+  ExternalApiConfig = NxtConfig.load Rails.root.join('config', 'external_api.yml.erb')
+end
 ```
 
-This assumes your rails app defines the `MyRailsApp` constant in `config/aplication.rb` and populates the configuration to `MyRailsApp::ExternalApiConfig`. You can also skip the namespace parameter alltogether or pass in any other module that is defined at the time of calling `::load_and_constantize`.
+Of course you can also load configuration structs everywhere else in the application. Depending on where you assign it to a constant, you can have many configuration structs available via constants namespaced all over your application, scoped to the context where you need them.
 
 ```ruby
 # Use struct like method chaining to access nested data
@@ -48,14 +46,19 @@ MyRailsApp::ExternalApiConfig.http.headers.user_agent
 MyRailsApp::ExternalApiConfig.non_existent_key
 # => raises NoMethodError
 
-# You can also use hash like #[] calls with symbols
-MyRailsApp::ExternalApiConfig[:http][:headers][:user_agent]
+# You can also use hash like #fetch calls with symbols (multiple ones, like with Hash#dig)
+MyRailsApp::ExternalApiConfig.fetch(:http, :headers, :user_agent)
 # => "MyRailsApp 1.0.0"
 
-# You can also use hash like #[] calls with strings
-MyRailsApp::ExternalApiConfig["http"]["headers"]["user_agent"]
+# You can also use hash like #fetch calls with strings (multiple ones, like with Hash#dig)
+MyRailsApp::ExternalApiConfig.fetch("http", "headers", "user_agent")
 # => "MyRailsApp 1.0.0"
 
+MyRailsApp::ExternalApiConfig.fetch(:http, :oh_no, :user_agent, &Proc.new { 'Hy!' })
+# => "Hy!"
+
+# You can also pass a block to #fetch in case a key does not exist
+
 # If you don't walk through the struct until its leaves, you will get a sub struct
 MyRailsApp::ExternalApiConfig.http
 # => #<NxtConfig::Struct:0x00007fe657467680 @hash={"headers"=>#<NxtConfig::Struct:0x00007fe657467518 @hash={"user_agent"=>"my cool app", "api_key"=>"secret123"}>}>

data/lib/nxt_config/struct.rb

@@ -6,7 +6,15 @@ module NxtConfig
       hash.freeze
     end
 
-    delegate :[], to: :hash
+    def fetch(*keys, &block)
+      if keys.length == 0
+        raise ArgumentError, "Provide at least one key"
+      elsif keys.length == 1
+        hash.fetch(keys.first, &block)
+      else
+        hash.fetch(keys.first, &block).fetch(*keys[1..-1], &block)
+      end
+    end
 
     private
 
@@ -19,7 +27,7 @@ module NxtConfig
     end
 
     def transform_hash_value(value)
-      if value.is_a?(ActiveSupport::HashWithIndifferentAccess)
+      if value.is_a?(ActiveSupport::HashWithIndifferentAccess) || value.is_a?(Hash)
         Struct.new(value)
       elsif value.is_a?(Array)
         value.map { |item| transform_hash_value(item) }

data/lib/nxt_config/version.rb

@@ -1,3 +1,3 @@
 module NxtConfig
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/nxt_config.rb

@@ -6,24 +6,10 @@ require "nxt_config/struct"
 require "nxt_config/version"
 
 module NxtConfig
-  class ConstantNameAlreadyTaken < StandardError; end
-
-  def load_and_constantize(source:, constant_name: nil, namespace: nil)
-    source_hash = YAML.safe_load(ERB.new(File.read(source)).result)
-    struct = Struct.new(source_hash)
-    namespace_constant = namespace || Object
-
-    begin
-      if namespace_constant.const_get(constant_name)
-        raise ConstantNameAlreadyTaken,
-              "Cannot define constant #{constant_name} on #{namespace_constant.name} because it already exists."
-      end
-    rescue NameError
-      # If the constant does not exist => fine, let's set it!
-    end
-
-    namespace_constant.const_set(constant_name, struct)
+  def load(filename)
+    source_hash = YAML.safe_load(ERB.new(File.read(filename)).result)
+    Struct.new(source_hash)
   end
 
-  module_function :load_and_constantize
+  module_function :load
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nxt_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nils Sommer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-04 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport