config 0.0.1 → 1.0.0.beta1

data/Rakefile

@@ -0,0 +1,42 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+
+  Bundler::GemHelper.install_tasks
+
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+##
+# Testing
+#
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# Test for multiple Rails scenarios
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  require "appraisal"
+
+  task :default => :appraisal
+else
+  task :default => :spec
+end
+
+##
+# Documentation
+#
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "Config #{Config::VERSION}"
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.*')
+  rdoc.rdoc_files.include('CHANGELOG.*')
+  rdoc.rdoc_files.include('LICENSE.*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config.gemspec

@@ -0,0 +1,46 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require 'config/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name             = "config"
+  s.version          = Config::VERSION
+  s.date             = Time.now.strftime '%F'
+  s.authors          = ["Jacques Crocker", "Fred Wu", "Piotr Kuczynski"]
+  s.email            = ["railsjedi@gmail.com", "ifredwu@gmail.com", "piotr.kuczynski@gmail.com"]
+  s.summary          = "Easiest way to add multi-environment yaml settings to Rails, Sinatra, Pandrino and other ruby projects."
+  s.description      = "Easiest way to add multi-environment yaml settings to Rails, Sinatra, Pandrino and other ruby projects."
+  s.homepage         = "https://github.com/railsconfig/config"
+  s.license          = "MIT"
+  s.extra_rdoc_files = ["README.md"]
+  s.rdoc_options     = ["--charset=UTF-8"]
+
+  s.files            = `git ls-files`.split($/)
+
+  s.executables      = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files       = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths    = ["lib"]
+
+  s.add_dependency "activesupport",           ">= 3.0"
+  s.add_dependency "deep_merge",              "~> 1.0.0"
+
+  s.add_development_dependency "bundler",     "~> 1.10.5"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rdoc"
+  s.add_development_dependency "pry"
+
+  # Testing
+  s.add_development_dependency "appraisal",   "~> 2.0.2"
+  s.add_development_dependency "rails",       "~> 4.2.3"
+  s.add_development_dependency "rspec",       "~> 3.3.0"
+  s.add_development_dependency "rspec-rails", "~> 3.3.3"
+  s.add_development_dependency "test-unit",   "~> 3.1.3"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rubocop"
+
+  if ENV['TRAVIS']
+    s.add_development_dependency "codeclimate-test-reporter"
+  end
+end

data/gemfiles/rails_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "3.2.22"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1.12"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2.3"
+
+gemspec :path => "../"

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0.13"
+
+gemspec :path => "../"

data/lib/config.rb

@@ -0,0 +1,64 @@
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'config/options'
+require 'config/version'
+require 'config/engine' if defined?(::Rails)
+require 'config/sources/yaml_source'
+require 'deep_merge'
+
+module Config
+  # ensures the setup only gets run once
+  @@_ran_once = false
+
+  mattr_accessor :const_name, :use_env
+  @@const_name = "Settings"
+  @@use_env = false
+
+  def self.setup
+    yield self if @@_ran_once == false
+    @@_ran_once = true
+  end
+
+  # Create a populated Options instance from a yaml file. If a second yaml file is given, then the sections of that
+  # file will overwrite existing sections of the first file.
+  def self.load_files(*files)
+    config = Options.new
+
+    # add yaml sources
+    [files].flatten.compact.uniq.each do |file|
+      config.add_source!(file.to_s)
+    end
+
+    config.load!
+    config.load_env! if @@use_env
+    config
+  end
+
+  # Loads and sets the settings constant!
+  def self.load_and_set_settings(*files)
+    Kernel.send(:remove_const, Config.const_name) if Kernel.const_defined?(Config.const_name)
+    Kernel.const_set(Config.const_name, Config.load_files(files))
+  end
+
+  def self.setting_files(config_root, env)
+    [
+      File.join(config_root, "settings.yml").to_s,
+      File.join(config_root, "settings", "#{env}.yml").to_s,
+      File.join(config_root, "environments", "#{env}.yml").to_s,
+
+      File.join(config_root, "settings.local.yml").to_s,
+      File.join(config_root, "settings", "#{env}.local.yml").to_s,
+      File.join(config_root, "environments", "#{env}.local.yml").to_s
+    ].freeze
+  end
+
+  def self.reload!
+    Kernel.const_get(Config.const_name).reload!
+  end
+end
+
+# add rails integration
+require('config/integration/rails') if defined?(::Rails)
+
+# add sinatra integration
+require('config/integration/sinatra') if defined?(::Sinatra)

data/lib/config/engine.rb

@@ -0,0 +1,5 @@
+module Config
+  class Engine < ::Rails::Engine
+    isolate_namespace Config
+  end
+end

data/lib/config/integration/rails.rb

@@ -0,0 +1,36 @@
+module Config
+  module Integration
+    module Rails
+      if defined?(::Rails::Railtie)
+        class Railtie < ::Rails::Railtie
+          # Load rake tasks (eg. Heroku)
+          rake_tasks do
+            Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+          end
+
+          config.before_configuration { preload }
+
+          def preload
+            # Manually load the custom initializer before everything else
+            initializer = ::Rails.root.join("config", "initializers", "config.rb")
+            require initializer if File.exist?(initializer)
+
+            # Parse the settings before any of the initializers
+            Config.load_and_set_settings(
+              Config.setting_files(::Rails.root.join("config"), ::Rails.env)
+            )
+          end
+
+          # Rails Dev environment should reload the Settings on every request
+          if ::Rails.env.development?
+            initializer :config_reload_on_development do
+              ActionController::Base.class_eval do
+                prepend_before_filter { ::Config.reload! }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/config/integration/sinatra.rb

@@ -0,0 +1,26 @@
+require "config/rack/reloader"
+
+module Config
+  # provide helper to register within your Sinatra app
+  #
+  # set :root, File.dirname(__FILE__)
+  # register Config
+  #
+  def self.registered(app)
+    app.configure do |inner_app|
+
+      env = inner_app.environment || ENV["RACK_ENV"]
+      root = inner_app.root
+
+      # use Padrino settings if applicable
+      if defined?(Padrino)
+        env = Padrino.env
+        root = Padrino.root
+      end
+
+      Config.load_and_set_settings(Config.setting_files(File.join(root, 'config'), env))
+
+      inner_app.use(::Config::Rack::Reloader) if inner_app.development?
+    end
+  end
+end

data/lib/config/options.rb

@@ -0,0 +1,157 @@
+require 'ostruct'
+module Config
+  class Options < OpenStruct
+    include Enumerable
+
+    def keys
+      marshal_dump.keys
+    end
+
+    def empty?
+      marshal_dump.empty?
+    end
+
+    def add_source!(source)
+      # handle yaml file paths
+      source = (Sources::YAMLSource.new(source)) if source.is_a?(String)
+
+      @config_sources ||= []
+      @config_sources << source
+    end
+
+    def prepend_source!(source)
+      source = (Sources::YAMLSource.new(source)) if source.is_a?(String)
+
+      @config_sources ||= []
+      @config_sources.unshift(source)
+    end
+
+    def reload_env!
+      return self if ENV.nil? || ENV.empty?
+      conf = Hash.new
+      ENV.each do |key, value|
+        next unless key.to_s.index(Config.const_name) == 0
+        hash = value
+        key.to_s.split('.').reverse.each do |element|
+          hash = {element => hash}
+        end
+        DeepMerge.deep_merge!(hash, conf, :preserve_unmergeables => false)
+      end
+
+      merge!(conf[Config.const_name] || {})
+    end
+
+    alias :load_env! :reload_env!
+
+    # look through all our sources and rebuild the configuration
+    def reload!
+      conf = {}
+      @config_sources.each do |source|
+        source_conf = source.load
+
+        if conf.empty?
+          conf = source_conf
+        else
+          DeepMerge.deep_merge!(source_conf, conf, :preserve_unmergeables => false)
+        end
+      end
+
+      # swap out the contents of the OStruct with a hash (need to recursively convert)
+      marshal_load(__convert(conf).marshal_dump)
+
+      reload_env! if Config.use_env
+
+      return self
+    end
+
+    alias :load! :reload!
+
+    def reload_from_files(*files)
+      Config.load_and_set_settings(files)
+      reload!
+    end
+
+    def to_hash
+      result = {}
+      marshal_dump.each do |k, v|
+        if v.instance_of? Config::Options
+          result[k] = v.to_hash
+        elsif v.instance_of? Array
+          result[k] = descend_array(v)
+        else
+          result[k] = v
+        end
+      end
+      result
+    end
+
+    def each(*args, &block)
+      marshal_dump.each(*args, &block)
+    end
+
+    def to_json(*args)
+      require "json" unless defined?(JSON)
+      to_hash.to_json(*args)
+    end
+
+    def merge!(hash)
+      current = to_hash
+      DeepMerge.deep_merge!(hash.dup, current)
+      marshal_load(__convert(current).marshal_dump)
+      self
+    end
+
+    # Some keywords that don't play nicely with OpenStruct
+    SETTINGS_RESERVED_NAMES = %w{select collect}
+
+    # An alternative mechanism for property access.
+    # This let's you do foo['bar'] along with foo.bar.
+    def [](param)
+      return super if SETTINGS_RESERVED_NAMES.include?(param)
+      send("#{param}")
+    end
+
+    def []=(param, value)
+      send("#{param}=", value)
+    end
+
+    SETTINGS_RESERVED_NAMES.each do |name|
+      define_method name do
+        self[name]
+      end
+    end
+
+    protected
+
+    def descend_array(array)
+      array.length.times do |i|
+        value = array[i]
+        if value.instance_of? Config::Options
+          array[i] = value.to_hash
+        elsif value.instance_of? Array
+          array[i] = descend_array(value)
+        end
+      end
+      array
+    end
+
+    # Recursively converts Hashes to Options (including Hashes inside Arrays)
+    def __convert(h) #:nodoc:
+      s = self.class.new
+
+      h.each do |k, v|
+        k = k.to_s if !k.respond_to?(:to_sym) && k.respond_to?(:to_s)
+        s.new_ostruct_member(k)
+
+        if v.is_a?(Hash)
+          v = v["type"] == "hash" ? v["contents"] : __convert(v)
+        elsif v.is_a?(Array)
+          v = v.collect { |e| e.instance_of?(Hash) ? __convert(e) : e }
+        end
+
+        s.send("#{k}=".to_sym, v)
+      end
+      s
+    end
+  end
+end

data/lib/config/rack/reloader.rb

@@ -0,0 +1,15 @@
+module Config
+  module Rack
+    # Rack middleware the reloads Config on every request (only use in dev mode)
+    class Reloader
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Config.reload!
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/config/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Config
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end