envar 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kane Baccigalupi
+
+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,88 @@
+# Envar
+
+Envar is a small shim between the ENV variables which are a pain to
+mock, and your app which needs to act differently according to
+environments. Under the covers Envar uses the Dotenv gem, which loads
+environmental variables from a .env file in your development
+environment. Envar does not so much, but it does it in a way that makes
+your life much easier!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'envar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install envar
+
+## Usage
+
+### With Rails:
+
+Envar was built to just work with Rails. If you are running in a
+development or a test environment, Envar will auto-load the .env file.
+Those variables will be available on the top level constant:
+
+With the `Rails.env = 'development'` and a .env file like so:
+
+    FACEBOOK_TOKEN=fb-for-life-YO
+
+Variables from the .env file will be loaded into the ENV variables
+space. Even better, the top level Envar space provides a helpful shim
+for accessing these variables so that you don't have to get all angle
+brackety.
+
+    Envar.facebook_token
+    # => fb-for-life-YO
+
+    # or the uglier uppercase version, if you prefer
+    Envar.FACEBOOK_TOKEN
+    # => fb-for-life-YO
+
+This is a lot easier to work with in tests. For example, in rspec it
+looks like this:
+
+    Envar.stub(:facebook_token).and_return('my_great_token')
+
+In ordinary circumstances you would need to set the ENV variables or
+assume in test knowlege about the .env variable. Or worse, stub out the
+:[] angle bracket methods. Try not to barf a little in your mouth if you
+are in that ugly situation. Instead, be happy with Envar.
+
+For extra configuration stuff, checkout the section below that details
+what to do without some Rails.
+
+### Without Rails:
+
+Set the Envar environment by hand:
+
+    Envar::Config.environment = 'development' # or whatever
+
+The development and test environment will trigger the loading of the
+local .env file. In other environments it is expected that you will have
+real environmental variables set.
+
+If you find you would rather set .env files in other environments, you
+can configure which environments should load the .env file:
+
+    Envar::Config.load_environments = ['development', 'staging']
+    # => ['development', 'staging']
+
+    # or to modify the defaults which are ['development', 'test']
+
+    Envar::Config.load_environments << ['staging']
+    # => ['development', 'test', 'staging']
+
+## 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 @@
+require "bundler/gem_tasks"

data/envar.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'envar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "envar"
+  spec.version       = Envar::VERSION
+  spec.authors       = ["Kane Baccigalupi"]
+  spec.email         = ["baccigalupi@gmail.com"]
+  spec.description   = %q{Envar is a simple wrapper around your environmental variables to ease development and testing}
+  spec.summary       = %q{Envar is a simple wrapper around your environmental variables to ease development and testing}
+  spec.homepage      = "http://github.com/baccigalupi/envar"
+  spec.license       = "MIT"
+
+  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|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'dotenv'
+  spec.add_dependency 'active_support'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/lib/envar.rb

@@ -0,0 +1,6 @@
+require 'active_support/core_ext/module/delegation'
+require 'dotenv'
+
+require "envar/version"
+require 'envar/config'
+require 'envar/accessor'

data/lib/envar/accessor.rb

@@ -0,0 +1,13 @@
+module Envar
+  class << self
+    def method_missing(name, *args, &block)
+      from_env(name)
+    end
+
+    def from_env(name)
+      name = name.to_s
+      Envar::Config.load
+      ENV[name] || ENV[name.upcase]
+    end
+  end
+end

data/lib/envar/config.rb

@@ -0,0 +1,41 @@
+module Envar
+  class Config
+    class << self
+      delegate :load_environments, :load_environments=,
+        :environment, :environment=,
+        :load?, :load, :loaded?,
+          to: :config
+
+      def config
+        @config ||= Envar::Config.new
+      end
+
+      def reset
+        @config = nil
+        config
+      end
+    end
+
+    attr_accessor :environment
+    attr_writer :load_environments
+
+    def load_environments
+      @load_environments ||= ['development', 'test']
+    end
+
+    def load?
+      load_environments.include?(environment)
+    end
+
+    def loaded?
+      @loaded
+    end
+
+    def load
+      if load? && !loaded?
+        Dotenv.load
+        @loaded = true
+      end
+    end
+  end
+end

data/lib/envar/version.rb

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

data/spec/accessor_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Envar, 'as an enivornment accessor' do
+  before do
+    Envar::Config.environment = 'test' # for autoloading of Dotenv
+  end
+
+  it "loads Dotenv when appropriate" do
+    Envar.facebook_token
+    ENV['FACEBOOK_TOKEN'].should_not be_nil
+  end
+
+  it "returns the value of the env variable" do
+    Envar.facebook_token.should == 'fb-for-life-YO'
+  end
+
+  it "works with upcase calls too" do
+    Envar.FACEBOOK_TOKEN.should == 'fb-for-life-YO'
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Envar::Config do
+  before do
+    Envar::Config.reset
+  end
+
+  it 'allows setting of the current environment' do
+    Envar::Config.environment.should be_nil
+    Envar::Config.environment = 'development'
+    Envar::Config.environment.should == 'development'
+  end
+
+  describe 'autoloading environments' do
+    it 'defaults to test and development' do
+      Envar::Config.load_environments.should =~ ['development', 'test']
+    end
+
+    it 'defaults can be modified' do
+      Envar::Config.load_environments << 'staging'
+      Envar::Config.load_environments.should =~ ['development', 'staging', 'test']
+    end
+
+    it "allows complete overriding of load environments" do
+      Envar::Config.load_environments = ['staging']
+      Envar::Config.load_environments.should == ['staging']
+    end
+  end
+
+  describe '.load?' do
+    it "will be true if the environment is in the load environments" do
+      Envar::Config.environment = 'test'
+      Envar::Config.load?.should == true
+    end
+
+    it 'will be false otherwise' do
+      Envar::Config.environment = 'foo'
+      Envar::Config.load?.should == false
+    end
+  end
+
+  describe '.load' do
+    context 'when the current environment is one of the load environments' do
+      before do
+        Envar::Config.environment = 'test'
+        Dotenv.stub(:load)
+      end
+
+      it "should load the Dotenv" do
+        Dotenv.should_receive(:load)
+        Envar::Config.load
+      end
+
+      it "should mark itself as loaded" do
+        Envar::Config.load
+        Envar::Config.loaded?.should == true
+      end
+
+      context 'after it has been loaded at least once' do
+        before do
+          Envar::Config.load
+        end
+
+        it "will not try to reload the Dotenv" do
+          Dotenv.should_not_receive(:load)
+          Envar::Config.load
+        end
+      end
+    end
+
+    context "when the environment should not be autoloaded" do
+      before do
+        Envar::Config.environment = 'foo'
+      end
+
+      it 'should not try to load the Dotenv' do
+        Dotenv.should_not_receive(:load)
+        Envar::Config.load
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$: << File.dirname(__FILE__) + "/../lib"
+require 'envar'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: envar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kane Baccigalupi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Envar is a simple wrapper around your environmental variables to ease
+  development and testing
+email:
+- baccigalupi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- envar.gemspec
+- lib/envar.rb
+- lib/envar/accessor.rb
+- lib/envar/config.rb
+- lib/envar/version.rb
+- spec/accessor_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/baccigalupi/envar
+licenses:
+- MIT
+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: Envar is a simple wrapper around your environmental variables to ease development
+  and testing
+test_files:
+- spec/accessor_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb