env_setting 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96310d9ae84d2c930ac48bf3a6fd90b6a954d413
+  data.tar.gz: 6935b91753a1c70aef433eb9d7823439009c14a2
+SHA512:
+  metadata.gz: 6b4a876883750972e645f49d54c1f02427e6114e4e9ae3312e579a74877c053495b5ff6573badc4b132e1c17e7427de1c3fc5c944f044c51f9a9db52f20c203d
+  data.tar.gz: bfce18429b78b30f255baa2791228591e6b220cb49f8f5b27559e67b4c4c29092a08690cc1642b7dc5a04b0452714585fdca0ac7a399e56027aa82424ac84778

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+L�)��\����vJ���)C�i}�6�������{p����"����ST%����E��GX�M�"���S�#��!���0Ϸ�Q�k����=m{�'�9J�R_��|+
%��s�g��f�aSOϽk��T,G����l-�ն��Z"$XA�Ҡ*eI�Cv������K��f�o媝�4��;��MڭpM�7�j=o�<���m�b#(O����+�W��V�
+Qr[�RK��F������5 �M ��6��ؼ�

data.tar.gz.sig

@@ -0,0 +1 @@
+y��^$?�#�~ml��v��Ni�U�YN�YbD>Q{�����火'�
�}J�v���#{��a9�E�c��,�����tQ!���f���+x7�JN�%���o^l��8�׌�����V�G#,����"sb��\����贸��,�?)�&4�y�]ɓ^��O�aTuv,^�z֎s�M?������N��+H��t�.r]-�{up�������5��ՋZ����1��Oų�:7���[+g��z��z�%

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec name: 'env_setting'
+
+# group :metrics do
+#   gem 'coveralls', require: false
+# end

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2016 ORM Technologies
+Copyright (c) 2013 Jonathan Camenisch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,333 @@
+# env_setting
+
+Inspired by [ENV!](https://rubygems.org/gems/env_bang) and [David Copeland's
+article on UNIX
+Environment](http://naildrivin5.com/blog/2016/06/10/dont-use-ENV-directly.html),
+`env_setting` is a slight rewrite of `env_bang` to provide OOP style access to
+your ENV.
+
+[![Build Status](https://travis-ci.org/ormtech/env_setting.svg?branch=master)](https://travis-ci.org/ormtech/env_setting)
+[![Coverage Status](https://coveralls.io/repos/github/ormtech/env_setting/badge.svg?branch=master)](https://coveralls.io/github/ormtech/env_setting?branch=master)
+
+`env_setting` is very similar to `ENV!`, it sets out to accomplish the same
+purpose:
+
+> - Provide a central place to specify all your app’s environment variables.
+> - Fail loudly and helpfully if any environment variables are missing.
+> - Prevent an application from starting up with missing environment variables.
+>   (This is especially helpful in environments like Heroku, as your app will
+>   continue running the old code until the server is configured for a new
+>   revision.)
+
+But with one extra requirement:
+
+- Provide access to environment variables in keeping with OOP doctrine.
+
+To accomplish that goal, Environment variables are just methods on the
+`EnvSetting` class after they are configured:
+
+```ruby
+ENV["SOME_SETTING"] = "something"
+
+EnvSetting.use "SOME_SETTING"
+
+...
+
+EnvSetting.some_setting
+# => "something"
+EnvSetting.some_setting?
+# => true
+```
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'env_setting'
+```
+
+Or for Rails apps, use `env_setting-rails` instead for more convenience:
+
+```ruby
+gem 'env_setting-rails'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+## Usage
+
+### Basic Configuration
+
+Configuration style is _exactly_ the same for `env_bang` and `env_setting`, only
+that there's no "ENV!" method... just the normal class: `EnvSetting` that is
+called and configured.
+
+First, configure your environment variables somewhere in your app’s startup
+process. If you use the `env_setting-rails` gem, place this in `config/env.rb`
+to load before application configuration.
+
+Example configuration:
+
+```ruby
+EnvSetting.config do
+  use :APP_HOST
+  use :RAILS_SECRET_TOKEN
+  use :STRIPE_SECRET_KEY
+  use :STRIPE_PUBLISHABLE_KEY
+  # ... etc.
+end
+```
+
+Once a variable is specified with the `use` method, access it with
+
+```ruby
+EnvSetting.my_var
+```
+
+Or you can still use the Hash syntax if you prefer it:
+
+```ruby
+EnvSetting["MY_VAR"]
+```
+
+This will function just like accessing `ENV` directly, except that it will
+require the variable to have been specified, and, if no default value is
+specified, it will raise a `KeyError` with an explanation of what needs to be
+configured. In the event you reference a variable that you haven't specified,
+it will produce a `NoMethodError` (if using the method syntax) or a `KeyError`
+if using the Hash syntax.
+
+### Adding a default value
+
+For some variables, you’ll want to include a default value in your code, and
+allow each environment to omit the variable for default behaviors. You can
+accomplish this with the `:default` option:
+
+```ruby
+EnvSetting.config do
+  # ...
+  use :MAIL_DELIVERY_METHOD, default: 'smtp'
+  # ...
+end
+```
+
+### Adding a description
+
+When a new team member installs or deploys your project, they may run into a
+missing environment variable error. Save them time by including documentation
+along with the error that is raised. To accomplish this, provide a description
+(of any length) to the `use` method:
+
+```ruby
+EnvSetting.config do
+  use 'RAILS_SECRET_KEY_BASE',
+      'Generate a fresh one with `SecureRandom.urlsafe_base64(64)`; see http://guides.rubyonrails.org/security.html#session-storage'
+end
+```
+
+Now if someone installs or deploys the app without setting the
+`RAILS_SECRET_KEY_BASE` variable, they will see these instructions immediately
+upon running the app.
+
+### Automatic type conversion
+
+`env_setting` can convert your environment variables for you, keeping that
+tedium out of your application code. To specify a type, use the `:class` option:
+
+```ruby
+EnvSetting.config do
+  use :COPYRIGHT_YEAR,       class: Integer
+  use :MEMCACHED_SERVERS,    class: Array
+  use :MAIL_DELIVERY_METHOD, class: Symbol, default: :smtp
+  use :DEFAULT_FRACTION,     class: Float
+  use :ENABLE_SOUNDTRACK,    class: :boolean
+  use :PUPPETMASTERS,        class: Hash
+end
+```
+
+**Note** that arrays will be derived by splitting the value on commas (','). To
+get arrays of a specific type of value, use the `:of` option:
+
+```ruby
+EnvSetting.config do
+  use :YEARS_OF_INTEREST, class: Array, of: Integer
+end
+```
+
+Hashes are split on commas (',') and key:value pairs are delimited by colon
+(':'). To get hashes of a specific type of value, use the `:of` option, and to
+use a different type for keys (default is `Symbol`), use the `:keys` option:
+
+```ruby
+EnvSetting.config do
+  use :BIRTHDAYS, class: Hash, of: Integer, keys: String
+end
+```
+
+#### Default type conversion behavior
+
+If you don’t specify a `:class` option for a variable, `env_setting` defaults to
+a special type conversion called `:StringUnlessFalsey`. This conversion returns
+a string, unless the value is a "falsey" string `['false', 'no', 'off', '0',
+'disable', 'disabled']`.  To turn off this magic for one variable, pass in
+`class: String`. To disable it globally, set
+
+```ruby
+EnvSetting.config do
+  default_class String
+end
+```
+
+Or if you just dislike what is considered "falsey", configure your own regex
+pattern of what strings are "falsey":
+
+```ruby
+EnvSetting.config do
+  default_falsey_regex(/0|fubar|false|n/i)
+end
+```
+
+#### Custom type conversion
+
+Suppose your app needs a special type conversion that doesn’t come with
+`env_setting`. You can implement the conversion yourself with the `add_class`
+method in the `EnvSetting.config` block.  For example, to convert one of your
+environment variables to type `Set`, you could write the following
+configuration:
+
+```sh
+# In your environment:
+export NUMBER_SET=1,3,5,7,9
+```
+
+```ruby
+# In your env.rb configuration file:
+require 'set'
+
+EnvSetting.config do
+  add_class Set do |value, options|
+    Set.new self.Array(value, options || {})
+  end
+
+  use :NUMBER_SET, class: Set, of: Integer
+end
+```
+
+```ruby
+# Somewhere in your application:
+EnvSetting.number_set
+#=> #<Set: {1, 3, 5, 7, 9}>
+```
+
+## What if I don't like `EnvSetting` for my settings class name?
+
+We don't blame you, the easiest way to "rename" the settings class from
+`EnvSetting` is to define a new class that inherits from `EnvSetting` like so:
+
+```ruby
+class Settings < EnvSetting
+end
+
+Settings.config do
+...
+end
+
+# elsewhere in your app
+Settings.my_special_env_var
+```
+
+## Implementation Notes
+
+1. Any method that can be run within an `EnvSetting.config` block can also be
+   run as a method directly on `EnvSetting`. For instance, instead of
+
+   ```ruby
+   EnvSetting.config do
+      add_class Set do
+        ...
+      end
+
+      use :NUMBER_SET, class: Set
+   end
+   ```
+
+   It would also work to run
+
+   ```ruby
+   EnvSetting.add_class Set do
+      ...
+   end
+
+   EnvSetting.use :NUMBER_SET, class: Set
+   ```
+   
+   While the `config` block is designed to provide a cleaner configuration
+   file, calling the methods directly can occasionally be handy, such as when
+   trying things out in an IRB/Pry session.
+
+2. `EnvSetting` is a wrapper for global state, and while it appears that
+   everything is stored/modified on the class level, it is actually defining and
+   delegating everything to a Singleton. Effectively that means that all the
+   ENV variable access methods are actually defined on an instance Singleton and
+   **not** on the `EnvSetting` class itself. For example:
+
+   ```ruby
+   EnvSetting.use "BUNDLE_BIN_PATH"
+
+   # The class appears to respond to respond to our envrionment variable method
+   EnvSetting.bundle_bin_path
+   # => "/srv/app/shared/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/gems/bundler-1.11.2/exe/bundle"
+   EnvSetting.:bundle_bin_path?
+   # => true
+
+   # However the Singelton is the true responder
+   EnvSetting.instance.bundle_bin_path
+   # => "/srv/app/shared/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/gems/bundler-1.11.2/exe/bundle"
+   EnvSetting.instance.bundle_bin_path?
+   # => true
+
+   # Swapping in a different Singelton instance shows the truth.
+   EnvSetting.set_instance(EnvSetting.new)
+   EnvSetting.respond_to?(:bundle_bin_path)
+   # => false
+   EnvSetting.respond_to?(:bundle_bin_path?)
+   # => false
+
+   EnvSetting.instance.respond_to?(:bundle_bin_path)
+   # => false
+   EnvSetting.instance.respond_to?(:bundle_bin_path?)
+   # => false
+   ```
+
+3. `EnvSetting` stores the converted ENV variable values in a cache (just to
+   avoid having to repeat a laborious conversion). In the event that you want
+   all the cache to be cleared out and all the conversions applied again, use
+   the `clear_cache!` method on the **instance Singelton**:
+
+   ```ruby
+   EnvSetting.instance.clear_cache!
+   ```
+
+## Acknowledgements
+
+Jonathan Camenisch, the author of `ENV!`, has done substantial work of which
+this gem takes advantage. This gem would not be possible without that work.
+This gem simply changes the style in which the work that `ENV!` does is exposed
+(i.e. via methods).
+
+## License
+
+This gem is licensed under the MIT License
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+namespace 'dotenv' do
+  Bundler::GemHelper.install_tasks :name => 'env_setting'
+end
+
+desc 'Run all tests'
+RSpec::Core::RakeTask.new(:spec) do |s|
+  s.rspec_opts = '-f d -c'
+  s.pattern = 'spec/**/*_spec.rb'
+end
+task :default => :spec

data/certs/wspurgin.pem

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQUFADBGMRUwEwYDVQQDDAx3aWxs
+LnNwdXJnaW4xGDAWBgoJkiaJk/IsZAEZFghvcm0tdGVjaDETMBEGCgmSJomT8ixk
+ARkWA2NvbTAeFw0xNjA2MjAxNTU4NDJaFw0xNzA2MjAxNTU4NDJaMEYxFTATBgNV
+BAMMDHdpbGwuc3B1cmdpbjEYMBYGCgmSJomT8ixkARkWCG9ybS10ZWNoMRMwEQYK
+CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+vRMpVroSt8OrOY/zyh/00HzNryjthX5JabsyIlZBBkqJSBakNa4p9y3EleODdvP8
+3DPnDgAax5/nYd+UumPbcqPB7lhXHn+vw+082DVVOaL2IMg1fbqLRSpCXGvgz4za
+P4QKMusXXRAo1+nLjl68pumyLfAD6dEF7bNk2diHpKppknb1ENsvs/v8/uWQBv27
+AnIrHntPpKCLwSjxufgCa9IKdSy9EdwCBCwX9IOGTjUhFoRy+Fsx7pUi0NM7eaER
+h0VYrXIPnembxN51iVA6LcM7wnzl6uVnSb/TJshc3zSIqZibvHSPKL1g17S2s8qa
+2AspSOGAQ7iDAkt1lRnccQIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
+AgSwMB0GA1UdDgQWBBTdymM1YAMQyvVpddd//6sgBWrCOTAkBgNVHREEHTAbgRl3
+aWxsLnNwdXJnaW5Ab3JtLXRlY2guY29tMCQGA1UdEgQdMBuBGXdpbGwuc3B1cmdp
+bkBvcm0tdGVjaC5jb20wDQYJKoZIhvcNAQEFBQADggEBAK4zjjfK53r01ZtIB+xF
+GT8OR3ri+iSrcTAaC7dk4XmjNU42hGBlFZ34RjnzxBGBjBZH9w+3jwCjN8FkPfmO
+f1kiI4+tCt+weUzWFqhKsIaC23TjEDrlhyZ2203HldlW4p26onVwDpIn3YOYG9Qr
+c+9wUpquUpi5e4bBVsIaHoYnECMOrGIgRSleI8YWLAakTWAXRL63dtekC945+3ep
+vbrWi4+bt0feapcxjBsEk2q1TW6XmEWU8HokYJOxNbqKt5XuWZq/fcGgBV+CftFN
+8o95YBJ2TniSxvMvbz2P9Q/Mh1AhMN4J0OqtcAo1One8UgJBXU8xZHj/qWMLwT9L
+gtM=
+-----END CERTIFICATE-----

data/env_setting.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'env_setting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "env_setting"
+  spec.version       = EnvSetting::VERSION
+  spec.authors       = ["Will Spurgin"]
+  spec.email         = ["will.spurgin@orm-tech.com"]
+  spec.summary       = %q{Mange your environment variables in OOP style}
+  spec.description   = %q{Allows OOP access to ENV variables by a slight re-write of the env_bang gem.}
+  spec.homepage      = "https://github.com/ormtech/env_setting"
+  spec.license       = "MIT"
+
+  spec.cert_chain  = ['certs/wspurgin.pem']
+  spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/lib/env_setting.rb

@@ -0,0 +1,113 @@
+require "env_setting/version"
+require "env_setting/classes"
+require "env_setting/formatter"
+
+class EnvSetting
+  def self.config(&block)
+    class_eval(&block)
+  end
+
+  def self.use(var, *args)
+    var = var.to_s
+    description = args.first.is_a?(String) && args.shift
+    description ||= ""
+    options = args.last.is_a?(Hash) ? args.pop : {}
+
+    unless ENV.has_key?(var)
+      ENV[var] = options.fetch(:default) { raise_formatted_error(var, description) }.to_s
+    end
+
+    vars[var] = options
+
+    method_name = var.downcase
+
+    instance.define_singleton_method(method_name) do
+      cache[method_name] ||= self.class.get_value(var)
+    end
+
+    method_name_bool = "#{method_name}?"
+    instance.define_singleton_method(method_name_bool) do
+      cache[method_name_bool] ||= !!(self.send(method_name))
+    end
+  end
+
+  def self.raise_formatted_error(var, description)
+    raise KeyError.new Formatter.formatted_error(var, description)
+  end
+
+  def self.add_class(klass, &block)
+    Classes.send :define_singleton_method, klass.to_s, &block
+  end
+
+  def self.default_class(*args)
+    if args.any?
+      Classes.default_class = args.first
+    else
+      Classes.default_class
+    end
+  end
+
+  def self.default_falsey_regex(regex = nil)
+    if regex
+      Classes.default_falsey_regex = regex
+    else
+      Classes.default_falsey_regex
+    end
+  end
+
+  def self.respond_to?(method_sym)
+    instance.respond_to?(method_sym) || super
+  end
+
+  def self.method_missing(method, *args, &block)
+    instance.send(method, *args, &block)
+  end
+
+  def self.instance
+    @@instance ||= new
+  end
+
+  def self.set_instance(obj)
+    raise ArgumentError.new "Object must be a derivative of EnvSetting" unless obj.is_a?(EnvSetting)
+    @@instance = obj
+  end
+
+  def self.vars
+    @@vars ||= {}
+  end
+
+  def self.keys
+    vars.keys
+  end
+
+  def self.values
+    keys.map { |k| self[k] }
+  end
+
+  def self.get_value(var)
+    var = var.to_s
+    raise KeyError.new("#{var} is not configured in the ENV") unless vars.has_key?(var)
+
+    Classes.cast ENV[var], vars[var]
+  end
+
+  def self.[](var)
+    self.get_value(var)
+  end
+
+  def cache
+    @cache ||= {}
+  end
+
+  def clear_cache!
+    @cache = nil
+  end
+
+  def respond_to?(method_sym)
+    ENV.respond_to?(method_sym) || super
+  end
+
+  def method_missing(method, *args, &block)
+    ENV.send(method, *args, &block)
+  end
+end

data/lib/env_setting/classes.rb

@@ -0,0 +1,60 @@
+class EnvSetting
+  module Classes
+    class << self
+      attr_writer :default_class
+    end
+
+    def self.default_class
+      @@default_class ||= :StringUnlessFalsey
+    end
+
+    def self.default_falsey_regex
+      @@default_falsey_regex ||= /^(|0|disabled?|false|no|off)$/i
+    end
+
+    def self.default_falsey_regex=(regex)
+      @@default_falsey_regex = regex
+    end
+
+    def self.cast(value, options = {})
+      public_send(:"#{options.fetch(:class, default_class)}", value, options)
+    end
+
+    def self.boolean(value, options)
+      !(value =~ default_falsey_regex)
+    end
+
+    def self.Array(value, options)
+      item_options = options.merge(class: options.fetch(:of, default_class))
+      value.split(',').map { |v| cast(v.strip, item_options) }
+    end
+
+    def self.Hash(value, options)
+      key_options   = options.merge(class: options.fetch(:keys, Symbol))
+      value_options = options.merge(class: options.fetch(:of, default_class))
+      {}.tap do |h|
+        value.split(',').each do |pair|
+          key, value = pair.split(':')
+          h[cast(key.strip, key_options)] = cast(value.strip, value_options)
+        end
+      end
+    end
+
+    def self.Symbol(value, options)
+      value.to_sym
+    end
+
+    def self.StringUnlessFalsey(value, options)
+      boolean(value, options) && value
+    end
+
+    def self.respond_to?(method_sym)
+      Kernel.respond_to?(method_sym) || super
+    end
+
+    # Delegate methods like Integer(), Float(), String(), etc. to the Kernel module
+    def self.method_missing(klass, value, options = {}, &block)
+      Kernel.send(klass, value)
+    end
+  end
+end

data/lib/env_setting/formatter.rb

@@ -0,0 +1,20 @@
+class EnvSetting
+  module Formatter
+    def self.formatted_error(var, description)
+      indent 4, <<-EOS
+
+  Missing required environment variable: #{var}#{ description and "\n" <<
+  unindent(description) }
+      EOS
+    end
+
+    def self.unindent(string)
+      width = string.scan(/^ */).map(&:length).min
+      string.gsub(/^ {#{width}}/, '')
+    end
+
+    def self.indent(width, string)
+      string.gsub "\n", "\n#{' ' * width}"
+    end
+  end
+end

data/lib/env_setting/version.rb

@@ -0,0 +1,3 @@
+class EnvSetting
+  VERSION = "1.0.0".freeze
+end

data/spec/env_setting_spec.rb

@@ -0,0 +1,300 @@
+require_relative 'spec_helper'
+
+RSpec.describe EnvSetting do
+
+  it "Raises exception if unconfigured ENV var requested" do
+    ENV['UNCONFIGURED'] = 'unconfigured'
+    expect { described_class.unconfigured }.to raise_error NoMethodError
+    expect { described_class['UNCONFIGURED'] }.to raise_error KeyError
+  end
+
+  it "Raises exception if configured ENV var is not present" do
+    ENV.delete('NOT_PRESENT')
+
+    expect {
+      described_class.config do
+        use 'NOT_PRESENT'
+      end
+    }.to raise_error KeyError
+  end
+
+  it "Should define two methods for each configured ENV var" do
+    ENV['CUSTOM_VAR'] = 'foo'
+
+    described_class.config do
+      use 'CUSTOM_VAR'
+    end
+
+    expect(described_class).to respond_to(:custom_var)
+    expect(described_class.custom_var).to eq 'foo'
+
+    expect(described_class).to respond_to(:custom_var?)
+    expect(described_class.custom_var?).to eq true
+  end
+
+  it "Uses provided default value if ENV var not already present" do
+    ENV.delete('WASNT_PRESENT')
+
+    described_class.config do
+      use 'WASNT_PRESENT', default: 'a default value'
+    end
+    expect(described_class.wasnt_present).to eq 'a default value'
+  end
+
+  it "Returns actual value from ENV if present" do
+    ENV['PRESENT'] = 'present in environment'
+
+    described_class.config do
+      use 'PRESENT', default: "You won't need this."
+    end
+    expect(described_class.present).to eq 'present in environment'
+  end
+
+  describe "Type casting" do
+    let(:truthy_values) { %w[true on yes yo yup anything] }
+    let(:falsey_values) { %w[false no off disable disabled 0] << '' }
+    let(:integers) { %w[0 1 10 -42 -55] }
+    let(:floats) { %w[0.1 1.3 10 -42.3 -55] }
+
+    it "Casts Integers" do
+      integer = integers.sample
+      ENV['INTEGER'] = integer
+      described_class.use 'INTEGER', class: Integer
+
+      expect(described_class.integer).to eq integer.to_i
+    end
+
+    it "Casts Symbols" do
+      ENV['SYMBOL'] = 'symbol'
+      described_class.use 'SYMBOL', class: Symbol
+
+      expect(described_class.symbol).to eq :symbol
+    end
+
+    it "Casts Floats" do
+      float = floats.sample
+      ENV['FLOAT'] = float
+      described_class.use 'FLOAT', class: Float
+
+      expect(described_class.float).to eq float.to_f
+      expect(described_class.float).to be_a Float
+    end
+
+    it "Casts Arrays" do
+      ENV['ARRAY'] = 'one,two , three, four'
+      described_class.use 'ARRAY', class: Array
+
+      expect(described_class.array).to match_array(%w[one two three four])
+    end
+
+    it "Casts Arrays of Integers" do
+      ENV['INTEGERS'] = integers.join(',')
+      described_class.use 'INTEGERS', class: Array, of: Integer
+
+      expect(described_class.integers).to match_array(integers.map(&:to_i))
+    end
+
+    it "Casts Arrays of Floats" do
+      ENV['FLOATS'] = floats.join(',')
+      described_class.use 'FLOATS', class: Array, of: Float
+
+      expect(described_class.floats).to match_array(floats.map(&:to_f))
+    end
+
+    it "regression: Casting Array always returns Array" do
+      ENV['ARRAY'] = 'one,two , three, four'
+      described_class.use 'ARRAY', class: Array
+
+      2.times do
+        expect(described_class.array).to match_array(%w[one two three four])
+      end
+    end
+
+    it "Casts Hashes" do
+      ENV['HASH_VAR'] = 'one: two, three: four'
+      described_class.use 'HASH_VAR', class: Hash
+
+      expect(described_class.hash_var).to eq({one: 'two', three: 'four'})
+    end
+
+    it 'Casts Hashes of Integers' do
+      ENV['INT_HASH'] = 'one: 111, two: 222'
+      described_class.use 'INT_HASH', class: Hash, of: Integer
+
+      expect(described_class.int_hash).to eq({one: 111, two: 222})
+    end
+
+    it 'Casts Hashes with String keys' do
+      ENV['STRKEY_HASH'] = 'one: two, three: four'
+      described_class.use 'STRKEY_HASH', class: Hash, keys: String
+
+      expect(described_class.strkey_hash).to eq({'one' => 'two', 'three' => 'four'})
+    end
+
+    it "Casts true" do
+      ENV['TRUE'] = truthy_values.sample
+      described_class.use 'TRUE', class: :boolean
+
+      expect(described_class.true).to eq true
+      expect(described_class.true?).to eq true
+    end
+
+    it "Casts false" do
+      ENV['FALSE'] = falsey_values.sample
+      described_class.use 'FALSE', class: :boolean
+
+      expect(described_class.false).to eq false
+      expect(described_class.false?).to eq false
+    end
+
+    it "converts falsey or empty string to false by default" do
+      ENV['FALSE'] = falsey_values.sample
+      described_class.use 'FALSE'
+
+      expect(described_class.false).to eq false
+    end
+
+    it "leaves falsey string as string if specified" do
+      ENV['FALSE'] = falsey_values.sample
+      described_class.use 'FALSE', class: String
+
+      expect(described_class.false).to be_a String
+    end
+
+    it "allows default class to be overridden" do
+      expect(described_class.default_class).to eq :StringUnlessFalsey
+      orig = described_class.default_class
+
+      described_class.config { default_class String }
+      ENV['FALSE'] = falsey_values.sample
+      described_class.use 'FALSE'
+
+      expect(described_class.false).to be_a String
+
+      described_class.default_class orig
+    end
+
+    it "allows default falsey regex to be overridden" do
+      expect(described_class.default_falsey_regex).to eq(/^(|0|disabled?|false|no|off)$/i)
+      orig = described_class.default_falsey_regex
+
+      described_class.config { default_falsey_regex(/fubar/i) }
+
+      ENV['FALSEY'] = 'fubar'
+      described_class.use 'FALSEY'
+
+      expect(described_class.falsey).to be_a FalseClass
+
+      # Reset the default for rest of tests.
+      described_class.default_falsey_regex orig
+    end
+
+    it "allows addition of custom types" do
+      require 'set'
+
+      ENV['NUMBER_SET'] = '1,3,5,7,9'
+      described_class.config do
+        add_class Set do |value, options|
+          Set.new self.Array(value, options || {})
+        end
+
+        use :NUMBER_SET, class: Set, of: Integer
+      end
+      expect(described_class::Classes).to respond_to(:Set)
+
+      expect(described_class.number_set).to eq Set.new [1, 3, 5, 7, 9]
+    end
+  end
+
+  describe "Hash-like behavior" do
+    it "provides configured keys" do
+      ENV['VAR1'] = 'something'
+      ENV['VAR2'] = 'something else'
+      described_class.use 'VAR1'
+      described_class.use 'VAR2'
+
+      expect(described_class.keys).to include(*%w[VAR1 VAR2])
+    end
+
+    it "provides configured values" do
+      ENV['VAR1'] = 'something'
+      ENV['VAR2'] = 'something else'
+      described_class.use 'VAR1'
+      described_class.use 'VAR2'
+
+      expect(described_class.values).to include(*%w[something something\ else])
+    end
+  end
+
+  describe "Formatting" do
+    it "Includes provided description in error message" do
+      ENV.delete('NOT_PRESENT')
+
+      expect {
+        described_class.config do
+          use 'NOT_PRESENT', 'You need a NOT_PRESENT var in your ENV'
+        end
+      }.to raise_error(KeyError, /You need a NOT_PRESENT var in your ENV/)
+    end
+  end
+
+  describe ".instance" do
+    it "returns the instance singleton of #{described_class}" do
+      expect(described_class.instance).to be_a(described_class)
+    end
+
+    it "should have a local instance cache of the ENV variables' method names and their return values" do
+      ENV['VAR1'] = 'something'
+      described_class.use 'VAR1'
+
+      described_class.var1
+      described_class.var1?
+
+      expect(described_class.instance.cache).to have_key("var1")
+      expect(described_class.instance.cache).to have_key("var1?")
+    end
+
+    it "allows the cache to be cleared" do
+      ENV['VAR1'] = 'something'
+      described_class.use 'VAR1'
+
+      described_class.var1
+      described_class.var1?
+
+      expect(described_class.instance.cache.keys). to include "var1", "var1?"
+
+      described_class.instance.clear_cache!
+      expect(described_class.instance.cache).to be_empty
+    end
+  end
+
+  describe "#set_instance" do
+    let(:setting_class) { Class.new(described_class) }
+    it "should set the instance Singleton to the given object" do
+      obj = setting_class.new
+      described_class.set_instance(obj)
+      expect(described_class.instance).to be obj
+
+      obj = described_class.new
+      described_class.set_instance(obj)
+      expect(described_class.instance).to be obj
+    end
+
+    it "should raise an argument error if the given class is not a derivative of #{described_class}" do
+      expect { described_class.set_instance(Object.new) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#instance" do
+    it "should have the ENV variable methods defined on the Singelton, not the class" do
+      # Reset Singleton for fresh test
+      described_class.set_instance(described_class.new)
+      ENV["MY_SPECIAL_VAR"] = "foo"
+
+      described_class.use :MY_SPECIAL_VAR
+      expect(described_class.method_defined? :my_special_var).to eq false
+      expect(described_class.instance).to respond_to(:my_special_var)
+      expect(described_class.instance.public_methods).to include :my_special_var, :my_special_var?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+SimpleCov.start
+
+Coveralls.wear!
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'env_setting'
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: env_setting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Will Spurgin
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQUFADBGMRUwEwYDVQQDDAx3aWxs
+  LnNwdXJnaW4xGDAWBgoJkiaJk/IsZAEZFghvcm0tdGVjaDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0xNjA2MjAxNTU4NDJaFw0xNzA2MjAxNTU4NDJaMEYxFTATBgNV
+  BAMMDHdpbGwuc3B1cmdpbjEYMBYGCgmSJomT8ixkARkWCG9ybS10ZWNoMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  vRMpVroSt8OrOY/zyh/00HzNryjthX5JabsyIlZBBkqJSBakNa4p9y3EleODdvP8
+  3DPnDgAax5/nYd+UumPbcqPB7lhXHn+vw+082DVVOaL2IMg1fbqLRSpCXGvgz4za
+  P4QKMusXXRAo1+nLjl68pumyLfAD6dEF7bNk2diHpKppknb1ENsvs/v8/uWQBv27
+  AnIrHntPpKCLwSjxufgCa9IKdSy9EdwCBCwX9IOGTjUhFoRy+Fsx7pUi0NM7eaER
+  h0VYrXIPnembxN51iVA6LcM7wnzl6uVnSb/TJshc3zSIqZibvHSPKL1g17S2s8qa
+  2AspSOGAQ7iDAkt1lRnccQIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
+  AgSwMB0GA1UdDgQWBBTdymM1YAMQyvVpddd//6sgBWrCOTAkBgNVHREEHTAbgRl3
+  aWxsLnNwdXJnaW5Ab3JtLXRlY2guY29tMCQGA1UdEgQdMBuBGXdpbGwuc3B1cmdp
+  bkBvcm0tdGVjaC5jb20wDQYJKoZIhvcNAQEFBQADggEBAK4zjjfK53r01ZtIB+xF
+  GT8OR3ri+iSrcTAaC7dk4XmjNU42hGBlFZ34RjnzxBGBjBZH9w+3jwCjN8FkPfmO
+  f1kiI4+tCt+weUzWFqhKsIaC23TjEDrlhyZ2203HldlW4p26onVwDpIn3YOYG9Qr
+  c+9wUpquUpi5e4bBVsIaHoYnECMOrGIgRSleI8YWLAakTWAXRL63dtekC945+3ep
+  vbrWi4+bt0feapcxjBsEk2q1TW6XmEWU8HokYJOxNbqKt5XuWZq/fcGgBV+CftFN
+  8o95YBJ2TniSxvMvbz2P9Q/Mh1AhMN4J0OqtcAo1One8UgJBXU8xZHj/qWMLwT9L
+  gtM=
+  -----END CERTIFICATE-----
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows OOP access to ENV variables by a slight re-write of the env_bang
+  gem.
+email:
+- will.spurgin@orm-tech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/wspurgin.pem
+- env_setting.gemspec
+- lib/env_setting.rb
+- lib/env_setting/classes.rb
+- lib/env_setting/formatter.rb
+- lib/env_setting/version.rb
+- spec/env_setting_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ormtech/env_setting
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Mange your environment variables in OOP style
+test_files: []

metadata.gz.sig

@@ -0,0 +1,3 @@
+�
V��R?����
+��O�c�b��#Ot�M��js�_';��&8Q���'�'3�w��@(
yu�7�2i�r"�Yx@����x�[� $�O{�S��1��=�����\��&6��gH��:E�(rf�gU�ȪN6F��/8:�W6aTG�����͌��|��"D:*D�||_��w�s��[D�����/�	��>���{~����k`�'[��	�������L
�?�1�O�k�C<_n
+�!����������a��