tcfg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39595952f6c08c280797fd9c93ee54dd72824b48
+  data.tar.gz: 7920588447e198f58433ff1b46587bdd4c724a8d
+SHA512:
+  metadata.gz: f924cc3a03d1213429ab451eead6e61bf0556ab2cdc616f9fb67a19b436deb20e31d9fbd5852e236316a6eb7476cc12f6ade545fee347054a413bb484c1995fa
+  data.tar.gz: 08f13614791d8ce60f4da75adf2eac7c7bd10e7b81fd33bba0b90e7b46ecbb792bad508e18484499501e207346a1a6f7c5f672fba80adb81ef6f1f658362ae30

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+#used for HashWithIndifferentAccess
+gem 'activesupport', '~> 3.2'
+
+group :development do
+  gem "rspec", '~> 2.14'
+  gem "jeweler", '~> 2'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    builder (3.2.2)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.21)
+    i18n (0.6.1)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mini_portile (0.5.2)
+    multi_json (1.9.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2)
+  jeweler (~> 2)
+  rspec (~> 2.14)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 rob
+
+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,90 @@
+TCFG
+====
+
+TCFG (pronounced "tee config") is test suite configuration for the real world.  TCFG offers:
+
+* Support for easily controlling which environment your tests execute against
+
+* A tiered structure to configuration which allows for every kind of configuration scenario to be supported.
+
+Background
+----------
+
+The Wiki contains more in depth information.  Some good places to start:
+
+* [Test suite configuration manifesto](https://github.com/rschultheis/tcfg/wiki/Test-Suite-Configuration-Manifesto)
+
+* [The tiers of configuration in TCFG](https://github.com/rschultheis/tcfg/wiki/The-tiers-of-configuration-in-TCFG)
+
+
+Getting started
+---------------
+
+### Using in RSpec
+
+Start by installing the gem:
+
+    $ gem install tcfg
+
+In the project root, make a yaml file called tcfg.yml that contains all configuration you want to be able to control.  For a selenium suite, it might look something like this:
+
+    ---
+    #start with basic defaults
+    BROWSER: firefox
+    BASE_URL: http://localhost:8080
+    LOG_LEVEL: INFO
+
+    #This is a special section with overrides by 'environment'
+    tcfg_environments:
+      QA:
+        BASE_URL: http://qa.mysite.com
+
+      Production:
+        BASE_URL: https://mysite.com
+
+Then configure RSpec to use tcfg in your spec helper file (typically called spec/spec_helper.rb):
+
+    require 'tcfg'
+
+    RSpec.configure do |config|
+      config.include TCFG::Helper
+    end
+
+Now you can access configuration in any before, after, or it block, like:
+
+    require 'selenium-webdriver'
+    RSpec.configure do |config|
+      config.before(:all) do
+        @browser = Selenium::WebDriver.for tcfg['BROWSER']
+      end
+
+      config.before(:each) do
+        @browser.get tcfg['BASE_URL']
+      end
+
+      config.after(:all) do
+        @browser.quit
+      end
+    end
+
+If you need to access configuration outside of a before, after, or it block you can use the TCFG module directly:
+
+    Log.level = TCFG.tcfg['LOG_LEVEL']
+
+To control your test suite, you can use environment variables.  To change the browser used:
+
+    #To execute with all default configuration
+    $ rspec
+
+    #To change the browser used
+    $ TCFG_BROWSER=chrome rspec
+
+    #To change which environment the tests execute against:
+    $ TCFG_ENVIRONMENT=QA rspec
+
+
+### Other uses
+
+TCFG is a general purpose configuration framework.  It should be possible to use with most Ruby test frameworks or even for non testing uses.  If you have a use and aren't sure how to handle it with tcfg, file an issue we'll see if we can help you out.
+
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "tcfg"
+  gem.homepage = "http://github.com/rschultheis/tcfg"
+  gem.license = "MIT"
+  gem.summary = "Test suite configuration for the real world"
+  gem.description = "A tiered approach to configuration which allows for full control of your test suite through environment variables"
+  gem.email = "robert.schultheis@gmail.com"
+  gem.authors = ["robert schultheis"]
+  gem.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+  ] + Dir.glob('lib/**/*.rb')
+
+  # dependencies defined in Gemfile
+
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/tcfg.rb

@@ -0,0 +1,3 @@
+require_relative 'tcfg/tcfg_base'
+require_relative 'tcfg/tcfg_helper'
+require_relative 'tcfg/tcfg_module'

data/lib/tcfg/tcfg_base.rb

@@ -0,0 +1,10 @@
+require_relative 'tcfg_helper'
+
+module TCFG
+  class Base
+    include TCFG::Helper
+    def initialize
+
+    end
+  end
+end

data/lib/tcfg/tcfg_helper.rb

@@ -0,0 +1,122 @@
+require 'yaml'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/deep_merge'
+
+require_relative 'tcfg_base'
+
+module TCFG
+  module Helper
+    DEFAULT_CONFIG_FILE = 'tcfg.yml'
+
+    def tcfg
+      unless @resolved_config
+        resolved_config = ActiveSupport::HashWithIndifferentAccess.new
+
+        #tier 1 code defaults
+        resolved_config.merge! tier_code_defaults
+
+        #tier 2, the main config file
+        resolved_config.merge! tier_config_file
+
+        #tier 3, the main config file
+        resolved_config.merge! tier_secret_config_file
+
+        #tier 4, environment overrides
+        resolved_config.merge! tier_environment_overrides
+
+        #tier 5, environment variable overrides
+        resolved_config.each_pair do |k, v|
+          env_var_name = "TCFG_#{k}"
+          resolved_config[k] = ENV.fetch(env_var_name, v)
+        end
+        @resolved_config = resolved_config
+      end
+      return @resolved_config
+    end
+
+    def tcfg_config_file filename
+      confirm_config_file_existence  filename
+      tcfg_reset
+      @tcfg_config_filename = filename
+    end
+
+    def tcfg_secret_config_file filename
+      confirm_config_file_existence  filename
+      tcfg_reset
+      @tcfg_secret_config_filename = filename
+    end
+
+    def tcfg_set key, value
+      tier_code_defaults[key] = value
+      tcfg_reset
+      return value
+    end
+
+    def tcfg_get key
+      tier_code_defaults[key]
+    end
+
+    def tcfg_reset
+      @resolved_config = nil
+    end
+
+    private
+
+    #define how we handle state for each of the tiers
+    def tier_code_defaults
+      @tcfg_code_defaults ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    def tier_config_file
+      @tcfg_config_filename ||= DEFAULT_CONFIG_FILE
+      tcfg_load_optional_config_file @tcfg_config_filename
+    end
+
+    def tier_secret_config_file
+      if @tcfg_secret_config_filename
+        tcfg_load_optional_config_file @tcfg_secret_config_filename
+      elsif @tcfg_config_filename
+        ext = File.extname @tcfg_config_filename
+        base = File.basename @tcfg_config_filename, ext
+        dir = File.dirname @tcfg_config_filename
+        possible_secret_filename = dir + '/' + base + '.secret' + ext
+        tcfg_load_optional_config_file possible_secret_filename
+      else
+        {}
+      end
+    end
+
+    def tier_environment_overrides
+      tenv = ENV['TCFG_ENVIRONMENT']
+      return {} unless @tcfg_environments_config and tenv
+      unless @tcfg_environments_config.has_key? tenv
+        raise TCFG::NoSuchEnvironmentError.new "No such environment in configuration '#{tenv}'"
+      end
+      @tcfg_environments_config[tenv].merge({'TCFG_ENVIRONMENT' => tenv})
+    end
+
+    def tcfg_load_optional_config_file filename
+      @tcfg_environments_config ||= ActiveSupport::HashWithIndifferentAccess.new
+      if File.exist? filename
+        file_contents = YAML.load_file filename
+        hashed = ActiveSupport::HashWithIndifferentAccess.new file_contents
+        environments = hashed.delete :tcfg_environments
+        @tcfg_environments_config.deep_merge!(environments) if environments
+        hashed
+      else
+        {}
+      end
+    end
+
+    def confirm_config_file_existence filename
+      unless File.exist? filename
+        raise TCFG::NoSuchConfigFileError.new "No such config file '#{filename}'"
+      end
+    end
+
+  end
+
+  #custom exceptions
+  class NoSuchEnvironmentError < StandardError; end
+  class NoSuchConfigFileError < StandardError; end
+end

data/lib/tcfg/tcfg_module.rb

@@ -0,0 +1,7 @@
+require_relative 'tcfg_helper'
+
+module TCFG
+  class << self
+    include TCFG::Helper
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: tcfg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- robert schultheis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A tiered approach to configuration which allows for full control of your
+  test suite through environment variables
+email: robert.schultheis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/tcfg.rb
+- lib/tcfg/tcfg_base.rb
+- lib/tcfg/tcfg_helper.rb
+- lib/tcfg/tcfg_module.rb
+homepage: http://github.com/rschultheis/tcfg
+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: Test suite configuration for the real world
+test_files: []