Merge pull request #48 from gocardless/require-load-args

Ensure `Prius#load` raises an error when unexpected options are passed

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 5.0.0
+
+* Ensure Prius#load raises an error when unexpected options are passed
+
 # 4.1.0
 
 * Add support for coercing to a date.

README.md

@@ -48,7 +48,7 @@ Environment variables need to be loaded into the Prius registry before being
 used. Typically this is done in an initialiser.
 
 ```ruby
-Prius.load(name, options = {})
+Prius.load(name, **options)
 ```
 
 If an environment variable can't be loaded, Prius will raise one of:

lib/prius.rb

@@ -25,8 +25,8 @@ module Prius
   # Raises a MissingValueError for required values that are missing.
   # Raises a TypeMismatchError if a value can't be coerced to the given `type`.
   # Raises an ArgumentError if an invalid `type` is provided.
-  def self.load(name, options = {})
-    registry.load(name, options)
+  def self.load(name, **options)
+    registry.load(name, **options)
   end
 
   # Fetch a value from the registry.

lib/prius/registry.rb

@@ -14,10 +14,8 @@ def initialize(env)
     end
 
     # See Prius.load for documentation.
-    def load(name, options = {})
-      env_var = options.fetch(:env_var, name.to_s.upcase)
-      type = options.fetch(:type, :string)
-      required = options.fetch(:required, true)
+    def load(name, env_var: nil, type: :string, required: true)
+      env_var = env_var.nil? ? name.to_s.upcase : env_var
       @registry[name] = case type
                         when :string then load_string(env_var, required)
                         when :int    then load_int(env_var, required)

lib/prius/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prius
-  VERSION = "4.1.0"
+  VERSION = "5.0.0"
 end

spec/prius/registry_spec.rb

@@ -15,6 +15,13 @@
   let(:registry) { Prius::Registry.new(env) }
 
   describe "#load" do
+    context "given an invalid option" do
+      it "raises an error" do
+        expect { registry.load(:age, unsupported_option: :foo) }.
+          to raise_error(ArgumentError)
+      end
+    end
+
     context "given a name that's present in the environment" do
       it "doesn't blow up" do
         expect { registry.load(:name) }.to_not raise_error