configerator 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adbb2b382aa1b45e54678f1f704565bd0161da27
-  data.tar.gz: 04597f001baaf1db15a3d3f0b233979b07695c52
+  metadata.gz: 1e2d61fe028ce7011ef38f7c66473779896d8909
+  data.tar.gz: 4c97a839350bb20cf57663cb72eeb9bd1442a91e
 SHA512:
-  metadata.gz: ca11055b43377f1593ee3d9d468a32a144c8ae676cd5c7e49fdce76393be719ed5a7c1a7e4aabcdb578cd034430bfa6ad2c0fba8767c0d9fdcb4c4af18d8c71a
-  data.tar.gz: 2c0839d61a3ef419dbad6101ec38598389966d93b49ba686169dd87fb6a0cb80bb2f5b08152c7eed9d5b2edca46723ce0a09c0b94fa8cb682608be46cb19efe6
+  metadata.gz: 7cb6c10835323f561115d47529dd1e040745f3ab802bc350f22a14eafd9f890dd4476f478f8d02c39d7ae6e6430d4f757f28929414ae6eb3d14d2759eb75b817
+  data.tar.gz: 526875af240df935bdcc219efb2b35e74af4889c70f646b61778f31ad17d34df2831f7ea39d10b9287fdd2985c9f9f05034d5fe73b3898cfbf92440f57a5e982

data/lib/configerator.rb

@@ -1,71 +1,24 @@
-require 'uri'
-
-module Configerator
-  def required(name, method=nil, error_on_load: true)
-    # Hash#fetch raises a KeyError, Hash#[] doesn't
-    value = error_on_load ? ENV.fetch(name.to_s.upcase) : ENV[name.to_s.upcase]
-    value = cast(value, method)
-
-    create(name, value, error_on_load)
-  end
-
-  def optional(name, method=nil)
-    value = cast(ENV[name.to_s.upcase], method)
-    create(name, value)
-  end
-
-  def override(name, default, method=nil)
-    value = cast(ENV.fetch(name.to_s.upcase, default), method)
-    create(name, value)
-  end
-
-  def int
-    ->(v) { v.to_i }
-  end
-
-  def float
-    ->(v) { v.to_f }
-  end
-
-  def bool
-    ->(v) { v.to_s=='true'}
-  end
-
-  def string
-    nil
-  end
-
-  def symbol
-    ->(v) { v.to_sym }
-  end
-
-  def url
-    ->(v) { v && URI.parse(v) }
-  end
-
-  # optional :accronyms, array(string)
-  # => ['a', 'b']
-  # optional :numbers, array(int)
-  # => [1, 2]
-  # optional :notype, array
-  # => ['a', 'b']
-  def array(method = nil)
-    -> (v) do
-      if v
-        v.split(',').map{|a| cast(a, method) }
-      end
-    end
-  end
-
-  private
-
-  def cast(value, method)
-    method ? method.call(value) : value
-  end
-
-  def create(name, value, error_on_load=true)
-    instance_variable_set(:"@#{name}", value)
-    instance_eval "def #{name}; @#{name} || (raise \"key not set '#{name}'\" unless #{error_on_load}) end"
-    instance_eval "def #{name}?; !!@#{name} end", __FILE__, __LINE__
-  end
+require 'configerator/configerator'
+
+# We want to detect if dotenv is in the environment and loaded it right after
+# the library is loaded so that if any configurations rely on it, the
+# .env environment variables will be available immediately.
+#
+# In order to bypass this autoloading of Dotenv, the user can load the library
+# directly:
+#
+# require 'configerator/configerator'
+
+begin
+  require 'dotenv/rails-now'
+rescue LoadError
+  # dotenv-rails not available
 end
+
+begin
+  # fallback to Dotenv
+  require 'dotenv'
+  Dotenv.load
+rescue LoadError
+  # dotenv not available
+end unless defined?(Dotenv::Railtie)

data/lib/configerator/configerator.rb

@@ -0,0 +1,88 @@
+require 'uri'
+
+module Configerator
+  @processed = []
+
+  def required(name, method=nil, error_on_load: true)
+    # Hash#fetch raises a KeyError, Hash#[] doesn't
+    value = error_on_load ? ENV.fetch(name.to_s.upcase) : ENV[name.to_s.upcase]
+    value = cast(value, method)
+
+    create(name, value, error_on_load)
+  end
+
+  def optional(name, method=nil)
+    value = cast(ENV[name.to_s.upcase], method)
+    create(name, value)
+  end
+
+  def namespace namespace, prefix: true, &block
+    @processed = []
+    @prefix = "#{namespace}_" if prefix
+    yield
+    instance_eval "def #{namespace}?; !!(#{@processed.join(' && ')}) end"
+  ensure
+    @prefix = nil
+    @processed = []
+  end
+
+  def override(name, default, method=nil)
+    value = cast(ENV.fetch(name.to_s.upcase, default), method)
+    create(name, value)
+  end
+
+  def int
+    ->(v) { v.to_i }
+  end
+
+  def float
+    ->(v) { v.to_f }
+  end
+
+  def bool
+    ->(v) { v.to_s=='true'}
+  end
+
+  def string
+    nil
+  end
+
+  def symbol
+    ->(v) { v.to_sym }
+  end
+
+  def url
+    ->(v) { v && URI.parse(v) }
+  end
+
+  # optional :accronyms, array(string)
+  # => ['a', 'b']
+  # optional :numbers, array(int)
+  # => [1, 2]
+  # optional :notype, array
+  # => ['a', 'b']
+  def array(method = nil)
+    -> (v) do
+      if v
+        v.split(',').map{|a| cast(a, method) }
+      end
+    end
+  end
+
+  private
+
+  def cast(value, method)
+    method ? method.call(value) : value
+  end
+
+  def create(name, value, error_on_load=true)
+    name = "#{@prefix}#{name}"
+
+    instance_variable_set(:"@#{name}", value)
+    instance_eval "def #{name}; @#{name} || (raise \"key not set '#{name}'\" unless #{error_on_load}) end"
+    instance_eval "def #{name}?; !!#{name} end", __FILE__, __LINE__
+
+    @processed ||= []
+    @processed << name
+  end
+end

data/lib/generators/config_generator.rb

@@ -0,0 +1,9 @@
+class ConfigGenerator < Rails::Generators::Base
+  desc "Creates a Configerator-based file at config/config.rb"
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def create_config_file
+    copy_file "config.rb", "config/config.rb"
+  end
+end

data/lib/generators/templates/config.rb

@@ -0,0 +1,66 @@
+require 'configerator'
+
+module Config
+  extend Configerator
+
+  #
+  # REQUIRED - exception is raised for these variables when missing
+  #
+
+  # required :database_url, string
+
+  # You can also defer raising an error until the key is requested:
+  # required :database_url, error_on_load: false, string
+
+
+  #
+  # OPTIONAL - value is returned or nil if it wasn't present
+  #
+
+  optional :app_name, string
+
+
+  #
+  # OVERRIDE - value is returned or the set default
+  #
+
+  override :rack_env,  'development', string
+  override :rails_env, 'development', string
+
+  # Other examplse
+  # override :database_timeout, 10,    int
+  # override :db_pool,          5,     int
+  # override :force_ssl,        true,  bool
+  # override :port,             5000,  int
+  # override :puma_max_threads, 16,    int
+  # override :puma_min_threads, 1,     int
+  # override :puma_workers,     3,     int
+  # override :raise_errors,     false, bool
+
+
+  #
+  # CLASS METHODS - for calculated/specialized values (its just ruby!)
+  #
+
+  # class << self
+  #   def app_name
+  #     "blammo-#{rails_env}"
+  #   end
+  #
+  #   def root
+  #     Rails.root
+  #   end
+  # end
+
+  #
+  # CASTING TYPES, there are several casting types
+  #
+
+  # optional :name,   string         # "blammo"
+  # optional :number, int            # 42
+  # optional :rate,   float          # 1.23
+  # optional :flag,   bool           # true
+  # optional :key,    symbol         # :info
+  # optional :github, url            # #<URI::HTTP https://github.com/heroku>
+  # optional :list,   array(string)  # ["this", "is", "a", "list"]
+end

data/test/configerator_test.rb

@@ -0,0 +1,172 @@
+require 'uri'
+require 'minitest/autorun'
+require './lib/configerator'
+
+module Config
+  extend Configerator
+end
+
+class TestConfigerator < Minitest::Test
+  FIXTURES = {
+    test_required: 'required',
+    test_optional: 'optional',
+    test_override: 'override',
+
+    test_int: 99,
+    test_float: 99.9,
+    test_string: 'ninty nine',
+    test_symbol: :ninty_nine,
+    test_url: 'https://99.com',
+    test_array_int: [ 9, 9 ],
+    test_array: [ 'nine', 'nine' ],
+
+    test_ns1: 'ns1',
+    test_ns2: 'ns2',
+
+    ns1: 'ns1',
+    ns2: 'ns2'
+  }.freeze
+
+  def setup
+    FIXTURES.each { |k, v|
+      ENV[k.to_s.upcase] = (v.is_a?(Array) ? v.join(',') : v.to_s)
+    }
+  end
+
+  def with_method
+    -> (v) { "method:#{v}" }
+  end
+
+  def test_required
+    Config.required :test_required
+
+    assert_equal Config.test_required, 'required'
+    assert Config.test_required?
+  end
+
+  def test_required_on_load_false
+    Config.required :test_required2, error_on_load: false
+
+    assert_raises RuntimeError do
+      Config.test_required2?
+    end
+
+    assert_raises RuntimeError do
+      Config.test_required2
+    end
+  end
+
+  def test_required_with_method
+    Config.required :test_required, with_method
+
+    assert_equal Config.test_required, 'method:required'
+    assert Config.test_required?
+  end
+
+  def test_required_missing
+    assert_raises KeyError do
+      Config.required :test_missing
+    end
+  end
+
+  def test_optional
+    Config.optional :test_optional
+
+    assert_equal Config.test_optional, 'optional'
+  end
+
+  def test_optional_with_method
+    Config.optional :test_optional, with_method
+
+    assert_equal Config.test_optional, 'method:optional'
+  end
+
+  def test_optional_missing
+    Config.optional :test_missing_optional
+
+    assert_nil Config.test_missing_optional
+  end
+
+  def test_namespace
+    Config.namespace :test do
+      Config.required :ns1
+      Config.optional :ns2
+      Config.override :ns3, "three"
+    end
+
+    assert Config.test_ns1
+    assert Config.test_ns2
+    assert Config.test_ns3
+    assert Config.test?
+  end
+
+  def test_namepsace_missing
+    Config.namespace :test do
+      Config.required :ns1
+      Config.optional :ns2
+      Config.override :ns3, "three"
+      Config.optional :ns4
+    end
+
+    assert Config.test_ns1
+    assert Config.test_ns2
+    assert Config.test_ns3
+    refute Config.test_ns4
+    refute Config.test?
+  end
+
+  def test_namespace_without_prefix
+    Config.namespace :test, prefix: false do
+      Config.optional :ns1
+      Config.optional :ns2
+    end
+
+    assert Config.ns1
+    assert Config.ns2
+  end
+
+  def test_override
+    Config.override :test_override, 'override_default'
+
+    assert_equal Config.test_override, 'override'
+  end
+
+  def test_override_with_method
+    Config.override :test_override, 'override_default', with_method
+
+    assert_equal Config.test_override, 'method:override'
+  end
+
+  def test_override_missing
+    Config.override :test_override_missing, 'override_default'
+
+    assert_equal Config.test_override_missing, 'override_default'
+  end
+
+  # build basic casting tests
+  FIXTURES.each do |meth, val|
+    caster = meth.to_s.gsub(/^test_/, '')
+
+    unless %w[ required optional override url ns1 ns2 ].include? caster
+      method = \
+        if caster =~ /_/
+          parts = caster.split('_')
+          Config.send(parts.first.to_sym, Config.send(parts.last.to_sym))
+        else
+          Config.send(caster.to_sym)
+        end
+
+      define_method(meth) do
+        Config.required meth, method
+
+        assert_equal Config.send(meth), val
+      end
+    end
+  end
+
+  def test_url
+    Config.required :test_url, Config.url
+
+    assert_equal Config.test_url, URI.parse('https://99.com')
+  end
+end

metadata

@@ -1,23 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: configerator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Joshua Mervine
+- Reid MacDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies: []
 description: Simple module for implementing environment based configuration adapted
   from Pliny and following the 12factor pattern.
-email: joshua@mervine.net
+email:
+- joshua@mervine.net
+- reidmix@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/configerator.rb
+- lib/configerator/configerator.rb
+- lib/generators/config_generator.rb
+- lib/generators/templates/config.rb
+- test/configerator_test.rb
 homepage: https://github.com/heroku/configerator
 licenses:
 - MIT
@@ -42,4 +49,5 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: 'Configerator: A Config Helper'
-test_files: []
+test_files:
+- test/configerator_test.rb