prius 2.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9fe10998b7a59082959f1d7d29c0d5b3058f680
-  data.tar.gz: 6810a7c774f84fbeef42667f7fd1f1d52958c0fe
+SHA256:
+  metadata.gz: a4ec85e28d88e7ac3605c1f22d6a71c9d14ec4e25c67cce15fb0655b9e878ea0
+  data.tar.gz: 81451517255e0cb04890cc93a1f39c4848e726019030cc45ccb11f07b7d934e0
 SHA512:
-  metadata.gz: 339dc76f9c99d86b2a5bb0e22c63ae610a418aaf6f103e34720b7cbc85ca83ebd214aa85ea325541c5fb250b42098b25949d3ce277365419c7b39001b5383727
-  data.tar.gz: 274354c57c75bd92ee1d84206f1fcbd0f124dbbf22e964ee2488cac9750fb4b20cedc0afd154aff3a3a95c3021cd59af43575ef7dabea35b45548ff4c49a8381
+  metadata.gz: 417aa19312808fac0140c6e052695268ea7291ea2dcec5aae6af3f5ee300e8cfdeb325380380a7b71ebec28b06b9ff127802f310d5e6b680287aaf83b0d49a43
+  data.tar.gz: fdd5adfc03b58811922487ca08e94add9ee99abf19e0840775f58cb1ee93e315787723ce29cd38b99af49904eed2b96aa6cc388fcd6256b33872bbbff17ad9e0

data/.circleci/config.yml

@@ -0,0 +1,60 @@
+version: 2
+
+references:
+  steps: &steps
+    - checkout
+
+    # CircleCI's Ruby images have Git installed, but the JRuby images lack it, so let's
+    # make sure it's installed
+    - run: apt-get update && apt-get install -y git
+
+    - type: cache-restore
+      key: prius-bundler-{{ checksum "prius.gemspec" }}
+
+    - run: gem install bundler -v 2.0.1
+
+    - run: bundle install --path vendor/bundle
+
+    - type: cache-save
+      key: prius-bundler-{{ checksum "prius.gemspec" }}
+      paths:
+        - vendor/bundle
+
+    - type: shell
+      command: |
+        bundle exec rspec --profile 10 \
+                          --format RspecJunitFormatter \
+                          --out /tmp/test-results/rspec.xml \
+                          --format progress \
+                          spec
+
+    - type: store_test_results
+      path: /tmp/test-results
+
+    - run: bundle exec rubocop
+jobs:
+  build-ruby26:
+    docker:
+      - image: ruby:2.6
+    steps: *steps
+  build-ruby27:
+    docker:
+      - image: ruby:2.7
+    steps: *steps
+  build-ruby3:
+    docker:
+      - image: ruby:3
+    steps: *steps
+  build-jruby93:
+    docker:
+      - image: jruby:9.3
+    steps: *steps
+
+workflows:
+  version: 2
+  tests:
+    jobs:
+      - build-ruby26
+      - build-ruby27
+      - build-ruby3
+      - build-jruby93

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   Exclude:
     - prius.gemspec
+    - vendor/**/*
+  TargetRubyVersion: 2.6
 
 # Limit lines to 80 characters.
 LineLength:

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 4.1.0
+
+* Add support for coercing to a date.
+
+# 4.0.0
+
+* Add support for Ruby 3.0
+* Enforce Ruby 2.6 as minimum required version
+* Drop support for Ruby 2.2, 2.3, 2.4, 2.5
+* Drop support for JRuby versions < 9.3.x (implicity enforced by C Ruby version 2.6 as minimum)
+
+# 3.0.0
+
+* Enforce Ruby 2.2 as minimum required version
+* Use CircleCI instead of Travis for CI builds
+* Add Dependabot support
+* Some development dependency updates
+
 # 2.0.0
 
 * Drop support for Ruby versions 1.9, 2.0, 2.1, and add support for 2.3 and 2.4

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -2,14 +2,14 @@
 Environmentally-friendly application config for Ruby.
 
 [![Gem Version](https://badge.fury.io/rb/prius.svg)](http://badge.fury.io/rb/prius)
-[![Build Status](https://travis-ci.org/gocardless/prius.svg?branch=master)](https://travis-ci.org/gocardless/prius)
+[![Build Status](https://circleci.com/gh/gocardless/prius.svg?style=svg)](https://app.circleci.com/pipelines/github/gocardless/prius)
 
 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
@@ -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/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prius
   class MissingValueError < StandardError; end
   class TypeMismatchError < StandardError; end

data/lib/prius/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prius
   class Railtie < Rails::Railtie
     config.before_configuration do

data/lib/prius/registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "prius/errors"
 
 module Prius
@@ -20,6 +22,7 @@ module Prius
                         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
@@ -37,6 +40,7 @@ module Prius
       @env.fetch(name)
     rescue KeyError
       return nil unless required
+
       raise MissingValueError, "config value '#{name}' not present"
     end
 
@@ -47,6 +51,7 @@ module Prius
       unless value =~ /\A[0-9]+\z/
         raise TypeMismatchError, "'#{name}' value '#{value}' is not an integer"
       end
+
       value.to_i
     end
 
@@ -55,7 +60,17 @@ module Prius
       return nil if value.nil?
       return true if %w[yes y true t 1].include?(value)
       return false if %w[no n false f 0].include?(value)
+
       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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prius
-  VERSION = "2.0.0".freeze
+  VERSION = "4.1.0"
 end

data/lib/prius.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "prius/registry"
 require "prius/railtie" if defined?(Rails)
 
@@ -12,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

data/prius.gemspec

@@ -6,7 +6,7 @@ require 'prius/version'
 Gem::Specification.new do |spec|
   spec.name          = "prius"
   spec.version       = Prius::VERSION
-  spec.authors       = ["Harry Marr"]
+  spec.authors       = ["GoCardless Engineering"]
   spec.email         = ["engineering@gocardless.com"]
   spec.description   = %q{Environmentally-friendly config}
   spec.summary       = spec.description
@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rubocop", "~> 0.49.1"
+  spec.add_development_dependency "rubocop", "~> 1.24"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.5.1"
+  spec.add_development_dependency "rubocop-performance", "~> 1.13"
 end

data/spec/prius/registry_spec.rb

@@ -1,7 +1,17 @@
+# frozen_string_literal: true
+
 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
@@ -70,6 +80,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: 2.0.0
+  version: 4.1.0
 platform: ruby
 authors:
-- Harry Marr
+- GoCardless Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '1.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 description: Environmentally-friendly config
 email:
 - engineering@gocardless.com
@@ -45,9 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -71,15 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Environmentally-friendly config

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-
-matrix:
-  allow_failures:
-    - rvm: jruby
-    - rvm: rbx-2
-
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - jruby
-  - rbx-2
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec spec