hconfig 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 722e17ec8f6840da97b31e85de9565180b0e607e
+  data.tar.gz: 721905876fe73c4047f504270306619d858ccff1
+SHA512:
+  metadata.gz: ef08569cbc388189a44ccdecfb6d6af11fd8dfa62d8999b44a1e7c80cbd95f177dce19d9f1f237f552cbb6875b2b42923695f8dd62ae881a2c72e803d3031077
+  data.tar.gz: 7fcdac73a79fb9549f2ed853eafd4277789d440c2a7403924b909dc7b428be74eb8eca94bba629e043acfe17aa3fdfb58d5ad7d2eed2d5ed98b2d1c43b56ec90

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hconfig.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matte Noble
+
+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,75 @@
+# hconfig
+
+hconfig translates ENV vars into `Config.*` attributes, with presence
+validation and type casting. hconfig is intended to be used in
+environments (Heroku, in my case) where much of the config is stored in ENV.
+
+hconfig is a standalone gem version of the `CastingConfigHelpers` module from
+[Pliny](https://github.com/interagent/pliny).
+
+## Installation
+
+```ruby
+gem 'hconfig'
+```
+
+## Usage
+
+```ruby
+module Config
+  extend HConfig
+
+  mandatory :database_url, string
+  optional  :versioning_default, string
+  override  :port, 5000, int
+end
+
+ENV["DATABASE_URL"] = "postgres:///thing-db"
+
+Config.database_url
+# => "postgres:///thing-db"
+```
+
+### RbConfig Note
+
+If you're mixing this into a module named `Config`, RbConfig will warn you 
+about doing so. You can supress the warning via:
+
+```ruby
+Object.send(:remove_const, :Config) if Object.const_defined?(:Config)
+```
+
+Alternatively, you can just namespace `Config` under your app/lib/etc.
+
+### Mandatory Variables
+
+An exception is raised when the ENV var is missing.
+
+```ruby
+mandatory :database_url, string
+```
+
+### Optional Variables
+
+The value is returned if set, otherwise `nil`.
+
+```ruby
+optional :versioning_default, string
+```
+
+### Override
+
+The value is returned if set, otherwise the default value will be
+returned.
+
+```ruby
+override :port, 5000, int
+```
+
+## Development
+
+```
+$ bundle install
+$ rake
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hconfig"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hconfig.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hconfig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hconfig"
+  spec.version       = Hconfig::VERSION
+  spec.authors       = ["Matte Noble"]
+  spec.email         = ["me@mattenoble.com"]
+
+  spec.summary       = %q{ENV var to Config object translation with validations.}
+  spec.description   = %q{ENV var to Config object translation with validations.}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hconfig.rb

@@ -0,0 +1,67 @@
+require "hconfig/version"
+
+module HConfig
+  def mandatory(name, method=nil)
+    value = cast(ENV.fetch(name.to_s.upcase), method)
+    create(name, value)
+  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
+
+  # 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)
+    instance_variable_set(:"@#{name}", value)
+    instance_eval "def #{name}; @#{name} end", __FILE__, __LINE__
+    if value.kind_of?(TrueClass) || value.kind_of?(FalseClass) || value.kind_of?(NilClass)
+      instance_eval "def #{name}?; !!@#{name} end", __FILE__, __LINE__
+    end
+  end
+end
+

data/lib/hconfig/version.rb

@@ -0,0 +1,3 @@
+module Hconfig
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: hconfig
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matte Noble
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ENV var to Config object translation with validations.
+email:
+- me@mattenoble.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hconfig-0.1.0.gem
+- hconfig.gemspec
+- lib/hconfig.rb
+- lib/hconfig/version.rb
+homepage: 
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: ENV var to Config object translation with validations.
+test_files: []