co_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efb57ac6fb4c6706e26450bfe8a2f82bf2138b2e
+  data.tar.gz: 4579b897c1e59fe31f603977e09f304781d5e9fa
+SHA512:
+  metadata.gz: dd6d42e31fd300fb385449e8816e42f15b94950332d36988dace16b323d66e13b8b144be63688724855b7974f945c58c67622caec896e8fed1cd556a491bccb2
+  data.tar.gz: 8e12fa30cfc1ca068eba4d3d65ebbb74ba253b5d3788bf18ec77d6c92175bbc4ae42cce2159a547259cdbb95f008190fe8d38ac13012977f885f60f5d028eb5a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ezequiel Rabinovich
+
+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,70 @@
+# CoConfig
+
+This is a simple gem to load configuration files on rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'co_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install co_config
+
+## Usage
+
+Create a `configuration.rb` file on your rails application's config folder.
+This file will indicate which files are loaded.
+
+```ruby
+# To load the test.yml file into the CoConfig::TEST hash
+load 'test' 
+
+# To validate the configuration you could use
+load 'test2' { |c| c.token.present? } 
+# or
+load 'test3' { |c| raise if token.empty? }
+```
+
+YAML files must have a root key called like the current `Rails.env`. A key called `defaults` can be used to specify defaults for undefined environments.
+
+```yaml
+# test.yml
+---
+
+development:
+   value: 1
+```
+
+```yaml
+# test2.yml
+---
+
+defaults:
+   token: 'MYAWESOMETOKEN'
+```
+
+To read your configuration you can access the hash (with indifferent access) at `CoConfig::CONFIG_NAME_UPPERCASE`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/co_config.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "co_config"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/co_config.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'co_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "co_config"
+  spec.version       = CoConfig::VERSION
+  spec.authors       = ["Ezequiel Rabinovich"]
+  spec.email         = ["erabinovich@gmail.com"]
+
+  spec.summary       = %q{Simple configuration management gem.}
+  spec.homepage      = "https://github.com/comparaonline/co_config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 3.0'
+  spec.add_dependency 'rails', '>= 3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/co_config.rb

@@ -0,0 +1,28 @@
+require "co_config/version"
+require 'co_config/loader'
+require 'co_config/railtie'
+
+module CoConfig
+  class Configuration
+    include Loader
+
+    def initialize(file)
+      instance_eval(File.read(file.to_s), file.to_s) if file.exist?
+    end
+  end
+
+  def config_path(file)
+    Rails.root.join('config', file)
+  end
+
+  def env
+    Rails.env
+  end
+
+  def load
+    file = config_path('configuration.rb')
+    Configuration.new(file)
+  end
+
+  module_function :load, :config_path, :env
+end

data/lib/co_config/errors.rb

@@ -0,0 +1,24 @@
+module CoConfig
+  class ConfigurationLoadError < RuntimeError
+    attr_reader :message
+    alias_method :to_s, :message
+  end
+
+  class MissingFileError < ConfigurationLoadError
+    def initialize(file_name)
+      @message = "Configuration file '#{file_name}' not found"
+    end
+  end
+
+  class MissingConfigError < ConfigurationLoadError
+    def initialize(file_name, env)
+      @message = "Missing configuration for '#{env}' on '#{file_name}'"
+    end
+  end
+
+  class FailedValidationError < ConfigurationLoadError
+    def initialize(file_name, error)
+      @message = "Failed validation for '#{file_name}' (#{error.to_s})"
+    end
+  end
+end

data/lib/co_config/loader.rb

@@ -0,0 +1,51 @@
+require 'co_config/errors'
+require 'yaml'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+
+module CoConfig
+  module Loader
+    module_function :load
+
+    def load(file_name, &validation)
+      config = load!(full_name(file_name), &validation)
+      CoConfig.const_set(base_name(file_name).upcase, config)
+    end
+
+    private
+
+    def load!(file_name, &validation)
+      hash = load_yaml(file_name)
+      config = hash.fetch(CoConfig.env, hash[:defaults])
+      fail MissingConfigError.new(file_name, CoConfig.env) unless config.present?
+      validate(config, file_name, &validation)
+      config
+    end
+
+    def validate(config, file_name)
+      return unless block_given?
+      raise 'Validation block returned false' if yield(config) == false
+    rescue StandardError => e
+      fail FailedValidationError.new(file_name, e)
+    end
+
+    def load_yaml(file_name)
+      file = CoConfig.config_path(file_name)
+      fail MissingFileError.new(file_name.to_s) unless file.exist?
+      ::YAML.load_file(file).with_indifferent_access
+    end
+
+    def full_name(file_name)
+      if /\.yml\Z/ =~ file_name
+        file_name
+      else
+        "#{file_name}.yml"
+      end
+    end
+
+    def base_name(file_name)
+      File.basename(file_name, '.*')
+    end
+
+  end
+end

data/lib/co_config/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module CoConfig
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      CoConfig.load
+    end
+  end
+end

data/lib/co_config/version.rb

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

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: co_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ezequiel Rabinovich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- erabinovich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- co_config.gemspec
+- lib/co_config.rb
+- lib/co_config/errors.rb
+- lib/co_config/loader.rb
+- lib/co_config/railtie.rb
+- lib/co_config/version.rb
+homepage: https://github.com/comparaonline/co_config
+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.3
+signing_key: 
+specification_version: 4
+summary: Simple configuration management gem.
+test_files: []