nxt_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99bdd425a2f8fad0172fcb0abed1b1a0c4c4b6c73f689020bd980018f6c9b405
+  data.tar.gz: 3a61b5deacd727ee4e932b0b82abdc6e31d1bbad3bc29623721f97d33f237996
+SHA512:
+  metadata.gz: d863dac54820171a4211ef9540510486dbcd5f95a792d0315d50db65a943c9e59b1248c1aac7e5111a73d068440d03049cf60e8773eed47b00c6304f8aab1578
+  data.tar.gz: '0832012a16cc951d9da8edb459c3d513414718121487df658150e384f87575d925e12e1dd3b83f3fa61a8243776d94282ce85922d7d55de4b52208667af3f656'

data/.circleci/config.yml

@@ -0,0 +1,56 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.7.0-node
+    environment:
+      BUNDLER_VERSION: 2.1.3
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run: gem install bundler --version $BUNDLER_VERSION
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{rb,yml,json,rake,erb}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nxt_config.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+group :test do
+  gem 'rspec_junit_formatter' # for CircleCI
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    nxt_config (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.13.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nxt_config!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+
+BUNDLED WITH
+   2.1.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nils Sommer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+[![CircleCI](https://circleci.com/gh/nxt-insurance/nxt_config.svg?style=svg)](https://circleci.com/gh/nxt-insurance/nxt_config) [![Depfu](https://badges.depfu.com/badges/55572b7950c22f7f472a0adbf81b2ea4/count.svg)](https://depfu.com/github/nxt-insurance/nxt_config?project_id=10455)
+
+# NxtConfig
+
+This is a very simple tool to load YAML files into strict configuration structs, accessible through global constants. This is inspired by the famous [config](https://github.com/railsconfig/config) gem. The core features are:
+
+* Load the content of a YAML file as a configuration object
+* Strict attribute accessors
+* Infinite amount of YAML files/configuration objects loadable (not just one)
+* Configuration objects can be registered in a given namespace (especially useful when in use in ruby gems loaded by other applications)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nxt_config'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nxt_config
+
+## 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`).
+
+```ruby
+NxtConfig.load_and_constantize(
+	source: Rails.root.join('config', 'external_api.yml.erb'),
+	constant_name: :ExternalApiConfig,
+	namespace: MyRailsApp
+)
+```
+
+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`.
+
+```ruby
+# Use struct like method chaining to access nested data
+MyRailsApp::ExternalApiConfig.http.headers.user_agent
+# => "MyRailsApp 1.0.0"
+
+# The struct methods are strict, so they raise an error if the attribute does not exist
+MyRailsApp::ExternalApiConfig.non_existent_key
+# => raises NoMethodError
+
+# You can also use hash like #[] calls with symbols
+MyRailsApp::ExternalApiConfig[:http][:headers][:user_agent]
+# => "MyRailsApp 1.0.0"
+
+# You can also use hash like #[] calls with strings
+MyRailsApp::ExternalApiConfig["http"]["headers"]["user_agent"]
+# => "MyRailsApp 1.0.0"
+
+# 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"}>}>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nxt-insurance/nxt_config.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nxt_config"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nxt_config/struct.rb

@@ -0,0 +1,40 @@
+module NxtConfig
+  class Struct
+    def initialize(hash)
+      @hash = hash.with_indifferent_access
+      define_key_accessor_methods
+      hash.freeze
+    end
+
+    delegate :[], to: :hash
+
+    private
+
+    attr_reader :hash
+
+    def define_key_accessor_methods
+      hash.transform_values! do |value|
+        transform_hash_value(value)
+      end
+    end
+
+    def transform_hash_value(value)
+      if value.is_a?(ActiveSupport::HashWithIndifferentAccess)
+        Struct.new(value)
+      elsif value.is_a?(Array)
+        value.map { |item| transform_hash_value(item) }
+      else
+        value
+      end
+    end
+
+    def method_missing(name, *args)
+      # Use #has_key? because even when the key exists, the value can be nil
+      if hash.has_key?(name)
+        hash.fetch(name)
+      else
+        super(name, *args)
+      end
+    end
+  end
+end

data/lib/nxt_config/version.rb

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

data/lib/nxt_config.rb

@@ -0,0 +1,29 @@
+require "active_support/all"
+require "erb"
+require "yaml"
+
+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)
+  end
+
+  module_function :load_and_constantize
+end

data/nxt_config.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/nxt_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nxt_config"
+  spec.version       = NxtConfig::VERSION
+  spec.authors       = ["Nils Sommer"]
+  spec.email         = ["mail@nilssommer.de"]
+
+  spec.summary       = "Simple configuration objects, loadable from YAML files"
+  spec.description   = "Create namespaced, immutable objects serving configuration properties to your ruby application."
+  spec.homepage      = "https://github.com/nxt-insurance/nxt_config"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nxt-insurance/nxt_config"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "activesupport"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: nxt_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nils Sommer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Create namespaced, immutable objects serving configuration properties
+  to your ruby application.
+email:
+- mail@nilssommer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/nxt_config.rb
+- lib/nxt_config/struct.rb
+- lib/nxt_config/version.rb
+- nxt_config.gemspec
+homepage: https://github.com/nxt-insurance/nxt_config
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nxt-insurance/nxt_config
+  source_code_uri: https://github.com/nxt-insurance/nxt_config
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple configuration objects, loadable from YAML files
+test_files: []