testcloud-config 0.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ebd18bb831a726e746e107b98eb182fbf580c8c
+  data.tar.gz: 596551c4465862283ddc2233e7826f30cb7a3d48
+SHA512:
+  metadata.gz: 0653bad60937806ac6893bd76bf579afc24a0674782971d17719ea9bd4562c0d4b258729303ecc34b7f81ead7a78cd948e4bae76b76f1e4b000ee63e9d86f7c4
+  data.tar.gz: 93cec4818cf79d57c54a97894a7040727d84836933764985de7df5c6af4120d8e37e98cac08b127c7345fa42a7828e124d8b28a07a077e0d59660b11e917feb7

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'cucumber', '~> 1.3.16'
+  gem 'rspec', '~> 3.0.0'
+  gem 'shoulda', '~> 3.5.0'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    testcloud-config (0.0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    coderay (1.1.0)
+    cucumber (1.3.16)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.1)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.6.2)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4.1)
+  bundler (~> 1.7)
+  cucumber (~> 1.3.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0.0)
+  shoulda (~> 3.5.0)
+  testcloud-config!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Faucett
+
+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,58 @@
+[![Build Status](https://travis-ci.org/testCloud/testcloud-config.svg?branch=master)](https://travis-ci.org/testCloud/testcloud-config)
+
+## Testcloud Config
+
+Testcloud config is a library for managing configuration options in gems, rails apps, and
+generic ruby projects.
+
+It currently handles loading yaml files based off of an environment.
+If you are not using environments in your project, it requires you to set a 'default'
+as your root yaml node.
+
+#### Usage
+
+Say we have this directory structure:
+```bash
+config/
+  redis.yml
+```
+
+And redis.yml looks like this:
+```yaml
+test:
+  url: 'redis://localhost:6378'
+development:
+  url: 'redis://password@localhost:6379'
+production:
+  url: 'redis://other-pw@production.server:4000'
+```
+
+Then we can load the file like so:
+
+```ruby
+
+Testcloud::Config.setup do |config|
+  config.environment = 'test'
+
+  # set the path to your root config directory
+  config.config_directory = '/path/to/config'
+
+  # set the name of the class you want to use
+  # to access the parsed config hash
+  config.config_classname = 'Configuration'
+
+  # automatically load/parse files after
+  # this setup block finishes executing
+  config.eager_load = true
+end
+```
+
+And now we can do the following:
+
+```ruby
+Configuration.redis.url #=> 'redis://localhost:6378'
+# oops, redis.yml had the wrong port
+# we edit redis.yml and then call reload!
+Testcloud::Config.reload!
+Configuration.redis.url #=> 'redis://localhost:6379'
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/lib/testcloud/config.rb

@@ -0,0 +1,26 @@
+require 'forwardable'
+require 'monitor'
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/slice'
+
+module Testcloud
+  module Config
+    require 'testcloud/config/errors'
+    require 'testcloud/config/manager'
+    require 'testcloud/config/settings'
+    require 'testcloud/config/configuration'
+    require 'testcloud/config/loader'
+
+    class << self
+      def setup(options = {}, &block)
+        lock = Monitor.new
+        lock.synchronize do
+          Manager.new(options, &block)
+        end
+      end
+    end
+
+  end
+end

data/lib/testcloud/config/configuration.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'forwardable'
+
+module Testcloud
+  module Config
+
+    # thin wrapper around the internal hash representation object
+    class Configuration
+      extend Forwardable
+
+      attr_reader :hash
+
+      def_delegators :hash, :key?, :[], :[]=, :to_hash, :to_json, :inspect
+
+      def initialize(hash)
+        @hash = hash.respond_to?(:with_indifferent_access) ? hash.with_indifferent_access : hash
+      end
+
+      protected
+
+        def method_missing(method_name, *args, &block)
+          method_name = method_name.to_s[0..-2] if method_name.to_s[-1] == '?'
+          if key?(method_name)
+            value = hash[method_name]
+            value.is_a?(Hash) ? Testcloud::Config::Configuration.new(value) : value
+          else
+            super(method_name, *args, &block)
+          end
+        end
+    end
+  end # Config
+end # Testcloud

data/lib/testcloud/config/errors.rb

@@ -0,0 +1,17 @@
+module Testcloud
+  module Config
+    module Errors
+
+      # raised when attempting to read the environment and no environment has been set
+      class NoEnvironmentError < StandardError; ;end
+
+      # raised when attempting to read the config_directory
+      # and no config_directory has been set
+      class ConfigDirectoryError < StandardError; ;end
+
+      # raised when trying to set config_name if something other than a String is passed.
+      class ConfigClassnameError < StandardError; ;end
+
+    end
+  end
+end

data/lib/testcloud/config/gem_version.rb

@@ -0,0 +1,15 @@
+module Testcloud
+  module Config
+    module VERSION
+      def self.gem_version
+        @gem_version ||= Gem::Version.new(STRING)
+      end
+
+      MAJOR = 0
+      MINOR = 0
+      PATCH = 0
+      PRE   = 1
+      STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze
+    end
+  end
+end

data/lib/testcloud/config/loader.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+require 'erb'
+
+
+module Testcloud
+  module Config
+    class Loader
+
+      extend Forwardable
+
+      def_delegators :@settings, :environment, :config_directory
+
+      def initialize(settings = nil)
+        @settings = settings
+      end
+
+      def load_configuration
+        _load_configuration(config_directory, environment)
+      end
+
+      private
+
+        def _load_configuration(dir, env)
+          config = load_from_file(dir, env)
+          config.deep_merge!(load_from_directory(dir, env))
+          Testcloud::Config::Configuration.new(config)
+        end
+
+        def load_from_file(dir, env)
+          config = {}
+          if File.exists?(file = "#{dir}.yml")
+            config_file = YAML.load(ERB.new(IO.read(file)).result)
+            config = config_file[:default] || config_file['default'] || {}
+            config.deep_merge!(config_file[env] || {})
+          end
+          config
+        end
+
+        def load_from_directory(dir, env)
+          config = {}
+          if File.directory?(dir)
+            Dir["#{dir}/*"].each do |entry|
+              namespace = namespace_for_entry(dir, entry)
+              config.deep_merge!(namespace => _load_configuration(entry.gsub(/.yml$/, ''), env))
+            end
+          end
+          config
+        end
+
+        def namespace_for_entry(dir, entry)
+          entry.gsub(/^#{dir}\/?/, '').gsub(/\.yml$/, '')
+        end
+
+    end
+  end
+end

data/lib/testcloud/config/manager.rb

@@ -0,0 +1,37 @@
+module Testcloud
+  module Config
+
+    class Manager
+
+      attr_reader :settings, :configuration, :loader
+
+      def initialize(options = {}, &block)
+        setup(options, &block)
+      end
+
+      def load!
+        @configuration = nil
+        @configuration = loader.load_configuration
+        set_config_constant!(@configuration) if settings.config_classname?
+      end
+
+      alias :reload! :load!
+
+      def setup(options = {}, &block)
+        @settings = Settings.new(options)
+        yield(@settings) if block_given?
+        @loader = Loader.new(@settings)
+        load! if settings.eager_load?
+      end
+
+      private
+        def set_config_constant!(config)
+          if Kernel.const_defined?(settings.config_classname)
+            Kernel.__send__(:remove_const, settings.config_classname)
+          end
+          Kernel.const_set(settings.config_classname, config)
+        end
+
+    end
+  end
+end

data/lib/testcloud/config/settings.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+module Testcloud
+  module Config
+    class Settings
+
+      PUBLIC_API_METHODS = [:environment, :config_directory, :config_classname, :eager_load].freeze
+
+      def initialize(options = {})
+        @eager_load = true # always eager_load unless overridden
+        options.slice!(*PUBLIC_API_METHODS)
+        options.each do |method_name, value|
+          api_method = "#{method_name}="
+          self.public_send(api_method, value) if self.respond_to?(api_method)
+        end
+      end
+
+      def environment=(env)
+        @environment = env.respond_to?(:call) ? env.call : env
+      end
+
+      def environment
+        unless @environment
+          raise Testcloud::Config::Errors::NoEnvironmentError.new('environment must be defined.')
+        end
+        @environment
+      end
+
+      def config_directory=(dir)
+        unless File.exists?(dir) && File.directory?(dir)
+          raise Testcloud::Config::Errors::ConfigDirectoryError.new("config_directory: #{dir.inspect} must exist and be a directory.")
+        end
+        @config_directory = dir
+      end
+
+      def config_directory
+        unless @config_directory
+          raise Testcloud::Config::Errors::ConfigDirectoryError.new('config_directory must be defined.')
+        end
+        @config_directory
+      end
+
+      def config_classname=(konst)
+        unless konst.is_a?(String)
+          raise Testcloud::Config::Errors::ConfigClassnameError.new("config_classname: #{konst.inspect} must be a String")
+        end
+        @config_classname = konst
+      end
+
+      def config_classname
+        @config_classname
+      end
+
+      def config_classname?
+        !!config_classname
+      end
+
+      # allow eager loading i.e. load configuration files directly after setup block
+      def eager_load=(value)
+        @eager_load = value
+      end
+
+      # default eager_load to false
+      def eager_load
+        !!@eager_load
+      end
+
+      alias :eager_load? :eager_load
+    end
+  end
+end

data/lib/testcloud/config/version.rb

@@ -0,0 +1,15 @@
+require_relative 'gem_version'
+
+module Testcloud
+  module Config
+    class << self
+      def gem_version
+        VERSION.gem_version
+      end
+
+      def version
+        VERSION::STRING
+      end
+    end
+  end
+end

data/lib/testcloud_config.rb

@@ -0,0 +1 @@
+require 'testcloud/config'

data/spec/fixtures/configs/one_level/redis.yml

@@ -0,0 +1,8 @@
+test:
+  url: 'redis://localhost.test:6379'
+development:
+  url: 'redis://localhost.dev:6379'
+staging:
+  url: 'redis://staging-server:6379'
+production:
+  url: 'redis://production-server:6379'

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+ENV['TESTCLOUD_ENV'] = ENV['RAILS_ENV'] = 'test'
+
+require 'bundler/setup'
+require 'testcloud_config'
+
+# load support files
+require_relative 'support/paths'
+
+RSpec.configure do |config|
+  config.include(Paths)
+  config.pattern = 'spec/**/*_spec.rb'
+end

data/spec/support/paths.rb

@@ -0,0 +1,17 @@
+module Paths
+  class << self
+
+    def spec_root
+      @root ||= File.expand_path('../../../spec', __FILE__)
+    end
+
+    def fixtures
+      @fixtures ||= File.join(spec_root, 'fixtures')
+    end
+
+    def configs
+      @configs ||= File.join(fixtures, 'configs')
+    end
+
+  end
+end

data/spec/testcloud/config/settings_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe Testcloud::Config::Settings do
+
+  before(:each) do
+    @settings = Testcloud::Config::Settings.new
+  end
+
+  context 'environment' do
+    it 'should raise a NoEnvironmentError when accessing and not set' do
+      expect {
+        @settings.environment
+      }.to raise_error(Testcloud::Config::Errors::NoEnvironmentError)
+    end
+
+    it 'should return the environment when already set' do
+      @settings.environment = 'foo'
+      expect(@settings.environment).to eq('foo')
+    end
+
+    it 'should accept a callable object' do
+      my_env = 'bar'
+      @settings.environment = Proc.new { my_env }
+      expect(@settings.environment).to eq('bar')
+    end
+  end
+
+  context 'config_directory' do
+    it 'should raise a ConfigDirectoryError when accessed and not set' do
+      expect {
+        @settings.config_directory
+      }.to raise_error(Testcloud::Config::Errors::ConfigDirectoryError)
+    end
+
+    it 'should raise a ConfigDirectoryError when not a directory' do
+      path = File.join(Paths.configs, 'one_level_file')
+      expect(File.exists?(path)).to eq(true)
+      expect {
+        @settings.config_directory = path
+      }.to raise_error(Testcloud::Config::Errors::ConfigDirectoryError)
+    end
+
+    it 'should raise a ConfigDirectoryError when not existent' do
+      path = 'foobar'
+      expect(File.exists?(path)).to eq(false)
+      expect {
+        @settings.config_directory = path
+      }.to raise_error(Testcloud::Config::Errors::ConfigDirectoryError)
+    end
+
+    it 'should set the config_directory when argument is a directory' do
+      path = File.join(Paths.configs, 'one_level')
+      expect(File.directory?(path)).to eq(true)
+      @settings.config_directory = path
+      expect(@settings.config_directory).to eq(path)
+    end
+  end
+
+  context 'config_classname' do
+    it 'should default to nil' do
+      expect(@settings.config_classname).to eq(nil)
+    end
+
+    it 'should be settable' do
+      @settings.config_classname = 'Foo'
+      expect(@settings.config_classname).to eq('Foo')
+    end
+
+    it 'should raise a ConfigClassnameError if a non-string is passed' do
+      [nil, Object.new, :foo, 45].each do |o|
+        expect {
+          @settings.config_classname = o
+        }.to raise_error(Testcloud::Config::Errors::ConfigClassnameError)
+      end
+    end
+
+    it 'should be boolean questionable' do
+      expect(@settings.config_classname?).to eq(false)
+    end
+  end
+
+  context 'eager_load' do
+    it 'should default to true' do
+      expect(@settings.eager_load).to eq(true)
+    end
+
+    it 'should be settable' do
+      @settings.eager_load = true
+      expect(@settings.eager_load).to eq(true)
+    end
+
+    it 'should accept truthy values for the setter' do
+      [Object.new, "asdf", 100, true].each do |value|
+        @settings.eager_load = value
+        expect(@settings.eager_load).to eq(true)
+      end
+    end
+
+    it 'should have an eager_load? alias' do
+      expect(@settings).to respond_to(:eager_load?)
+    end
+  end
+end

data/spec/testcloud/config_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Testcloud::Config do
+
+  context 'public_api' do
+
+    it 'should have a setup method' do
+      expect(Testcloud::Config).to respond_to(:setup)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: testcloud-config
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+platform: ruby
+authors:
+- testCloud Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: 
+email:
+- team@testcloud.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testcloud/config.rb
+- lib/testcloud/config/configuration.rb
+- lib/testcloud/config/errors.rb
+- lib/testcloud/config/gem_version.rb
+- lib/testcloud/config/loader.rb
+- lib/testcloud/config/manager.rb
+- lib/testcloud/config/settings.rb
+- lib/testcloud/config/version.rb
+- lib/testcloud_config.rb
+- spec/fixtures/configs/one_level/redis.yml
+- spec/fixtures/configs/one_level_file
+- spec/spec_helper.rb
+- spec/support/paths.rb
+- spec/testcloud/config/settings_spec.rb
+- spec/testcloud/config_spec.rb
+homepage: https://testcloud.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Manage configuration options for gems and ruby apps
+test_files:
+- spec/fixtures/configs/one_level/redis.yml
+- spec/fixtures/configs/one_level_file
+- spec/spec_helper.rb
+- spec/support/paths.rb
+- spec/testcloud/config/settings_spec.rb
+- spec/testcloud/config_spec.rb