konfig-yaml 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 655ff90650e291f68f89b1c9b85e50443722a594
-  data.tar.gz: d20864bd49f7610a8bedd5afb54dafdbe5c9ebcc
+  metadata.gz: fde29a61af33ae8a4814948bbc67fdd876e2b47e
+  data.tar.gz: 228da72085e0a21d1ee18a961c35a2f3bded46d2
 SHA512:
-  metadata.gz: 192f77af8b61f26a6932e612d312fc82caf75d95d5cd54b23cce79a5dfadf54c4542362829100dd197b090e3f607f5489894b882bb262702acdeae711cdccc41
-  data.tar.gz: 329d9eb47988927b9abc280b08eda11619bf55c7b596dbad67b17571fda79fbb15c2a384ddb9d7ac78e5cdfa0aa113fe586a96a13a52339d8e2f818eec20f62e
+  metadata.gz: e9b0603ac9f70e0ee2ab0aa35cbd926e4fe7fb90e7e0a130597445a1c3bb14f9b323869210cc611b8b59aa3d15ddf3dfe282119c92207ed855455fc90042f61a
+  data.tar.gz: 8c7e625c074a5bc38a90b5e77e923ab0d38e5a22499f99a383fe8b0c5903b8d0505bd2fa57548e9f4f0e9feeaf2a9a0dd73955037eb5681e1625bc71b94b9712

data/README.md

@@ -32,7 +32,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Load a configuration
+### Load a configuration instance
 
 ```ruby
 require 'konfig-yaml'
@@ -46,6 +46,18 @@ config = KonfigYaml.new([name], [opts]);
   * `: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
+
+```ruby
+require 'konfig-yaml'
+
+KonfigYaml.setup do |config|
+  config.const_name = 'Config' # default is 'Settings'
+end
+
+p Config.log.level
+```
+
 ### Access the values
 
 #### by accessor method
@@ -71,7 +83,7 @@ log_lv = config['log'].level
 
 ### Dynamically change settings
 
-Support only symbol or string
+Support only symbol or string key if adding new field
 
 ```ruby
 config[:port] = 80

data/lib/konfig_yaml/main.rb

@@ -1,16 +1,17 @@
 require 'pathname'
 require 'neohash'
+require 'ostruct'
 
 # KonfigYaml main class
 class KonfigYaml
   include NeoHash::Support
 
-  # Create an configuration from yaml file
+  # Create an configuration from YAML file
   #
-  # @param [String] name ('app') the basename of yaml file
+  # @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 [String] :path ('config') directory path that contains the yaml file
+  # @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?
@@ -19,100 +20,138 @@ class KonfigYaml
     elsif opts.nil?
       opts = {}
     end
+    hash = self.class.create_hash(name, opts)
+    set_inner_hash(hash)
+  end
 
-    path = File.expand_path(opts[:path] || 'config', Dir.pwd)
-    env = environment(opts)
-    use_cache = opts.fetch(:use_cache, true)
+  class << self
+    # Setup global configuration class from YAML file
+    # If this is called without block, this defines `Settings` class by loading `config/app.yml`
+    # @yield [config] configuration to the block
+    # @yieldparam config [OpenStruct] support `const_name`, `name`, `env`, `path` and `use_cahe` attribute
+    def setup(&block)
+      const_name = 'Settings'
+      name = nil
+      opts = {}
 
-    h = load_config(name, env, path, use_cache)
-    set_inner_hash(dup_hash_expand_envs(h))
-  end
+      if block_given?
+        cfg = OpenStruct.new
+        yield(cfg)
+        cfg.each_pair do |key, val|
+          if key == :const_name
+            const_name = val
+          elsif key == :name
+            name = val
+          else
+            opts[key] = val
+          end
+        end
+      end
 
-  # Clear caches
-  def self.clear
-    @@cfg_cache = {};
-  end
+      hash = create_hash(name, opts)
+      cls = Class.new do
+        extend NeoHash::Support
+        set_inner_hash(hash)
+      end
+      Object.const_set(const_name, cls)
+    end
 
-  private
+    # Clear caches
+    def clear
+      @cfg_cache = {}
+    end
 
-  def environment(opts)
-    env = opts[:env]
-    return env.to_s if env
-    ENV['RUBY_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
-  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)
 
-  def cfg_cache
-    @@cfg_cache ||= {}
-  end
+      h = load_config(name, env, path, use_cache)
+      dup_hash_expand_envs(h)
+    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]
+    private
+
+    def environment(opts)
+      env = opts[:env]
+      return env.to_s if env
+      ENV['RUBY_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
 
-    data = load_yaml(name, path)
-    cfg_cache[cfg_key] = convert_data_to_hash(data, env)
-  end
+    def cfg_cache
+      @cfg_cache ||= {}
+    end
 
-  def load_yaml(name, dir)
-    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))
-  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
 
-  def convert_data_to_hash(data, env)
-    if data.include?(env)
-      deep_merge(data[env] || {}, data['default'] || {})
-    elsif data.include?('default')
-      data['default']
-    else
-      raise ArgumentError.new("The configuration for #{env} is not defined in #{name}")
+      data = load_yaml(name, path)
+      cfg_cache[cfg_key] = convert_data_to_hash(data, env)
     end
-  end
 
-  def deep_merge(target, default)
-    target.merge(default) do |key, target_val, default_val|
-      if target_val.is_a?(Hash) && default_val.is_a?(Hash)
-        deep_merge(target_val, default_val)
+    def load_yaml(name, dir)
+      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))
+    end
+
+    def convert_data_to_hash(data, env)
+      if data.include?(env)
+        deep_merge(data[env] || {}, data['default'] || {})
+      elsif data.include?('default')
+        data['default']
       else
-        target_val
+        raise ArgumentError.new("The configuration for #{env} is not defined in #{name}")
       end
     end
-  end
 
-  def dup_hash_expand_envs(root)
-    root.map do |name, val|
-      if val.is_a?(Hash)
-        [name, dup_hash_expand_envs(val)]
-      elsif val.is_a?(Array)
-        [name, dup_array_expand_envs(val)]
-      elsif val.is_a?(String)
-        [name, expand_envs(val)]
-      else
-        [name, val]
+    def deep_merge(target, default)
+      target.merge(default) do |key, target_val, default_val|
+        if target_val.is_a?(Hash) && default_val.is_a?(Hash)
+          deep_merge(target_val, default_val)
+        else
+          target_val
+        end
       end
-    end.to_h
-  end
+    end
 
-  def dup_array_expand_envs(root)
-    root.map do |val|
-      if val.is_a?(Hash)
-        dup_hash_expand_envs(val)
-      elsif val.is_a?(Array)
-        dup_array_expand_envs(val)
-      elsif val.is_a?(String)
-        expand_envs(val)
-      else
-        val
+    def dup_hash_expand_envs(root)
+      root.map do |name, val|
+        if val.is_a?(Hash)
+          [name, dup_hash_expand_envs(val)]
+        elsif val.is_a?(Array)
+          [name, dup_array_expand_envs(val)]
+        elsif val.is_a?(String)
+          [name, expand_envs(val)]
+        else
+          [name, val]
+        end
+      end.to_h
+    end
+
+    def dup_array_expand_envs(root)
+      root.map do |val|
+        if val.is_a?(Hash)
+          dup_hash_expand_envs(val)
+        elsif val.is_a?(Array)
+          dup_array_expand_envs(val)
+        elsif val.is_a?(String)
+          expand_envs(val)
+        else
+          val
+        end
       end
     end
-  end
 
-  def expand_envs(str)
-    str.gsub(/\$\{(.+?)\}/) do |m|
-      env_key, default = $1.split(/:\-?/)
-      ENV[env_key] || default || ''
+    def expand_envs(str)
+      str.gsub(/\$\{(.+?)\}/) do |m|
+        env_key, default = $1.split(/:\-?/)
+        ENV[env_key] || default || ''
+      end
     end
   end
 end

data/lib/konfig_yaml/version.rb

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

data/spec/fixtures/another.yml

@@ -1,10 +1,10 @@
 default:
-  logger:
+  log:
     level: info
   short_env: default
 
 development:
-  logger:
+  log:
     level: debug
   short_env: dev
 
@@ -15,5 +15,5 @@ staging:
 
 production:
   short_env: prd
-  logger:
+  log:
     level: error

data/spec/fixtures/app.yaml

@@ -1,10 +1,10 @@
 default:
-  logger:
+  log:
     level: info
   short_env: default
 
 development:
-  logger:
+  log:
     level: debug
   short_env: dev
 
@@ -15,5 +15,5 @@ staging:
 
 production:
   short_env: prd
-  logger:
+  log:
     level: error

data/spec/konfig_yaml_spec.rb

@@ -125,7 +125,7 @@ describe KonfigYaml do
       let!(:pre_instance) { described_class.new }
 
       before do
-        allow_any_instance_of(described_class).to receive(:load_yaml).and_raise('load_yaml called')
+        allow(described_class).to receive(:load_yaml).and_raise('load_yaml called')
       end
 
       context 'not specified' do
@@ -162,6 +162,31 @@ describe KonfigYaml do
     end
   end
 
+  describe '#setup' do
+    let!(:path) { File.expand_path("../fixtures", __FILE__) }
+
+    context 'without block' do
+      it 'defines Settings class' do
+        described_class.setup
+
+        expect(Settings.log.file).to eq('log/app.log')
+      end
+    end
+
+    context 'with block' do
+      it 'defines SettingsB class' do
+        described_class.setup do |config|
+          config.name = 'another'
+          config.path = path
+          config.const_name = 'SettingsB'
+        end
+
+        expect(SettingsB.log.level).to eq('debug')
+        expect(SettingsB.short_env).to eq('dev')
+      end
+    end
+  end
+
   describe 'merged configuraton' do
     subject { described_class.new('app', path: 'config', env: env) }
 
@@ -175,8 +200,8 @@ describe KonfigYaml do
         expect(subject.db.user).to eq('user')
         expect(subject.db.pass).to eq('password')
         expect(subject.root_url).to eq('http://localhost')
-        expect(subject.logger.level).to eq('debug')
-        expect(subject.logger.file).to eq('log/app.log')
+        expect(subject.log.level).to eq('debug')
+        expect(subject.log.file).to eq('log/app.log')
         expect{ subject.bucket }.to raise_error(NoMethodError)
         expect{ subject.bucket_path }.to raise_error(NoMethodError)
         expect{ subject.cloud_access_key }.to raise_error(NoMethodError)
@@ -195,8 +220,8 @@ describe KonfigYaml do
         expect(subject.db.user).to eq('user')
         expect(subject.db.pass).to eq('password')
         expect(subject.root_url).to eq('http://localhost')
-        expect(subject.logger.level).to eq('error')
-        expect(subject.logger.file).to eq('log/test.log')
+        expect(subject.log.level).to eq('error')
+        expect(subject.log.file).to eq('log/test.log')
         expect{ subject.bucket }.to raise_error(NoMethodError)
         expect{ subject.bucket_path }.to raise_error(NoMethodError)
         expect{ subject.cloud_access_key }.to raise_error(NoMethodError)
@@ -232,8 +257,8 @@ describe KonfigYaml do
         expect(subject.db.user).to eq('user')
         expect(subject.db.pass).to eq('password')
         expect(subject.root_url).to eq('https://api-itg.example.com')
-        expect(subject.logger.level).to eq('info')
-        expect(subject.logger[:file]).to be_nil
+        expect(subject.log.level).to eq('info')
+        expect(subject.log[:file]).to be_nil
         expect(subject.bucket).to eq('storage-service-stg')
         expect(subject.bucket_path).to eq('/itg')
         expect(subject.cloud_access_key).to eq('aaabbbccc')
@@ -274,8 +299,8 @@ describe KonfigYaml do
         expect(subject.db.user).to eq('user')
         expect(subject.db.pass).to eq('password')
         expect(subject.root_url).to eq('https://api-stg.example.com')
-        expect(subject.logger.level).to eq('info')
-        expect(subject.logger['file']).to be_nil
+        expect(subject.log.level).to eq('info')
+        expect(subject.log['file']).to be_nil
         expect(subject.bucket).to eq('storage-service-stg')
         expect(subject.bucket_path).to eq('/stg')
         expect(subject.cloud_access_key).to eq('aaabbbccc')
@@ -316,8 +341,8 @@ describe KonfigYaml do
         expect(subject.db.user).to eq('user')
         expect(subject.db.pass).to eq('password')
         expect(subject.root_url).to eq('https://api-pre.example.com')
-        expect(subject.logger.level).to eq('warn')
-        expect(subject.logger[:file]).to be_nil
+        expect(subject.log.level).to eq('warn')
+        expect(subject.log[:file]).to be_nil
         expect(subject.bucket).to eq('storage-service-stg')
         expect(subject.bucket_path).to eq('/pre')
         expect(subject.cloud_access_key).to eq('aaabbbccc')
@@ -358,8 +383,8 @@ describe KonfigYaml do
         expect(subject.db.user).to eq('user')
         expect(subject.db.pass).to eq('password')
         expect(subject.root_url).to eq('https://api.example.com')
-        expect(subject.logger.level).to eq('error')
-        expect(subject.logger['file']).to be_nil
+        expect(subject.log.level).to eq('error')
+        expect(subject.log['file']).to be_nil
         expect(subject.bucket).to eq('storage-service')
         expect(subject.bucket_path).to eq('/')
         expect(subject.cloud_access_key).to eq('xxxyyyzzz')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: konfig-yaml
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.1
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neohash
@@ -73,12 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
 - lib/konfig-yaml.rb
 - lib/konfig_yaml.rb
 - lib/konfig_yaml/main.rb

data/.gitignore

@@ -1,34 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## 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

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in konfig-yaml.gemspec
-gemspec
-
-group :test do
-  gem 'simplecov', require: false
-end

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    konfig-yaml (0.8.1)
-      neohash (~> 0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    docile (1.1.5)
-    json (2.1.0)
-    neohash (0.1.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  konfig-yaml!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov
-
-BUNDLED WITH
-   1.16.0

data/Rakefile

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