ee_cummings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad7554ad3ef9a071e81eec0845fd7f24c756235b
+  data.tar.gz: 359cd27beaf7ea5a67d4c89d8b30042ea8952c04
+SHA512:
+  metadata.gz: 4ee6d6dfbfa94b3a3904ff060f90aefc92675bef4cffd3a4986b828e21e10aa30915b371aed88b44a16eaba311156231e7649ecc562b9d55cf0cf6ea0fdedb40
+  data.tar.gz: 3362b312d62e067301a0a839b7e14f37f4dd9ece7a7dbf9fe8465ce01b959fffc75c6e28248a7ba4ec1b26b3270aa27231d43a8c90bd68a9c4e16abb41e34fe9

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ee_cummings.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    ee_cummings (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.2)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    slop (3.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  ee_cummings!
+  pry
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aubrey Rhodes
+
+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,51 @@
+E. E. Cummings
+==========
+
+A tool to validate your environment variables
+
+:rotating_light: *This is a work in progress and not ready for use* :rotating_light:
+
+## Description
+
+E. E. Cummings manages your ENV variables and gives you clear warnings when they are misconfigured.
+
+## Installation
+
+```
+gem install ee_cummings
+```
+or add the following to a Gemfile
+```
+gem 'ee_commings'
+```
+
+## Usage
+
+```ruby
+require 'ee_cummings'
+
+# list your environment variables
+EECummings.configure do |c|
+
+  # register an environment variable to require
+  c.variable do |var|
+  
+    # the environment variable name
+    var.name = 'API_KEY'
+    
+    # a regular expression that the value of the
+    # variable must match
+    var.regex = /[a-zA-Z0-9]+/
+  end
+  
+  # register another varialbe
+  c.variable do |var|
+    var.name = 'API_SECRET'
+    # regex is defaulted to /.*/
+  end
+end
+
+# to retrieve the values of the environment variables
+EECummings.api_secret
+EECummings.api_key
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ee_cummings.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ee_cummings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ee_cummings"
+  spec.version       = EECummings::VERSION
+  spec.authors       = ["Aubrey Rhodes"]
+  spec.email         = ["aubrey.c.rhodes@gmail.com"]
+  spec.description   = %q{E. E. Cummings manages your ENV variables and gives you clear warnings when they are misconfigured.}
+  spec.summary       = %q{A tool to validate your environment variables}
+  spec.homepage      = "https://github.com/aubreyrhodes/ee_cummings"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/ee_cummings.rb

@@ -0,0 +1,14 @@
+require "ee_cummings/version"
+require "ee_cummings/configuration"
+require "ee_cummings/values"
+require "ee_cummings/variable_registry"
+require "ee_cummings/variable_definition"
+require "ee_cummings/variable_warehouse"
+require "ee_cummings/variable_source"
+require "ee_cummings/variable_validator"
+require "ee_cummings/misconfigured_variable"
+
+module EECummings
+  extend Configuration
+  extend Values
+end

data/lib/ee_cummings/configuration.rb

@@ -0,0 +1,40 @@
+module EECummings
+  module Configuration
+    def configure
+      variable_list = variable_registry
+      yield variable_list
+      variable_warehouse.load_variables_from_registry(variable_list)
+      if variable_warehouse.errors.length > 0
+        raise_errors(variable_warehouse.errors)
+      end
+      self.warehouse = variable_warehouse
+    end
+
+    def variable_registry=(registry)
+      @variable_registry = registry
+    end
+
+    def variable_warehouse=(warehouse)
+      @variable_warehouse = warehouse
+    end
+
+    def cleanup
+      @variable_registry = nil
+      @variable_warehouse = nil
+    end
+
+    private
+
+    def variable_registry
+      @variable_registry ||= EECummings::VariableRegistry.new
+    end
+
+    def variable_warehouse
+      @variable_warehouse ||= EECummings::VariableWarehouse.new
+    end
+
+    def raise_errors(errors)
+      raise MisconfiguredVariable.new "The following variables are missing or misconfigured: #{ errors.join(',') }"
+    end
+  end
+end

data/lib/ee_cummings/misconfigured_variable.rb

@@ -0,0 +1,4 @@
+module EECummings
+  class MisconfiguredVariable < StandardError
+  end
+end

data/lib/ee_cummings/values.rb

@@ -0,0 +1,12 @@
+module EECummings
+  module Values
+    def warehouse=(warehouse)
+      @@warehouse=warehouse
+    end
+
+    def method_missing(meth, *args, &block)
+      key = meth.upcase.to_s
+      @@warehouse.get_value(key) || super
+    end
+  end
+end

data/lib/ee_cummings/variable_definition.rb

@@ -0,0 +1,7 @@
+module EECummings
+  class VariableDefinition < Struct.new(:name, :regex)
+    def initialize
+      self.regex = /.*/
+    end
+  end
+end

data/lib/ee_cummings/variable_registry.rb

@@ -0,0 +1,22 @@
+module EECummings
+  class VariableRegistry
+    attr_reader :variables
+
+    def initialize(variable_definition_class = VariableDefinition)
+      @variable_definition_class = variable_definition_class
+      @variables = []
+    end
+
+    def variable
+      variable = new_variable_definition
+      yield variable
+      @variables << variable
+    end
+
+    private
+
+    def new_variable_definition
+      @variable_definition_class.new
+    end
+  end
+end

data/lib/ee_cummings/variable_source.rb

@@ -0,0 +1,7 @@
+module EECummings
+  class VariableSource
+    def get_value(key)
+      ENV[key]
+    end
+  end
+end

data/lib/ee_cummings/variable_validator.rb

@@ -0,0 +1,7 @@
+module EECummings
+  class VariableValidator
+    def is_valid?(definition, value)
+      value =~ definition.regex
+    end
+  end
+end

data/lib/ee_cummings/variable_warehouse.rb

@@ -0,0 +1,27 @@
+module EECummings
+  class VariableWarehouse
+    attr_reader :variable_source, :errors, :validator
+
+    def initialize(variable_source = VariableSource.new, validator = VariableValidator.new)
+      @variable_source = variable_source
+      @validator = validator
+      @variables = {}
+      @errors = []
+    end
+
+    def load_variables_from_registry(registry)
+      registry.variables.each do |var|
+        value = variable_source.get_value(var.name)
+        if validator.is_valid?(var, value)
+          @variables[var.name] = value
+        else
+          @errors << var.name
+        end
+      end
+    end
+
+    def get_value(key)
+      @variables[key]
+    end
+  end
+end

data/lib/ee_cummings/version.rb

@@ -0,0 +1,3 @@
+module EECummings
+  VERSION = "0.1.0"
+end

data/spec/acceptance/environment_variables_spec.rb

@@ -0,0 +1,46 @@
+require 'ee_cummings'
+
+describe 'Managing Environment Variables' do
+  context 'an environment variable is present' do
+    let(:variable_value){ 'test' }
+
+    before do
+      EECummings.cleanup
+      ENV['EE_CUMMINGS_TEST_VAR'] ||= variable_value
+    end
+
+    it 'allows a user to require an environment variable' do
+      EECummings.configure do |c|
+        c.variable do |var|
+          var.name = 'EE_CUMMINGS_TEST_VAR'
+        end
+      end
+
+      expect(EECummings.ee_cummings_test_var).to eq(variable_value)
+    end
+
+    it 'throws an exception if a configured variable is missing' do
+      expect do
+        EECummings.configure do |c|
+          c.variable do |var|
+            var.name = 'EE_CUMMINGS_TEST_VAR'
+          end
+          c.variable do |var|
+            var.name = 'MISSING_VARIABLE'
+          end
+        end
+      end.to raise_error(EECummings::MisconfiguredVariable)
+    end
+
+    it 'throws an exception if a configured variable does not match the expected regex' do
+      expect do
+        EECummings.configure do |c|
+          c.variable do |var|
+            var.name = 'EE_CUMMINGS_TEST_VAR'
+            var.regex = /bad_regex/
+          end
+        end
+      end.to raise_error(EECummings::MisconfiguredVariable)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,36 @@
+require 'ee_cummings/configuration'
+require 'ee_cummings/misconfigured_variable'
+
+describe EECummings::Configuration do
+  let(:variable_registry){ double }
+  let(:variable_warehouse){ double(errors: []) }
+
+  subject{ Object.new.extend(EECummings::Configuration) }
+
+  before do
+    subject.variable_registry = variable_registry
+    subject.variable_warehouse = variable_warehouse
+
+    variable_warehouse.stub(:load_variables_from_registry)
+    subject.stub(:warehouse=)
+  end
+
+  it 'yeilds a variable registry' do
+    target = expect{ |b| subject.configure(&b)}.to yield_with_args(variable_registry)
+  end
+
+  it 'loads variables into the warehouse from the registry' do
+    variable_warehouse.should_receive(:load_variables_from_registry).with(variable_registry)
+    subject.configure{}
+  end
+
+  it 'sets the objects warehouse' do
+    subject.should_receive(:warehouse=).with(variable_warehouse)
+    subject.configure{}
+  end
+
+  it 'raises an error if there are misconfigured variables' do
+    variable_warehouse.stub(:errors).and_return(['bad_variable'])
+    expect{ subject.configure{} }.to raise_error(EECummings::MisconfiguredVariable)
+  end
+end

data/spec/ee_cummings_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe EECummings do
+  it 'should have a version number' do
+    EECummings::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'ee_cummings'

data/spec/values_spec.rb

@@ -0,0 +1,18 @@
+require 'ee_cummings/values'
+
+describe EECummings::Values do
+  let(:warehouse){ double }
+
+  subject{ Object.new.extend(EECummings::Values) }
+
+  describe 'retrieveing values' do
+    before do
+      warehouse.stub(:get_value).with('TEST_KEY').and_return('test')
+      subject.warehouse = warehouse
+    end
+
+    it 'returns the value for the right key with a method call' do
+      expect(subject.test_key).to eq('test')
+    end
+  end
+end

data/spec/variable_definition_spec.rb

@@ -0,0 +1,4 @@
+require 'ee_cummings/variable_definition'
+
+describe EECummings::VariableDefinition do
+end

data/spec/variable_registry_spec.rb

@@ -0,0 +1,21 @@
+require 'ee_cummings/variable_registry'
+
+describe EECummings::VariableRegistry do
+
+  class MockVariableDefinition; end
+
+  subject{ EECummings::VariableRegistry.new(MockVariableDefinition) }
+
+  describe '#variable' do
+    it 'yields a variable definition' do
+      expect{ |b| subject.variable(&b) }.to yield_with_args(MockVariableDefinition)
+    end
+  end
+
+  describe '#variables' do
+    it 'keeps track of variables that were registered' do
+      3.times do subject.variable{} end
+      expect(subject.variables.length).to eq(3)
+    end
+  end
+end

data/spec/variable_source_spec.rb

@@ -0,0 +1,10 @@
+require 'ee_cummings/variable_source'
+
+describe EECummings::VariableSource do
+  describe '#get_value' do
+    it 'returns the value of an environment variable' do
+      ENV['test_key'] = 'test'
+      expect(subject.get_value('test_key')).to eq('test')
+    end
+  end
+end

data/spec/variable_validator_spec.rb

@@ -0,0 +1,15 @@
+require 'ee_cummings/variable_validator'
+
+describe EECummings::VariableValidator do
+  let(:definition){ double(name: 'test_name', regex: /[a-z]+/) }
+
+  describe '#is_valid?' do
+    it 'returns true if the value is valid' do
+      expect(subject.is_valid?(definition, 'test')).to be_true
+    end
+
+    it 'returns false if the value does not match the variables regex' do
+      expect(subject.is_valid?(definition, '123')).to be_false
+    end
+  end
+end

data/spec/variable_warehouse_spec.rb

@@ -0,0 +1,34 @@
+require 'ee_cummings/variable_warehouse'
+
+describe EECummings::VariableWarehouse do
+  let(:variable_source){ double }
+  let(:registry){ double(variables: [ double(name: 'test_name') ]) }
+  let(:validator){ double(is_valid?: true) }
+
+  subject{ EECummings::VariableWarehouse.new(variable_source, validator) }
+
+  describe '#load_variables_from_registry' do
+
+    before do
+      variable_source.should_receive(:get_value).with('test_name')
+    end
+
+    it 'loads values from the variable source' do
+      subject.load_variables_from_registry(registry)
+    end
+
+    it 'saves the error if the validator fails' do
+      validator.stub(:is_valid?).and_return(false)
+      subject.load_variables_from_registry(registry)
+      expect(subject.errors.length).to eq(1)
+    end
+  end
+
+  describe '#get_value' do
+    it 'returns loaded values by key' do
+      variable_source.should_receive(:get_value).with('test_name').and_return('test')
+      subject.load_variables_from_registry(registry)
+      expect(subject.get_value('test_name')).to eq('test')
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: ee_cummings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aubrey Rhodes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: pry
+  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: E. E. Cummings manages your ENV variables and gives you clear warnings
+  when they are misconfigured.
+email:
+- aubrey.c.rhodes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ee_cummings.gemspec
+- lib/ee_cummings.rb
+- lib/ee_cummings/configuration.rb
+- lib/ee_cummings/misconfigured_variable.rb
+- lib/ee_cummings/values.rb
+- lib/ee_cummings/variable_definition.rb
+- lib/ee_cummings/variable_registry.rb
+- lib/ee_cummings/variable_source.rb
+- lib/ee_cummings/variable_validator.rb
+- lib/ee_cummings/variable_warehouse.rb
+- lib/ee_cummings/version.rb
+- spec/acceptance/environment_variables_spec.rb
+- spec/configuration_spec.rb
+- spec/ee_cummings_spec.rb
+- spec/spec_helper.rb
+- spec/values_spec.rb
+- spec/variable_definition_spec.rb
+- spec/variable_registry_spec.rb
+- spec/variable_source_spec.rb
+- spec/variable_validator_spec.rb
+- spec/variable_warehouse_spec.rb
+homepage: https://github.com/aubreyrhodes/ee_cummings
+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.3
+signing_key: 
+specification_version: 4
+summary: A tool to validate your environment variables
+test_files:
+- spec/acceptance/environment_variables_spec.rb
+- spec/configuration_spec.rb
+- spec/ee_cummings_spec.rb
+- spec/spec_helper.rb
+- spec/values_spec.rb
+- spec/variable_definition_spec.rb
+- spec/variable_registry_spec.rb
+- spec/variable_source_spec.rb
+- spec/variable_validator_spec.rb
+- spec/variable_warehouse_spec.rb