daqing_figaro 1.2.1

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[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/heroku_set.rb

@@ -0,0 +1,33 @@
+require "figaro/cli/task"
+
+module Figaro
+  class CLI < Thor
+    class HerokuSet < Task
+      def run
+        system(env, command)
+      end
+
+      private
+
+      def command
+        "heroku config:set #{vars} #{for_app} #{for_remote}"
+      end
+
+      def for_app
+        options[:app] ? "--app=#{options[:app]}" : nil
+      end
+
+      def for_remote
+        options[:remote] ? "--remote=#{options[:remote]}" : 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/install/application.yml

@@ -0,0 +1,11 @@
+# Add configuration values here, as shown below.
+#
+# pusher_app_id: "2954"
+# pusher_key: 7381a978f7dd7f9a1117
+# pusher_secret: abdc3b896a0ffb85d373
+# stripe_api_key: sk_test_2J0l093xOyW72XUYJHE4Dv2r
+# stripe_publishable_key: pk_test_ro9jV5SNwGb1yYlQfzG17LHK
+#
+# production:
+#   stripe_api_key: sk_live_EeHnL644i6zo4Iyq4v1KdV9H
+#   stripe_publishable_key: pk_live_9lcthxpSIHbGwmdO941O1XVU

data/lib/figaro/cli/install.rb

@@ -0,0 +1,32 @@
+require "thor/group"
+
+module Figaro
+  class CLI < Thor
+    class Install < Thor::Group
+      include Thor::Actions
+
+      class_option "path",
+        aliases: ["-p"],
+        default: "config/application.yml",
+        desc: "Specify a configuration file path"
+
+      def self.source_root
+        File.expand_path("../install", __FILE__)
+      end
+
+      def create_configuration
+        copy_file("application.yml", options[:path])
+      end
+
+      def ignore_configuration
+        if File.exist?(".gitignore")
+          append_to_file(".gitignore", <<-EOF)
+
+# Ignore application configuration
+/#{options[:path]}
+EOF
+        end
+      end
+    end
+  end
+end

data/lib/figaro/cli/task.rb

@@ -0,0 +1,37 @@
+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 env
+        ENV.to_hash.update(configuration)
+      end
+
+      def configuration
+        application.configuration
+      end
+
+      def application
+        @application ||= Figaro::Application.new(options)
+      end
+
+      if defined? Bundler
+        def system(*)
+          Bundler.with_clean_env { super }
+        end
+      end
+    end
+  end
+end

data/lib/figaro/cli.rb

@@ -0,0 +1,42 @@
+require "thor"
+
+module Figaro
+  class CLI < Thor
+    # figaro install
+
+    desc "install", "Install Figaro"
+
+    method_option "path",
+      aliases: ["-p"],
+      default: "config/application.yml",
+      desc: "Specify a configuration file path"
+
+    def install
+      require "figaro/cli/install"
+      Install.start
+    end
+
+    # figaro heroku:set
+
+    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"
+    method_option "remote",
+      aliases: ["-r"],
+      desc: "Specify a Heroku git remote"
+
+    define_method "heroku:set" do
+      require "figaro/cli/heroku_set"
+      HerokuSet.run(options)
+    end
+  end
+end

data/lib/figaro/env.rb

@@ -0,0 +1,45 @@
+module Figaro
+  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, *)
+      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 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(key)
+    end
+
+    def get_value(key)
+      _, value = ::ENV.detect { |k, _| k.downcase == key }
+      value
+    end
+  end
+end

data/lib/figaro/error.rb

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

data/lib/figaro/rails/application.rb

@@ -0,0 +1,21 @@
+module Figaro
+  module Rails
+    class Application < Figaro::Application
+      private
+
+      def default_path
+        rails_not_initialized! unless ::Rails.root
+
+        ::Rails.root.join("config", "application.yml")
+      end
+
+      def default_environment
+        ::Rails.env
+      end
+
+      def rails_not_initialized!
+        raise RailsNotInitialized
+      end
+    end
+  end
+end

data/lib/figaro/rails/railtie.rb

@@ -0,0 +1,9 @@
+module Figaro
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.before_configuration do
+        Figaro.load
+      end
+    end
+  end
+end

data/lib/figaro/rails/tasks.rake

@@ -0,0 +1,6 @@
+namespace :figaro do
+  desc "Configure Heroku according to application.yml"
+  task :heroku, [:app] => :environment do |_, args|
+    Figaro::Tasks::Heroku.new(args[:app]).invoke
+  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

data/lib/figaro.rb

@@ -0,0 +1,32 @@
+require "figaro/error"
+require "figaro/env"
+require "figaro/application"
+
+module Figaro
+  extend self
+
+  attr_writer :adapter, :application
+
+  def env
+    Figaro::ENV
+  end
+
+  def adapter
+    @adapter ||= Figaro::Application
+  end
+
+  def application
+    @application ||= adapter.new
+  end
+
+  def load
+    application.load
+  end
+
+  def require_keys(*keys)
+    missing_keys = keys.flatten - ::ENV.keys
+    raise MissingKeys.new(missing_keys) if missing_keys.any?
+  end
+end
+
+require "figaro/rails"

data/spec/figaro/application_spec.rb

@@ -0,0 +1,262 @@
+require "tempfile"
+
+module Figaro
+  describe Application do
+    before do
+      allow_any_instance_of(Application).to receive(:default_path) { "/path/to/app/config/application.yml" }
+      allow_any_instance_of(Application).to receive(:default_environment) { "development" }
+    end
+
+    describe "#path" do
+      it "uses the default" do
+        application = Application.new
+
+        expect(application.path).to eq("/path/to/app/config/application.yml")
+      end
+
+      it "is configurable via initialization" do
+        application = Application.new(path: "/app/env.yml")
+
+        expect(application.path).to eq("/app/env.yml")
+      end
+
+      it "is configurable via setter" do
+        application = Application.new
+        application.path = "/app/env.yml"
+
+        expect(application.path).to eq("/app/env.yml")
+      end
+
+      it "casts to string" do
+        application = Application.new(path: Pathname.new("/app/env.yml"))
+
+        expect(application.path).to eq("/app/env.yml")
+        expect(application.environment).not_to be_a(Pathname)
+      end
+
+      it "follows a changing default" do
+        application = Application.new
+
+        expect {
+          allow(application).to receive(:default_path) { "/app/env.yml" }
+        }.to change {
+          application.path
+        }.from("/path/to/app/config/application.yml").to("/app/env.yml")
+      end
+    end
+
+    describe "#environment" do
+      it "uses the default" do
+        application = Application.new
+
+        expect(application.environment).to eq("development")
+      end
+
+      it "is configurable via initialization" do
+        application = Application.new(environment: "test")
+
+        expect(application.environment).to eq("test")
+      end
+
+      it "is configurable via setter" do
+        application = Application.new
+        application.environment = "test"
+
+        expect(application.environment).to eq("test")
+      end
+
+      it "casts to string" do
+        application = Application.new(environment: :test)
+
+        expect(application.environment).to eq("test")
+        expect(application.environment).not_to be_a(Symbol)
+      end
+
+      it "respects nil" do
+        application = Application.new(environment: nil)
+
+        expect(application.environment).to eq(nil)
+      end
+
+      it "follows a changing default" do
+        application = Application.new
+
+        expect {
+          allow(application).to receive(:default_environment) { "test" }
+        }.to change {
+          application.environment
+        }.from("development").to("test")
+      end
+    end
+
+    describe "#configuration" do
+      def yaml_to_path(yaml)
+        Tempfile.open("figaro") do |file|
+          file.write(yaml)
+          file.path
+        end
+      end
+
+      it "loads values from YAML" do
+        application = Application.new(path: yaml_to_path(<<-YAML))
+foo: bar
+YAML
+
+        expect(application.configuration).to eq("foo" => "bar")
+      end
+
+      it "merges environment-specific values" do
+        application = Application.new(path: yaml_to_path(<<-YAML), environment: "test")
+foo: bar
+test:
+  foo: baz
+YAML
+
+        expect(application.configuration).to eq("foo" => "baz")
+      end
+
+      it "drops unused environment-specific values" do
+        application = Application.new(path: yaml_to_path(<<-YAML), environment: "test")
+foo: bar
+test:
+  foo: baz
+production:
+  foo: bad
+YAML
+
+        expect(application.configuration).to eq("foo" => "baz")
+      end
+
+      it "is empty when no YAML file is present" do
+        application = Application.new(path: "/path/to/nowhere")
+
+        expect(application.configuration).to eq({})
+      end
+
+      it "is empty when the YAML file is blank" do
+        application = Application.new(path: yaml_to_path(""))
+
+        expect(application.configuration).to eq({})
+      end
+
+      it "is empty when the YAML file contains only comments" do
+        application = Application.new(path: yaml_to_path(<<-YAML))
+# Comment
+YAML
+
+        expect(application.configuration).to eq({})
+      end
+
+      it "processes ERB" do
+        application = Application.new(path: yaml_to_path(<<-YAML))
+foo: <%= "bar".upcase %>
+YAML
+
+        expect(application.configuration).to eq("foo" => "BAR")
+      end
+
+      it "handles an empty environment block" do
+        application = Application.new(path: yaml_to_path("development:"))
+
+        expect {
+          application.configuration
+        }.not_to raise_error
+      end
+
+      it "follows a changing default path" do
+        path_1 = yaml_to_path("foo: bar")
+        path_2 = yaml_to_path("foo: baz")
+
+        application = Application.new
+        allow(application).to receive(:default_path) { path_1 }
+
+        expect {
+          allow(application).to receive(:default_path) { path_2 }
+        }.to change {
+          application.configuration
+        }.from("foo" => "bar").to("foo" => "baz")
+      end
+
+      it "follows a changing default environment" do
+        application = Application.new(path: yaml_to_path(<<-YAML))
+foo: bar
+test:
+  foo: baz
+YAML
+        allow(application).to receive(:default_environment) { "development" }
+
+        expect {
+          allow(application).to receive(:default_environment) { "test" }
+        }.to change {
+          application.configuration
+        }.from("foo" => "bar").to("foo" => "baz")
+      end
+    end
+
+    describe "#load" do
+      let!(:application) { Application.new }
+
+      before do
+        allow(application).to receive(:configuration) { { "foo" => "bar" } }
+      end
+
+      it "merges values into ENV" do
+        expect {
+          application.load
+        }.to change {
+          ::ENV["foo"]
+        }.from(nil).to("bar")
+      end
+
+      it "skips keys (and warns) that have already been set externally" do
+        ::ENV["foo"] = "baz"
+
+        expect(application).to receive(:warn)
+
+        expect {
+          application.load
+        }.not_to change {
+          ::ENV["foo"]
+        }
+      end
+
+      it "sets keys that have already been set internally" do
+        application.load
+
+        allow(application).to receive(:configuration) { { "foo" => "baz" } }
+
+        expect {
+          application.load
+        }.to change {
+          ::ENV["foo"]
+        }.from("bar").to("baz")
+      end
+
+      it "warns when a key isn't a string" do
+        allow(application).to receive(:configuration) { { foo: "bar" } }
+
+        expect(application).to receive(:warn)
+
+        application.load
+      end
+
+      it "warns when a value isn't a string" do
+        allow(application).to receive(:configuration) { { "foo" => ["bar"] } }
+
+        expect(application).to receive(:warn)
+
+        application.load
+      end
+
+      it "allows nil values" do
+        allow(application).to receive(:configuration) { { "foo" => nil } }
+
+        expect {
+          application.load
+        }.not_to change {
+          ::ENV["foo"]
+        }
+      end
+    end
+  end
+end