consul_application_settings 0.1.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abc7a1661131160a981373791ccc8ac3a48323283803b32f04a866ae33d3cd2
-  data.tar.gz: f6c70feae5652f55c564a98df789518efe4e3980ded79c09f51c7429811444b6
+  metadata.gz: fa6d5fd8ad5cf3b9df7fcbc3622a6efac55fc1bc3fcc81327ea061eab9a1ae77
+  data.tar.gz: 93434d8c607adf270f4acb503cc93bed92850b0fb366fb2d4513f679f39154e3
 SHA512:
-  metadata.gz: 20fd00d62bbb2c98fcb4566fe505d67b208190c6bf7b5240520c410d11822252caad6b5574d08a7603f0c5400d75dc80d4b566c1524bd8181ae912fb5d6d3d48
-  data.tar.gz: a0d0d0ed7fbdb672bb4252558875d01638d78fb4a92c5179f661192fc4125db47800aff3c6b27b1a185f85cde38c356f096fc6ee1ee09b1c05f24c8718dd6abe
+  metadata.gz: e86cddbca8a53cf608b72abb8dbe8c1aefdee558636f21cad45b6b3111ced6159f758175e4a377c55fbe2eba0ffab729b7fe427cf84ae43e77e25818a06593d1
+  data.tar.gz: 1ad1589204db6e0fa56ca42300f68c32a796a8c181b03c2aebde4104b66568c9100c2cec032b76ade78b811106228611717f92900f96fa451721be4fafebd240

data/.github/workflows/main.yml

@@ -39,13 +39,15 @@ jobs:
       - name: Set up Dependencies
         run: bundle install --path vendor/bundle
 
-      - name: Run Tests
-        uses: paambaati/codeclimate-action@v2.3.0
+      - name: Run specs
         env:
           COVERAGE: true
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-        with:
-          coverageCommand: ./bin/rspec
+        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

data/.simplecov

@@ -1 +1,6 @@
-SimpleCov.start if ENV["COVERAGE"]
+if ENV["COVERAGE"]
+  require 'simplecov'
+  require 'codecov'
+  SimpleCov.start
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 ## [Unreleased]
 
+## [3.0.0]
+### Breaking Changes
+- Use Preloaded Consul Settings Provider by default
+### New features
+- Configurable setting providers
+- Preloaded Consul Settings Provider to prioritize performance over consistency
+- Performance tests in spec
+- Benchmarking script
+### Fixes
+- Return nil instead of empty hash when reading missing setting from file
+- Return nil instead of empty string when reading missing value from Consul
+- Add missing load method on Settings Reader to create object with narrow scope
+
+## [2.1.1]
+### Changes
+- Update Diplomat to latest version 
+
+## [2.1.0]
+### Fixes
+- Return nil for unknown keys 
+
+## [2.0.0]
+### Breaking Changes
+- Change default naming for setting files 
+
+## [1.0.0]
+### Features
+- Add support for second settings file (local settings for development) 
+
+## [0.1.4]
+### Fixes
+- Clone values before returning
+
 ## [0.1.3]
 ### Fixes
 - Add `Diplomat::PathNotFound` to the list of caught exceptions
@@ -22,7 +55,13 @@
 - Support deep settings search
 - Support nested configs
 
-[Unreleased]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.3...HEAD
+[Unreleased]: https://github.com/matic-insurance/consul_application_settings/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/matic-insurance/consul_application_settings/compare/2.0.0...3.0.0
+[2.1.1]: https://github.com/matic-insurance/consul_application_settings/compare/2.1.0...2.1.1
+[2.1.0]: https://github.com/matic-insurance/consul_application_settings/compare/2.0.0...2.1.0
+[2.0.0]: https://github.com/matic-insurance/consul_application_settings/compare/1.0.0...2.0.0
+[1.0.0]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.4...1.0.0
+[0.1.4]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.3...0.1.4
 [0.1.3]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.2...0.1.3
 [0.1.2]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.1...0.1.2
 [0.1.1]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.0...0.1.1

data/Gemfile.lock

@@ -2,29 +2,34 @@ PATH
   remote: .
   specs:
     consul_application_settings (0.0.0)
-      diplomat (~> 2.1.3)
+      diplomat (~> 2.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    codecov (0.4.3)
+      simplecov (>= 0.15, < 0.22)
     deep_merge (1.2.1)
     diff-lcs (1.3)
-    diplomat (2.1.3)
-      deep_merge (~> 1.0, >= 1.0.1)
-      faraday (~> 0.9)
+    diplomat (2.5.1)
+      deep_merge (~> 1.2)
+      faraday (>= 0.9)
     docile (1.3.1)
-    faraday (0.17.3)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
     jaro_winkler (1.5.2)
-    json (2.2.0)
+    json (2.3.1)
     multipart-post (2.1.1)
     parallel (1.16.2)
     parser (2.6.2.0)
       ast (~> 2.4.0)
     psych (3.1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -49,6 +54,7 @@ GEM
     rubocop-rspec (1.32.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
+    ruby2_keywords (0.0.4)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -61,8 +67,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  codecov (~> 0.4)
   consul_application_settings!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.66)
   rubocop-rspec (~> 1.32.0)

data/README.md

@@ -1,8 +1,7 @@
 # ConsulApplicationSettings
 
 ![Build Status](https://github.com/matic-insurance/consul_application_settings/workflows/ci/badge.svg?branch=master)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/b0eaebcf83898535ea4e/test_coverage)](https://codeclimate.com/github/matic-insurance/consul_application_settings/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/b0eaebcf83898535ea4e/maintainability)](https://codeclimate.com/github/matic-insurance/consul_application_settings/maintainability)
+[![Test Coverage](https://codecov.io/gh/matic-insurance/consul_application_settings/branch/master/graph/badge.svg?token=5E8NA8EE8L)](https://codecov.io/gh/matic-insurance/consul_application_settings)
 
 Gem that simplifies usage of Consul (via [Diplomat gem](https://github.com/WeAreFarmGeek/diplomat)) 
 to host application settings. Gem provides defaults via yaml files and other utilities 
@@ -23,7 +22,7 @@ Example use cases:
 
 Gem reads any particular setting from consul and if it is missing tries to find value in YAML defaults file
 
-**NOTE** Consul is requested every time you query the settings. Defaults YAML file loaded in memory and not changing.
+**NOTE** Consul is requested every time you query the settings. Defaults YAML file is loaded in memory and is not changing.
 
 ## Installation
 
@@ -40,13 +39,22 @@ gem 'consul_application_settings'
 At the load of application: 
 ```ruby
 ConsulApplicationSettings.configure do |config|
-  # Specify path to defaults file
-  config.defaults = Rails.root.join('config/settings.yml')
-  # Specify namespace to consul settings
-  config.namespace = 'staging/my_cool_app'
+  # Specify path to the base settings YML. Default: 'config/application_settings.yml' 
+  config.base_file_path = Rails.root.join('config/my_settings.yml')
+  # Specify path to the local settings YML, which overrides the base file. Default: 'config/application_settings.local.yml'
+  config.local_file_path = Rails.root.join('config/my_settings.local.yml')
+  # Specify whether exceprion should be thrown on Consul connection errors. Default: false
+  config.disable_consul_connection_errors = true
+  # Specify setting providers. Default: [ConsulApplicationSettings::Providers::ConsulPreloaded, ConsulApplicationSettings::Providers::LocalStorage]
+  config.settings_providers = [
+    ConsulApplicationSettings::Providers::Consul,          
+    ConsulApplicationSettings::Providers::LocalStorage          
+  ]
 end
 
 APP_SETTINGS = ConsulApplicationSettings.load
+# Specify path to settings both in YML files and Consul
+AUTH_SETTIGNS = ConsulApplicationSettings.load('authentication')
 ```
 
 **NOTE** For rails you can add this code to custom initializer `console_application_settings.rb` in `app/config/initializers`
@@ -55,7 +63,7 @@ APP_SETTINGS = ConsulApplicationSettings.load
 
 ### Settings structure
 
-Assuming your defaults file in repository `config/settings.yml` looks like:
+Assuming your defaults file in repository `config/application_settings.yml` looks like:
 ```yaml
 staging:
   my_cool_app:
@@ -98,15 +106,13 @@ 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['app_name']                           # "MyCoolApp"
 APP_SETTINGS.get(:hostname)                     # "https://mycoolapp.com"
 
 APP_SETTINGS.get('integrations/database/user')  # "app"
 APP_SETTINGS['integrations/slack/enabled']      # true
 ```
 
-**NOTE** Gem is pulling settings from consul with namespace but ignores namespace for defaults
-
 ### Nested settings
 
 Assuming some part of your code needs to work with smaller part of settings - 
@@ -114,36 +120,34 @@ gem provides interface to avoid duplicating absolute path
 
 ```ruby
 # You can load subsettings from root object
-db_settings = APP_SETTINGS.load_from('integrations/database')
-db_settings.domain                  # "194.78.92.19"
-db_settings['user']                 # "app"
-
-# You can load subsettings from subsettings
-integrations_settings = APP_SETTINGS.load_from('integrations')
-slack_settings = integrations_settings.load_from('slack')  
-slack_settings.enabled              # true
-slack_settings.get('webhook_url')   # "https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX"
+db_settings = APP_SETTINGS.load('integrations/database')
+db_settings.get(:domain)                  # "194.78.92.19"
+db_settings['user']                       # "app"
 ``` 
 
 ### Gem Configuration
 You can configure gem with block:
 ```ruby
 ConsulApplicationSettings.configure do |config|
-  config.namespace = 'staging/my_cool_app'
+  config.local_file_path = 'config/config.yml'
 end
 ```
 or one option at a time
 ```ruby
-ConsulApplicationSettings.config.namespace = 'staging/my_cool_app'
+ConsulApplicationSettings.config.local_file_path = 'config/config.yml'
 ```
 
 All Gem configurations
 
-| Configuration                    | Required | Default | Type    | Description                                                                  |
-|----------------------------------|----------|---------|---------|------------------------------------------------------------------------------|
-| defaults                         | yes      |         | String  | Path to the file with default settings                                       |
-| namespace                        | no       |         | String  | Base path to read settings from in consul and defaults                       |
-| disable_consul_connection_errors | no       | false   | Boolean | Do not raise exception when consul is not available (useful for development) |
+| Configuration                    | Required | Default | Type    | Description                                                                                                  |
+|----------------------------------|----------|-----------------------------------------|---------|------------------------------------------------------------------------------|
+| base_file_path                   | no       | 'config/application_settings.yml'       | String  | Path to the file with base settings                                          |
+| local_file_path                  | no       | 'config/application_settings.local.yml' | String  | Path to the file with local settings overriding the base settings            |
+| disable_consul_connection_errors | no       | true                                    | Boolean | Do not raise exception when consul is not available (useful for development) |
+| settings_providers               | no       | Array(Provider)                         | Array   | Specify custom setting provider lists                                        |
+
+### Performance vs Consistency
+To be defined in future iterations on Consul Providers
 
 ## Development
 

data/bin/benchmark

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'consul_application_settings'
+require 'benchmark'
+
+ITERATIONS = 1000
+
+def kill_consul
+  `pgrep consul | xargs kill`
+end
+
+def start_consul
+  spawn('consul agent -dev -node machine > /dev/null 2>&1')
+end
+
+def application_settings(providers)
+  file = 'spec/fixtures/base_application_settings.yml'
+  ConsulApplicationSettings.configure do |config|
+    config.settings_providers = providers
+  end
+  ConsulApplicationSettings.load(file)
+end
+
+def benchmark_gem
+  Benchmark.bm(20) do |x|
+    x.report('Real Time Consul') do
+      ca = application_settings([
+                                  ConsulApplicationSettings::Providers::Consul,
+                                  ConsulApplicationSettings::Providers::LocalStorage
+                                ])
+      ITERATIONS.times { ca.get('application/name') }
+    end
+
+    x.report('Preloaded Consul') do
+      ca = application_settings([
+                                  ConsulApplicationSettings::Providers::ConsulPreloaded,
+                                  ConsulApplicationSettings::Providers::LocalStorage
+                                ])
+      ITERATIONS.times { ca.get('application/name') }
+    end
+
+    x.report('File Only') do
+      ca = application_settings([
+                                  ConsulApplicationSettings::Providers::ConsulPreloaded
+                                ])
+      ITERATIONS.times { ca.get('application/name') }
+    end
+  end
+end
+
+puts '-' * 80
+puts 'Benchmark without consul agent'
+kill_consul
+benchmark_gem
+
+
+puts '-' * 80
+puts 'Benchmark with consul agent running'
+start_consul
+benchmark_gem
+
+kill_consul

data/consul_application_settings.gemspec

@@ -29,12 +29,13 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'diplomat', '~> 2.1.3'
+  spec.add_dependency 'diplomat', '~> 2.5.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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'
+  spec.add_development_dependency 'codecov', '~> 0.4'
 end

data/lib/consul_application_settings.rb

@@ -1,11 +1,13 @@
 require 'consul_application_settings/version'
+require 'consul_application_settings/providers/abstract'
+require 'consul_application_settings/providers/consul'
+require 'consul_application_settings/providers/consul_preloaded'
+require 'consul_application_settings/providers/local_storage'
 require 'consul_application_settings/configuration'
-require 'consul_application_settings/defaults'
-require 'consul_application_settings/options'
+require 'consul_application_settings/reader'
 require 'consul_application_settings/utils'
-require 'diplomat'
 
-# Main class used to configure defaults file path and load initial settings
+# The gem provides possibility to load settings from Consul and automatically fall back to data stored in file system
 module ConsulApplicationSettings
   class Error < StandardError; end
 
@@ -16,19 +18,11 @@ module ConsulApplicationSettings
 
   self.config ||= ConsulApplicationSettings::Configuration.new
 
-  class << self
-    def configure
-      yield(config)
-      self.defaults = ConsulApplicationSettings::Defaults.read(config.defaults_path)
-    end
-
-    def load_from(path)
-      settings_path = ConsulApplicationSettings::Utils.generate_path(config.namespace, path)
-      ConsulApplicationSettings::Options.new(settings_path, defaults)
-    end
+  def self.configure
+    yield(config)
+  end
 
-    def load
-      load_from('')
-    end
+  def self.load(path = '')
+    Reader.new(path, config)
   end
 end

data/lib/consul_application_settings/configuration.rb

@@ -1,14 +1,19 @@
 module ConsulApplicationSettings
   # All gem configuration settings
   class Configuration
-    # Required attributes
-    attr_accessor :defaults_path
-    # Optional attributes
-    attr_accessor :namespace
-    attr_accessor :disable_consul_connection_errors
+    DEFAULT_BASE_FILE_PATH = 'config/app_settings.yml'.freeze
+    DEFAULT_LOCAL_FILE_PATH = 'config/app_settings.local.yml'.freeze
+    DEFAULT_PROVIDERS = [
+      ConsulApplicationSettings::Providers::ConsulPreloaded,
+      ConsulApplicationSettings::Providers::LocalStorage
+    ]
+    attr_accessor :base_file_path, :local_file_path, :disable_consul_connection_errors, :settings_providers
 
     def initialize
-      self.namespace = ''
+      @base_file_path = DEFAULT_BASE_FILE_PATH
+      @local_file_path = DEFAULT_LOCAL_FILE_PATH
+      @disable_consul_connection_errors = true
+      @settings_providers = DEFAULT_PROVIDERS
     end
   end
 end

data/lib/consul_application_settings/providers/abstract.rb

@@ -0,0 +1,25 @@
+module ConsulApplicationSettings
+  module Providers
+    # Abstract class with basic functionality
+    class Abstract
+      def initialize(base_path, config)
+        @base_path, @config = base_path, config
+      end
+
+      def get(path)
+        raise NotImplementedError
+      end
+
+      protected
+
+      def absolute_key_path(path)
+        ConsulApplicationSettings::Utils.generate_path(@base_path, path)
+      end
+
+      def get_value_from_hash(path, data)
+        parts = ConsulApplicationSettings::Utils.decompose_path(path)
+        data.dig(*parts).clone
+      end
+    end
+  end
+end

data/lib/consul_application_settings/providers/consul.rb

@@ -0,0 +1,24 @@
+require 'diplomat'
+
+module ConsulApplicationSettings
+  module Providers
+    # Provides access to settings stored in Consul
+    class Consul < Abstract
+      def get(path)
+        full_path = absolute_key_path(path)
+        value = get_from_consul(full_path)
+        ConsulApplicationSettings::Utils.cast_consul_value(value)
+      end
+
+      private
+
+      def get_from_consul(path)
+        Diplomat::Kv.get(path, {})
+      rescue Diplomat::KeyNotFound
+        return nil
+      rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
+        raise e unless @config.disable_consul_connection_errors
+      end
+    end
+  end
+end

data/lib/consul_application_settings/providers/consul_preloaded.rb

@@ -0,0 +1,26 @@
+module ConsulApplicationSettings
+  module Providers
+    # Provides access to settings stored in Consul. Loads them once
+    class ConsulPreloaded < Abstract
+      def initialize(base_path, config)
+        super
+        @data = get_all_from_consul
+      end
+
+      def get(path)
+        value = get_value_from_hash(absolute_key_path(path), @data)
+        ConsulApplicationSettings::Utils.cast_consul_value(value)
+      end
+
+      protected
+
+      def get_all_from_consul
+        Diplomat::Kv.get_all(@base_path, { convert_to_hash: true })
+      rescue Diplomat::KeyNotFound
+        {}
+      rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
+        raise e unless @config.disable_consul_connection_errors
+      end
+    end
+  end
+end

data/lib/consul_application_settings/providers/local_storage.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module ConsulApplicationSettings
+  module Providers
+    # Provides access to settings stored in file system with support of base and local files
+    class LocalStorage < Abstract
+      def initialize(base_path, config)
+        super
+        @data = load
+      end
+
+      def get(path)
+        get_value_from_hash(absolute_key_path(path), @data)
+      end
+
+      private
+
+      def load
+        base_yml = read_yml(base_file_path)
+        local_yml = read_yml(local_file_path)
+        DeepMerge.deep_merge!(local_yml, base_yml, preserve_unmergeables: false, overwrite_arrays: true,
+                              merge_nil_values: true)
+      end
+
+      def base_file_path
+        @config.base_file_path
+      end
+
+      def local_file_path
+        @config.local_file_path
+      end
+
+      def read_yml(path)
+        return {} unless File.exist?(path)
+
+        YAML.safe_load(IO.read(path))
+      rescue Psych::SyntaxError, Errno::ENOENT => e
+        raise ConsulApplicationSettings::Error, "Cannot read settings file at #{path}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/consul_application_settings/reader.rb

@@ -0,0 +1,25 @@
+module ConsulApplicationSettings
+  # Provides access to settings stored in Consul or in file system
+  class Reader
+    def initialize(base_path, config)
+      @base_path = base_path
+      @config = config
+      @providers = config.settings_providers.map { |provider| provider.new(base_path, config) }
+    end
+
+    def get(path)
+      @providers.each do |provider|
+        value = provider.get(path)
+        return value unless value.nil?
+      end
+      nil
+    end
+
+    alias [] get
+
+    def load(sub_path)
+      new_path = ConsulApplicationSettings::Utils.generate_path(@base_path, sub_path)
+      self.class.new(new_path, @config)
+    end
+  end
+end

data/lib/consul_application_settings/utils.rb

@@ -6,6 +6,7 @@ module ConsulApplicationSettings
 
     class << self
       def cast_consul_value(value)
+        return nil if value.nil?
         return false if value == 'false'
         return true if value == 'true'
 

data/lib/consul_application_settings/version.rb

@@ -1,3 +1,3 @@
 module ConsulApplicationSettings
-  VERSION = '0.1.4'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul_application_settings
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Volodymyr Mykhailyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !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'
 description: |-
   Gem that simplifies usage of Consul (via Diplomat gem) to host application settings.
                         Gem provides defaults and utilities
@@ -117,7 +131,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -130,14 +143,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/benchmark
 - bin/console
 - bin/rspec
 - bin/setup
 - consul_application_settings.gemspec
 - lib/consul_application_settings.rb
 - lib/consul_application_settings/configuration.rb
-- lib/consul_application_settings/defaults.rb
-- lib/consul_application_settings/options.rb
+- lib/consul_application_settings/providers/abstract.rb
+- lib/consul_application_settings/providers/consul.rb
+- lib/consul_application_settings/providers/consul_preloaded.rb
+- lib/consul_application_settings/providers/local_storage.rb
+- lib/consul_application_settings/reader.rb
 - lib/consul_application_settings/utils.rb
 - lib/consul_application_settings/version.rb
 homepage: https://github.com/matic-insurance/consul_application_settings
@@ -162,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Application settings via Consul with yaml defaults

data/.codeclimate.yml

@@ -1,15 +0,0 @@
-version: 2
-plugins:
-#  disabled before git-legal supports bundler 2 https://github.com/kmewhort/git.legal-codeclimate/issues/6
-#  git-legal:
-#    enabled: true
-  rubocop:
-    enabled: true
-    channel: rubocop-0-73
-    config:
-      file: ".rubocop.yml"
-  bundler-audit:
-    enabled: true
-exclude_patterns:
-  - "spec/"
-  - "*.gemspec"

data/lib/consul_application_settings/defaults.rb

@@ -1,43 +0,0 @@
-require 'yaml'
-
-module ConsulApplicationSettings
-  # Reading default file from YAML file and providing interface to query them
-  class Defaults
-    attr_reader :contents
-
-    def initialize(hash)
-      @contents = hash
-    end
-
-    def get(name)
-      read_path(name, contents).clone
-    end
-
-    def load_from(path)
-      keys = ConsulApplicationSettings::Utils.decompose_path(path)
-      new_defaults = keys.reduce(contents) { |hash, key| read_path(key, hash, {}) }
-      self.class.new(new_defaults)
-    end
-
-    def self.read(path)
-      new YAML.safe_load(IO.read(path))
-    rescue Psych::SyntaxError, Errno::ENOENT => e
-      raise ConsulApplicationSettings::Error, "Cannot read defaults file at #{path}: #{e.message}"
-    end
-
-    private
-
-    def read_path(path, hash, default = nil)
-      parts = ConsulApplicationSettings::Utils.decompose_path(path)
-      result = parts.reduce(hash, &method(:read_value))
-      result || default
-    end
-
-    def read_value(hash, key)
-      raise ConsulApplicationSettings::Error, 'reading arrays not implemented' if hash.is_a? Array
-      return {} if hash.nil?
-
-      hash.fetch(key.to_s)
-    end
-  end
-end

data/lib/consul_application_settings/options.rb

@@ -1,53 +0,0 @@
-require 'json'
-
-module ConsulApplicationSettings
-  # Reads settings from consul or ask defaults for value
-  class Options
-    attr_reader :path, :defaults
-
-    def initialize(path, defaults)
-      @path = path
-      @defaults = defaults.load_from(path)
-    end
-
-    def load_from(new_path)
-      full_path = ConsulApplicationSettings::Utils.generate_path(path, new_path)
-      self.class.new(full_path, defaults)
-    end
-
-    def get(name)
-      consul_value = key_value(name)
-      if consul_value.nil? || consul_value.empty?
-        defaults.get(name)
-      else
-        ConsulApplicationSettings::Utils.cast_consul_value(consul_value)
-      end
-    end
-
-    def [](name)
-      get(name)
-    end
-
-    # rubocop:disable Style/MethodMissingSuper
-    def method_missing(name, *_args)
-      get(name)
-    end
-    # rubocop:enable Style/MethodMissingSuper
-
-    def respond_to_missing?(_name)
-      true
-    end
-
-    private
-
-    def key_value(name)
-      Diplomat::Kv.get(key_path(name), {}, :return)
-    rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
-      raise e unless ConsulApplicationSettings.config.disable_consul_connection_errors
-    end
-
-    def key_path(name)
-      ConsulApplicationSettings::Utils.generate_path(path, name)
-    end
-  end
-end