prius 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2e2b95c7456b01442cf90ba9ad16d4a4ca872bbcf765f15aefeb0b5ff132003
-  data.tar.gz: 1f3cf76e9746fc2433d297e0090a1f4ab166ceda25de176ccee0826e02b99c50
+  metadata.gz: f3a8c8693c57b1528dc91a93f3cc4343315db4beb5e5f4eeea6d11be4bbb6fa8
+  data.tar.gz: 3784c94e35340ef5dcab6d6ca380204f7d5beac63937b4df3baa4e9352da995b
 SHA512:
-  metadata.gz: cb70cd3bc19f29b24ed2a980d713a45476a8ff1006f853b6dbc8ab2091f743208d819eaffdf098234114c847420729bf7c7d119c8726f8ca8a02fabc0c95c68f
-  data.tar.gz: 53df6a3b348e74b69c193a36ad56b3d5e4c5dc0360347eadd7f570a06b820ebdef8344d921467d7cd6e5221f61499d8890fa7bea5264e1b563a6d760397210f4
+  metadata.gz: 1f06a5b14da5781a04009b414943f0485b5f7729c87ca2585756d65d94fbea599c56c07aef4278fc28873752652591cf346fa2ffd678aed155d6570ce3ed5e68
+  data.tar.gz: 48211d8f7ae7c20e59d411f08ba8b82cb366242510c4dabe2dbea94d8b3eb010a88d5f885dc0fd2f5e8b21c5199932eee43a9ebc59dc05fb8c0a5d1c7191f10c

data/CHANGELOG.md

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

data/README.md

@@ -9,7 +9,7 @@ Prius helps you guarantee that your environment variables are:
 - **Present** - an exception is raised if an environment variable is missing,
   so you can hear about it as soon as your app boots.
 - **Valid** - an environment variable can be coerced to a desired type
-  (integer, boolean or string), and an exception will be raised if the value
+  (integer, boolean, string, or date), and an exception will be raised if the value
   doesn't match the type.
 
 ## Usage
@@ -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:
@@ -60,7 +60,7 @@ If an environment variable can't be loaded, Prius will raise one of:
 | Param             | Default       | Description                                                                               |
 |-------------------|---------------|-------------------------------------------------------------------------------------------|
 | `required`        | `true`        | Flag to require the environment variable to have been set.                                |
-| `type`            | `:string`     | Type to coerce the environment variable to. Allowed values are `:string`, `:int` and `:bool`. |
+| `type`            | `:string`     | Type to coerce the environment variable to. Allowed values are `:string`, `:int`, `:bool`, and `:date`. |
 | `env_var`         | `name.upcase` | Name of the environment variable name (if different from the upcased `name`).             |
 
 #### Reading Environment Variables

data/lib/prius/registry.rb

@@ -14,14 +14,13 @@ module Prius
     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)
                         when :bool   then load_bool(env_var, required)
+                        when :date   then load_date(env_var, required)
                         else raise ArgumentError, "Invalid type #{type}"
                         end
     end
@@ -62,5 +61,14 @@ module Prius
 
       raise TypeMismatchError, "'#{name}' value '#{value}' is not a boolean"
     end
+
+    def load_date(name, required)
+      value = load_string(name, required)
+      return nil if value.nil?
+
+      Date.parse(value)
+    rescue ArgumentError
+      raise TypeMismatchError, "'#{name}' value '#{value}' is not a date"
+    end
   end
 end

data/lib/prius/version.rb

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

data/lib/prius.rb

@@ -14,7 +14,7 @@ module Prius
   #                       omitted the uppercased form of `name` will be used.
   #           :type     - The Symbol type of the environment variable's value.
   #                       The value will be coerced to this type. Must be one
-  #                       of :string, :int, or :bool (default :string).
+  #                       of :string, :int, :bool, or :date (default :string).
   #           :required - A Boolean indicating whether the value must be
   #                       present in the environment. If true, a
   #                       MissingValueError exception will be raised if the
@@ -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.

data/spec/prius/registry_spec.rb

@@ -3,10 +3,25 @@
 require "prius/registry"
 
 describe Prius::Registry do
-  let(:env) { { "NAME" => "Harry", "AGE" => "25", "ALIVE" => "yes" } }
+  let(:env) do
+    {
+      "NAME" => "Harry",
+      "AGE" => "25",
+      "ALIVE" => "yes",
+      "BORN" => "2022-09-02",
+      "INVALID_DATE" => "2022-02-99"
+    }
+  end
   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
@@ -72,6 +87,34 @@ describe Prius::Registry do
         end
       end
     end
+
+    context "when specifying :date as the type" do
+      context "given a date value" do
+        it "doesn't blow up" do
+          expect { registry.load(:born, type: :date) }.to_not raise_error
+        end
+
+        it "stores a date" do
+          registry.load(:born, type: :date)
+          expect(registry.get(:born)).to be_a(Date)
+          expect(registry.get(:born)).to eq(Date.parse(env["BORN"]))
+        end
+      end
+
+      context "given an invalid date value" do
+        it "blows up" do
+          expect { registry.load(:invalid_date, type: :date) }.
+            to raise_error(Prius::TypeMismatchError)
+        end
+      end
+
+      context "given a non-date value" do
+        it "blows up" do
+          expect { registry.load(:name, type: :date) }.
+            to raise_error(Prius::TypeMismatchError)
+        end
+      end
+    end
   end
 
   describe "#get" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prius
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -92,7 +92,7 @@ homepage: https://github.com/gocardless/prius
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Environmentally-friendly config
 test_files: