constfig 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in constfig.gemspec
+gemspec
+gem 'rspec'
+gem 'guard'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cli: '--color --format nested' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vitaly Kushner
+
+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,73 @@
+# Constfig
+
+Simple configuration for Ruby.
+
+Allows you to define configuration CONSTANTS that take values from ENV.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'constfig'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install constfig
+
+## Usage
+
+There is only one function provided by the gem: `define_config`.
+
+### With a default (optional variable)
+
+You can call it with a default, like this:
+
+    define_config :DEFAULT_DOMAIN, "astrails.com"
+
+In which case it will first look if `ENV['DEFAULT_DOMAIN']` is available, and
+if not will use the 'astrails.com'. A constant `DEFAULT_DOMAIN` will be
+defined.
+
+### Without a default (required variable)
+
+Or you can call it without the default:
+
+    define_config :DEFAULT_DOMAIN
+
+In which case it will raise exception `Constfig::Undefined` if
+`ENV['DEFAULT_DOMAIN']` is not available.
+
+### Variable type
+
+One last thing. Non-string variables are supported. If you provide a non-string
+default (boolean, integer, float or symbol), the value that is coming from
+`ENV` will be converted to the same type (using `to_i`, `to_f`, and
+`to_symbol`).  For the true/false types `"true"`, `"TRUE"`, and `"1"` will be
+treated as `true`, anything else will be treated as `false`.
+
+In the case of required variables, you can supply a `Class` in place of the
+default, and it will be used for the type conversion. Like this:
+
+    define_config :EXPIRATION_DAYS, Fixnum
+
+For boolean variables you can supply either `TrueClass`, or  `FalseClass`.
+
+### Existing constants
+
+This gem will not re-define existing constants.
+
+### Managing environment
+
+You can use the [dotenv gem](https://github.com/bkeepers/dotenv) to manage your `ENV`.
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/constfig.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'constfig/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "constfig"
+  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.summary       = %q{Simple Constnt configuration for Ruby.}
+  gem.homepage      = "http://astrails.com/blog/constfig"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/constfig.rb

@@ -0,0 +1,3 @@
+require 'constfig/config'
+
+Object.send :include, Constfig::Config

data/lib/constfig/config.rb

@@ -0,0 +1,40 @@
+require "constfig/version"
+module Constfig
+  class Undefined < RuntimeError; end
+  module Config
+    def define_config name, default = (no_default = true;nil)
+      return if Object.const_defined?(name)
+
+      has_default_value = !no_default # && default.class != Class
+
+      if value = ENV[name.to_s]
+        if has_default_value
+          type = default.is_a?(Class) ? default.name : default.class.name
+          value = convert_to_type value, type
+        end
+      else
+        raise RuntimeError, "missing config #{name}, and no default was provided" unless has_default_value
+        value = default
+      end
+
+      Object.const_set name, value
+    end
+
+    private
+
+    def convert_to_type(value, type)
+      case type
+      when 'Fixnum'
+        value.to_i
+      when 'Float'
+        value.to_f
+      when 'Symbol'
+        value.to_sym
+      when 'TrueClass', 'FalseClass'
+        '1' == value || 'true' == value || 'TRUE' == value
+      else
+        value
+      end
+    end
+  end
+end

data/lib/constfig/version.rb

@@ -0,0 +1,3 @@
+module Constfig
+  VERSION = "0.0.1"
+end

data/spec/constfig/constfig_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Constfig do
+  before(:each) do
+    Object.send :remove_const, :FOO if Object.const_defined?(:FOO)
+    ENV.delete 'FOO'
+  end
+
+  it "should define config var from a default" do
+    define_config :FOO, 123
+    FOO.should == 123
+  end
+
+  it "should define config var from ENV" do
+    ENV['FOO'] = '456'
+    define_config :FOO
+    FOO.should == '456'
+  end
+
+  it "should prefer ENV over default" do
+    ENV['FOO'] = 'bar'
+    define_config :FOO, 'baz'
+    FOO.should == 'bar'
+  end
+
+  it "should raise exception when no default and no ENV" do
+    ->{
+      define_config :FOO
+    }.should raise_error(/missing/)
+  end
+
+  it "should not change an already defined constant" do
+    Object.const_set :FOO, 'foo'
+    define_config :FOO, 'bar'
+    FOO.should == 'foo'
+  end
+
+  describe :conversions do
+    def self.verify_conversion(env, default, expected)
+      it "should convert #{env.inspect}\tto\t#{expected.inspect}\twhen default is\t#{default.inspect}" do
+        ENV['FOO'] = env
+        define_config :FOO, default
+        FOO.should == expected
+      end
+    end
+
+    verify_conversion '12.3',  '456', '12.3'
+    verify_conversion '12.3',  456,   12
+    verify_conversion '12.3',  456.0, 12.3
+    verify_conversion 'foo',   :bar,  :foo
+    verify_conversion '0',     true,  false
+    verify_conversion 'false', true,  false
+    verify_conversion 'FALSE', true,  false
+    verify_conversion 'foo',   true,  false
+    verify_conversion '1',     true,  true
+    verify_conversion 'true',  true,  true
+    verify_conversion 'TRUE',  true,  true
+
+    verify_conversion '12.3', Fixnum,     12
+    verify_conversion '12.3', Float,      12.3
+    verify_conversion '12.3', String,     '12.3'
+    verify_conversion 'foo',  Symbol,     :foo
+    verify_conversion 'foo',  TrueClass,  false
+    verify_conversion 'foo',  FalseClass, false
+    verify_conversion '0',    TrueClass,  false
+    verify_conversion '0',    FalseClass, false
+    verify_conversion '1',    TrueClass,  true
+    verify_conversion '1',    FalseClass, true
+    verify_conversion 'true', TrueClass,  true
+    verify_conversion 'true', FalseClass, true
+    verify_conversion 'TRUE', TrueClass,  true
+    verify_conversion 'TRUE', FalseClass, true
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'constfig'
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: constfig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vitaly Kushner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-22 00:00:00.000000000 Z
+dependencies: []
+description: Simple Constnt Configuration for Ruby. Creates CONSTANTS with values
+  from ENV
+email:
+- vitaly@astrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- constfig.gemspec
+- lib/constfig.rb
+- lib/constfig/config.rb
+- lib/constfig/version.rb
+- spec/constfig/constfig_spec.rb
+- spec/spec_helper.rb
+homepage: http://astrails.com/blog/constfig
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Constnt configuration for Ruby.
+test_files:
+- spec/constfig/constfig_spec.rb
+- spec/spec_helper.rb