benry-config 0.1.0 → 0.2.0

data/test/config_test.rb

@@ -1,15 +1,13 @@
 # -*- coding: utf-8 -*-
 
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'minitest/ok'
+require 'oktest'
 
 require 'benry/config'
 
 
 
 
-class TestCommonConfig < Benry::BaseConfig
+class TestCommonConfig < Benry::Config
   add :db_name            , "db1"
   add :db_user            , "user1"
   add :db_pass            , ABSTRACT
@@ -31,151 +29,330 @@ class TestConfig3 < TestCommonConfig
   #set :session_secret     , "abc123"
 end
 
+class TestConfig4 < TestCommonConfig
+  set :db_pass            , ABSTRACT['DBPASS']
+  set :session_secret     , ABSTRACT['SESS_SECRET']
+end
+
+
 
+Oktest.scope do
 
-describe Benry::BaseConfig do
 
+  topic Benry::Config::AbstractValue do
 
-  describe '#initialize()' do
 
-    it "[!7rdq4] traverses parent class and gathers config values." do
-      config = TestConfig.new
-      ok {config.db_name} == "db1"
-      ok {config.db_user} == "user1"
-      ok {config.db_pass} == "pass1"
-      ok {config.session_secret} == "abc123"
+    topic '#initialize()' do
+
+      spec "[!6hcf9] accepts environment variable name." do
+        v = Benry::Config::AbstractValue.new(:FOO)
+        ok {v.envvar} == :FOO
+      end
+
     end
 
-    it "[!z9mno] raises ConfigError when ABSTRACT or SECRET is not overriden." do
-      pr = proc { TestConfig2.new }
-      ex = ok {pr}.raise?(Benry::ConfigError)
-      ok {ex.message} == "config ':db_pass' should be set, but not."
-      #
-      pr = proc { TestConfig3.new }
-      ex = ok {pr}.raise?(Benry::ConfigError)
-      ok {ex.message} == "config ':session_secret' should be set, but not."
+
+    topic '#[]' do
+
+      spec "[!p0acp] returns new object with environment variable name." do
+        foo = Benry::Config::ABSTRACT[:FOO]
+        ok {foo.class} == Benry::Config::AbstractValue
+        ok {foo.envvar} == :FOO
+        #
+        bar = Benry::Config::SECRET[:BAR]
+        ok {bar.class} == Benry::Config::SecretValue
+        ok {bar.envvar} == :BAR
+      end
     end
 
+
   end
 
 
-  describe '.add()' do
 
-    it "[!m7w96] raises ConfigError when already added." do
-      pr = proc do
-        TestCommonConfig.class_eval do
-          add :db_name,  "db9"
+  topic Benry::Config do
+
+
+    topic '#initialize()' do
+
+      spec "[!7rdq4] traverses parent class and gathers config values." do
+        config = TestConfig.new
+        ok {config.db_name} == "db1"
+        ok {config.db_user} == "user1"
+        ok {config.db_pass} == "pass1"
+        ok {config.session_secret} == "abc123"
+      end
+
+      case_when "[!v9f3k] when envvar name not specified..." do
+
+        spec "[!z9mno] raises ConfigError if ABSTRACT or SECRET is not overriden." do
+          pr = proc { TestConfig2.new }
+          ok {pr}.raise?(Benry::ConfigError,
+                         "config ':db_pass' should be set, but not.")
+          #
+          pr = proc { TestConfig3.new }
+          ok {pr}.raise?(Benry::ConfigError,
+                         "config ':session_secret' should be set, but not.")
         end
+
       end
-      ex = ok {pr}.raise?(Benry::ConfigError)
-      ok {ex.message} == "add :db_name : already defined (use set() instead)."
-    end
 
-    it "[!s620t] adds new key and value." do
-      ok {TestCommonConfig.instance_variable_get('@__dict')} == {
-        :db_name        => "db1",
-        :db_user        => "user1",
-        :db_pass        => Benry::BaseConfig::ABSTRACT,
-        :session_secret => Benry::BaseConfig::SECRET,
-      }
-    end
+      case_when "[!ida3r] when envvar name specified..." do
+
+        spec "[!txl88] raises ConfigError when envvar not set." do
+          ENV['DBPASS'] = nil
+          ENV['SESS_SECRET'] = nil
+          pr = proc { TestConfig4.new }
+          ok {pr}.raise?(Benry::ConfigError,
+                         "environment variable '$DBPASS' should be set for config item ':db_pass'.")
+          #
+          ENV['DBPASS'] = "pass1"
+          pr = proc { TestConfig4.new }
+          ok {pr}.raise?(Benry::ConfigError,
+                         "environment variable '$SESS_SECRET' should be set for config item ':session_secret'.")
+        end
+
+        spec "[!y47ul] sets envvar value as config value if envvar provided." do
+          ENV['DBPASS']      = "<PASS>"
+          ENV['SESS_SECRET'] = "<SECRETVALUE>"
+          conf = TestConfig4.new
+          ok {conf.db_pass}        == "<PASS>"
+          ok {conf.session_secret} == "<SECRETVALUE>"
+        end
 
-    it "[!o0ts4] defines getter method." do
-      cls = Class.new(Benry::BaseConfig) do
-        add :foo  , "FOO"
       end
-      obj = cls.new
-      ok {obj}.respond_to?(:foo)
-      ok {obj.foo} == "FOO"
+
     end
 
-  end
 
+    topic '.add()' do
 
-  describe '.set()' do
+      spec "[!m7w96] raises ConfigError when already added." do
+        pr = proc do
+          TestCommonConfig.class_eval do
+            add :db_name,  "db9"
+          end
+        end
+        ok {pr}.raise?(Benry::ConfigError,
+                       "add :db_name : already defined (use set() instead).")
+      end
 
-    it "[!fxc4h] raises ConfigError when not defined yet." do
-      pr = proc do
-        TestCommonConfig.class_eval do
-          set :db_port,  5432
+      spec "[!s620t] adds new key and value." do
+        ok {TestCommonConfig.instance_variable_get('@__dict')} == {
+          :db_name        => "db1",
+          :db_user        => "user1",
+          :db_pass        => Benry::Config::ABSTRACT,
+          :session_secret => Benry::Config::SECRET,
+        }
+      end
+
+      spec "[!o0ts4] defines getter method." do
+        cls = Class.new(Benry::Config) do
+          add :foo  , "FOO"
         end
+        obj = cls.new
+        ok {obj}.respond_to?(:foo)
+        ok {obj.foo} == "FOO"
       end
-      ex = ok {pr}.raise?(Benry::ConfigError)
-      ok {ex.message} == "set :db_port : not defined (use add() instead)."
+
     end
 
-    it "[!cv8iz] overrides existing value." do
-      ok {TestConfig.instance_variable_get('@__dict')} == {
-        :db_pass        => "pass1",
-        :session_secret => "abc123",
-      }
-      #
-      config = TestConfig.new
-      ok {config.db_pass} == "pass1"
-      ok {config.session_secret} == "abc123"
+
+    topic '.set()' do
+
+      spec "[!fxc4h] raises ConfigError when not defined yet." do
+        pr = proc do
+          TestCommonConfig.class_eval do
+            set :db_port,  5432
+          end
+        end
+        ok {pr}.raise?(Benry::ConfigError,
+                       "set :db_port : not defined (use add() instead).")
+      end
+
+      spec "[!cv8iz] overrides existing value." do
+        ok {TestConfig.instance_variable_get('@__dict')} == {
+          :db_pass        => "pass1",
+          :session_secret => "abc123",
+        }
+        #
+        config = TestConfig.new
+        ok {config.db_pass} == "pass1"
+        ok {config.session_secret} == "abc123"
+      end
+
     end
 
-  end
 
+    topic '.put()' do
 
-  describe '.put()' do
+      spec "[!abd3f] raises nothing whener defined or not." do
+        pr = proc do
+          Class.new(TestCommonConfig) do
+            put :db_name    , "db9"      # existing
+            put :db_port    , "5432"     # not existing
+          end
+        end
+        ok {pr}.NOT.raise?(Exception)
+      end
+
+      spec "[!gu2f0] sets key and value." do
+        cls = Class.new(TestCommonConfig) do
+          put :db_name    , "db9"     # existing
+          put :db_port    , 5432      # not existing
+        end
+        ok {cls.instance_variable_get('@__dict')} == {
+          :db_name   => "db9",
+          :db_port   => 5432,
+        }
+      end
 
-    it "[!abd3f] raises nothing whener defined or not." do
-      pr = proc do
-        Class.new(TestCommonConfig) do
-          put :db_name    , "db9"      # existing
-          put :db_port    , "5432"     # not existing
+      spec "[!84kbr] defines getter method." do
+        cls = Class.new(TestCommonConfig) do
+          put :db_name    , "db9"     # existing
+          put :db_port    , 5432      # not existing
         end
+        ok {cls}.method_defined?(:db_name)
+        ok {cls}.method_defined?(:db_port)
       end
-      ok {pr}.NOT.raise?(Exception)
+
     end
 
-    it "[!gu2f0] sets key and value." do
-      cls = Class.new(TestCommonConfig) do
-        put :db_name    , "db9"     # existing
-        put :db_port    , 5432      # not existing
+
+    topic '#[]' do
+
+      spec "[!z9r30] returns config value." do
+        config = TestConfig.new()
+        ok {config[:db_user]} == "user1"
+        ok {config[:db_pass]} == "pass1"
       end
-      ok {cls.instance_variable_get('@__dict')} == {
-        :db_name   => "db9",
-        :db_port   => 5432,
-      }
+
     end
 
-    it "[!84kbr] defines getter method." do
-      cls = Class.new(TestCommonConfig) do
-        put :db_name    , "db9"     # existing
-        put :db_port    , 5432      # not existing
+
+    topic '#get_all()' do
+
+      spec "[!85z23] gathers configs which name starts with specified prefix." do
+        config = TestConfig.new()
+        ok {config.get_all(:db_)} == {:name=>"db1", :user=>"user1", :pass=>"pass1"}
       end
-      ok {cls}.method_defined?(:db_name)
-      ok {cls}.method_defined?(:db_port)
+
+      spec "[!b72fr] if prefix is a string, then keys returend will also be string." do
+        config = TestConfig.new()
+        ok {config.get_all("db_")} == {"name"=>"db1", "user"=>"user1", "pass"=>"pass1"}
+      end
+
     end
 
-  end
 
+    topic '#defined?()' do
 
-  describe '#[]' do
+      spec "[!y1fsh] returns true if config key defined." do
+        conf = TestConfig.new()
+        ok {conf.defined?(:db_pass)} == true
+      end
+
+      spec "[!k1b5q] returns false if config key not defined." do
+        conf = TestConfig.new()
+        ok {conf.defined?(:db_password)} == false
+      end
 
-    it "[!z9r30] returns config value." do
-      config = TestConfig.new()
-      ok {config[:db_user]} == "user1"
-      ok {config[:db_pass]} == "pass1"
     end
 
-  end
 
+    topic '#each()' do
+
+      spec "[!f4ljv] returns Enumerator object if block not given." do
+        conf = TestConfig.new
+        ok {conf.each}.is_a?(Enumerator)
+      end
+
+      spec "[!4wqpu] yields each key and val with hiding secret values." do
+        conf = TestConfig.new
+        d = {}
+        conf.each {|k, v| d[k] = v }
+        ok {d} == {:db_name=>"db1", :db_user=>"user1", :db_pass=>"pass1",
+                   :session_secret=>"(secret)"}  # !!!
+      end
+
+      spec "[!a9glw] sorts keys if 'true' specified as the first argument." do
+        conf = TestConfig.new
+        keys1 = []
+        conf.each {|k, v| keys1 << k }
+        keys2 = []
+        conf.each(true) {|k, v| keys2 << k }
+        ok {keys1} == [:db_name, :db_user, :db_pass, :session_secret]
+        ok {keys2} == [:db_name, :db_pass, :db_user, :session_secret]
+      end
+
+      spec "[!wggik] returns self if block given." do
+        conf = TestConfig.new
+        ok {conf.each {|k, v| nil }}.same?(conf)
+      end
+
+    end
 
-  describe '#get_all()' do
 
-    it "[!85z23] gathers configs which name starts with specified prefix." do
-      config = TestConfig.new()
-      ok {config.get_all(:db_)} == {:name=>"db1", :user=>"user1", :pass=>"pass1"}
+    topic '#each!()' do
+
+      spec "[!zd9lk] returns Enumerator object if block not given." do
+        conf = TestConfig.new
+        ok {conf.each!}.is_a?(Enumerator)
+      end
+
+      spec "[!7i5p2] yields each key and val without hiding secret values." do
+        conf = TestConfig.new
+        d = {}
+        conf.each! {|k, v| d[k] = v }
+        ok {d} == {:db_name=>"db1", :db_user=>"user1", :db_pass=>"pass1",
+                   :session_secret=>"abc123"}  # !!!
+      end
+
+      spec "[!aib7c] sorts keys if 'true' specified as the first argument." do
+        conf = TestConfig.new
+        keys1 = []
+        conf.each! {|k, v| keys1 << k }
+        keys2 = []
+        conf.each(true) {|k, v| keys2 << k }
+        ok {keys1} == [:db_name, :db_user, :db_pass, :session_secret]
+        ok {keys2} == [:db_name, :db_pass, :db_user, :session_secret]
+      end
+
+      spec "[!2abgb] returns self if block given." do
+        conf = TestConfig.new
+        ok {conf.each! {|k, v| nil }}.same?(conf)
+      end
+
     end
 
-    it "[!b72fr] if prefix is a string, then keys returend will also be string." do
-      config = TestConfig.new()
-      ok {config.get_all("db_")} == {"name"=>"db1", "user"=>"user1", "pass"=>"pass1"}
+
+    topic '#_each()' do
+
+      spec "[!6yvgd] sorts keys if 'sort' is true." do
+        keys1 = []
+        keys2 = []
+        TestConfig.new.instance_eval do
+          _each(false, false) {|k, v| keys1 << k }
+          _each(true, false)  {|k, v| keys2 << k }
+        end
+        ok {keys1} == [:db_name, :db_user, :db_pass, :session_secret]
+        ok {keys2} == [:db_name, :db_pass, :db_user, :session_secret]
+      end
+
+      spec "[!5ledb] hides value if 'hide_secret' is true and value is Secretvalue object." do
+        d1 = {}
+        d2 = {}
+        TestConfig.new.instance_eval do
+          _each(false, true ) {|k, v| d1[k] = v }
+          _each(false, false) {|k, v| d2[k] = v }
+        end
+        ok {d1[:session_secret]} == "(secret)"
+        ok {d2[:session_secret]} == "abc123"
+      end
+
     end
 
+
   end
 
 

metadata

@@ -1,62 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: benry-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- makoto kuwata
-autorequire: 
+- kwatch
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: oktest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-ok
-  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: 'See https://github.com/kwatch/benry/tree/ruby/benry-config for details.
+        version: '1'
+description: |
+  Small library for configuration of application.
 
-'
-email:
-- kwa(at)kuwata-lab.com
+  See https://kwatch.github.io/benry-ruby/benry-config.html for details.
+email: kwatch@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE.txt
+- CHANGES.md
+- MIT-LICENSE
 - README.md
-- Rakefile
+- Rakefile.rb
+- benry-config.gemspec
+- doc/benry-config.html
+- doc/css/style.css
+- examples/config/app.rb
+- examples/config/app.secret
+- examples/config/app_dev.rb
+- examples/config/app_prod.rb
+- examples/main.rb
 - lib/benry/config.rb
+- task/common-task.rb
+- task/package-task.rb
+- task/readme-task.rb
+- task/test-task.rb
 - test/config_test.rb
-homepage: https://github.com/kwatch/benry/tree/ruby/benry-config
+homepage: https://kwatch.github.io/benry-ruby/benry-config.html
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,16 +63,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: useful configuration class
-test_files: []
+summary: Application configuration library
+test_files:
+- test/config_test.rb

data/Rakefile

@@ -1,83 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-project   = "benry-config"
-release   = ENV['RELEASE'] || "0.0.0"
-copyright = "copyright(c) 2016 kuwata-lab.com all rights reserved"
-license   = "MIT License"
-
-target_files = Dir[*%W[
-  README.md MIT-LICENSE.txt Rakefile
-  lib/**/*.rb
-  test/**/*_test.rb
-  #{project}.gemspec
-]]
-
-
-task :default => :help
-
-
-desc "show help"
-task :help do
-  puts "rake help                   # help"
-  puts "rake test                   # run test"
-  puts "rake package RELEASE=X.X.X  # create gem file"
-  puts "rake publish RELEASE=X.X.X  # upload gem file"
-end
-
-
-desc "do test"
-task :test do
-  sh "ruby", *Dir.glob("test/*.rb")
-end
-
-
-desc "create package"
-task :package do
-  release != "0.0.0"  or
-    raise "specify $RELEASE"
-  ## copy
-  dir = "build"
-  rm_rf dir if File.exist?(dir)
-  mkdir dir
-  target_files.each do |file|
-    dest = File.join(dir, File.dirname(file))
-    mkdir_p dest, :verbose=>false unless File.exist?(dest)
-    cp file, "#{dir}/#{file}"
-  end
-  ## edit
-  Dir.glob("#{dir}/**/*").each do |file|
-    next unless File.file?(file)
-    File.open(file, 'rb+') do |f|
-      s = f.read()
-      s = s.gsub(/\$Release: 0.1.0 $/,   "$"+"Release: #{release} $")
-      s = s.gsub(/\$Copyright: copyright(c) 2016 kuwata-lab.com all rights reserved $/, "$"+"Copyright: #{copyright} $")
-      s = s.gsub(/\$License: MIT License $/,   "$"+"License: #{license} $")
-      #
-      f.rewind()
-      f.truncate(0)
-      f.write(s)
-    end
-  end
-  ## build
-  chdir dir do
-    sh "gem build #{project}.gemspec"
-  end
-  mv "#{dir}/#{project}-#{release}.gem", "."
-end
-
-
-desc "upload gem file to rubygems.org"
-task :publish do
-  release != "0.0.0"  or
-    raise "specify $RELEASE"
-  #
-  gemfile = "#{project}-#{release}.gem"
-  print "** Are you sure to publish #{gemfile}? [y/N]: "
-  ans = $stdin.gets().strip()
-  if ans.downcase.start_with?("y")
-    sh "gem push #{gemfile}"
-    sh "git tag #{project}-#{release}"
-    sh "git push --tags"
-  end
-end