figaro 0.4.1 → 0.5.0

data/.travis.yml

@@ -8,7 +8,6 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ruby-head
 before_script:
   - unset RAILS_ENV
   - unset RACK_ENV

data/README.md

@@ -44,6 +44,16 @@ Pusher.key    = ENV["PUSHER_KEY"]
 Pusher.secret = ENV["PUSHER_SECRET"]
 ```
 
+In addition, you can access these same configuration values through Figaro itself:
+
+```ruby
+Pusher.app_id = Figaro.env.pusher_app_id
+Pusher.key    = Figaro.env.pusher_key
+Pusher.secret = Figaro.env.pusher_secret
+```
+
+But wait… I thought configuration via constant was bad! Well, this is different. Rather than storing a _copy_ of `ENV` internally, `Figaro.env` passes directly through to `ENV`, making it just like using `ENV` itself. So why two approaches? Having your configurations available via method calls makes it easy to stub them out in tests. Either way is fine. The choice is yours!
+
 If your app requires Rails-environment-specific configuration, you can also namespace your configuration under a key for `Rails.env`.
 
 ```yaml
@@ -82,6 +92,8 @@ Optionally, you can pass in the name of the Heroku app:
 rake figaro:heroku[my-awesome-app]
 ```
 
+Additionally, if `RAILS_ENV` is configured on your Heroku server, Figaro will use that environment automatically in determining your proper configuration.
+
 ## What if I'm not using Heroku?
 
 No problem. Just add `config/application.yml` to your production app on the server.

data/features/rails.feature

@@ -8,6 +8,14 @@ Feature: Rails
       task :hello => :environment do
         puts ["Hello", ENV["HELLO"]].compact.join(", ") << "!"
       end
+
+      task :nena => :environment do
+        puts [ENV["LUFTBALLOONS"], "Luftballoons"].compact.join(" ")
+      end
+
+      task :greet => :environment do
+        puts ([Figaro.env.greeting] * 3).join(", ") << "!"
+      end
       """
 
   Scenario: Has no application.yml
@@ -71,6 +79,14 @@ Feature: Rails
     When I run "rake hello RAILS_ENV=production"
     Then the output should be "Hello, users!"
 
+  Scenario: Has application.yml with non-string values
+    Given I create "config/application.yml" with:
+      """
+      LUFTBALLOONS: 99
+      """
+    When I run "rake nena"
+    Then the output should be "99 Luftballoons"
+
   Scenario: Generator creates and ignores application.yml file
     When I run "rails generate figaro:install"
     Then "config/application.yml" should exist
@@ -85,3 +101,11 @@ Feature: Rails
   Scenario: Includes Heroku Rake task
     When I run "rake --tasks figaro:heroku"
     Then the output should be "rake figaro:heroku[app]  # Configure Heroku according to application.yml"
+
+  Scenario: Accessing values through the Figaro.env proxy
+    Given I create "config/application.yml" with:
+      """
+      GREETING: Figaro
+      """
+    When I run "rake greet"
+    Then the output should be "Figaro, Figaro, Figaro!"

data/figaro.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name    = "figaro"
-  gem.version = "0.4.1"
+  gem.version = "0.5.0"
 
   gem.authors     = ["Steve Richert"]
   gem.email       = ["steve.richert@gmail.com"]

data/lib/figaro.rb

@@ -1,22 +1,28 @@
+require "figaro/env"
 require "figaro/railtie"
 
 module Figaro
   extend self
 
-  def env
-    flatten(raw).merge(raw.fetch(environment, {}))
+  def vars(custom_environment = nil)
+    env(custom_environment).map{|k,v| "#{k}=#{v}" }.sort.join(" ")
+  end
+
+  def env(custom_environment = nil)
+    environment = (custom_environment || self.environment).to_s
+    Figaro::Env.from(stringify(flatten(raw).merge(raw.fetch(environment, {}))))
   end
 
   def raw
-    yaml && YAML.load(yaml) || {}
+    @raw ||= yaml && YAML.load(yaml) || {}
   end
 
   def yaml
-    File.exist?(path) ? File.read(path) : nil
+    @yaml ||= File.exist?(path) ? File.read(path) : nil
   end
 
   def path
-    Rails.root.join("config/application.yml")
+    @path ||= Rails.root.join("config/application.yml")
   end
 
   def environment
@@ -28,4 +34,8 @@ module Figaro
   def flatten(hash)
     hash.reject{|_,v| Hash === v }
   end
+
+  def stringify(hash)
+    hash.inject({}){|h,(k,v)| h[k.to_s] = v.to_s; h }
+  end
 end

data/lib/figaro/env.rb

@@ -0,0 +1,15 @@
+module Figaro
+  class Env < Hash
+    def self.from(hash)
+      new.replace(hash)
+    end
+
+    def method_missing(method, *)
+      ENV.fetch(method.to_s.upcase){ super }
+    end
+
+    def respond_to?(method)
+      ENV.key?(method.to_s.upcase)
+    end
+  end
+end

data/lib/figaro/tasks.rake

@@ -1,9 +1,9 @@
 namespace :figaro do
   desc "Configure Heroku according to application.yml"
   task :heroku, [:app] => :environment do |_, args|
-    vars = Figaro.env.map{|k,v| "#{k}=#{v}" }.sort.join(" ")
-    command = "heroku config:add #{vars}"
-    command << " --app #{args[:app]}" if args[:app]
-    Kernel.system(command)
+    app = args[:app] ? " --app #{args[:app]}" : ""
+    rails_env = Kernel.system("heroku config:get RAILS_ENV#{app}").presence
+    Rails.env = rails_env if rails_env
+    Kernel.system("heroku config:add #{Figaro.vars}#{app}")
   end
 end

data/spec/figaro/env_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Figaro::Env do
+  before do
+    ENV["HELLO"] = "world"
+  end
+
+  after do
+    ENV.delete("HELLO")
+  end
+
+  it "makes ENV values accessible as methods" do
+    subject.HELLO.should == "world"
+  end
+
+  it "makes lowercase ENV values accessible as methods" do
+    subject.hello.should == "world"
+  end
+
+  it "raises an error if no ENV key matches" do
+    expect{ subject.goodbye }.to raise_error(NoMethodError)
+  end
+end

data/spec/figaro/tasks_spec.rb

@@ -2,16 +2,42 @@ require "spec_helper"
 
 describe "Figaro Rake tasks", :rake => true do
   describe "figaro:heroku" do
+    before do
+      @original_rails_env = ENV["RAILS_ENV"]
+      ENV["RAILS_ENV"] = "development"
+    end
+
+    after do
+      ENV["RAILS_ENV"] = @original_rails_env
+      Rails.send(:remove_instance_variable, :@_env)
+    end
+
     it "configures Heroku" do
       Figaro.stub(:env => {"HELLO" => "world", "FOO" => "bar"})
+      Kernel.stub(:system).with("heroku config:get RAILS_ENV").and_return("development")
       Kernel.should_receive(:system).once.with("heroku config:add FOO=bar HELLO=world")
       task.invoke
     end
 
     it "configures a specific Heroku app" do
       Figaro.stub(:env => {"HELLO" => "world", "FOO" => "bar"})
+      Kernel.stub(:system).with("heroku config:get RAILS_ENV --app my-app").and_return("development")
       Kernel.should_receive(:system).once.with("heroku config:add FOO=bar HELLO=world --app my-app")
       task.invoke("my-app")
     end
+
+    it "respects the Heroku's remote Rails environment" do
+      Figaro.stub(:raw => {"development" => {"HELLO" => "developers"}, "production" => {"HELLO" => "world"}})
+      Kernel.stub(:system).with("heroku config:get RAILS_ENV").and_return("production")
+      Kernel.should_receive(:system).once.with("heroku config:add HELLO=world")
+      task.invoke
+    end
+
+    it "defaults to the local Rails environment if not set remotely" do
+      Figaro.stub(:raw => {"development" => {"HELLO" => "developers"}, "production" => {"HELLO" => "world"}})
+      Kernel.stub(:system).with("heroku config:get RAILS_ENV").and_return("\n")
+      Kernel.should_receive(:system).once.with("heroku config:add HELLO=developers")
+      task.invoke
+    end
   end
 end

data/spec/figaro_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Figaro do
+  describe ".vars" do
+    it "dumps and sorts env" do
+      Figaro.stub(:raw => {"HELLO" => "world", "FOO" => "bar"})
+      Figaro.vars.should == "FOO=bar HELLO=world"
+    end
+
+    it "allows access to a particular environment" do
+      Figaro.stub(:raw => {"development" => {"HELLO" => "developers"}, "production" => {"HELLO" => "world"}})
+      Figaro.vars(:development).should == "HELLO=developers"
+      Figaro.vars(:production).should == "HELLO=world"
+    end
+  end
+
+  describe ".env" do
+    it "makes ENV values accessible" do
+      ENV["HELLO"] = "world"
+      Figaro.stub(:raw => {})
+      Figaro.env.hello.should == "world"
+      ENV.delete("HELLO")
+    end
+
+    it "allows access to a particular environment" do
+      Figaro.stub(:raw => {"development" => {"HELLO" => "developers"}, "production" => {"HELLO" => "world"}})
+      Figaro.env(:development).should == {"HELLO" => "developers"}
+      Figaro.env(:production).should == {"HELLO" => "world"}
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figaro
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -133,11 +133,14 @@ files:
 - gemfiles/rails31.gemfile
 - gemfiles/rails32.gemfile
 - lib/figaro.rb
+- lib/figaro/env.rb
 - lib/figaro/railtie.rb
 - lib/figaro/tasks.rake
 - lib/generators/figaro/install/install_generator.rb
 - lib/generators/figaro/install/templates/application.yml
+- spec/figaro/env_spec.rb
 - spec/figaro/tasks_spec.rb
+- spec/figaro_spec.rb
 - spec/spec_helper.rb
 - spec/support/rake.rb
 homepage: https://github.com/laserlemon/figaro
@@ -152,15 +155,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3428766527844493391
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3428766527844493391
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple Rails app configuration