prius 4.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ec85e28d88e7ac3605c1f22d6a71c9d14ec4e25c67cce15fb0655b9e878ea0
-  data.tar.gz: 81451517255e0cb04890cc93a1f39c4848e726019030cc45ccb11f07b7d934e0
+  metadata.gz: 8892ebc746ab5baf0ea2fee00e8bd3f7fc8f52494d8d2e9aec1e9d178e358333
+  data.tar.gz: d5443265d28678cb4f96fc5ec2fe3cea7afa3c3c7bb7a85f8d3155c1e61128a9
 SHA512:
-  metadata.gz: 417aa19312808fac0140c6e052695268ea7291ea2dcec5aae6af3f5ee300e8cfdeb325380380a7b71ebec28b06b9ff127802f310d5e6b680287aaf83b0d49a43
-  data.tar.gz: fdd5adfc03b58811922487ca08e94add9ee99abf19e0840775f58cb1ee93e315787723ce29cd38b99af49904eed2b96aa6cc388fcd6256b33872bbbff17ad9e0
+  metadata.gz: de66a2ae735c7cc8632085b01a47ddf3970cd68c928e60d82556305014770d3afc38e394beb72d0bb11d632ea270df97d7e259eb030a0a9eaf0c37c8c61e467d
+  data.tar.gz: 490b1e5e00a419cc500cd640fcc81af32d5b446f14a93f1cecbae0c33d3774d740a81068c1b622f50d92e1f2ec156090a0745f7430d9bbcfbc98db60aa1fa043

data/.rubocop.yml

@@ -1,28 +1,33 @@
+inherit_gem:
+  gc_ruboconfig: rubocop.yml
+
+require:
+  - rubocop-rspec
+
 AllCops:
+  NewCops: enable
   Exclude:
-    - prius.gemspec
     - vendor/**/*
-  TargetRubyVersion: 2.6
-
-# Limit lines to 80 characters.
-LineLength:
-  Max: 80
-
-ClassLength:
-  Max: 300
-
-StringLiterals:
-  Enabled: false
+  TargetRubyVersion: 3.1
 
 Style/Documentation:
   Enabled: false
 
 Style/SignalException:
-  EnforcedStyle: 'only_raise'
+  EnforcedStyle: "only_raise"
 
 Layout/DotPosition:
-  EnforcedStyle: 'trailing'
+  EnforcedStyle: "trailing"
 
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*_spec.rb"
+
+RSpec/NestedGroups:
+  Max: 5
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -1,24 +1,34 @@
+# 6.0.0 - 2024-01-09
+
+- Drop support for Ruby 2.6 and 2.7.
+- Add support for Ruby 3.2 and 3.3.
+- Downcase boolean values when checking for truthiness.
+
+# 5.0.0
+
+- Ensure Prius#load raises an error when unexpected options are passed
+
 # 4.1.0
 
-* Add support for coercing to a date.
+- 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)
+- 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
+- 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
+- Drop support for Ruby versions 1.9, 2.0, 2.1, and add support for 2.3 and 2.4
 
 # 1.0.0
 

data/Gemfile

@@ -3,3 +3,10 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "gc_ruboconfig", "~> 4.4"
+  gem 'pry'
+  gem "rspec", "~> 3.12"
+  gem "rspec-github", "~> 2.4.0"
+end

data/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:

data/lib/prius/registry.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "date"
 require "prius/errors"
 
 module Prius
@@ -14,10 +15,8 @@ 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 = name.to_s.upcase if env_var.nil?
       @registry[name] = case type
                         when :string then load_string(env_var, required)
                         when :int    then load_int(env_var, required)
@@ -48,7 +47,7 @@ module Prius
       value = load_string(name, required)
       return value if value.nil?
 
-      unless value =~ /\A[0-9]+\z/
+      unless /\A[0-9]+\z/.match?(value)
         raise TypeMismatchError, "'#{name}' value '#{value}' is not an integer"
       end
 
@@ -58,6 +57,8 @@ module Prius
     def load_bool(name, required)
       value = load_string(name, required)
       return nil if value.nil?
+
+      value = value.downcase
       return true if %w[yes y true t 1].include?(value)
       return false if %w[no n false f 0].include?(value)
 

data/lib/prius/version.rb

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

data/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.

data/prius.gemspec

@@ -1,27 +1,30 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'prius/version'
+# frozen_string_literal: true
+
+require_relative "lib/prius/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "prius"
   spec.version       = Prius::VERSION
   spec.authors       = ["GoCardless Engineering"]
   spec.email         = ["engineering@gocardless.com"]
-  spec.description   = %q{Environmentally-friendly config}
-  spec.summary       = spec.description
+  spec.summary       = "Environmentally-friendly config. Validate and enforce the presence " \
+                       "and correct types of environment variables."
+  spec.description = <<~MSG.strip.tr("\n", " ")
+    Prius is a powerful and versatile gem designed to simplify the management of environment variables
+    in your application. With Prius, you can guarantee that your environment variables are not only
+    present but also valid, ensuring a smoother and more reliable app experience.
+  MSG
   spec.homepage      = "https://github.com/gocardless/prius"
   spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 3.0"
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/
+                                                             .git .circleci appveyor])
+    end
+  end
 
-  spec.add_development_dependency "rspec", "~> 3.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"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,82 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: prius
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.24'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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
+date: 2024-01-09 00:00:00.000000000 Z
+dependencies: []
+description: Prius is a powerful and versatile gem designed to simplify the management
+  of environment variables in your application. With Prius, you can guarantee that
+  your environment variables are not only present but also valid, ensuring a smoother
+  and more reliable app experience.
 email:
 - engineering@gocardless.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/dependabot.yml"
-- ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -87,12 +32,12 @@ files:
 - lib/prius/registry.rb
 - lib/prius/version.rb
 - prius.gemspec
-- spec/prius/registry_spec.rb
 homepage: https://github.com/gocardless/prius
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,16 +45,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
-summary: Environmentally-friendly config
-test_files:
-- spec/prius/registry_spec.rb
+summary: Environmentally-friendly config. Validate and enforce the presence and correct
+  types of environment variables.
+test_files: []

data/.circleci/config.yml

@@ -1,60 +0,0 @@
-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

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

data/.gitignore

@@ -1,3 +0,0 @@
-Gemfile.lock
-.bundle
-*.gem

data/spec/prius/registry_spec.rb

@@ -1,135 +0,0 @@
-# frozen_string_literal: true
-
-require "prius/registry"
-
-describe Prius::Registry do
-  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 a name that's present in the environment" do
-      it "doesn't blow up" do
-        expect { registry.load(:name) }.to_not raise_error
-      end
-    end
-
-    context "given a name that's not present in the environment" do
-      it "blows up" do
-        expect { registry.load(:slogan) }.
-          to raise_error(Prius::MissingValueError)
-      end
-
-      context "when required is false" do
-        it "doesn't blow up" do
-          expect { registry.load(:slogan, required: false) }.to_not raise_error
-        end
-      end
-    end
-
-    context "given an invalid type" do
-      it "blows up" do
-        expect { registry.load(:name, type: :lightsabre) }.
-          to raise_error(ArgumentError)
-      end
-    end
-
-    context "when specifying :int as the type" do
-      context "given a integer value" do
-        it "doesn't blow up" do
-          expect { registry.load(:age, type: :int) }.to_not raise_error
-        end
-
-        it "stores an int" do
-          registry.load(:age, type: :int)
-          expect(registry.get(:age)).to be_a(Integer)
-        end
-      end
-
-      context "given a non-integer value" do
-        it "blows up" do
-          expect { registry.load(:name, type: :int) }.
-            to raise_error(Prius::TypeMismatchError)
-        end
-      end
-    end
-
-    context "when specifying :bool as the type" do
-      context "given a boolean value" do
-        it "doesn't blow up" do
-          expect { registry.load(:alive, type: :bool) }.to_not raise_error
-        end
-
-        it "stores an boolean" do
-          registry.load(:alive, type: :bool)
-          expect(registry.get(:alive)).to be_a(TrueClass)
-        end
-      end
-
-      context "given a non-boolean value" do
-        it "blows up" do
-          expect { registry.load(:name, type: :bool) }.
-            to raise_error(Prius::TypeMismatchError)
-        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
-    context "given a name that has been loaded" do
-      before { registry.load(:name) }
-      it "returns the value" do
-        expect(registry.get(:name)).to eq("Harry")
-      end
-    end
-
-    context "given a name that hasn't been loaded" do
-      it "blows up" do
-        expect { registry.get(:name) }.
-          to raise_error(Prius::UndeclaredNameError)
-      end
-    end
-
-    context "given a nillable name that has been loaded" do
-      before { registry.load(:lightsabre, required: false) }
-      it "returns nil" do
-        expect(registry.get(:lightsabre)).to be_nil
-      end
-    end
-  end
-end