schrank 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bc6aa17924df10b2ea5c26ed7b992f5ed8981c0
+  data.tar.gz: 7d6aabfbad460abd3cdf6241709bb86f28a765c5
+SHA512:
+  metadata.gz: 9c85dc98a2ca78c584b0e1da1566204cea981f1895062bfec70ffc0223a0145d5493c013164debeadd6ed289ea1be7936319a83f549c8735309aa766fda1daf5
+  data.tar.gz: 6490da451b4f758c5357df0e01384ff617c5aade9cb5b890c415fd20243a40ba5604a24b4b08b1a16e6af08415ab5cb453fe377bf477a6a5042a8106201c6e90

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+script: bundle exec rake
+sudo: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [opensource@tape.tv](mailto:opensource@tape.tv).
+All complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 tape.tv AG
+
+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,37 @@
+# Schrank
+
+A simple YAML config file loader.
+
+[![Build](https://travis-ci.org/tape-tv/schrank.svg?branch=master)](https://travis-ci.org/tape-tv/schrank)
+[![Docs](https://inch-ci.org/github/tape-tv/schrank.svg?branch=master)](https://inch-ci.org/github/tape-tv/schrank)
+
+## Usage
+
+```ruby
+require 'schrank'
+```
+
+Load your config, providing defaults.
+
+```ruby
+config = Schrank.load(Rails.root.join('config/production.yml')) do
+  {
+    provider: 's3',
+    prefix: 'folder/'
+  }
+end
+```
+
+See [the docs](http://www.rubydoc.info/github/tape-tv/schrank/master) for more details.
+
+## License
+
+MIT.
+
+## Contribution
+
+Contributions welcome! Create a pull request and we'll get back to you as soon as
+possible. Open an issue to discuss anything big.
+
+This project has a code of conduct, found in the root of this repo. Please read it
+before contributing.

data/Rakefile

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

data/lib/schrank.rb

@@ -0,0 +1,56 @@
+require 'schrank/version'
+require 'yaml'
+require 'active_support/core_ext/hash/indifferent_access'
+
+# Namespace module.
+module Schrank
+  # Attempts to load YAML file. Falls back on defaults
+  # hash when file is not found.
+  #
+  # In development mode, the defaults hash is merged
+  # with the YAML file, with the file taking precedence.
+  # This is intentional, since it allows shared config
+  # to live in your application source code, but
+  # per-user secrets (such as access keys) can be kept
+  # in a file and out of version control.
+  #
+  # @example Simply load your config.
+  #   config = Schrank.load(Rails.root.join('config/production.yml'))
+  #
+  # @example Load your config, providing defaults.
+  #   config = Schrank.load(Rails.root.join('config/production.yml')) do
+  #     {
+  #       provider: 's3',
+  #       prefix: 'folder/'
+  #     }
+  #   end
+  #
+  # @param [String] path The path to the config file
+  # @yieldreturn [Hash] Default config
+  # @return [ActiveSupport::HashWithIndifferentAccess]
+  def self.load(path, &defaults)
+    config = {}
+
+    if yaml_path(path).exist?
+      config.merge!(defaults.call) if defaults && development?
+      config.merge!(YAML.load(yaml_path(path).open('r:utf-8')))
+    else
+      puts "[Schrank] Could not find config file at #{path}, loading defaults..."
+      config.merge!(defaults.call) if defaults
+    end
+
+    config.with_indifferent_access
+  end
+
+  # Returns true when the application is in development mode, otherwise returns false.
+  #
+  # @return [Boolean]
+  def self.development?
+    ((defined?(Rails) && Rails.env) || ENV['RACK_ENV'] || ENV['APP_ENV']) == 'development'
+  end
+
+  # @private
+  def self.yaml_path(path)
+    Pathname.new(path)
+  end
+end

data/lib/schrank/version.rb

@@ -0,0 +1,3 @@
+module Schrank
+  VERSION = '2.0.0'
+end

data/schrank.gemspec

@@ -0,0 +1,27 @@
+#coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'schrank/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'schrank'
+  spec.version       = Schrank::VERSION
+  spec.authors       = ['Christof Dorner', 'Joe Corcoran']
+  spec.email         = ['opensource@tape.tv']
+  spec.summary       = 'Simply load YAML configuration files'
+  spec.description   = %Q{A simple tool that helps you to load YAML config
+files, with specifics to help you in development mode.
+  }
+  spec.homepage      = 'https://github.com/tape-tv/schrank'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'activesupport', '~> 4.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/spec/schrank_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Schrank do
+  subject { Schrank }
+
+  describe '.yaml_path' do
+    let(:path) { '/tmp/config.yml' }
+
+    it 'returns a Pathname' do
+      expect(subject.yaml_path(path)).to be_instance_of(Pathname)
+    end
+
+    it 'initializes a new Pathname with the passed-in path' do
+      expect(Pathname).to receive(:new).with(path)
+
+      subject.yaml_path(path)
+    end
+  end
+
+  describe '.load' do
+    include_context :uses_tmp_dir
+
+    let(:path) { File.join(tmp_dir, 'config.yml') }
+
+    context 'when the passed-in file path exists' do
+      before do
+        File.write(path, YAML.dump({
+          foo: 'bar',
+          'bar' => 'baz',
+          baz: 42
+        }))
+      end
+
+      it 'returns a correct hash based on the YAML' do
+        expect(subject.load(path)).to eq({
+          'foo' => 'bar',
+          'bar' => 'baz',
+          'baz' => 42
+        })
+      end
+
+      it 'allows indifferent access' do
+        expect(subject.load(path)['foo']).to eq('bar')
+        expect(subject.load(path)[:foo]).to eq('bar')
+      end
+
+      context 'defaults' do
+        it 'merges defaults with values from file in development environment' do
+          allow(subject).to receive(:development?) { true }
+
+          config = subject.load(path) do
+            { foo: 'baz', qux: 'quux' }
+          end
+
+          expect(config[:foo]).to eq('bar')
+          expect(config[:qux]).to eq('quux')
+        end
+
+        it 'does not use the defaults in other environments' do
+          config = subject.load(path) do
+            { foo: 'baz', qux: 'quux' }
+          end
+
+          expect(config[:foo]).to eq('bar')
+          expect(config[:qux]).to eq(nil)
+        end
+      end
+    end
+
+
+    context 'when the passed-in file path is missing' do
+      it 'uses the default' do
+        expect(subject.load(path) do
+          { 'foo' => 'baz' }
+        end[:foo]).to eq('baz')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'schrank'
+
+Dir[File.expand_path('../support/*.rb', __FILE__)].sort.each do |file_path|
+  require file_path
+end
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/uses_tmp_dir.rb

@@ -0,0 +1,12 @@
+require 'tmpdir'
+
+shared_context :uses_tmp_dir do
+  around do |example|
+    Dir.mktmpdir('schrank-rspec-') do |dir|
+      @tmp_dir = dir
+      example.run
+    end
+  end
+
+  attr_reader :tmp_dir
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: schrank
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Christof Dorner
+- Joe Corcoran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: "A simple tool that helps you to load YAML config\nfiles, with specifics
+  to help you in development mode.\n  "
+email:
+- opensource@tape.tv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schrank.rb
+- lib/schrank/version.rb
+- schrank.gemspec
+- spec/schrank_spec.rb
+- spec/spec_helper.rb
+- spec/support/uses_tmp_dir.rb
+homepage: https://github.com/tape-tv/schrank
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simply load YAML configuration files
+test_files:
+- spec/schrank_spec.rb
+- spec/spec_helper.rb
+- spec/support/uses_tmp_dir.rb
+has_rdoc: