prius 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4efd54f9144bd36ec263a5cb4207ee0adc8b80c
+  data.tar.gz: 4a1cfedd0b63a10146b9164ca3cbc78f276afbfd
+SHA512:
+  metadata.gz: f5f916b7b56ae454bed8bdcc82f37e7bad980a6003af01aa669776d725131e0fe74e479d8ad06be9be34e760d1cc4047debb538e94e4c8e471c64d37144687e5
+  data.tar.gz: 6d6788a1500a1efc21c7620fc09e902c3f4606feba3ce6211feb493eec44211248a5ba8da7f94dec700572e16a1e306d524b1370fde375f34114c5f43351bdff

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+# Prius
+
+Environmentally-friendly application config for Ruby.
+

data/lib/prius.rb

@@ -0,0 +1,16 @@
+require "prius/registry"
+require "prius/railtie" if defined?(Rails)
+
+module Prius
+  def self.load(name, type: :string, allow_nil: false)
+    registry.load(name, type: type, allow_nil: allow_nil)
+  end
+
+  def self.get(name)
+    registry.get(name)
+  end
+
+  def self.registry
+    @registry ||= Registry.new(ENV)
+  end
+end

data/lib/prius/errors.rb

@@ -0,0 +1,5 @@
+module Prius
+  class MissingValueError < StandardError; end
+  class TypeMismatchError < StandardError; end
+  class UndeclaredNameError < StandardError; end
+end

data/lib/prius/railtie.rb

@@ -0,0 +1,9 @@
+module Prius
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      if ::Rails.root.join("config", "prius.rb").exist?
+        require ::Rails.root.join("config", "prius.rb")
+      end
+    end
+  end
+end

data/lib/prius/registry.rb

@@ -0,0 +1,65 @@
+require "prius/errors"
+
+module Prius
+  class Registry
+    TYPES = [:string, :int, :bool]
+
+    def initialize(env)
+      @env = env
+      @registry = {}
+    end
+
+    def load(name, env_var: nil, type: :string, allow_nil: false)
+      env_var ||= name.to_s.upcase
+      @registry[name] = case type
+                        when :string then load_string(env_var, allow_nil)
+                        when :int    then load_int(env_var, allow_nil)
+                        when :bool   then load_bool(env_var, allow_nil)
+                        else raise ArgumentError
+                        end
+    end
+
+    def get(name)
+      @registry.fetch(name)
+    rescue KeyError
+      raise UndeclaredNameError, "config value '#{name}' never loaded"
+    end
+
+    private
+
+    def check_valid_type(type)
+      unless TYPES.include?(type)
+        raise ArgumentError, "invalid type '#{type}'"
+      end
+    end
+
+    def load_string(name, allow_nil)
+      @env.fetch(name)
+    rescue KeyError
+      return nil if allow_nil
+      raise MissingValueError, "config value '#{name}' not present"
+    end
+
+    def load_int(name, allow_nil)
+      value = load_string(name, allow_nil)
+      return value if value.nil?
+
+      unless /\A[0-9]+\z/.match(value)
+        raise TypeMismatchError, "'#{name}' value '#{value}' is not an integer"
+      end
+      value.to_i
+    end
+
+    def load_bool(name, allow_nil)
+      value = load_string(name, allow_nil)
+      return nil if value.nil?
+
+      if /\A(yes|y|true|t|1)\z/i.match(value)
+        return true
+      elsif /\A(no|n|false|f|0)\z/i.match(value)
+        return false
+      end
+      raise TypeMismatchError, "'#{name}' value '#{value}' is not an boolean"
+    end
+  end
+end

data/lib/prius/version.rb

@@ -0,0 +1,3 @@
+module Prius
+  VERSION = "0.2.0".freeze
+end

data/prius.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prius/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prius"
+  spec.version       = Prius::VERSION
+  spec.authors       = ["Harry Marr"]
+  spec.email         = ["engineering@gocardless.com"]
+  spec.description   = %q{Environmentally-friendly config}
+  spec.summary       = spec.description
+  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.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/prius/registry_spec.rb

@@ -0,0 +1,97 @@
+require "prius/registry"
+
+describe Prius::Registry do
+  let(:env) { { "NAME" => "Harry", "AGE" => "25", "ALIVE" => "yes" } }
+  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 allow_nil is true" do
+        it "doesn't blow up" do
+          expect { registry.load(:slogan, allow_nil: true) }.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(Fixnum)
+        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
+  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, allow_nil: true) }
+      it "returns nil" do
+        expect(registry.get(:lightsabre)).to be_nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: prius
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Harry Marr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-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'
+description: Environmentally-friendly config
+email:
+- engineering@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/prius.rb
+- lib/prius/errors.rb
+- lib/prius/railtie.rb
+- 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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Environmentally-friendly config
+test_files:
+- spec/prius/registry_spec.rb