env-config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1896a65fd942910ad642261a1fd8c527e6a2e24
+  data.tar.gz: 84624eb3c1508cd45a14fcb15d320d271ef16c7d
+SHA512:
+  metadata.gz: 6809a76d3f24d34ded0ba3ab0668c2128dcaa9c0be61a331ae46501dbe559da4759b7a6aaa6cc1f28720fdb3bb8634e575f5e29de26b72459505cb319c412eb1
+  data.tar.gz: 38daa24b84ce05fb52603da0ae546d9eb4a2717114573a0ec50d989b227240096fd2544f1680450221eb5a6a17846826c15efcb892a63ebb88994e0602550e56

data/.gitignore

@@ -0,0 +1,40 @@
+# SimpleCov
+test/coverage
+
+# Bundler
+Gemfile.lock
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.simplecov

@@ -0,0 +1,13 @@
+SimpleCov.start do
+  coverage_dir "test/coverage"
+  command_name "tests"
+
+  use_merging true
+  merge_timeout 3600
+
+  add_filter "test/"
+
+  add_group "All", "/lib/*.rb"
+
+  formatter SimpleCov::Formatter::HTMLFormatter
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+guard :minitest do
+
+  # run all tests when lib main module file changes
+  watch(%r{^lib/configuration.rb$}) { "test" }
+
+  # run accompanying test for single source file if it changes
+  watch(%r{^lib/(.*)\.rb$}) {|m| "test/#{m[1]}_test.rb" }
+
+  # run test whenever it changes
+  watch(%r{^test/(.*)\/?(.*)?_test\.rb$})
+
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Markus Seeger
+
+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,5 @@
+Configuration
+=============
+
+Basic ruby environment-dependent configuration
+

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/env-config.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "env-config"
+  gem.version       = EnvConfig::VERSION
+  gem.authors       = ["Markus Seeger"]
+  gem.email         = ["mail@codegourmet.de"]
+  gem.description   = "Basic ruby environment-dependent configuration"
+  gem.summary       = ""
+  gem.homepage      = "https://github.com/codegourmet/env-config"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake",  "~> 10.1"
+  gem.add_development_dependency "guard-minitest"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "minitest-reporters"
+  gem.add_development_dependency "simplecov"
+end

data/lib/env_config.rb

@@ -0,0 +1,76 @@
+# usage example:
+#
+# # environment.rb
+# EnvConfig.configure(:default) do |config|
+#   config[:verbose] = true
+# end
+#
+# # test.rb
+# EnvConfig.configure(:test) do |config|
+#   config[:verbose] = false
+# end
+#
+# # development.rb
+# EnvConfig.configure(:development) do |config|
+# end
+#
+#
+# config = EnvConfig.new(:test)
+# config[:verbose] # => false
+#
+# config = EnvConfig.new(:development)
+# config[:verbose] # => true
+#
+class EnvConfig
+
+  class UnknownEnvironmentError < RuntimeError ; end
+  class AbstractError < RuntimeError ; end
+  class LoadOrderError < RuntimeError ; end
+  class ImmutableError < RuntimeError ; end
+
+  @@configurations = {}
+
+  attr_reader :environment
+
+  def self.configure(environment)
+    environment = environment.to_sym
+    set_default_values(environment)
+    yield @@configurations[environment]
+  end
+
+  def initialize(environment)
+    @environment = environment.to_sym
+    raise AbstractError if @environment == :default
+    raise UnknownEnvironmentError if !@@configurations.has_key?(@environment)
+  end
+
+  def [](key)
+    get_config[key]
+  end
+
+  # NOTE this ensures readonly only for toplevel key=>value,
+  # not the value objects themselves
+  def []=(key, value)
+    raise ImmutableError.new("config is read-only")
+  end
+
+  protected
+
+    def self.set_default_values(environment)
+      if environment == :default
+        @@configurations[environment] = {}
+      else
+        if !@@configurations.has_key?(:default)
+          raise LoadOrderError.new("have to define :default configuration first")
+        end
+        # TODO raise default not found error if doesnt exist yet!
+        @@configurations[environment] = @@configurations[:default].clone
+      end
+    end
+
+    def get_config
+      @@configurations[@environment]
+    end
+end
+
+require 'version'

data/lib/version.rb

@@ -0,0 +1,3 @@
+class EnvConfig
+  VERSION = "0.0.1"
+end

data/test/env_config_test.rb

@@ -0,0 +1,81 @@
+require_relative "test_helper"
+require_relative "../lib/env_config"
+
+class EnvConfigTest < MiniTest::Test
+
+  def setup
+    EnvConfig.configure(:default) do |config|
+      config[:default_test_setting] = 'default default_test_setting'
+    end
+
+    EnvConfig.configure(:test) do |config|
+      config[:test_setting] = 'test test_setting'
+    end
+
+    EnvConfig.configure(:development) do |config|
+      config[:test_setting] = 'dev test_setting'
+    end
+  end
+
+  def test_raises_if_unknown_environment
+    assert_raises EnvConfig::UnknownEnvironmentError do
+      EnvConfig.new('unknown')
+    end
+  end
+
+  def test_raises_if_default_isnt_loaded_first
+    EnvConfig.send(:class_variable_set, :@@configurations, {})
+
+    assert_raises EnvConfig::LoadOrderError do
+      EnvConfig.configure(:test) do |config|
+        config[:test_setting] = 'test test_setting'
+      end
+    end
+  end
+
+  def test_default_applies_if_key_not_set
+    EnvConfig.configure(:test2) do |config|
+    end
+    config = EnvConfig.new(:test2)
+    assert_equal 'default default_test_setting', config[:default_test_setting]
+  end
+
+  def test_environment_specific_setting_overrides_default
+    EnvConfig.configure(:test2) do |config|
+      config[:default_test_setting] = 'overwritten default_test_setting'
+    end
+    config = EnvConfig.new(:test2)
+    assert_equal 'overwritten default_test_setting', config[:default_test_setting]
+  end
+
+  def test_prevents_instantiation_of_default_values_as_environment
+    assert_raises EnvConfig::AbstractError do
+      EnvConfig.new(:default)
+    end
+  end
+
+  def test_initialize_uses_chosen_config
+    config = EnvConfig.new('test')
+    assert_equal 'test test_setting', config[:test_setting]
+
+    config = EnvConfig.new('development')
+    assert_equal 'dev test_setting', config[:test_setting]
+  end
+
+  def test_initialize_sets_environment
+    config = EnvConfig.new('test')
+    assert_equal :test, config.environment
+
+    config = EnvConfig.new('development')
+    assert_equal :development, config.environment
+  end
+
+  def test_config_is_immutable
+    config = EnvConfig.new('test')
+
+    assert_raises EnvConfig::ImmutableError do
+      config[:test_setting] = 3
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov' # has to be at top, will execute ../.simplecov
+
+require 'env_config'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+if ENV["RM_INFO"] || ENV["TEAMCITY_VERSION"]
+  MiniTest::Reporters.use! MiniTest::Reporters::RubyMineReporter.new
+else
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: env-config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Markus Seeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic ruby environment-dependent configuration
+email:
+- mail@codegourmet.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .simplecov
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- env-config.gemspec
+- lib/env_config.rb
+- lib/version.rb
+- test/env_config_test.rb
+- test/test_helper.rb
+homepage: https://github.com/codegourmet/env-config
+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.0.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/env_config_test.rb
+- test/test_helper.rb