nitro_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7055701182010d5935ca398768db0f1d5dffeeda042bd7096278beaf6504da9
+  data.tar.gz: 3bd0acd7ea41fcf58dfdca6811bb50a9ccf87df0619633908d5bd150a0aecb86
+SHA512:
+  metadata.gz: 7036c60be8e7b4ba9842220e5c8ff752d5d3d44a0256d20458f851aa77cd3cc1a9a76a546df0b0aa7536e1d55b92a6e92b641fd71db04471a19b4beaa473905c
+  data.tar.gz: f14127304b5d4880b09cd467406b1941d63aa68662789b3e5efac5ad48aa38cc6e6500c47f4609b61e3311ce800d7a773c5e55504f62aed7b256ce7ac4febc53

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ["lib/**/*.rb"]
+    t.options = [
+      "--no-private",
+    ]
+  end
+rescue LoadError
+  warn "Could not require() YARD! Install with 'gem install yard' to get the 'yardoc' task"
+end
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/docs/README.md

@@ -0,0 +1,51 @@
+# NitroConfig
+
+When included in a Rails application, NitroConfig loads the configuration file at `config/config.yml` within the application directory and makes its values available at `NitroConfig.config`. Config values are loaded based on the Rails environment, permitting the specification of multiple environments' configurations in a single file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nitro_config'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Given the following example config file, the following examples demonstrate how to obtain these values.
+
+```yaml
+base: &base
+  some:
+    nested: value
+
+development:
+  <<: *base
+  some:
+    nested: devvalue
+
+test:
+  <<: *base
+  some:
+    nested: testvalue
+
+```
+
+    $ rails c
+    [1] pry(main)> NitroConfig.config.get('some/nested')
+    => "devvalue"
+    [2] pry(main)> NitroConfig.config.get('some/other')
+    => nil
+    [3] pry(main)> NitroConfig.config.get!('some/other')
+    NitroConfig::Error: some/other not found in app config!
+    from /Users/ben/code/power/nitro/components/nitro_config/lib/nitro_config/options.rb:20:in `block in get!'
+    [2] pry(main)> NitroConfig.config.get('some/other', 'default')
+    => "default"
+
+    $ RAILS_ENV=test rails c
+    [1] pry(main)> NitroConfig.config.get('some/nested')
+    => "testvalue"

data/lib/nitro_config/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NitroConfig
+  # Raised when a path cannot be found in the config tree
+  class Error < StandardError
+    def initialize(path)
+      super "#{path} not found in app config! If you're working in development, you probably need to" \
+            "`cp config/config_sample.yml config/config.yml` or create a symlink for convenience."
+    end
+  end
+end

data/lib/nitro_config/options.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/try"
+require "active_support/hash_with_indifferent_access"
+
+require "nitro_config/error"
+
+module NitroConfig
+  PATH_SEPARATOR = "/"
+
+  # Representation of a config key-value tree with path-based access
+  class Options < HashWithIndifferentAccess
+    # Preserves values in the global configuration which might be altered within the yielded block.
+    # This is useful for testing, where a test needs to assert behaviour with certain settings values,
+    # but you want them to be restored for the next test.
+    #
+    # @example Preserving configuration in all tests
+    #   config.around(:each) do |example|
+    #     NitroConfig.preserve! do
+    #       example.run
+    #     end
+    #   end
+    #   OR
+    #   config.include NitroConfig::Rspec
+    #
+    # @yield A block within which configuration can safely be altered, being restored on return
+    def preserve!
+      tmp = clone
+      yield
+      replace(tmp)
+    end
+
+    # Returns a configuration value by path
+    #
+    # @param [String,Array] path the path within the configuration to return, with nested keys "separated/like/this"
+    # @param default a default value to return if the path is not found in the configuration
+    #
+    # @return The value extracted from configuration, of the type specified when declared.
+    def get(path, default = nil)
+      get!(path)
+    rescue NitroConfig::Error
+      default
+    end
+
+    # Returns a configuration value by path
+    #
+    # @param [String,Array] path the path within the configuration to return, with
+    #   nested keys "separated/like/this", ['or', 'like', 'this']
+    #
+    # @return The value extracted from configuration, of the type specified when declared.
+    #
+    # @raise [NitroConfig::Error] when the configuration option is not found
+    def get!(path)
+      split_path = path.respond_to?(:split) ? path.split(PATH_SEPARATOR) : path
+      split_path.flatten.reduce(self) do |config, key|
+        raise(NitroConfig::Error, path) unless config.try(:has_key?, key)
+
+        config[key]
+      end
+    end
+  end
+end

data/lib/nitro_config/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NitroConfig
+  # Hook into Rails initialisation to make config available on application boot
+  # @private
+  class Railtie < Rails::Railtie
+    config.before_configuration do |app|
+      NitroConfig.load! app.root.join("config", "config.yml"), Rails.env
+    rescue Errno::ENOENT => e
+      abort("Failed to initialize Nitro Config for #{app}:\n#{e.message}")
+    end
+  end
+
+  private_constant :Railtie
+end

data/lib/nitro_config/rspec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require "nitro_config/options"
+
+# When included in a Rails application, NitroConfig loads the
+# configuration file at `config/config.yml` within the application
+# directory and makes its values available at {NitroConfig.config}.
+#
+# Config values are loaded based on the Rails environment, permitting
+# the specification of multiple environments' configurations in a
+# single file.
+module NitroConfig
+  module Rspec
+    def self.included(base)
+      base.around(:each) do |example|
+        NitroConfig.config.preserve! do
+          example.run
+        end
+      end
+    end
+  end
+end

data/lib/nitro_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NitroConfig
+  VERSION = "0.1.0"
+end

data/lib/nitro_config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require "nitro_config/options"
+
+# When included in a Rails application, NitroConfig loads the
+# configuration file at `config/config.yml` within the application
+# directory and makes its values available at {NitroConfig.config}.
+#
+# Config values are loaded based on the Rails environment, permitting
+# the specification of multiple environments' configurations in a
+# single file.
+module NitroConfig
+  # Loads a configuration file as the global config, making it accessible via {NitroConfig.config}
+  #
+  # @param [String] file path to the config file to be loaded
+  # @param [String] env the environment to load from the file (top level key)
+  #
+  # @return [NitroConfig::Options] the loaded configuration
+  def self.load!(file, env)
+    @config = NitroConfig::Options.new(YAML.load_file(file)[env])
+  end
+
+  # Provides the loaded global configuration
+  #
+  # @return [NitroConfig::Options] the loaded configuration
+  def self.config
+    @config ||= NitroConfig::Options.new
+  end
+
+  # @see NitroConfig::Options#get
+  def self.get(*args)
+    config.get(*args)
+  end
+
+  # @see NitroConfig::Options#get
+  def self.get!(*args)
+    config.get!(*args)
+  end
+
+  # Returns a function that will return the requested config when invoked.
+  # This method is useful for fetching configurations in declarative contexts where the code will be invoked
+  # in boot time. This will defer the fetching of the config to when needed.
+  #
+  # @see NitroConfig::Options#get
+  # @return [Proc] a proc that takes any number of arguments and returns the requested config
+  def self.get_deferred!(*args)
+    ->(*_args) { config.get!(*args) }
+  end
+
+  require "nitro_config/railtie" if defined?(Rails)
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: nitro_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Palhares
+- Jill Klang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.8
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-powerhome
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.21
+description: Loads Nitro configuration and makes it available to the application
+email:
+- chjunior@gmail.com
+- jillian.emilie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- docs/README.md
+- lib/nitro_config.rb
+- lib/nitro_config/error.rb
+- lib/nitro_config/options.rb
+- lib/nitro_config/railtie.rb
+- lib/nitro_config/rspec.rb
+- lib/nitro_config/version.rb
+homepage: https://github.com/powerhome/power-tools/blob/main/packages/nitro_config/docs/README.md
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Nitro Configuration Loader
+test_files: []