constfig 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,3 +1,7 @@
+# 0.0.3
+
+- fixed typos and added intro section to README
+
 # 0.0.2
 
 - improved README

data/README.md

@@ -2,11 +2,48 @@
 
 Simple configuration for Ruby.
 
-Allows you to define configuration CONSTANTS that take values from ENV.
+Allows you to define configuration CONSTANTS that take values from environment
+variables. With support for default values, required variables and type
+conversions.
 
 [![Build Status](https://travis-ci.org/astrails/constfig.png)](https://travis-ci.org/astrails/constfig)
 [![Code Climate](https://codeclimate.com/github/astrails/constfig.png)](https://codeclimate.com/github/astrails/constfig)
 
+## Introduction
+
+The are multiple ways of configuring your Rails application for different
+environments (e.g. staging, production, etc.). One of the popular ones is
+through environment variables. For example Heroku uses this type of
+configuration extensively.
+
+One of the benefits of it is that configuration values are never stored in the
+source control system, which improves security (for sensitive configuration
+parameters) and also makes it easier to try different configuration setups w/o
+changing the sources or re-deploying the application.
+
+On the other hand writing `(ENV['PRIMARY_DOMAIN'] || "myapp.com")` every time
+you need your domain string becomes cumbersome pretty fast, not to mention
+duplication and having the default repeated all over the place.
+
+A competent programmer will of course only do this once, and re-use the value
+everywhere. Something like this:
+
+    PRIMARY_DOMAIN = ENV['PRIMARY_DOMAIN'].presence || 'myapp.com'
+    S3_BUCKET = ENV['S3_BUCKET'] || raise 'missing S3_BUCKET'
+    ORDER_EXPIRATION_DAYS = (ENV['ORDER_EXPIRATION_DAYS'].presence || 1).to_i
+
+But it quickly becomes complicated, and again, quite a bit of similarly looking
+code that begs to be refactored out.
+
+This gem is something I extracted from a couple of my latest projects. It
+allows you to do just that, have a configuration parameters stored in constants
+with values coming from environment variables and ability to provide defaults
+or have required parameters (i.e. fail if missing).
+
+I just released version 0.0.1 of [constfig](https://rubygems.org/gems/constfig)
+to rubygems. Sources are of course on
+[github](https://github.com/astrails/constfig).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -69,7 +106,7 @@ defaults for non-production environments.
 There is one caveat with Rails on Heroku. By default Heroku doesn't provide
 environment variables to your application during the `rake assets:precompile`
 stage of slug compilation. If you don't take care of it your application will
-fail to compile its assets and might fail to work in produciton. To take care
+fail to compile its assets and might fail to work in production. To take care
 of it you can either use Heroku Labs
 [user-env-compile](https://devcenter.heroku.com/articles/labs-user-env-compile)
 option, or (and this is what I'd recommend) you can use development defaults
@@ -83,7 +120,7 @@ For example in Rails you con do this:
 
     define_config :DEFAULT_DOMAIN
 
-In development and test environments it willuse 'myapp.dev' ad
+In development and test environments it will use 'myapp.dev' ad
 `PRIMARY_DOMAIN`, but in production and staging environment it will fail unless
 `PRIMARY_DOMAIN` is provided by environment.
 

data/constfig.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Constfig::VERSION
   gem.authors       = ["Vitaly Kushner"]
   gem.email         = ["vitaly@astrails.com"]
-  gem.description   = %q{Simple Constnt Configuration for Ruby. Creates CONSTANTS with values from ENV}
+  gem.description   = %q{Simple Constnt Configuration for Ruby.  Allows you to define configuration CONSTANTS that take values from environment variables. With support for default values, required variables and type conversions.}
   gem.summary       = %q{Simple Constnt configuration for Ruby.}
   gem.homepage      = "http://astrails.com/blog/constfig"
 

data/lib/constfig/version.rb

@@ -1,3 +1,3 @@
 module Constfig
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: constfig
 version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
 authors:
 - Vitaly Kushner
@@ -11,8 +11,9 @@ bindir: bin
 cert_chain: []
 date: 2013-05-26 00:00:00.000000000 Z
 dependencies: []
-description: Simple Constnt Configuration for Ruby. Creates CONSTANTS with values
-  from ENV
+description: Simple Constnt Configuration for Ruby.  Allows you to define configuration
+  CONSTANTS that take values from environment variables. With support for default
+  values, required variables and type conversions.
 email:
 - vitaly@astrails.com
 executables: []
@@ -40,23 +41,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      version: '0'
       segments:
       - 0
-      hash: 2038963096202275797
-      version: '0'
-  none: false
+      hash: -4468990784169410071
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      version: '0'
       segments:
       - 0
-      hash: 2038963096202275797
-      version: '0'
-  none: false
+      hash: -4468990784169410071
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25