co_config 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +70 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/co_config.gemspec +27 -0
- data/lib/co_config.rb +28 -0
- data/lib/co_config/errors.rb +24 -0
- data/lib/co_config/loader.rb +51 -0
- data/lib/co_config/railtie.rb +9 -0
- data/lib/co_config/version.rb +3 -0
- metadata +129 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: efb57ac6fb4c6706e26450bfe8a2f82bf2138b2e
|
4
|
+
data.tar.gz: 4579b897c1e59fe31f603977e09f304781d5e9fa
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: dd6d42e31fd300fb385449e8816e42f15b94950332d36988dace16b323d66e13b8b144be63688724855b7974f945c58c67622caec896e8fed1cd556a491bccb2
|
7
|
+
data.tar.gz: 8e12fa30cfc1ca068eba4d3d65ebbb74ba253b5d3788bf18ec77d6c92175bbc4ae42cce2159a547259cdbb95f008190fe8d38ac13012977f885f60f5d028eb5a
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2015 Ezequiel Rabinovich
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
# CoConfig
|
2
|
+
|
3
|
+
This is a simple gem to load configuration files on rails.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'co_config'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install co_config
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Create a `configuration.rb` file on your rails application's config folder.
|
24
|
+
This file will indicate which files are loaded.
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
# To load the test.yml file into the CoConfig::TEST hash
|
28
|
+
load 'test'
|
29
|
+
|
30
|
+
# To validate the configuration you could use
|
31
|
+
load 'test2' { |c| c.token.present? }
|
32
|
+
# or
|
33
|
+
load 'test3' { |c| raise if token.empty? }
|
34
|
+
```
|
35
|
+
|
36
|
+
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.
|
37
|
+
|
38
|
+
```yaml
|
39
|
+
# test.yml
|
40
|
+
---
|
41
|
+
|
42
|
+
development:
|
43
|
+
value: 1
|
44
|
+
```
|
45
|
+
|
46
|
+
```yaml
|
47
|
+
# test2.yml
|
48
|
+
---
|
49
|
+
|
50
|
+
defaults:
|
51
|
+
token: 'MYAWESOMETOKEN'
|
52
|
+
```
|
53
|
+
|
54
|
+
To read your configuration you can access the hash (with indifferent access) at `CoConfig::CONFIG_NAME_UPPERCASE`
|
55
|
+
|
56
|
+
## Development
|
57
|
+
|
58
|
+
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.
|
59
|
+
|
60
|
+
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).
|
61
|
+
|
62
|
+
## Contributing
|
63
|
+
|
64
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/co_config.
|
65
|
+
|
66
|
+
|
67
|
+
## License
|
68
|
+
|
69
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
70
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "co_config"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/co_config.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'co_config/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "co_config"
|
8
|
+
spec.version = CoConfig::VERSION
|
9
|
+
spec.authors = ["Ezequiel Rabinovich"]
|
10
|
+
spec.email = ["erabinovich@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Simple configuration management gem.}
|
13
|
+
spec.homepage = "https://github.com/comparaonline/co_config"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = "exe"
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency 'activesupport', '>= 3.0'
|
22
|
+
spec.add_dependency 'rails', '>= 3.0'
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.10"
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
26
|
+
spec.add_development_dependency "rspec"
|
27
|
+
end
|
data/lib/co_config.rb
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
require "co_config/version"
|
2
|
+
require 'co_config/loader'
|
3
|
+
require 'co_config/railtie'
|
4
|
+
|
5
|
+
module CoConfig
|
6
|
+
class Configuration
|
7
|
+
include Loader
|
8
|
+
|
9
|
+
def initialize(file)
|
10
|
+
instance_eval(File.read(file.to_s), file.to_s) if file.exist?
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
def config_path(file)
|
15
|
+
Rails.root.join('config', file)
|
16
|
+
end
|
17
|
+
|
18
|
+
def env
|
19
|
+
Rails.env
|
20
|
+
end
|
21
|
+
|
22
|
+
def load
|
23
|
+
file = config_path('configuration.rb')
|
24
|
+
Configuration.new(file)
|
25
|
+
end
|
26
|
+
|
27
|
+
module_function :load, :config_path, :env
|
28
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
module CoConfig
|
2
|
+
class ConfigurationLoadError < RuntimeError
|
3
|
+
attr_reader :message
|
4
|
+
alias_method :to_s, :message
|
5
|
+
end
|
6
|
+
|
7
|
+
class MissingFileError < ConfigurationLoadError
|
8
|
+
def initialize(file_name)
|
9
|
+
@message = "Configuration file '#{file_name}' not found"
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
class MissingConfigError < ConfigurationLoadError
|
14
|
+
def initialize(file_name, env)
|
15
|
+
@message = "Missing configuration for '#{env}' on '#{file_name}'"
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
class FailedValidationError < ConfigurationLoadError
|
20
|
+
def initialize(file_name, error)
|
21
|
+
@message = "Failed validation for '#{file_name}' (#{error.to_s})"
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
require 'co_config/errors'
|
2
|
+
require 'yaml'
|
3
|
+
require 'active_support/core_ext/hash/indifferent_access'
|
4
|
+
require 'active_support/core_ext/object/blank'
|
5
|
+
|
6
|
+
module CoConfig
|
7
|
+
module Loader
|
8
|
+
module_function :load
|
9
|
+
|
10
|
+
def load(file_name, &validation)
|
11
|
+
config = load!(full_name(file_name), &validation)
|
12
|
+
CoConfig.const_set(base_name(file_name).upcase, config)
|
13
|
+
end
|
14
|
+
|
15
|
+
private
|
16
|
+
|
17
|
+
def load!(file_name, &validation)
|
18
|
+
hash = load_yaml(file_name)
|
19
|
+
config = hash.fetch(CoConfig.env, hash[:defaults])
|
20
|
+
fail MissingConfigError.new(file_name, CoConfig.env) unless config.present?
|
21
|
+
validate(config, file_name, &validation)
|
22
|
+
config
|
23
|
+
end
|
24
|
+
|
25
|
+
def validate(config, file_name)
|
26
|
+
return unless block_given?
|
27
|
+
raise 'Validation block returned false' if yield(config) == false
|
28
|
+
rescue StandardError => e
|
29
|
+
fail FailedValidationError.new(file_name, e)
|
30
|
+
end
|
31
|
+
|
32
|
+
def load_yaml(file_name)
|
33
|
+
file = CoConfig.config_path(file_name)
|
34
|
+
fail MissingFileError.new(file_name.to_s) unless file.exist?
|
35
|
+
::YAML.load_file(file).with_indifferent_access
|
36
|
+
end
|
37
|
+
|
38
|
+
def full_name(file_name)
|
39
|
+
if /\.yml\Z/ =~ file_name
|
40
|
+
file_name
|
41
|
+
else
|
42
|
+
"#{file_name}.yml"
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
def base_name(file_name)
|
47
|
+
File.basename(file_name, '.*')
|
48
|
+
end
|
49
|
+
|
50
|
+
end
|
51
|
+
end
|
metadata
ADDED
@@ -0,0 +1,129 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: co_config
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ezequiel Rabinovich
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-09-16 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activesupport
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rails
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '3.0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '3.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.10'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.10'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- erabinovich@gmail.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- ".rspec"
|
92
|
+
- ".travis.yml"
|
93
|
+
- Gemfile
|
94
|
+
- LICENSE.txt
|
95
|
+
- README.md
|
96
|
+
- Rakefile
|
97
|
+
- bin/console
|
98
|
+
- bin/setup
|
99
|
+
- co_config.gemspec
|
100
|
+
- lib/co_config.rb
|
101
|
+
- lib/co_config/errors.rb
|
102
|
+
- lib/co_config/loader.rb
|
103
|
+
- lib/co_config/railtie.rb
|
104
|
+
- lib/co_config/version.rb
|
105
|
+
homepage: https://github.com/comparaonline/co_config
|
106
|
+
licenses:
|
107
|
+
- MIT
|
108
|
+
metadata: {}
|
109
|
+
post_install_message:
|
110
|
+
rdoc_options: []
|
111
|
+
require_paths:
|
112
|
+
- lib
|
113
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
119
|
+
requirements:
|
120
|
+
- - ">="
|
121
|
+
- !ruby/object:Gem::Version
|
122
|
+
version: '0'
|
123
|
+
requirements: []
|
124
|
+
rubyforge_project:
|
125
|
+
rubygems_version: 2.2.3
|
126
|
+
signing_key:
|
127
|
+
specification_version: 4
|
128
|
+
summary: Simple configuration management gem.
|
129
|
+
test_files: []
|