rails-options_config 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5e669dc9026caa28b374c95341eea0ad720b8d1de0f1f5c789ef7c4f20a7556
-  data.tar.gz: 899c092cb5a2dd5bfe081baff6a7407f59e63488ad06c2585ee95cc71318a60e
+  metadata.gz: a7689f5625604db17772a75d1fdcdc5e7b316a3adbd79e8d691e575f1ba663f8
+  data.tar.gz: 47367ce04d3f612b6c627e18d5f481f104ece4d2579ce3bbda150ffef3826b84
 SHA512:
-  metadata.gz: a82af4388620233d6117a20d495f7ab3bc036ecd5e53591d5bc7705b4c80d12ff55e2bbd200ee1fd65291bcdffbc55da25257a282e8db8da715b759b346d2896
-  data.tar.gz: 2111daef39809e54c1b5c0aec3cf3beda5d9ffd6d8ee24f1983eb41ec9d3a08448da4b601e54317049b642b3412ad07e2acde9fdd246dd19d9fd21318619f886
+  metadata.gz: 315b51d35d4db43a0957f53fd8a4f991a9f282ebfda4ec0c993855649af7e3e27c91a04603bcf7b1db09d7e306d3cf6687de5efe7f4e74686f27a079b9bf221e
+  data.tar.gz: a2dd452cdce5b421b8dc3f8df1152cbbf777b039d249c28f1f2ac74df89c302c921a0cab8cf346cdd0ab66ed9c9a7d724ddacbe96bc13521ee3a2469e9c3bcf6

data/README.md

@@ -9,7 +9,7 @@ As a project's size increases, its credentials file tends to become unmanageable
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rails-options', '~> 1.0'
+gem 'rails-options_config', '~> 1.0'
 ```
 
 And then execute:
@@ -44,7 +44,7 @@ The YAML files can be encrypted: if the filename ends in `.enc`, the content wil
 
 If a filename contains an environment tag, the content will be considered only in the respective environment: `config/options/pokemon.development.yml` will only be loaded in the `development` environment.
 
-Files with the same root name will overwrite each other: environment specific files will overwrite generic ones, and encrypted files will overwrite clear text ones. This way you can provide sensible defaults in the generic files, with encryption if necessary, and override them in specific environments (for example using a `.development` gitignored file to use a local mocked server instead of the real thing).
+Files with the same root name will overwrite each other: environment specific files will overwrite generic ones, and encrypted files will overwrite clear text ones. This way you can provide sensible defaults in the generic files, with encryption if necessary, and override them in specific environments (for example using a `.development` gitignored file to use a local mocked server instead of the real thing). The values are overwritten using `Hash#deep_merge` from Active Support, so you can overwrite only selected values and keep the default for the rest.
 
 Options can also be picked up from environment variables. Any `!env/VAR` YAML tag will be substituted for the value of the `VAR` variable, anywhere in the file (even in keys). For example, setting `VAR=variable`:
 
@@ -64,7 +64,7 @@ will become:
 
 You can set these options in `application.rb` or in any of the `environments/*.rb` files.
 
-- `config.options.roots` : the directories, relative to `Rails.root`, in which to look for options files. You can either add to the existing array with `<<` or assign a new array. Default: `['config']`. 
+- `config.options.roots` : the directories, relative to `Rails.root`, in which to look for options files. You can either add to the existing array with `<<` or assign a new array. Default: `['config']`.
 - `config.options.paths` : the patterns (in the format of `Dir.glob`) corresponding to the options files. They will be looked for in all the `roots` directories. Default: `['options.{yml,yaml}{.enc,}', 'options/**/*.{yml,yaml}{.enc,}']`.
 - `config.options.raise_on_override` : set this to `true` if you want an exception to be raised if any key would be set by multiple files. If this is `false` and a "conflict" happens, one key will overwrite the other, but the order is undefined. This only applies to files with a different `path/to/file`, not to conflicts between the base and any environment-specific version. Default: `false`.
 

data/lib/rails/options_config/application.rb

@@ -1,5 +1,6 @@
 require_relative 'yaml/env_visitor'
 require_relative 'key_override_error'
+require_relative 'unusable_options_error'
 
 module Rails
   class Application
@@ -15,10 +16,16 @@ module Rails
                                full_path = Pathname(root).join(path)
                                encrypted = md[:enc].present?
                                content = if encrypted
-                                           yaml_visitor.accept YAML.parse(encrypted(full_path).read)
+                                           YAML.parse encrypted(full_path).read
                                          else
-                                           yaml_visitor.accept YAML.parse_file(full_path)
+                                           YAML.parse_file full_path
                                          end
+                                           .therefore { |yaml| yaml_visitor.accept yaml }
+
+                               unless content.is_a? Hash
+                                 raise OptionsConfig::UnusableOptionsError,
+                                       "The contents of options file `#{full_path}` are unsuitable. It must be a hash."
+                               end
 
                                {
                                  path:      full_path,
@@ -49,7 +56,7 @@ module Rails
                          if config.options.raise_on_override
                            hashes.reduce credentials.config do |acc, hash|
                              acc.deep_merge hash do |key, value1, value2|
-                               raise Options::KeyOverrideError,
+                               raise OptionsConfig::KeyOverrideError,
                                      'Key override while loading options: ' \
                                      "trying to set `#{key}' to #{value2.inspect}:#{value2.class}, " \
                                      "but it is already set to #{value1.inspect}:#{value1.class}"

data/lib/rails/options_config/unusable_options_error.rb

@@ -0,0 +1,6 @@
+module Rails
+  module OptionsConfig
+    class UnusableOptionsError < StandardError
+    end
+  end
+end

data/lib/rails/options_config/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module OptionsConfig
-    VERSION = '1.3.1'.freeze
+    VERSION = '1.3.2'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-options_config
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: therefore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: As a project's size increases, its credentials file tends to become unmanageable.
   With Rails Options Config you can split the credentials into smaller separate YAML
   files.
@@ -40,6 +54,7 @@ files:
 - lib/rails/options_config/application.rb
 - lib/rails/options_config/engine.rb
 - lib/rails/options_config/key_override_error.rb
+- lib/rails/options_config/unusable_options_error.rb
 - lib/rails/options_config/version.rb
 - lib/rails/options_config/yaml/env_visitor.rb
 homepage: https://github.com/moku-io/rails-options
@@ -64,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A uniform interface to multiple option YAML files.