collapsium-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 741381d93d430ecc5543a6078668afa243e37411
+  data.tar.gz: 95ede2d38dfa692e8fd280b588af56abd50038e3
+SHA512:
+  metadata.gz: 3395ffe0c860a7b1a87c3ea302aedec670c2c59b0267c7dc2dba223a3a18e29b6c5f36b78ed28696de3000c6af7cee38493d7f7168373d09b3d4ccb5283e7451
+  data.tar.gz: 321173292d3886f27a0686e6286441b2d8ae104cef74a6737bf2639261cd31830870f9b6e393c71365a17cb07548501987f53a56f8a1b75001162f619261621f

data/.codeclimate.yml

@@ -0,0 +1,34 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    exclude_fingerprints:
+      - d85d6f12c93d79ccd43868b8315d8816
+      - a8e2b4ccb258f16eda697c5f98e21823
+      - 442a316695836b4f4693fe3786cd3396
+      - 1c24bb5da72323796b645814cc006684
+      - 4ff1112a73f7be30ecefa7bd90fdbf5a
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/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
+
+# Editor files
+.*.sw*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,75 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+# Metrics
+
+Metrics/LineLength:
+  Max: 83
+  Details: >-
+    Line length of 80 is ideal for readability and compatibility; we'll accept
+    an extra 3 for minor edge cases.
+
+Metrics/MethodLength:
+  Max: 35
+
+Metrics/BlockNesting:
+  Max: 5
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/ModuleLength:
+  Max: 300
+
+# Style
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/SpaceAfterNot:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+addons:
+  code_climate:
+    repo_token: 3cca4d10a51839bc5d115d41a0c12b98cbdb27a21e9c86544324fa028b799b84

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in collapsium-config.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    collapsium-config (0.1.0)
+      collapsium (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.2.0)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    collapsium (0.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unicode-display_width (1.0.5)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  codeclimate-test-reporter
+  collapsium-config!
+  rake (~> 11.1)
+  rspec (~> 3.4)
+  rubocop (~> 0.40)
+  simplecov (~> 0.11)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.12.3

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) Jens Finkhaeuser (http://finkhaeuser.de/) and other collapsium-config
+contributors. All rights not covered below are reserved.
+
+The MIT +no-false-attribs License (MITNFA)
+
+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.
+
+Distributions of all or part of the Software intended to be used by the
+recipients as they would use the unmodified Software, containing modifications
+that substantially alter, remove, or disable functionality of the Software,
+outside of the documented configuration mechanisms provided by the Software,
+shall be modified such that the Original Author's bug reporting email addresses
+and urls are either replaced with the contact information of the parties
+responsible for the changes, or removed entirely.
+
+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,35 @@
+# collapsium-config
+
+Using [collapsium](https://github.com/jfinkhaeuser/collapsium)'s `UberHash`
+class for easy access to configuration values, this gem reads and merges
+various configuration sources into one configuration object.
+
+
+[![Gem Version](https://badge.fury.io/rb/collapsium-config.svg)](https://badge.fury.io/rb/collapsium-config)
+[![Build status](https://travis-ci.org/jfinkhaeuser/collapsium-config.svg?branch=master)](https://travis-ci.org/jfinkhaeuser/collapsium-config)
+[![Code Climate](https://codeclimate.com/github/jfinkhaeuser/collapsium-config/badges/gpa.svg)](https://codeclimate.com/github/jfinkhaeuser/collapsium-config)
+[![Test Coverage](https://codeclimate.com/github/jfinkhaeuser/collapsium-config/badges/coverage.svg)](https://codeclimate.com/github/jfinkhaeuser/collapsium-config/coverage)
+
+# Functionality
+
+- Supports [JSON](http://www.json.org/) and [YAML](http://yaml.org/) file
+  formats.
+- Given a main configuration file `foo.yml` to load, also loads `foo-local.yml`
+  if that exists, and merges it's contents recursively into the main
+  configuration.
+- Using the special `extends` configuration key, allows a configuration Hash
+  to include all values from another configuration Hash.
+- Using the special, top-level `include` configuration key, allows a
+  configuration file to be split into multiple included files.
+
+# Usage
+
+While you can use the `Configuration` class yourself, the simplest usage is to
+access a global configuration object:
+
+```ruby
+require 'collapsium-config'
+include Collapsium::Config
+
+puts config["foo"] # loaded automatically from config.yml
+```

data/Rakefile

@@ -0,0 +1,25 @@
+# Rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+# Rspec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:rspec)
+
+# Documentation
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['-m', 'markdown']
+  t.stats_options = ['--list-undoc']
+end
+
+# Combined test task
+desc "Test all the things!"
+task :test do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:rspec].invoke
+end
+
+# Default is the test task
+task default: :test

data/collapsium-config.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+#
+# collapsium-config
+# https://github.com/jfinkhaeuser/collapsium-config
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other collapsium-config contributors.
+# All rights reserved.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'collapsium-config/version'
+
+# rubocop:disable Style/UnneededPercentQ, Style/ExtraSpacing
+# rubocop:disable Style/SpaceAroundOperators
+Gem::Specification.new do |spec|
+  spec.name          = "collapsium-config"
+  spec.version       = Collapsium::Config::VERSION
+  spec.authors       = ["Jens Finkhaeuser"]
+  spec.email         = ["jens@finkhaeuser.de"]
+  spec.description   = %q(
+    Using collapsium's UberHash class for easy access to configuration values,
+    this gem reads and merges various configuration sources into one
+    configuration object.
+  )
+  spec.summary       = %q(
+    Collapse multiple configuration sources into one collapsium UberHash.
+  )
+  spec.homepage      = "https://github.com/jfinkhaeuser/collapsium-config"
+  spec.license       = "MITNFA"
+
+  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.required_ruby_version = '>= 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rubocop", "~> 0.40"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "yard", "~> 0.8"
+
+  spec.add_dependency 'collapsium', '~> 0.1'
+end
+# rubocop:enable Style/SpaceAroundOperators
+# rubocop:enable Style/UnneededPercentQ, Style/ExtraSpacing

data/lib/collapsium-config.rb

@@ -0,0 +1,51 @@
+# coding: utf-8
+#
+# collapsium-config
+# https://github.com/jfinkhaeuser/collapsium-config
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other collapsium-config contributors.
+# All rights reserved.
+#
+
+require 'collapsium-config/version'
+
+require 'collapsium-config/configuration'
+
+module Collapsium
+  # Include the Config module to get access to a #config function that provides
+  # access to a global configuration object.
+  module Config
+    # The default configuration file path
+    DEFAULT_CONFIG_PATH = 'config.yml'.freeze
+
+    ##
+    # Modules can have class methods, too, but it's a little more verbose to
+    # provide them.
+    module ClassMethods
+      # Set the configuration file
+      def config_file=(name)
+        @config_file = name
+      end
+
+      # @return [String] the config file path, defaulting to 'config/config.yml'
+      def config_file
+        return @config_file || DEFAULT_CONFIG_PATH
+      end
+    end # module ClassMethods
+    extend ClassMethods
+
+    ##
+    # Access the global configuration
+    def config
+      if @config.nil?
+        begin
+          @config = Configuration.load_config(Config.config_file)
+        rescue Errno::ENOENT
+          @config = {}
+        end
+      end
+
+      return @config
+    end
+  end # module Config
+end # module Collapsium