figroll 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14a63f584f645b93fac14fc5828541385cb6a7f9071051805037b9a483c3fbf0
+  data.tar.gz: 4544076f2daad2456dce6342b8d22fa9d0fdfffb0a0bc541f978bea6642a2ab6
+SHA512:
+  metadata.gz: 7a0a9a5c95d9fa16fda6a42106e37209976b576e9593dee2b2c64c22740d7aaeea8b84e4ea0c71c511d556e9172360e481f1deb370be8efb2f4f68d064b0b5c1
+  data.tar.gz: b3b70d15d130702b413e0da9f4edde943a6b532d4cd86f33b2d1e29f23360a7f105611e1db4c76b9496a47ad8bb31a579cc926e58db2f5aa6232c6d45b24cf14

data/.gitignore

@@ -0,0 +1,8 @@
+/Gemfile.lock
+pkg
+.bundle
+*.gem
+spec-*/fixtures/gitrepo
+/coverage
+*~
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - 2.3.4
+
+sudo: false
+
+dist: precise
+
+env:
+  - FIGROLL_ENV=test

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Engine Yard, Inc.
+
+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,31 @@
+# figroll #
+
+Figroll is a somewhat simple gem to ease your way into the use of environment variables for configuration. That said, it is not currently documented, and you should not use it just yet.
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'figroll'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install figroll
+
+## Usage ##
+
+Wow. Just look at all this empty space. You should check back here soon, but not right now. Later than now, definitely. As in there isn't any documentation at the present moment.
+
+## History ##
+
+* 0.0.1 - A prerelease for internal tire kicking
+
+## License ##
+
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--color]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/figroll.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'figroll/version'
+
+Gem::Specification.new do |gem|
+  gem.name    = "figroll"
+  gem.version = Figroll::VERSION
+
+  gem.author      = "EY Cloud Team"
+  gem.email       = "cloud@engineyard.com"
+  gem.summary     = "Rails 2 configuration via ENV"
+  gem.description = "Rails 2 app configuration using ENV and a single YAML file"
+  gem.homepage    = "https://github.com/engineyard/figroll"
+  gem.license     = "MIT"
+
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "rake", "~> 10.4"
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'json', '<2'
+
+  gem.files      = `git ls-files`.split($\)
+  gem.files.reject! {|file| ['Dockerfile', 'docker-compose.yml'].include?(file)}
+  gem.test_files = gem.files.grep(/^(spec|mock)/)
+
+end

data/lib/figroll.rb

@@ -0,0 +1,62 @@
+require 'figroll/config'
+require 'figroll/storage'
+
+module Figroll
+  def self.load_file(config_file)
+    setup
+
+    # Load the config file
+    config.load_file(config_file)
+
+    # Import the environment configuration from the config
+    storage.import(config.data)
+
+    # Import the actual ENV hash
+    storage.import(ENV)
+
+    # verify all required variables are set
+    validate_configuration
+  end
+
+  def self.fetch(key)
+    storage.fetch(key)
+  end
+
+  def self.storage
+    @storage
+  end
+
+  def self.config
+    @config
+  end
+
+  
+  def self.validate_configuration
+    return nil if required.length == 0
+    return nil if (keys - required).length == keys.length - required.length
+
+    missing = required.reject {|key| keys.include?(key)}
+    raise "Required variables not set: #{missing}"
+  end
+
+  def self.required
+    config.required
+  end
+
+  def self.keys
+    storage.keys
+  end
+
+  def self.environment
+    config.environment
+  end
+
+  def self.normalize(key)
+    key.to_s.upcase.gsub(/\s+/, '_')
+  end
+
+  def self.setup
+    @config = Config.new
+    @storage = Storage.new
+  end
+end

data/lib/figroll/config.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+
+module Figroll
+  class Config
+    attr_reader :required, :environment, :data
+
+    def initialize
+      reset
+    end
+
+    def load_file(config_file)
+      return unless File.exists?(config_file)
+
+      file_data = YAML.load_file(config_file) || {}
+
+      # set up required keys
+      file_data['required'] ||= []
+      file_data['required'].each do |key|
+        required.push(Figroll.normalize(key))
+      end
+
+      # load up the environment-specific data
+      file_data['environments'] ||= {}
+      @data = file_data['environments'][environment] || {}
+    end
+
+    private
+    def reset
+      @environment = ENV['FIGROLL_ENV']
+      @required = []
+      @data = {}
+    end
+  end
+end

data/lib/figroll/storage.rb

@@ -0,0 +1,30 @@
+module Figroll
+  class Storage
+    attr_reader :vars
+
+    def initialize
+      reset
+    end
+
+    def fetch(key)
+      @vars.fetch(Figroll.normalize(key))
+    end
+
+    def import(incoming)
+      incoming.keys.each do |key|
+        vars[Figroll.normalize(key)] = incoming[key]
+      end
+
+      nil
+    end
+
+    def keys
+      vars.keys
+    end
+
+    private
+    def reset
+      @vars = {}
+    end
+  end
+end

data/lib/figroll/version.rb

@@ -0,0 +1,3 @@
+module Figroll
+  VERSION = '0.0.1'
+end

data/mock/figroll.yml

@@ -0,0 +1,6 @@
+#required:
+  #- SAUSAGES
+
+#environments:
+  #staging:
+    #SAUSAGES: gold

data/mock/withoutreqs.yml

@@ -0,0 +1,3 @@
+environments:
+  test:
+    SAUSAGES: gold

data/mock/withreqs.yml

@@ -0,0 +1,2 @@
+required:
+  - SAUSAGES

data/spec/figroll/config_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Figroll::Config do
+  let(:config) {described_class.new}
+
+  describe '#load_file' do
+    let(:filename) {'figroll.yml'}
+    let(:config_file) {
+      File.join(MOCK_PATH, filename)
+    }
+
+    let(:load_file) {config.load_file(config_file)}
+
+    context 'when the file does not exist' do
+      let(:filename) {'nosuch.yml'}
+
+      it 'returns nil' do
+        expect(load_file).to eql(nil)
+      end
+    end
+
+    context 'when the file exists' do
+      let(:filename) {'figroll.yml'}
+
+      context 'and it contains required variables' do
+        let(:filename) {'withreqs.yml'}
+
+        it 'sets up the required variable names' do
+          load_file
+
+          expect(config.required).not_to be_empty
+        end
+      end
+
+      context 'and it contains an applicable environment' do
+        let(:filename) {'withoutreqs.yml'}
+
+        it 'sets up the data' do
+          load_file
+          expect(config.data).not_to be_empty
+        end
+      end
+    end
+
+  end
+
+
+
+
+end

data/spec/figroll/storage_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Figroll::Storage do
+  let(:storage) {described_class.new}
+
+  describe '#fetch' do
+    let(:data) {
+      {
+        'one' => 'two',
+        'two' => 'three',
+        'i like good' => 'ruby',
+        'and' => 'I like good memes'
+      }
+    }
+
+    let(:key) {'two'}
+    let(:fetch) {storage.fetch(key)}
+
+    before(:each) do
+      storage.send(:reset)
+      storage.import(data)
+    end
+
+    context 'when I reference a known variable' do
+      let(:expected) {'ruby'}
+
+      context 'in standard env var format' do
+        let(:key) {'I_LIKE_GOOD'}
+
+        it 'is the expected value' do
+          expect(fetch).to eql(expected)
+        end
+      end
+
+      context 'in standard symbol format' do
+        let(:key) {:i_like_good}
+
+        it 'is the expected value' do
+          expect(fetch).to eql(expected)
+        end
+      end
+
+      context 'in a conversational manner' do
+        let(:key) {'I like good'}
+
+        it 'is the expected value' do
+          expect(fetch).to eql(expected)
+        end
+      end
+    end
+
+    context 'when I reference an unknown variable' do
+      let(:key) {:unknown}
+
+      it 'raises an error' do
+        expect {fetch}.to raise_error
+      end
+    end
+  end
+
+end

data/spec/figroll_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Figroll do
+  let(:storage) {described_class::Storage.new}
+  let(:config) {described_class::Config.new}
+
+  before(:each) do
+    allow(described_class).to receive(:storage).and_return(storage)
+    allow(described_class).to receive(:config).and_return(config)
+    allow(described_class).to receive(:reset).and_return(true)
+
+    allow(storage).to receive(:import).and_call_original
+  end
+
+  describe '.load_file' do
+    let(:filename) {'figroll.yml'}
+    let(:config_file) {
+      File.join(MOCK_PATH, filename)
+    }
+
+    let(:load_file) {described_class.load_file(config_file)}
+
+    before(:each) do
+      storage.send(:reset)
+      config.send(:reset)
+    end
+
+    it 'forwards the call to a config object' do
+      expect(described_class.config).to eql(config)
+      expect(config).
+        to receive(:load_file).
+        with(config_file)
+
+      load_file
+    end
+
+    context 'when there is an applicable configuration environment' do
+      let(:filename) {'withoutreqs.yml'}
+
+      it 'imports the configuration environment' do
+        expect(storage).
+          to receive(:import).
+          with({'SAUSAGES' => 'gold'})
+
+        load_file
+      end
+    end
+
+    it 'imports the execution environment' do
+      expect(storage).
+        to receive(:import).
+        with(ENV)
+
+      load_file
+    end
+
+    context 'when there are required variables' do
+      let(:filename) {'withreqs.yml'}
+  
+      context 'but there is a missing required variable' do
+        before(:each) do
+          ENV.delete('SAUSAGES')
+        end
+
+        it 'raises an error' do
+          expect {load_file}.to raise_error
+        end
+      end
+
+      context 'and they are all present' do
+        before(:each) do
+          ENV['SAUSAGES'] = 'gold'
+        end
+
+        after(:each) do
+          ENV.delete('SAUSAGES')
+        end
+
+        it 'returns nil' do
+          expect(load_file).to eql(nil)
+        end
+      end
+    end
+
+    context 'when there are not required variables' do
+      let(:filename) {'withoutreqs.yml'}
+
+      it 'returns nil' do
+        expect(load_file).to eql(nil)
+      end
+    end
+  end
+
+  describe '.fetch' do
+    let(:key) {:whatever}
+    let(:value) {'yassss'}
+
+    let(:fetch) {described_class.fetch(key)}
+
+    it 'forwards the call to a storage object' do
+      expect(storage).to receive(:fetch).with(key).and_return(value)
+
+      expect(fetch).to eql(value)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+unless RUBY_VERSION =~ /^1\.8\./
+  require 'simplecov'
+  SimpleCov.coverage_dir 'coverage'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/mock/'
+  end
+end
+
+ENV['FIGROLL_ENV'] = 'test'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+MOCK_PATH = File.expand_path('../../mock', __FILE__)
+require 'figroll'

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: figroll
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- EY Cloud Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-16 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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: Rails 2 app configuration using ENV and a single YAML file
+email: cloud@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- figroll.gemspec
+- lib/figroll.rb
+- lib/figroll/config.rb
+- lib/figroll/storage.rb
+- lib/figroll/version.rb
+- mock/figroll.yml
+- mock/withoutreqs.yml
+- mock/withreqs.yml
+- spec/figroll/config_spec.rb
+- spec/figroll/storage_spec.rb
+- spec/figroll_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/engineyard/figroll
+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.7.9
+signing_key: 
+specification_version: 4
+summary: Rails 2 configuration via ENV
+test_files:
+- mock/figroll.yml
+- mock/withoutreqs.yml
+- mock/withreqs.yml
+- spec/figroll/config_spec.rb
+- spec/figroll/storage_spec.rb
+- spec/figroll_spec.rb
+- spec/spec_helper.rb