blinkist-config 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ea30ece0d13a1b1603254be36125c28709c77d2
-  data.tar.gz: 9c9bb44d87a2310bfceb28e2e21c1d2eb387e58f
+  metadata.gz: f124d3763ba77723dd15b742f34059417f04e669
+  data.tar.gz: 9d83b0e2e91c7f4f8dee43f31d678e8ad29b7ae9
 SHA512:
-  metadata.gz: 660c83fc9d879674dd268b90f63bf5398d6b0a470ecbf049844ce29c86d0bdc4b766d77c3e63728a3480025622f585a162d9984259e2f51b074ac70e2576b1a8
-  data.tar.gz: e5d1b4cd3db5f6522a622dfabbcd8d02ad5a15a69668579e33ab97de07db93e87c2fde7ce83880e5b673afa50cfc5029b493aeea13e364721cdbeebeb1352fc8
+  metadata.gz: 357f0e51ee0a058243a548e0f2a5a150554b3d3d022146d96c4850e280f6065279b305f918263b9f7d04e5906dadc301956db83a798e623c4dac525ca6436aae
+  data.tar.gz: 8c3352a6add14f838b3a10da3bacdf08304775e25a79304a1dbb1154e8de8b1703e2f457cc8d18cdc5cc9b9b1d22e864c18f71de8b48838d42ab5f44804d40bf

data/README.md

@@ -13,16 +13,33 @@ This GEM allows you to access configuration stores with different adapters. Here
 Blinkist::Config.env = ENV["RAILS_ENV"]
 Blinkist::Config.app_name = "my_nice_app"
 Blinkist::Config.adapter_type = :env
+Blinkist::Config.error_handler = :strict
 
-my_config_value = Blinkist::Config.get "some/folder/config"
+my_config_value = Blinkist::Config.get! "some/folder/config"
 
 # This is being translated to ENV["SOME_FOLDER_CONFIG"]
 ```
 
+### Error handling
+
+When configured with `Blinkist::Config.error_handler = :strict` (as recommended)
+reading a configuration entry for which the value is missing 
+(for example missing enviroment variables) will cause
+`Blinkist::Config::ValueMissingError` to be raised.
+
+There is also an alternative mode `Blinkist::Config.error_handler = :heuristic` which
+will raise exceptions only when `Blinkist::Config.env == "production"`.
+
+This alternative mode is also the default for compatibility.
+
 ### Having a default value
 
+If you don't want `Blinkist::Config.get!` to scream at you for missing
+configuration entries then you canprovide a default value as a second
+paramter to `get!`:
+
 ```ruby
-my_config_value = Blinkist::Config.get "some/folder/config", "default value"
+my_config_value = Blinkist::Config.get! "some/folder/config", "default value"
 
 # If ENV["SOME_FOLDER_CONFIG"] is nil, "default value" will be returned
 ```
@@ -42,7 +59,7 @@ Blinkist::Config.env = ENV["RAILS_ENV"]
 Blinkist::Config.app_name = "my_nice_app"
 Blinkist::Config.adapter_type = ENV["CONSUL_AVAILABLE"] == "true" ? :diplomat : :env
 
-my_config_value = Blinkist::Config.get "some/folder/config"
+my_config_value = Blinkist::Config.get! "some/folder/config"
 
 # This is will try to get a value from Consul's KV store at "my_nice_app/some/folder/config"
 ```
@@ -51,7 +68,7 @@ my_config_value = Blinkist::Config.get "some/folder/config"
 ```ruby
 # Here we setting a scope outside of the app
 
-my_config_value = Blinkist::Config.get "another/config", scope: "global"
+my_config_value = Blinkist::Config.get! "another/config", scope: "global"
 
 # This will replace `my_nice_app` with `global` and try to resolve "global/another/config"
 # With :env the scope will simply be ignored

data/Rakefile

@@ -3,10 +3,10 @@ require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new do |task|
-  task.options = %w(-a)
+  task.options = %w[-a]
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
 task(:default).clear
-task default: %i(rubocop spec)
+task default: %i[rubocop spec]

data/blinkist-config.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require_relative "lib/blinkist/config/version"
@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["sj@blinkist.com"]
 
   spec.summary       = "Simple adapter based configuration handler (supports ENV and Consul/Diplomat)."
-  spec.description   = "This GEM allows you to keep your configuration class-based by calling Blinkist::Config.get(...) instead of accessing the ENV directly. You can set up different types of adapters to connect to various configuration systems like your ENV or Consul's key-value-store."
+  spec.description   = "This GEM allows you to keep your configuration class-based by calling Blinkist::Config.get!(...) instead of accessing the ENV directly. You can set up different types of adapters to connect to various configuration systems like your ENV or Consul's key-value-store."
   spec.homepage      = "https://github.com/blinkist/blinkist-config"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 12.0"

data/lib/blinkist/config/adapters/adapter.rb

@@ -12,15 +12,11 @@ module Blinkist
 
       class << self
         def instance_for(type, env, app_name)
-          case type
-          when :env
-            EnvAdapter.new env, app_name
-          when :diplomat
-            DiplomatAdapter.new env, app_name
-          else
-            raise NotImplementedError
-          end
+          Factory.new("Blinkist::Adapter.for", Adapters::BUILT_IN, env, app_name).call(type)
         end
+
+        extend Gem::Deprecate
+        deprecate :instance_for, :none, 2017, 12
       end
     end
   end

data/lib/blinkist/config/adapters.rb

@@ -0,0 +1,10 @@
+module Blinkist
+  class Config
+    module Adapters
+      BUILT_IN = {
+        env: EnvAdapter,
+        diplomat: DiplomatAdapter
+      }.freeze
+    end
+  end
+end

data/lib/blinkist/config/error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class Error < ::StandardError
+    end
+  end
+end

data/lib/blinkist/config/error_handlers/error_handler.rb

@@ -0,0 +1,14 @@
+module Blinkist
+  class Config
+    class ErrorHandler
+      def initialize(env, app_name)
+        @env = env
+        @app_name = app_name
+      end
+
+      def call(key, scope)
+        raise ValueMissingError, "Missing value for #{key} in the scope: #{scope || '<default>'} (Please check the configuration for missing keys)"
+      end
+    end
+  end
+end

data/lib/blinkist/config/error_handlers/production_only_error_handler.rb

@@ -0,0 +1,9 @@
+module Blinkist
+  class Config
+    class ProductionOnlyErrorHandler < ErrorHandler
+      def call(key, scope)
+        super(key, scope) if @env.to_s == "production"
+      end
+    end
+  end
+end

data/lib/blinkist/config/error_handlers.rb

@@ -0,0 +1,11 @@
+
+module Blinkist
+  class Config
+    module ErrorHandlers
+      BUILT_IN = {
+        strict: ErrorHandler,
+        heuristic: ProductionOnlyErrorHandler
+      }.freeze
+    end
+  end
+end

data/lib/blinkist/config/factory.rb

@@ -0,0 +1,30 @@
+module Blinkist
+  class Config
+    class Factory
+      def initialize(aspect, implementations, env=Blinkist::Config.env, app_name=Blinkist::Config.app_name)
+        @aspect = aspect
+        @implementations = implementations
+        @env = env
+        @app_name = app_name
+      end
+
+      def call(strategy)
+        case strategy
+        when Symbol
+          klass = @implementations[strategy] ||
+                  raise(NotImplementedError, "Unknown strategy #{strategy} for #{@aspect}")
+        when Class
+          klass = strategy
+        else
+          if strategy.respond_to?(:call)
+            return strategy
+          else
+            raise InvalidStrategyError
+          end
+        end
+
+        klass.new(@env, @app_name)
+      end
+    end
+  end
+end

data/lib/blinkist/config/invalid_strategy_error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class InvalidStrategyError < Error
+    end
+  end
+end

data/lib/blinkist/config/not_implemented_error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class NotImplementedError < Error
+    end
+  end
+end

data/lib/blinkist/config/value_missing_error.rb

@@ -0,0 +1,6 @@
+module Blinkist
+  class Config
+    class ValueMissingError < Error
+    end
+  end
+end

data/lib/blinkist/config/version.rb

@@ -1,5 +1,5 @@
 module Blinkist
   class Config
-    VERSION = "1.0.2".freeze
+    VERSION = "1.1.0".freeze
   end
 end

data/lib/blinkist/config.rb

@@ -1,19 +1,63 @@
 require_relative "config/version"
+require_relative "config/error"
+require_relative "config/factory"
+require_relative "config/not_implemented_error"
+require_relative "config/invalid_strategy_error"
+require_relative "config/value_missing_error"
+require_relative "config/error_handlers/error_handler"
+require_relative "config/error_handlers/production_only_error_handler"
+require_relative "config/error_handlers"
 require_relative "config/adapters/env_adapter"
 require_relative "config/adapters/diplomat_adapter"
+require_relative "config/adapters"
 
 module Blinkist
   class Config
     class << self
-      attr_accessor :adapter_type, :logger, :env, :app_name
+      attr_accessor :adapter_type, :logger, :env, :app_name, :error_handler
 
       def get(key, default = nil, scope: nil)
-        adapter.get(key, scope: scope) || default
+        get!(key, default, scope: scope)
+      end
+
+      extend Gem::Deprecate
+      deprecate :get, "get!", 2017, 12
+
+      def get!(key, *args, scope: nil)
+        # NOTE: we need to do this this way
+        # to handle 'nil' default correctly
+        case args.length
+        when 0
+          default = nil
+          bang    = true
+        when 1
+          default = args.first
+          bang    = false
+        else
+          raise ArgumentError, "wrong number of arguments (given #{args.length + 1}, expected 1..2)"
+        end
+
+        from_adapter = adapter.get(key, scope: scope)
+
+        if from_adapter.nil? && bang
+          handle_error(key, scope)
+        else
+          return from_adapter || default
+        end
       end
 
       def adapter
-        @adapter ||= Adapter.instance_for adapter_type, env, app_name
+        @adapter ||= Factory.new("Blinkist::Config.adapter_type", Adapters::BUILT_IN).call(adapter_type)
       end
+
+      def handle_error(key, scope)
+        handler = Factory.new("Blinkist::Config.error_handler", ErrorHandlers::BUILT_IN).call(error_handler)
+        handler.call(key, scope)
+      end
+
     end
+
+    # NOTE: default configuration goes here
+    self.error_handler = :heuristic
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blinkist-config
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Sebastian Schleicher, Blinks Labs GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 description: This GEM allows you to keep your configuration class-based by calling
-  Blinkist::Config.get(...) instead of accessing the ENV directly. You can set up
+  Blinkist::Config.get!(...) instead of accessing the ENV directly. You can set up
   different types of adapters to connect to various configuration systems like your
   ENV or Consul's key-value-store.
 email:
@@ -89,9 +89,18 @@ files:
 - blinkist-config.gemspec
 - docker-compose.yml
 - lib/blinkist/config.rb
+- lib/blinkist/config/adapters.rb
 - lib/blinkist/config/adapters/adapter.rb
 - lib/blinkist/config/adapters/diplomat_adapter.rb
 - lib/blinkist/config/adapters/env_adapter.rb
+- lib/blinkist/config/error.rb
+- lib/blinkist/config/error_handlers.rb
+- lib/blinkist/config/error_handlers/error_handler.rb
+- lib/blinkist/config/error_handlers/production_only_error_handler.rb
+- lib/blinkist/config/factory.rb
+- lib/blinkist/config/invalid_strategy_error.rb
+- lib/blinkist/config/not_implemented_error.rb
+- lib/blinkist/config/value_missing_error.rb
 - lib/blinkist/config/version.rb
 homepage: https://github.com/blinkist/blinkist-config
 licenses:
@@ -113,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Simple adapter based configuration handler (supports ENV and Consul/Diplomat).