settings_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebad4556c91f82603c3811808d396bbc12875352e8f19acee09ad4787b958edc
+  data.tar.gz: 0a1e35282c1d2ce2b1ea49be238d2dda10ba7877ca5d066526f6981d3826f639
+SHA512:
+  metadata.gz: e01df5eea2864552cde89b3bebb194ee762a0573c2b782a1fba4d7525e4729f359643651e168090f0e09547bb4c6c625d1d9b68e4b5cd5dde8696def39d288a4
+  data.tar.gz: 681a99042b9b582935478b2f8a8d2455baa156e5c027700cab87d857767f9abba523c540a9ab42ad17bd47bf94a9d21ef6ac8b73a469dd8dc4ea7354fea7010b

data/.github/workflows/linters.yml

@@ -0,0 +1,52 @@
+name: "linters"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '30 0 * * 1'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel
+
+  code-ql:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/main.yml

@@ -0,0 +1,66 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run specs
+        env:
+          COVERAGE: true
+        run: bundle exec rspec
+
+      - name: Upload coverage
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: bash <(curl -s https://codecov.io/bash)
+
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Set up credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${{secrets.RUBYGEMS_AUTH_TOKEN}}\n" > $HOME/.gem/credentials
+
+      - name: Get version
+        run: echo "${GITHUB_REF/refs\/tags\//}" > release.tag
+      - name: Set version
+        run: sed -i "s/0.0.0/$(<release.tag)/g" */**/version.rb
+
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Push gem
+        run: gem push *.gem

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/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5.0
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context', 'shared_examples']

data/.simplecov

@@ -0,0 +1,9 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'codecov'
+  SimpleCov.start do
+    enable_coverage :branch
+    primary_coverage :branch
+    formatter SimpleCov::Formatter::Codecov
+  end
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [Unreleased]
+
+## [0.1.0]
+Initial Release
+
+### New features
+- Backends & Resolvers
+- Simplified interface
+- Plugin system
+
+[Unreleased]: https://github.com/matic-insurance/settings_reader-vault_resolver/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/matic-insurance/settings_reader-vault_resolver/commits/0.1.0
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 712680+volodymyr-mykhailyk@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in settings_reader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    settings_reader (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov (~> 0.4)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.66)
+  rubocop-rspec (~> 1.32.0)
+  settings_reader!
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Volodymyr Mykhailyk
+
+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,222 @@
+# SettingsReader
+
+![Build Status](https://github.com/matic-insurance/settings_reader/workflows/ci/badge.svg?branch=main)
+[![Test Coverage](https://codecov.io/gh/matic-insurance/settings_reader/branch/main/graph/badge.svg?token=5E8NA8EE8L)](https://codecov.io/gh/matic-insurance/settings_reader)
+
+Settings Reader provides flexible way to make settings available for any application.
+
+Settings are retrieved in 2 steps:
+1. Get value from one of Backends (Yaml, KV storage, Database, etc)
+2. Process value using one of Resolver (Environment variable, Erb template, Vault, etc)
+
+Gem support any number of backends and resolvers. 
+Such scheme allows customized and flexible settings for any environment. For example:
+ - Read value in Consul, fallback to yaml, resolve via ERB for additional flexibility
+ - Read value in Yaml for specific environment (local file), fallback to generic Yaml config, resolve in env when deployed 
+
+The gem is built around an idea that having full set of settings in the repository allows any maintainer of app 
+to better understand how it works. At the same time providing flexibility of where the settings will be retrieved/resolved
+in the end environment (local dev machine, production instance, k8s pod).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'settings_reader'
+```
+
+## Initialization
+
+At the load of application configure and load settings:
+
+```ruby
+APP_SETTINGS = SettingsReader.load('my_cool_app') do |config|
+  # Configure backends.
+  config.backends = [
+    SettingsReader::Backends::YamlFile.new(Rails.root.join("config/settings/#{Rails.env}.yml")),
+    SettingsReader::Backends::YamlFile.new(Rails.root.join('config/settings.yml'))
+  ]
+  # Configure resolvers.
+  config.resolvers = [
+    SettingsReader::Resolvers::Env.new,
+    SettingsReader::Resolvers::Erb.new
+  ]
+end
+```
+
+**NOTE** For rails you can add this code to as initializer `settings_reader.rb` in `app/config/initializers`
+
+## Usage
+### Example settings structure
+
+Assuming your defaults settings file in repository `config/settings.yml` looks like:
+```yaml
+my_cool_app:
+  app_name: 'MyCoolApp'
+  url: 'http://localhost:3001'
+  
+  integrations:
+    database:
+      domain: localhost
+      user: app
+      password: password1234
+      parameters:
+        pool: 20
+        ssl: false
+```
+
+And production config `config/settings/produciton.yml` has following values
+```yaml
+my_cool_app:
+  url: 'https://mycoolapp.com'
+
+  integrations:
+    database:
+      domain: 10.0.5.141
+      password: 'env://DATABASE_PASSWORD'
+```
+
+### Get setting via full path
+
+Anywhere in your code base, after initialization, you can use
+previously loaded settings to query any key by full path
+
+```ruby
+APP_SETTINGS['app_name']                          # "MyCoolApp"
+APP_SETTINGS.get(:hostname)                       # "https://mycoolapp.com"
+
+APP_SETTINGS.get('integrations/database/user')    # "app"
+APP_SETTINGS['integrations/database/password']    # Value of environment variable DATABASE_PASS
+
+#if you try to get sub settings via get - error is raised
+APP_SETTINGS.get('integrations/database')         # raise SettingsReader::Error
+```
+
+**IMPORTANT** If you try to get settings tree via `get` method `SettingsReader::Error` is going to be raised. 
+This is done due to the fact that we need to resolve settings every time they are requested. 
+Resolving whole tree upfront is not possible as gem is not aware about final structure of all backends  
+
+### Sub settings
+
+Assuming some part of your code needs to work with smaller part of settings -
+gem provides interface to avoid repeating absolute path
+
+```ruby
+# You can load sub settings from root object
+db_settings = APP_SETTINGS.load('integrations/database') # SettingsReader::Reader
+db_settings.get(:domain)                                 # "10.0.5.141"
+db_settings['user']                                      # "app"
+db_params = db_settings.load('parameters')               # SettingsReader::Reader
+```
+
+## Advanced Configurations & Customization
+
+### Backends
+Backends controls how and in which order settings are retrieved. 
+During initial load - provide list of backend instances you want to query on all requests.
+
+When application asks for specific setting - gem asks every backend in order of the configuration
+until one returns not nil value. Full path to the setting provided to backend 
+
+Default order for providers is:
+1. `SettingsReader::Backends::YamlFile.new('config/app_settings.local.yml')`
+2. `SettingsReader::YamlFile.new('config/app_settings.yml')`
+
+Additional backend plugins:
+- [settings_reader-consul_backend]() - Implementation pending
+
+Custom provider can be added as long as it support following interface:
+```ruby
+class CustomProvider
+  # get value by full_path or return nil if missing
+  def get(full_path)
+  end
+end 
+```
+
+### Resolvers
+Once value is retrieved - it will be additionally processed by resolvers.
+This allows for additional flexibility like resolving one specific value in external sources.
+
+While every resolver can be implemented in a form of a provider - one will be limited by the structure of settings,
+that other system might not be compatible with this.
+
+When value is retrieved - gem finds **first** provider that can resolve value and resolves it.
+Resolved value is returned to application.
+
+Default list of resolvers:
+- `SettingsReader::Resolvers::Env.new`
+- `SettingsReader::Resolvers::Erb.new`
+
+List of built in resolvers:
+- `SettingsReader::Resolvers::Env` - resolves compatible value by looking up environment variable.
+  Matching any value that starts with `env://`. Value like `env://TEST_URL` will be resolved as `ENV['TEST_URL']`
+- `SettingsReader::Resolvers::Erb` - resolves value by rendering it via ERB if it contains ERB template.
+  Matching any value that contains `<%` and `%>` in it. Value like `<%= 2 + 2 %>` will be resolved as `4`
+
+Additional resolver plugins:
+- [settings_reader-vault_resolver](https://github.com/matic-insurance/settings_reader-vault_resolver) - 
+resolves compatible value by getting it from Vault. Matching any value that starts with `vault://`. 
+Value like `vault://secret/my_app/secrets#foo` will be resolved in vault as `Vault.kv('secret').get('my_app/secrets')`
+and attribute `foo` will be retrieved from the resolved secret.  
+
+Custom resolver can be added as long as it support following interface:
+```ruby
+class CustomResolver
+  # should return true if current value should be resolved
+  def resolvable?(value, full_path)
+  end
+  
+  # resolve value
+  def resolve(value, full_path)
+  end
+end 
+```
+
+### Gem Configuration
+
+You can configure gem while loading settings:
+```ruby
+APP_SETTINGS = SettingsReader.configure do |config|
+  config.backends = []
+  config.resolvers = []
+end
+```
+
+### Default gem configuration
+Below is current default gem configuration
+```ruby
+APP_SETTINGS = SettingsReader.load do |config|
+  config.backends = [
+    SettingsReader::Backends::YamlFile.new('config/app_settings.local.yml'),
+    SettingsReader::Backends::YamlFile.new('config/app_settings.yml')
+  ]
+  config.resolvers = [
+    SettingsReader::Resolvers::Env.new,
+    SettingsReader::Resolvers::Erb.new
+  ]
+end
+```
+
+## Development
+
+1. Run `bin/setup` to install dependencies
+1. Run tests `rspec`
+1. Add new test
+1. Add new code
+1. Go to step 3
+1. Create PR
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/matic-insurance/settings_reader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/matic-insurance/settings_reader/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SettingsReader project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matic-insurance/settings_reader/blob/master/CODE_OF_CONDUCT.md).

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 'settings_reader'
+
+# 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/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/settings_reader/backends/abstract.rb

@@ -0,0 +1,14 @@
+module SettingsReader
+  module Backends
+    # Abstract class with basic functionality
+    class Abstract
+      include SettingsReader::Mixins::Path
+      include SettingsReader::Mixins::Values
+
+      # get value from backend by full_path or return nil if missing
+      def get(_full_path)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/settings_reader/backends/yaml_file.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module SettingsReader
+  module Backends
+    # Provides access to settings stored as YAML file.
+    # File will be read once on init and cached in memory:
+    #   When file is missing - no error will be raised
+    #   When file is invalid - SettingsReader::Error is raised
+    class YamlFile < Abstract
+      def initialize(file_path)
+        super()
+        @data = read_yml(file_path)
+      end
+
+      def get(path)
+        parts = decompose_path(path)
+        get_value_from_hash(@data, parts)
+      end
+
+      private
+
+      def read_yml(path)
+        return {} unless File.exist?(path)
+
+        YAML.safe_load(IO.read(path))
+      rescue Psych::SyntaxError, Errno::ENOENT => e
+        raise SettingsReader::Error, "Cannot read settings file at #{path}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/settings_reader/configuration.rb

@@ -0,0 +1,20 @@
+module SettingsReader
+  # All gem configuration settings
+  class Configuration
+    DEFAULT_BASE_FILE_PATH = 'config/app_settings.yml'.freeze
+    DEFAULT_LOCAL_FILE_PATH = 'config/app_settings.local.yml'.freeze
+    attr_accessor :backends, :resolvers
+
+    def initialize
+      @base_file_path = DEFAULT_BASE_FILE_PATH
+      @local_file_path = DEFAULT_LOCAL_FILE_PATH
+      @backends = [
+        SettingsReader::Backends::YamlFile.new(DEFAULT_LOCAL_FILE_PATH),
+        SettingsReader::Backends::YamlFile.new(DEFAULT_BASE_FILE_PATH)
+      ]
+      @resolvers = [
+        SettingsReader::Resolvers::Env.new
+      ]
+    end
+  end
+end

data/lib/settings_reader/mixins/path.rb

@@ -0,0 +1,21 @@
+module SettingsReader
+  module Mixins
+    # Path related utility methods
+    module Path
+      PATH_SEPARATOR = '/'.freeze
+
+      # Create path from parts using '/' as a separator
+      def generate_path(*parts)
+        strings = parts.map(&:to_s)
+        all_parts = strings.map { |s| s.split(PATH_SEPARATOR) }.flatten
+        all_parts.reject(&:empty?).join('/')
+      end
+
+      # Create list of parts from path using '/' as separator. Remove empty/nil parts
+      def decompose_path(path)
+        parts = path.to_s.split(PATH_SEPARATOR).compact
+        parts.reject(&:empty?)
+      end
+    end
+  end
+end

data/lib/settings_reader/mixins/values.rb

@@ -0,0 +1,43 @@
+module SettingsReader
+  module Mixins
+    # Value casting utility methods
+    module Values
+      PARSING_CLASSES = [Integer, Float, ->(value) { JSON.parse(value) }].freeze
+
+      def cast_value_from_string(value)
+        return nil if value.nil?
+        return false if value == 'false'
+        return true if value == 'true'
+        return value if value.is_a?(Hash)
+        return convert_to_hash(value) if value.is_a?(Array)
+
+        cast_complex_value(value)
+      end
+
+      def get_value_from_hash(data, path_parts)
+        data.dig(*path_parts).clone
+      end
+
+      protected
+
+      def cast_complex_value(value)
+        PARSING_CLASSES.each do |parser|
+          return parser.call(value)
+        rescue StandardError => _e
+          nil
+        end
+        value.to_s
+      end
+
+      def convert_to_hash(data)
+        data_h = data.map do |item|
+          value = cast_value_from_string(item[:value])
+          item[:key].split('/').reverse.reduce(value) { |h, v| { v => h } }
+        end
+        data_h.reduce({}) do |dest, source|
+          source.merge(dest)
+        end
+      end
+    end
+  end
+end

data/lib/settings_reader/reader.rb

@@ -0,0 +1,53 @@
+module SettingsReader
+  # Orchestrates fetching values from backend and resolving them
+  class Reader
+    include SettingsReader::Mixins::Path
+
+    def initialize(base_path, config)
+      @base_path = base_path
+      @config = config
+      @backends = config.backends
+      @resolvers = config.resolvers
+    end
+
+    def get(sub_path)
+      full_path = generate_path(@base_path, sub_path)
+      value = fetch_value(full_path)
+      resolve_value(value, full_path)
+    end
+
+    alias [] get
+
+    def load(sub_path)
+      new_path = generate_path(@base_path, sub_path)
+      SettingsReader::Reader.new(new_path, @config)
+    end
+
+    protected
+
+    def check_deep_structure(value, path)
+      return unless value.is_a?(Hash)
+
+      message = "Getting value of complex object at path: '#{path}'. Use #load method to get new scoped instance"
+      raise SettingsReader::Error, message if value.is_a?(Hash)
+    end
+
+    def fetch_value(path)
+      @backends.each do |backend|
+        value = backend.get(path)
+        check_deep_structure(value, path)
+        return value unless value.nil?
+      end
+      nil
+    end
+
+    def resolve_value(value, path)
+      resolver = @resolvers.detect { |r| r.resolvable?(value, path) }
+      if resolver
+        resolver.resolve(value, path)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/settings_reader/resolvers/abstract.rb

@@ -0,0 +1,18 @@
+module SettingsReader
+  module Resolvers
+    # Abstract resolver interface
+    class Abstract
+      include SettingsReader::Mixins::Values
+
+      # Should return true if value is resolvable
+      def resolvable?(_value, _path)
+        false
+      end
+
+      # Should resolve value
+      def resolve(value, _path)
+        value
+      end
+    end
+  end
+end

data/lib/settings_reader/resolvers/env.rb

@@ -0,0 +1,21 @@
+module SettingsReader
+  module Resolvers
+    # Resolve values in environment variable
+    class Env
+      IDENTIFIER = 'env://'.freeze
+
+      # Returns true when value starts from `env://`
+      def resolvable?(value, _path)
+        return unless value.respond_to?(:start_with?)
+
+        value.start_with?(IDENTIFIER)
+      end
+
+      # Return value of environment variable by removing `env://` prefix and calling `ENV[env_path]`
+      def resolve(value, _path)
+        env_path = value.to_s.delete_prefix(IDENTIFIER)
+        ENV[env_path]
+      end
+    end
+  end
+end

data/lib/settings_reader/resolvers/erb.rb

@@ -0,0 +1,20 @@
+module SettingsReader
+  module Resolvers
+    # Run values through ERB
+    class Erb
+      IDENTIFIER = /(<%=).*(%>)/.freeze
+
+      # Returns true when value contain Erb template <%= code_is_here %>
+      def resolvable?(value, _path)
+        return unless value.is_a?(String)
+
+        IDENTIFIER.match?(value)
+      end
+
+      # Renders value using ERB
+      def resolve(value, _path)
+        ERB.new(value.to_s).result
+      end
+    end
+  end
+end

data/lib/settings_reader/version.rb

@@ -0,0 +1,3 @@
+module SettingsReader
+  VERSION = '0.1.0'.freeze
+end

data/lib/settings_reader.rb

@@ -0,0 +1,21 @@
+require 'settings_reader/mixins/path'
+require 'settings_reader/mixins/values'
+require 'settings_reader/backends/abstract'
+require 'settings_reader/backends/yaml_file'
+require 'settings_reader/resolvers/abstract'
+require 'settings_reader/resolvers/env'
+require 'settings_reader/resolvers/erb'
+require 'settings_reader/configuration'
+require 'settings_reader/reader'
+require 'settings_reader/version'
+
+# Flexible Settings reader with support of custom backends and value resolutions
+module SettingsReader
+  class Error < StandardError; end
+
+  def self.load(base_path = '')
+    configuration = SettingsReader::Configuration.new
+    yield(configuration) if block_given?
+    Reader.new(base_path, configuration)
+  end
+end

data/settings_reader.gemspec

@@ -0,0 +1,39 @@
+require_relative 'lib/settings_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'settings_reader'
+  spec.version       = SettingsReader::VERSION
+  spec.authors       = ['Volodymyr Mykhailyk']
+  spec.email         = ['712680+volodymyr-mykhailyk@users.noreply.github.com']
+
+  spec.summary       = 'Flexible Settings reader with support of custom backends and value resolutions'
+  spec.description   = <<-DESCRIPTION
+    Customizable 2 step setting reading for your application.
+
+    First settings is retrieved from list of backends and afterwards processed 
+    by the list of resolvers to allow even more flexibility.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/matic-insurance/settings_reader'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) 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_development_dependency 'codecov', '~> 0.4'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.66'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.32.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: settings_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodymyr Mykhailyk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: "    Customizable 2 step setting reading for your application.\n\n    First
+  settings is retrieved from list of backends and afterwards processed \n    by the
+  list of resolvers to allow even more flexibility.\n"
+email:
+- 712680+volodymyr-mykhailyk@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/linters.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/settings_reader.rb
+- lib/settings_reader/backends/abstract.rb
+- lib/settings_reader/backends/yaml_file.rb
+- lib/settings_reader/configuration.rb
+- lib/settings_reader/mixins/path.rb
+- lib/settings_reader/mixins/values.rb
+- lib/settings_reader/reader.rb
+- lib/settings_reader/resolvers/abstract.rb
+- lib/settings_reader/resolvers/env.rb
+- lib/settings_reader/resolvers/erb.rb
+- lib/settings_reader/version.rb
+- settings_reader.gemspec
+homepage: https://github.com/matic-insurance/settings_reader
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matic-insurance/settings_reader
+  source_code_uri: https://github.com/matic-insurance/settings_reader
+  changelog_uri: https://github.com/matic-insurance/settings_reader/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Flexible Settings reader with support of custom backends and value resolutions
+test_files: []