konfig-yaml 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fde29a61af33ae8a4814948bbc67fdd876e2b47e
-  data.tar.gz: 228da72085e0a21d1ee18a961c35a2f3bded46d2
+SHA256:
+  metadata.gz: 81472d9c7b5adac249a44bf50b5ca8d6746f112ecb12638e32021fd8c134a8a2
+  data.tar.gz: b5063c6f970702f29dae0d9637fc3bb8e9395fa0929a81e5c53bc2c79950c478
 SHA512:
-  metadata.gz: e9b0603ac9f70e0ee2ab0aa35cbd926e4fe7fb90e7e0a130597445a1c3bb14f9b323869210cc611b8b59aa3d15ddf3dfe282119c92207ed855455fc90042f61a
-  data.tar.gz: 8c7e625c074a5bc38a90b5e77e923ab0d38e5a22499f99a383fe8b0c5903b8d0505bd2fa57548e9f4f0e9feeaf2a9a0dd73955037eb5681e1625bc71b94b9712
+  metadata.gz: 7365f1e19f29aae6627491839a5c622792ff607721865e632aaf554b945ccc05c0e44bbc7ccaa75e8d4c1a3d5719a3b8184e8f3b0adf2f3f45a5238e74248730
+  data.tar.gz: 1f96bb8b49d895c9f296fbd86fe8d05caba42da3a7733715ff30baae90d639974f470904e3c762714e4a345e8c2d2afbb3e90b2dc770a06c833ca2f8c90fec61

data/README.md

@@ -1,6 +1,7 @@
 # konfig-yaml for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/konfig-yaml.svg)](https://badge.fury.io/rb/konfig-yaml)
+[![document](https://img.shields.io/badge/document-1.0.0-green.svg)](http://www.rubydoc.info/gems/konfig-yaml/)
 [![Build Status](https://travis-ci.org/tilfin/konfig-yaml-rb.svg?branch=master)](https://travis-ci.org/tilfin/konfig-yaml-rb)
 [![Code Climate](https://codeclimate.com/github/tilfin/konfig-yaml-rb/badges/gpa.svg)](https://codeclimate.com/github/tilfin/konfig-yaml-rb)
 [![Test Coverage](https://codeclimate.com/github/tilfin/konfig-yaml-rb/badges/coverage.svg)](https://codeclimate.com/github/tilfin/konfig-yaml-rb/coverage)
@@ -43,8 +44,8 @@ config = KonfigYaml.new([name], [opts]);
 * `name` specifys the name of `config/<name>.yml` ( default `app` )
 * `opts`
   * `:path` config directory path resolved from the process current one ( default `config` )
+  * `:erb` whether expand ERB or not ( default `false` )
   * `:env` Execution environment ( default **RUBY_ENV** value, **RAILS_ENV** value, **RACK_ENV** value, or `development` )
-  * `:use_cache` whether using cache ( default `true` )
 
 ### Load a configuration as Static class
 
@@ -96,14 +97,6 @@ p config.backend.host # "cms.example.com"
 p config.backend.port # 7080
 ```
 
-### Clear caches
-
-For testing purpose
-
-```
-KonfigYaml.clear
-```
-
 ## Example
 
 ### Setup

data/config/another.yaml

@@ -0,0 +1,19 @@
+default:
+  log:
+    level: info
+  short_env: default
+
+development:
+  log:
+    level: debug
+  short_env: dev
+
+empty_env:
+
+staging:
+  short_env: stg
+
+production:
+  short_env: prd
+  log:
+    level: error

data/config/app.yml

@@ -0,0 +1,64 @@
+default:
+  port: 1080
+  db:
+    host: localhost
+    name: service-${RUBY_ENV:development}
+    user: ${DATABASE_USER:-user}
+    pass: ${DATABASE_PASSWORD:-password}
+  log:
+    level: debug
+  access_limits:
+    - 127.0.0.1
+  entries:
+    - 0
+    - name: A
+      value: 1
+    - name: B
+      value: 2
+
+development: &dev
+  root_url: http://localhost
+  log:
+    file: log/app.log
+
+test:
+  <<: *dev
+  log:
+    level: error
+    file: log/test.log
+
+integration: &deployments
+  root_url: https://api-itg.example.com
+  db:
+    host: ${DATABASE_HOST}
+  log:
+    level: info
+  bucket: storage-service-stg
+  bucket_path: /itg
+  cloud_access_key: aaabbbccc
+  access_limits:
+    - 192.168.0.0/24
+    - 10.0.0.0/8
+
+staging:
+  <<: *deployments
+  root_url: https://api-stg.example.com
+  bucket_path: /stg
+
+preproduction:
+  <<: *deployments
+  root_url: https://api-pre.example.com
+  log:
+    level: warn
+  bucket_path: /pre
+
+production:
+  root_url: https://api.example.com
+  db:
+    host: ${DATABASE_HOST}
+  log:
+    level: error
+  bucket: storage-service
+  bucket_path: /
+  cloud_access_key: xxxyyyzzz
+  access_limits:

data/lib/konfig_yaml/main.rb

@@ -11,8 +11,8 @@ class KonfigYaml
   # @param [String] name ('app') the basename of YAML file
   # @param [Hash] opts the options to intialize
   # @option opts [String] :env (ENV['RUBY_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development') execution environment
+  # @option opts [Boolean] :erb (false) whether evaluate ERB or not
   # @option opts [String] :path ('config') directory path that contains the YAML file
-  # @option opts [Boolean] :use_cache (true) whether cache settings or not
   def initialize(name = 'app', opts = nil)
     if name.is_a?(Hash) && opts.nil?
       opts = name
@@ -20,6 +20,7 @@ class KonfigYaml
     elsif opts.nil?
       opts = {}
     end
+
     hash = self.class.create_hash(name, opts)
     set_inner_hash(hash)
   end
@@ -56,18 +57,13 @@ class KonfigYaml
       Object.const_set(const_name, cls)
     end
 
-    # Clear caches
-    def clear
-      @cfg_cache = {}
-    end
-
     def create_hash(name, opts)
       name ||= 'app'
       path = File.expand_path(opts[:path] || 'config', Dir.pwd)
       env = environment(opts)
-      use_cache = opts.fetch(:use_cache, true)
+      expand_erb = opts.fetch(:erb, false)
 
-      h = load_config(name, env, path, use_cache)
+      h = load_config(name, env, path, expand_erb)
       dup_hash_expand_envs(h)
     end
 
@@ -79,24 +75,17 @@ class KonfigYaml
       ENV['RUBY_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
 
-    def cfg_cache
-      @cfg_cache ||= {}
-    end
-
-    def load_config(name, env, path, use_cache)
-      cfg_key = "#{name}/#{env}"
-      if use_cache && cfg_cache.key?(cfg_key)
-        return cfg_cache[cfg_key]
-      end
-
-      data = load_yaml(name, path)
-      cfg_cache[cfg_key] = convert_data_to_hash(data, env)
+    def load_config(name, env, path, expand_erb)
+      data = load_yaml(name, path, expand_erb)
+      convert_data_to_hash(data, env)
     end
 
-    def load_yaml(name, dir)
+    def load_yaml(name, dir, expand_erb)
       file_path = Dir.glob("#{dir}/#{name}.{yml,yaml}").first
       raise ArgumentError.new("Not found configuration yaml file") unless file_path
-      YAML.load(File.read(file_path))
+      str = File.read(file_path)
+      str = ERB.new(str).result if expand_erb
+      YAML.load(str)
     end
 
     def convert_data_to_hash(data, env)

data/lib/konfig_yaml/version.rb

@@ -1,3 +1,3 @@
 class KonfigYaml
-  VERSION = '0.9.1'
+  VERSION = '1.0.0'
 end

data/spec/fixtures/app.yaml

@@ -2,6 +2,10 @@ default:
   log:
     level: info
   short_env: default
+  array:
+    - foo
+    - field1: bar
+      field2: baz
 
 development:
   log:

data/spec/fixtures/erb_config.yml

@@ -0,0 +1,2 @@
+default:
+  label: <%= 3 * 15 %>seconds

data/spec/konfig_yaml_spec.rb

@@ -120,43 +120,31 @@ describe KonfigYaml do
       end
     end
 
-    describe 'option use_cache' do
+    describe 'option erb' do
       let!(:path) { File.expand_path("../fixtures", __FILE__) }
       let!(:pre_instance) { described_class.new }
 
-      before do
-        allow(described_class).to receive(:load_yaml).and_raise('load_yaml called')
-      end
-
       context 'not specified' do
-        subject { described_class.new }
+        subject { described_class.new('erb_config', path: path) }
 
-        it 'loads cached instance without calling load_yaml' do
-          expect{ subject }.not_to raise_error 'load_yaml called'
+        it 'loads without evaluating ERB' do
+          expect(subject.label).to eq '<%= 3 * 15 %>seconds'
         end
       end
 
       context 'true' do
-        subject { described_class.new(use_cache: true) }
-
-        it 'loads cached instance without calling load_yaml' do
-          expect{ subject }.not_to raise_error 'load_yaml called'
-        end
-
-        context 'after cache cleared' do
-          before { described_class.clear }
+        subject { described_class.new('erb_config', path: path, erb: true) }
 
-          it 'loads new instance with calling load_yaml' do
-            expect{ subject }.to raise_error 'load_yaml called'
-          end
+        it 'loads with evaluating ERB' do
+          expect(subject.label).to eq '45seconds'
         end
       end
 
       context 'false' do
-        subject { described_class.new(use_cache: false) }
+        subject { described_class.new('erb_config', path: path, erb: false) }
 
-        it 'loads new instance with calling load_yaml' do
-          expect{ subject }.to raise_error 'load_yaml called'
+        it 'loads without evaluating ERB' do
+          expect(subject.label).to eq '<%= 3 * 15 %>seconds'
         end
       end
     end
@@ -207,6 +195,11 @@ describe KonfigYaml do
         expect{ subject.cloud_access_key }.to raise_error(NoMethodError)
         expect(subject[:cloud_access_key]).to be_nil
         expect(subject.access_limits).to eq ['127.0.0.1']
+        expect(subject.entries[0]).to eq 0
+        expect(subject.entries[1].name).to eq 'A'
+        expect(subject.entries[1].value).to eq 1
+        expect(subject.entries[2].name).to eq 'B'
+        expect(subject.entries[2].value).to eq 2
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: konfig-yaml
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neohash
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,12 +75,15 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- config/another.yaml
+- config/app.yml
 - lib/konfig-yaml.rb
 - lib/konfig_yaml.rb
 - lib/konfig_yaml/main.rb
 - lib/konfig_yaml/version.rb
 - spec/fixtures/another.yml
 - spec/fixtures/app.yaml
+- spec/fixtures/erb_config.yml
 - spec/konfig_yaml_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tilfin/konfig-yaml-rb
@@ -103,12 +106,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Loader for YAML configuration with ENVs.
 test_files:
 - spec/konfig_yaml_spec.rb
 - spec/fixtures/another.yml
+- spec/fixtures/erb_config.yml
 - spec/fixtures/app.yaml
 - spec/spec_helper.rb
+- config/another.yaml
+- config/app.yml