config_default 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db6708e562f296b9fc30108bfccaedf20958ec2f1854f78340469a3bc5305c82
-  data.tar.gz: 52e89e977db9e4e84c77474c9293a49bd7221a31e4332a63cb46d3a0c0753fee
+  metadata.gz: 64815caf5e319e0a0450d51ffcec8e2e90358cad44ea56b96810f05ff7376a4f
+  data.tar.gz: 37412fc1357aa64d689bc94310b2208a1b2f120f91a303fb9b2700398fb65110
 SHA512:
-  metadata.gz: 362be41b678e92605b275f821e7b600455e46cba0eb35dbd2cddf2440de97e1c26b92ba4cca86cb194c5df2376cf4f001ea1096339721c1b51e3c52fabb3c3a7
-  data.tar.gz: e607fab179b3aa0ccf9906ad426c158b812736cac16cc07e17aff4963096e68cad1d66141a884a796af30ba6d3fe66d82dc9623ae2e51edf7386c0f4390a0c02
+  metadata.gz: e867d8bed4ce7d7fcbd9b0ff5101cb9049954cb69b3212cdba2f891db5c36ab3799fe25997e7a81a0d94b9bcdfe0e6bb5988086537eb37e7ba68fcad05cbb157
+  data.tar.gz: 6d1b4e3b838952deb21db1cbddea070703d2737e922db0b2c27c86c795f74c67e075c02cfbc532b8520c1d6279720bc598618d87443c45d02ca7d4fc6e6a8be3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.5.4
+- Upgrade gems.
+- Rename #load to #hash
+- Rename #load_struct to #struct
+- Change ArgumentError to NoMethodError (call super)
+- Make #read_file method private
+
 ## 0.5.2
 
 - Upgrade to ruby & gems.

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    config_default (0.5.3)
+    config_default (0.5.4)
       activesupport (>= 6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    action_text-trix (2.1.16)
+    action_text-trix (2.1.17)
       railties
     actioncable (8.1.2)
       actionpack (= 8.1.2)
@@ -92,7 +92,7 @@ GEM
     date (3.5.1)
     diff-lcs (1.6.2)
     drb (2.2.3)
-    erb (6.0.1)
+    erb (6.0.2)
     erubi (1.13.1)
     globalid (1.3.0)
       activesupport (>= 6.1)
@@ -104,11 +104,11 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.18.1)
+    json (2.19.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loofah (2.25.0)
+    loofah (2.25.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.9.0)
@@ -120,7 +120,8 @@ GEM
     marcel (1.1.0)
     method_source (1.1.0)
     mini_mime (1.1.5)
-    minitest (6.0.1)
+    minitest (6.0.2)
+      drb (~> 2.0)
       prism (~> 1.5)
     net-imap (0.6.3)
       date
@@ -132,11 +133,11 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.5)
-    nokogiri (1.19.1-arm64-darwin)
+    nokogiri (1.19.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.1-x86_64-darwin)
+    nokogiri (1.19.2-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.1-x86_64-linux-gnu)
+    nokogiri (1.19.2-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.10.2)
@@ -180,8 +181,8 @@ GEM
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
+    rails-html-sanitizer (1.7.0)
+      loofah (~> 2.25)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     railties (8.1.2)
       actionpack (= 8.1.2)
@@ -210,11 +211,11 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.82.1)
+    rubocop (1.84.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -222,14 +223,14 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.48.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
-    rubocop-config-umbrellio (1.82.117)
-      rubocop (~> 1.82.0)
+    rubocop-config-umbrellio (1.84.118)
+      rubocop (~> 1.84.0)
       rubocop-factory_bot (~> 2.28.0)
       rubocop-performance (~> 1.26.0)
       rubocop-rails (~> 2.34.0)
@@ -262,7 +263,7 @@ GEM
     securerandom (0.4.1)
     stringio (3.2.0)
     thor (1.5.0)
-    timeout (0.6.0)
+    timeout (0.6.1)
     tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -275,7 +276,7 @@ GEM
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.7.4)
+    zeitwerk (2.7.5)
 
 PLATFORMS
   arm64-darwin

data/README.md

@@ -92,7 +92,7 @@ Just create `config/app.default.yml` (test/staging) and `config/app.yml` (stagin
 And then in your application load it:
 
 ```ruby
-config = ConfigDefault.load(:app)
+config = ConfigDefault.hash(:app)
 ```
 
 It will load result hash with merging `app.yml` and `app.default.yml` files.
@@ -101,34 +101,34 @@ So it's mean that what key (string or symbol) you will define in the YAML file =
 
 You can change this behaviour with `#load` options:
 ```ruby
-config = ConfigDefault.load(:app, symbolize_keys: true) # Hash with symbolized first keys
-config = ConfigDefault.load(:app, deep_symbolize_keys: true) # Hash with symbolized all keys
+config = ConfigDefault.hash(:app, symbolize_keys: true) # Hash with symbolized first keys
+config = ConfigDefault.hash(:app, deep_symbolize_keys: true) # Hash with symbolized all keys
 ```
 
 By default `ConfigDefault` using `Rails.env` to determnine what key you need from you config file.
 You can pass this key by your own:
 ```ruby
-config = ConfigDefault.load(:app, key: nil) # Will not use key at all and result by full file
-config = ConfigDefault.load(:app, key: "preprod") # Will search preprod key in file
+config = ConfigDefault.hash(:app, key: nil) # Will not use key at all and result by full file
+config = ConfigDefault.hash(:app, key: "preprod") # Will search preprod key in file
 ```
 
-### `#load_struct` method
+### `#struct` method
 
-If you want to use configuration as a struct object you can use `#load_struct` method.
+If you want to use configuration as a struct object you can use `#struct` method.
 Let's see an example with `database.yaml` config above:
 
 ```ruby
-config = ConfigDefault.load_struct(:database)
+config = ConfigDefault.struct(:database)
 config.host
 # => "postgres"
 config.lolkek
-# => StandardError: There is no option :lolkek in configuration.
+# => NoMethodError
 ```
 
 If your want to not raise an error on wrong key using (sometimes it's helpful) please use `allow_nil` option:
 
 ```ruby
-config = ConfigDefault.load_struct(:database, allow_nil: true)
+config = ConfigDefault.struct(:database, allow_nil: true)
 config.host
 # => "postgres"
 config.lolkek
@@ -145,7 +145,7 @@ first:
 ```
 
 ```ruby
-config = ConfigDefault.load_struct(:app, key: nil, recursive: true)
+config = ConfigDefault.struct(:app, key: nil, recursive: true)
 config.first.second.third
 # => "option"
 ```
@@ -155,7 +155,7 @@ It will be `ActiveSupport::HashWithIndifferentAccess`.
 Example with `app.default.yml` from above:
 
 ```ruby
-config = ConfigDefault.load_struct(:app, key: nil, recursive: true)
+config = ConfigDefault.struct(:app, key: nil, recursive: true)
 config.to_hash
 # => { "first" => { "second" => { "third" => "option" } } }
 config.first.to_hash
@@ -177,7 +177,7 @@ config.first.to_hash
 config.first.second.third
 # => "option"
 config.first.lolkek
-# => StandardError: There is no option :lolkek in configuration.
+# => NoMethodError
 ```
 
 `ConfigDefault::Struct` supports `recursive` and `allow_nil` options.

data/lib/config_default/rails_patch.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+# NOTE: Patch for #config_for method to support configuration. Used by rabbit_messaging gem
+# https://github.com/rails/rails/blob/main/railties/lib/rails/application.rb#L295
 module ConfigDefault::RailsApplicationConfigurationPatch
   def load_database_yaml
-    ConfigDefault.load(:database, key: nil)
+    ConfigDefault.hash(:database, key: nil)
   end
 
   def database_configuration
@@ -10,9 +12,11 @@ module ConfigDefault::RailsApplicationConfigurationPatch
   end
 end
 
+# NOTE: Patch Rails to load database configuration
+# https://github.com/rails/rails/blob/main/railties/lib/rails/application/configuration.rb#L467
 module ConfigDefault::RailsApplicationPatch
   def config_for(name, env: Rails.env)
-    data = ConfigDefault.load(name, key: env, deep_symbolize_keys: true)
+    data = ConfigDefault.hash(name, key: env, deep_symbolize_keys: true)
     ActiveSupport::OrderedOptions.new.merge(data)
   end
 end

data/lib/config_default/struct.rb

@@ -20,7 +20,7 @@ class ConfigDefault::Struct
 
   def method_missing(method, *_args)
     return if @allow_nil
-    raise ArgumentError.new("There is no option :#{method} in configuration.")
+    super
   end
 
   def respond_to_missing?(*_args)

data/lib/config_default/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConfigDefault
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/lib/config_default.rb

@@ -22,9 +22,9 @@ module ConfigDefault
     ConfigDefault::RailsPatch.apply!
   end
 
-  def load(name, key: Rails.env, symbolize_keys: false, deep_symbolize_keys: false)
-    default_config = load_file("#{name}.#{config.postfix}")
-    config = load_file(name)
+  def hash(name, key: Rails.env, symbolize_keys: false, deep_symbolize_keys: false)
+    default_config = read_file("#{name}.#{config.postfix}")
+    config = read_file(name)
 
     if key
       default_config = default_config[key] || {}
@@ -32,7 +32,6 @@ module ConfigDefault
     end
 
     data = default_config.deep_merge(config)
-    return {} if data.nil?
 
     if deep_symbolize_keys
       data.deep_symbolize_keys
@@ -43,15 +42,17 @@ module ConfigDefault
     end
   end
 
-  def load_file(name)
+  def struct(name, key: Rails.env, recursive: false, allow_nil: false)
+    attributes = hash(name, key: key)
+    ConfigDefault::Struct.new(attributes, recursive: recursive, allow_nil: allow_nil)
+  end
+
+  private
+
+  def read_file(name)
     file_name = File.join(config.config_path, "#{name}.yml")
     ActiveSupport::ConfigurationFile.parse(file_name)
   rescue
     {}
   end
-
-  def load_struct(name, key: Rails.env, recursive: false, allow_nil: false)
-    attributes = load(name, key: key)
-    ConfigDefault::Struct.new(attributes, recursive: recursive, allow_nil: allow_nil)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config_default
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Stepan Kirushkin