rails-options_config 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b279dd643c9c6b7d0fc3145b7a6eb377be0c9c34be871046b07d9e2066010027
+  data.tar.gz: 61c959dee4601f5912a4f9e392755630013f3e92bc9da9682bc18285dd0bb1d5
+SHA512:
+  metadata.gz: 283b34dfcf65bf90501089299200ae5399b89491f56b027d91759aab879864ae099091eb8893c2e33b5b0cf632ce103dfec1ddf0625293890f65f3fa5f140069
+  data.tar.gz: 932a06cdc8996134b8cbcf690a0a79164793393d30869041ac3e46a06f3fcfe9342759b39b0aa1afcc7b910887622b3966042d6191f83edfb5b494379edcb2ee

data/README.md

@@ -0,0 +1,93 @@
+# Rails Options
+
+A uniform interface to multiple option YAML files.
+
+As a project's size increases, its credentials file tends to become unmanageable. With Rails Options you can split the credentials into smaller separate YAML files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-options', '~> 1.0'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+Create any YAML (`.yml` or `.yaml`) file inside the `config/options` directory. You will find everything in `Rails.application.options`, including the credentials:
+
+```yaml
+# config/options/pokemon.yml
+pokemon_api:
+  base_url: https://pokeapi.co/api/v2
+```
+
+```ruby
+Rails.application.options
+# => {pokemon_api: {base_url: "https://pokeapi.co/api/v2"}}
+```
+
+`options` actually returns an `ActiveSupport::OrderedOptions`, which lets you access options as methods, as well as nested hash keys:
+
+```ruby
+Rails.application.options.dig(:pokemon_api, :base_url)
+Rails.application.options.pokemon_api.base_url
+```
+
+The YAML files can be encrypted: if the filename ends in `.enc`, the content will be assumed to have been encrypted with `rails encrypted:edit`. Notice that the command will *not* automatically append the `.enc` extension.
+
+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).
+
+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`:
+
+```yaml
+a_key: !env/VAR
+```
+
+will become:
+
+```ruby
+{
+  a_key: 'variable'
+}
+```
+
+### Options
+
+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.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`.
+
+## Version numbers
+
+Rails Options loosely follows [Semantic Versioning](https://semver.org/), with a hard guarantee that breaking changes to the public API will always coincide with an increase to the `MAJOR` number.
+
+Version numbers are in three parts: `MAJOR.MINOR.PATCH`.
+
+- Breaking changes to the public API increment the `MAJOR`. There may also be changes that would otherwise increase the `MINOR` or the `PATCH`.
+- Additions, deprecations, and "big" non breaking changes to the public API increment the `MINOR`. There may also be changes that would otherwise increase the `PATCH`.
+- Bug fixes and "small" non breaking changes to the public API increment the `PATCH`.
+
+Notice that any feature deprecated by a minor release can be expected to be removed by the next major release.
+
+## Changelog
+
+Full list of changes in [CHANGELOG.md](CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moku-io/rails-options.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path 'test/dummy/Rakefile', __dir__
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/lib/rails/options_config/application.rb

@@ -0,0 +1,75 @@
+require_relative 'yaml/env_visitor'
+require_relative 'key_override_error'
+
+module Rails
+  class Application
+    def options
+      @options ||= begin
+                     yaml_visitor = OptionsConfig::EnvVisitor.create symbolize_names: true
+                     Array(config.options.roots)
+                       .flat_map do |root|
+                         Dir
+                           .glob(Array(config.options.paths), base: root)
+                           .map do |path|
+                             path.match %r{^(?<filename>.*?)(?<env>\..*?)?(?<extension>\.ya?ml)(?<enc>\.enc)?$} do |md|
+                               full_path = Pathname(root).join(path)
+                               encrypted = md[:enc].present?
+                               content = if encrypted
+                                           yaml_visitor.accept YAML.parse(encrypted(full_path).read)
+                                         else
+                                           yaml_visitor.accept YAML.parse_file(full_path)
+                                         end
+
+                               {
+                                 path:      full_path,
+                                 filename:  md[:filename],
+                                 content:   content,
+                                 encrypted: encrypted
+                               }
+                                 .tap do |hash|
+                                   hash[:environment] = md[:env].delete_prefix('.').to_sym if md[:env].present?
+                                 end
+                             end
+                           end
+                       end
+                       .group_by { |file| file[:filename] }
+                       .map do |_, files|
+                         # Specifics overwrite bases, and encrypted overwrite cleartexts for each.
+                         bases = files
+                                   .reject { |file| file.key? :environment }
+                                   .sort_by { |file| file[:encrypted] ? 1 : 0 }
+                         specifics = files
+                                       .filter { |file| file[:environment] == Rails.env.to_sym }
+                                       .sort_by { |file| file[:encrypted] ? 1 : 0 }
+
+                         (bases + specifics)
+                           .reduce({}) { |acc, override| acc.deep_merge override[:content] }
+                       end
+                       .then do |hashes|
+                         if config.options.raise_on_override
+                           hashes.reduce credentials.config do |acc, hash|
+                             acc.deep_merge hash do |key, value1, value2|
+                               raise Options::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}"
+                             end
+                           end
+                         else
+                           hashes.reduce(credentials.config, &:deep_merge)
+                         end
+                       end
+                       .then do |hash|
+                         deep_transform = proc do |value|
+                           if value.is_a? Hash
+                             ActiveSupport::OrderedOptions[value.transform_values(&deep_transform)]
+                           else
+                             value
+                           end
+                         end
+                         deep_transform.call hash
+                       end
+                   end
+    end
+  end
+end

data/lib/rails/options_config/engine.rb

@@ -0,0 +1,11 @@
+module Rails
+  module OptionsConfig
+    class Engine < ::Rails::Engine
+      config.options = ActiveSupport::OrderedOptions.new
+
+      config.options.roots = ['config']
+      config.options.paths = ['options{,.*}.{yml,yaml}{.enc,}', 'options/**/*.{yml,yaml}{.enc,}']
+      config.options.raise_on_override = false
+    end
+  end
+end

data/lib/rails/options_config/key_override_error.rb

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

data/lib/rails/options_config/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module OptionsConfig
+    VERSION = '1.3.0'.freeze
+  end
+end

data/lib/rails/options_config/yaml/env_visitor.rb

@@ -0,0 +1,13 @@
+module Rails
+  module OptionsConfig
+    class EnvVisitor < Psych::Visitors::ToRuby
+      def accept target
+        if !target.tag.nil? && target.tag.start_with?('!env/')
+          ENV[target.tag.delete_prefix('!env/')]
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/rails/options_config.rb

@@ -0,0 +1,3 @@
+require 'rails/options_config/version'
+require 'rails/options_config/engine'
+require 'rails/options_config/application'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rails-options_config
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Moku S.r.l.
+- Riccardo Agatea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.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.
+email:
+- info@moku.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rails/options_config.rb
+- lib/rails/options_config/application.rb
+- lib/rails/options_config/engine.rb
+- lib/rails/options_config/key_override_error.rb
+- lib/rails/options_config/version.rb
+- lib/rails/options_config/yaml/env_visitor.rb
+homepage: https://bitbucket.org/moku_team/rails-options
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/moku_team/rails-options
+  source_code_uri: https://bitbucket.org/moku_team/rails-options
+  changelog_uri: https://github.com/moku-io/rails-options/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: A uniform interface to multiple option YAML files.
+test_files: []