figaro 0.7.0 → 1.0.0.rc1

data/Rakefile

@@ -1,17 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "cucumber/rake/task"
 
 RSpec::Core::RakeTask.new(:spec)
-Cucumber::Rake::Task.new(:cucumber)
 
-task :default => [:spec, :cucumber]
-
-if ENV["COVERAGE"]
-  Rake::Task[:default].enhance do
-    require "simplecov"
-    require "coveralls"
-
-    Coveralls::SimpleCov::Formatter.new.format(SimpleCov.result)
-  end
-end
+task default: :spec

data/bin/figaro

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "figaro/cli"
+
+Figaro::CLI.start

data/figaro.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name    = "figaro"
-  gem.version = "0.7.0"
+  gem.version = "1.0.0.rc1"
 
   gem.author      = "Steve Richert"
   gem.email       = "steve.richert@gmail.com"
@@ -11,10 +11,14 @@ Gem::Specification.new do |gem|
   gem.homepage    = "https://github.com/laserlemon/figaro"
   gem.license     = "MIT"
 
-  gem.add_dependency "bundler", "~> 1.0"
   gem.add_dependency "rails", ">= 3", "< 5"
+  gem.add_dependency "thor", "~> 0.14"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.test_files    = gem.files.grep(/^(features|spec)/)
-  gem.require_paths = ["lib"]
+  gem.add_development_dependency "bundler", "~> 1.5"
+  gem.add_development_dependency "rake", "~> 10.1"
+
+  gem.files      = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(/^spec/)
+
+  gem.executables << "figaro"
 end

data/gemfiles/rails30.gemfile

@@ -1,12 +1,11 @@
 source "https://rubygems.org"
 
-gemspec :path => "../"
+gemspec path: "../"
 
 gem "rails", "~> 3.0.2"
 
 group :test do
   gem "aruba", "~> 0.5"
-  gem "cucumber", "~> 1.3"
-  gem "rake", "~> 10.0"
-  gem "rspec", "~> 2.13"
+  gem "rspec", "~> 2.14"
+  gem "sqlite3", "~> 1.3"
 end

data/gemfiles/rails31.gemfile

@@ -1,12 +1,11 @@
 source "https://rubygems.org"
 
-gemspec :path => "../"
+gemspec path: "../"
 
 gem "rails", "~> 3.1.0"
 
 group :test do
   gem "aruba", "~> 0.5"
-  gem "cucumber", "~> 1.3"
-  gem "rake", "~> 10.0"
-  gem "rspec", "~> 2.13"
+  gem "rspec", "~> 2.14"
+  gem "sqlite3", "~> 1.3"
 end

data/gemfiles/rails32.gemfile

@@ -1,12 +1,11 @@
 source "https://rubygems.org"
 
-gemspec :path => "../"
+gemspec path: "../"
 
 gem "rails", "~> 3.2.0"
 
 group :test do
   gem "aruba", "~> 0.5"
-  gem "cucumber", "~> 1.3"
-  gem "rake", "~> 10.0"
-  gem "rspec", "~> 2.13"
+  gem "rspec", "~> 2.14"
+  gem "sqlite3", "~> 1.3"
 end

data/gemfiles/rails40.gemfile

@@ -1,15 +1,11 @@
 source "https://rubygems.org"
 
-gemspec :path => "../"
+gemspec path: "../"
 
 gem "rails", "~> 4.0.0"
 
 group :test do
   gem "aruba", "~> 0.5"
-  gem "coveralls", "~> 0.6", :require => false
-  gem "cucumber", "~> 1.3"
-  gem "json", "~> 1.7.7"
-  gem "rake", "~> 10.0"
-  gem "rspec", "~> 2.13"
-  gem "simplecov", "~> 0.7", :require => false
+  gem "rspec", "~> 2.14"
+  gem "sqlite3", "~> 1.3"
 end

data/gemfiles/rails41.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 4.1.0"
+
+group :test do
+  gem "aruba", "~> 0.5"
+  gem "rspec", "~> 2.14"
+  gem "sqlite3", "~> 1.3"
+end

data/lib/figaro.rb

@@ -1,45 +1,32 @@
-require "shellwords"
+require "figaro/error"
 require "figaro/env"
-require "figaro/railtie"
-require "figaro/tasks"
+require "figaro/application"
 
 module Figaro
   extend self
 
-  def vars(custom_environment = nil)
-    env(custom_environment).map { |key, value|
-      "#{key}=#{Shellwords.escape(value)}"
-    }.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
+  attr_writer :adapter, :application
 
-  def raw
-    @raw ||= yaml && YAML.load(yaml) || {}
+  def env
+    Figaro::ENV
   end
 
-  def yaml
-    @yaml ||= File.exist?(path) ? ERB.new(File.read(path)).result : nil
+  def adapter
+    @adapter ||= Figaro::Application
   end
 
-  def path
-    @path ||= Rails.root.join("config", "application.yml")
+  def application
+    @application ||= adapter.new
   end
 
-  def environment
-    Rails.env
+  def load
+    application.load
   end
 
-  private
-
-  def flatten(hash)
-    hash.reject { |_, v| Hash === v }
-  end
-
-  def stringify(hash)
-    hash.inject({}) { |h, (k, v)| h[k.to_s] = v.nil? ? nil : v.to_s; h }
+  def require(*keys)
+    missing_keys = keys.flatten - ::ENV.keys
+    raise MissingKeys.new(missing_keys) if missing_keys.any?
   end
 end
+
+require "figaro/rails"

data/lib/figaro/application.rb

@@ -0,0 +1,91 @@
+require "erb"
+require "yaml"
+
+module Figaro
+  class Application
+    FIGARO_ENV_PREFIX = "_FIGARO_"
+
+    include Enumerable
+
+    def initialize(options = {})
+      @options = options.inject({}) { |m, (k, v)| m[k.to_sym] = v; m }
+    end
+
+    def path
+      @options.fetch(:path) { default_path }.to_s
+    end
+
+    def path=(path)
+      @options[:path] = path
+    end
+
+    def environment
+      environment = @options.fetch(:environment) { default_environment }
+      environment.nil? ? nil : environment.to_s
+    end
+
+    def environment=(environment)
+      @options[:environment] = environment
+    end
+
+    def configuration
+      global_configuration.merge(environment_configuration)
+    end
+
+    def load
+      each do |key, value|
+        skip?(key) ? key_skipped!(key) : set(key, value)
+      end
+    end
+
+    def each(&block)
+      configuration.each(&block)
+    end
+
+    private
+
+    def default_path
+      raise NotImplementedError
+    end
+
+    def default_environment
+      nil
+    end
+
+    def raw_configuration
+      (@parsed ||= Hash.new { |hash, path| hash[path] = parse(path) })[path]
+    end
+
+    def parse(path)
+      File.exist?(path) && YAML.load(ERB.new(File.read(path)).result) || {}
+    end
+
+    def global_configuration
+      raw_configuration.reject { |_, value| value.is_a?(Hash) }
+    end
+
+    def environment_configuration
+      raw_configuration.fetch(environment) { {} }
+    end
+
+    def set(key, value)
+      non_string_configuration!(key) unless key.is_a?(String)
+      non_string_configuration!(value) unless value.is_a?(String) || value.nil?
+
+      ::ENV[key.to_s] = value.nil? ? nil : value.to_s
+      ::ENV[FIGARO_ENV_PREFIX + key.to_s] = value.nil? ? nil: value.to_s
+    end
+
+    def skip?(key)
+      ::ENV.key?(key.to_s) && !::ENV.key?(FIGARO_ENV_PREFIX + key.to_s)
+    end
+
+    def non_string_configuration!(value)
+      warn "WARNING: Use strings for Figaro configuration. #{value.inspect} was converted to #{value.to_s.inspect}."
+    end
+
+    def key_skipped!(key)
+      warn "WARNING: Skipping key #{key.inspect}. Already set in ENV."
+    end
+  end
+end

data/lib/figaro/cli.rb

@@ -0,0 +1,24 @@
+require "thor"
+
+require "figaro/cli/heroku_set"
+
+module Figaro
+  class CLI < Thor
+    desc "heroku:set", "Send Figaro configuration to Heroku"
+
+    method_option "app",
+      aliases: ["-a"],
+      desc: "Specify a Heroku app"
+    method_option "environment",
+      aliases: ["-e"],
+      desc: "Specify an application environment"
+    method_option "path",
+      aliases: ["-p"],
+      default: "config/application.yml",
+      desc: "Specify a configuration file path"
+
+    define_method "heroku:set" do
+      HerokuSet.run(options)
+    end
+  end
+end

data/lib/figaro/cli/heroku_set.rb

@@ -0,0 +1,29 @@
+require "figaro/cli/task"
+
+module Figaro
+  class CLI < Thor
+    class HerokuSet < Task
+      def run
+        system(configuration, command)
+      end
+
+      private
+
+      def command
+        "heroku config:set #{vars} #{for_app}"
+      end
+
+      def for_app
+        options[:app] ? "--app=#{options[:app]}" : nil
+      end
+
+      def vars
+        configuration.keys.map { |k| var(k) }.join(" ")
+      end
+
+      def var(key)
+        Gem.win_platform? ? %(#{key}="%#{key}%") : %(#{key}="$#{key}")
+      end
+    end
+  end
+end

data/lib/figaro/cli/task.rb

@@ -0,0 +1,27 @@
+require "figaro/application"
+
+module Figaro
+  class CLI < Thor
+    class Task
+      attr_reader :options
+
+      def self.run(options = {})
+        new(options).run
+      end
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      private
+
+      def configuration
+        application.configuration
+      end
+
+      def application
+        @application ||= Figaro::Application.new(options)
+      end
+    end
+  end
+end

data/lib/figaro/env.rb

@@ -1,16 +1,45 @@
 module Figaro
-  class Env < Hash
-    def self.from(hash)
-      new.replace(hash)
+  module ENV
+    extend self
+
+    def respond_to?(method, *)
+      key, punctuation = extract_key_from_method(method)
+
+      case punctuation
+      when "!" then has_key?(key) || super
+      when "?", nil then true
+      else super
+      end
     end
 
+    private
+
     def method_missing(method, *)
-      pair = ENV.detect { |k, _| k.upcase == method.to_s.upcase }
-      pair ? pair[1] : super
+      key, punctuation = extract_key_from_method(method)
+
+      case punctuation
+      when "!" then send(key) || missing_key!(key)
+      when "?" then !!send(key)
+      when nil then get_value(key)
+      else super
+      end
     end
 
-    def respond_to?(method, *)
-      ENV.keys.any? { |k| k.upcase == method.to_s.upcase } || super
+    def extract_key_from_method(method)
+      method.to_s.downcase.match(/^(.+?)([!?=])?$/).captures
+    end
+
+    def has_key?(key)
+      ::ENV.any? { |k, _| k.downcase == key }
+    end
+
+    def missing_key!(key)
+      raise MissingKey.new("Missing required Figaro configuration key #{key.inspect}.")
+    end
+
+    def get_value(key)
+      _, value = ::ENV.detect { |k, _| k.downcase == key }
+      value
     end
   end
 end

data/lib/figaro/error.rb

@@ -0,0 +1,12 @@
+module Figaro
+  class Error < StandardError; end
+
+  class RailsNotInitialized < Error; end
+  class MissingKey < Error; end
+
+  class MissingKeys < Error
+    def initialize(keys)
+      super("Missing required configuration keys: #{keys.inspect}")
+    end
+  end
+end

data/lib/figaro/rails.rb

@@ -0,0 +1,9 @@
+begin
+  require "rails"
+rescue LoadError
+else
+  require "figaro/rails/application"
+  require "figaro/rails/railtie"
+
+  Figaro.adapter = Figaro::Rails::Application
+end