benry-config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3370f1b72911ca0f9a74d6240b1025a792166d3d
-  data.tar.gz: a4b2152cb0e4f51f4b3c36e25fccd66bf210f5e3
+SHA256:
+  metadata.gz: 29ac681e125266660c141ed00cd5c1d8b1667a2769b89810a4747ea5d0fa144b
+  data.tar.gz: 619ca8af95d35aebe618c2b87e8438bbaf7300658a4fdf8dac62705946b759a4
 SHA512:
-  metadata.gz: 7f81be992cc07abe26b2680940cf618daa2f5f4047ac91748e3ad16286d54d6c64a527a543e68e2fa50bcd7114307d3dfb4ac202d977b54ad5720651db3a3913
-  data.tar.gz: 1939f9f82a48c679ae927ea9f34f0e34d75bfb08e3909984b6e68a07267fb24f959a2a588e8bf2210a4721a96efef152bde1ebd4636089708b691d5e7b213021
+  metadata.gz: 45113ff1e524a0c92053e30488c8963e64ea0b87b941cd44ffdb1fd93e7f3a76a2e24fa8b75348260c851577c7398aa5eef16408b4e4c6ee2db47c28c1b508fd
+  data.tar.gz: 36a644e4fb0f053bda69836abca724470a212743a7bbfd297fbe2c50b50114ba6d7b7ae1d2240923b36a310705f7466adec260e48c9ebf33431926d762b5792f

data/CHANGES.md

@@ -0,0 +1,19 @@
+CHANGES
+=======
+
+
+Release 0.2.0 (2023-10-11)
+--------------------------
+
+* [change] Rename 'Benry::BaseConfig' class to 'Benry::Config' class. (Old name is still available for compatibility.)
+* [enhance] Add `SECRET` which represents secret value.
+* [enhance] Enhance `ABSTRACT` to support `ABSTRACT['NAME']` style setting.
+* [enhance] Define `#defined?()` in `Benry::Config` class.
+* [enhance] Define `#each()` and `#each!()`  in `Benry::Config` class.
+* [chnage] Switch unit test library from MiniTest to Oktest.
+
+
+Release 0.1.0 (2016-09-04)
+--------------------------
+
+* First public release.

data/{MIT-LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 kuwata-lab.com
+Copyright (c) 2016 kwatch@gmail.com
 
 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

data/README.md

@@ -1,65 +1,128 @@
-benry-config
-============
+# Benry-Config
 
-($Release: 0.1.0 $)
+($Release: 0.2.0 $)
 
 
-Overview
---------
+## What's this?
 
 Utility class to support configuration.
 
+Features:
+
 * Easy to define configuration for environments (production, development, ...).
 * Raises error when configuration name is wrong (typo).
-* Represents secret configurations which should be set in private file.
+* Represents secret configurations which should be set by environment var or in secret file.
+
+Links:
+
+* Document: <https://kwatch.github.io/benry-ruby/benry-config.html>
+* GitHub: <https://github.com/kwatch/benry-ruby/tree/main/benry-config>
+* Changes: <https://github.com/kwatch/benry-ruby/tree/main/benry-config/CHANGES.md>
+
+
+
+### Table of Contents
+
+<!-- TOC -->
+
+* [What's this?](#whats-this)
+* [Example](#example)
+* [Copyright and License](#copyright-and-license)
 
+<!-- /TOC -->
 
-Example
--------
+
+
+## Example
+
+File: config/app.rb
 
 ```ruby
-#----- config/common.rb -----
 require 'benry/config'
-class CommonConfig < Benry::BaseConfig
-  add :db_user            , "user1"
-  add :db_pass            , ABSTRACT
-  add :session_cooie      , "sess"
-  add :session_secret     , SECRET
+
+class AppConfigBase < Benry::Config
+  ## add names and values
+  add :db_host          , "localhost"
+  add :db_user          , "user1"
+  add :db_pass          , ABSTRACT       # should be set value in subclass
+  add :session_cookie   , "sess"
+  add :session_secret   , SECRET
+  ## or:
+  #add :db_pass         , ABSTRACT['DB_PASS']    # get value from ENV
+  #add :session_secret  , SECRET['SESS_SECRET']  # get secret value from ENV
+end
+```
+
+File: config/app_dev.rb (for development environment)
+
+```ruby
+require_relative './app'
+
+## for development environment
+class AppConfig < AppConfigBase
+  ## set (= override) existing values
+  set :db_pass          , "pass1"        # set ABSTRACT value
 end
+```
+
+File: config/app_prod.rb (for production environment)
 
-#----- config/development.rb -----
-require 'config/common'
-class Config < CommonConfig
-  set :db_pass            , "pass1"
+```ruby
+require_relative './app'
+
+## for production environment
+class AppConfig < AppConfigBase
+  ## set (= override) existing values
+  set :db_host          , "db-master"    # override existing value
+  set :db_pass          , "passXXX"      # set ABSTRACT value
+  ## error because `:db_name` is not defined in paremnt class.
+  set :db_name          , "prod1"        #=> Benry::ConfigError (not defined)
 end
+```
+
+File: config/app.secret (should be ignored by `.gitignore`)
 
-#----- config/development.private -----
-Config.class_eval do
-  set :session_secret     , "abc123"
+```ruby
+## this file should be ignored by '.gitignore', and
+## file permission should be `600`.
+AppConfig.class_eval do
+  set :session_secret   , "YRjCIAiPlCBvwLUq5mnZ"  # set SECRET value
 end
+```
 
-#----- main.rb -----
-## Ruby < 2.2 has obsoleted 'Config' class, therefore remove it at first.
-Object.class_eval { remove_const :Config } if defined?(Config)
-#
-rack_env = ENV['RACK_ENV']  or raise "$RACK_ENV required."
-require "./config/#{rack_env}.rb"
-load    "./config/#{rack_env}.private"
+File: main.rb
+
+```ruby
+## load config files
+app_env = ENV['APP_ENV']  or raise "$APP_ENV required."
+require "./config/app.rb"                # define AppConfigBase class
+require "./config/app_#{app_env}.rb"     # define AppConfig class
+load    "./config/app.secret"            # modify AppConfig class
+## or:
+#load   "./config/app.#{app_env}.secret"
+
+## create a config object
+$config = AppConfig.new.freeze
 #
-$config = Config.new.freeze
 p $config.db_user             #=> "user1"
 p $config.db_pass             #=> "pass1"
 p $config.session_cookie      #=> "sess"
-p $config.session_secret      #=> "abc123"
+p $config.session_secret      #=> "YRjCIAiPlCBvwLUq5mnZ"
+#
+p $config.defined?(:db_user)  #=> true
+p $config.defined?(:db_pass)  #=> true
+p $config.defined?(:db_name)  #=> false
+#
+p $config.get_all(:db_)       #=> {:host=>"localhost", :user=>"user1", :pass=>"pass1"}
+p $config.get_all(:session_)  #=> {:cookie=>"sess", :secret=>"YRjCIAiPlCBvwLUq5mnZ"}
 #
-p $config.get_all(:db_)       #=> {:user=>"user1", :pass=>"pass1"}
-p $config.get_all(:session_)  #=> {:cookie=>"sess", :secret=>"abc123"}
+$config.each  {|k, v| puts "#{k}=#{v.inspect}" }   # hide secret values as "(secret)"
+$config.each! {|k, v| puts "#{k}=#{v.inspect}" }   # not hide secret values
 ```
 
 
-Copyright and License
----------------------
 
-$Copyright: copyright(c) 2016 kuwata-lab.com all rights reserved $
+## Copyright and License
 
-$License: MIT License $
+* $Copyright: copyright(c) 2016 kwatch@gmail.com $
+* $License: MIT License $

data/Rakefile.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+
+PROJECT   = "benry-config"
+RELEASE   = ENV['RELEASE'] || "0.0.0"
+COPYRIGHT = "copyright(c) 2016 kwatch@gmail.com"
+LICENSE   = "MIT License"
+
+README_DESTDIR   = "examples"
+
+Dir.glob('./task/*-task.rb').sort.each {|x| require x }
+
+desc "retrieve example code from README"
+task :examples => "readme:retrieve"

data/benry-config.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name            = "benry-config"
+  spec.version         = "$Release: 0.2.0 $".split()[1]
+  spec.author          = "kwatch"
+  spec.email           = "kwatch@gmail.com"
+  spec.platform        = Gem::Platform::RUBY
+  spec.homepage        = "https://kwatch.github.io/benry-ruby/benry-config.html"
+  spec.summary         = "Application configuration library"
+  spec.description     = <<"END"
+Small library for configuration of application.
+
+See #{spec.homepage} for details.
+END
+  spec.license         = "MIT"
+  spec.files           = Dir[
+                           "README.md", "MIT-LICENSE", "CHANGES.md",
+                           "Rakefile.rb", "#{spec.name}.gemspec",
+                           "lib/**/*.rb", "test/**/*_test.rb", "task/**/*.rb",
+                           "examples/**/*.*", #"bin/*",
+                           "doc/*.html", "doc/css/*",
+                         ]
+  #spec.executables     = []
+  spec.bindir          = "bin"
+  spec.require_path    = "lib"
+  spec.test_files      = Dir["test/**/*_test.rb"]   # or: ["test/run_all.rb"]
+  #spec.extra_rdoc_files = ["README.md", "CHANGES.md"]
+
+  spec.required_ruby_version = ">= 2.3"
+  spec.add_development_dependency "oktest"          , "~> 1"
+end

data/doc/benry-config.html

@@ -0,0 +1,139 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8"/>
+  <meta name="viewport" content="width=device-width,initial-scale=1"/>
+  <meta name="description" content="">
+  <meta name="theme-color" content="#fafafa">
+  <meta property="og:title" content="">
+  <meta property="og:type" content="">
+  <meta property="og:url" content="">
+  <meta property="og:image" content="">
+  <title></title>
+  <link rel="stylesheet" href="lib/sanitize.css/2.0.0/sanitize.min.css">
+  <link rel="stylesheet" href="css/style.css">
+</head>
+<body>
+<main>
+<section class="chapter" id="benry-config">
+<h1>Benry-Config</h1>
+<nav class="nav">
+  <ul class="nav">
+  </ul>
+</nav>
+<p>($Release: 0.2.0 $)</p>
+<section class="section" id="whats-this">
+<h2>What's this?</h2>
+<p>Utility class to support configuration.</p>
+<p>Features:</p>
+<ul>
+<li>Easy to define configuration for environments (production, development, ...).</li>
+<li>Raises error when configuration name is wrong (typo).</li>
+<li>Represents secret configurations which should be set by environment var or in secret file.</li>
+</ul>
+<p>Links:</p>
+<ul>
+<li>Document: <a href="https://kwatch.github.io/benry-ruby/benry-config.html">https://kwatch.github.io/benry-ruby/benry-config.html</a></li>
+<li>GitHub: <a href="https://github.com/kwatch/benry-ruby/tree/main/benry-config">https://github.com/kwatch/benry-ruby/tree/main/benry-config</a></li>
+<li>Changes: <a href="https://github.com/kwatch/benry-ruby/tree/main/benry-config/CHANGES.md">https://github.com/kwatch/benry-ruby/tree/main/benry-config/CHANGES.md</a></li>
+</ul>
+<section class="subsection" id="table-of-contents">
+<h3>Table of Contents</h3>
+<div class="toc">
+<ul>
+<li><a href="#whats-this">What's this?</a></li>
+<li><a href="#example">Example</a></li>
+<li><a href="#copyright-and-license">Copyright and License</a></li>
+</ul>
+</div>
+</section>
+</section>
+<section class="section" id="example">
+<h2>Example</h2>
+<p>File: config/app.rb</p>
+<pre class="language-ruby">
+<strong>require 'benry/config'</strong>
+
+<strong>class AppConfigBase &lt Benry::Config</strong>
+  ## add names and values
+  <strong>add</strong> :db_host          , "localhost"
+  <strong>add</strong> :db_user          , "user1"
+  <strong>add</strong> :db_pass          , <strong>ABSTRACT</strong>       # should be set value in subclass
+  <strong>add</strong> :session_cookie   , "sess"
+  <strong>add</strong> :session_secret   , <strong>SECRET</strong>
+  ## or:
+  #add :db_pass         , <strong>ABSTRACT['DB_PASS']</strong>    # get value from ENV
+  #add :session_secret  , <strong>SECRET['SESS_SECRET']</strong>  # get secret value from ENV
+end
+</pre>
+<p>File: config/app_dev.rb (for development environment)</p>
+<pre class="language-ruby">
+require_relative './app'
+
+## for development environment
+<strong>class AppConfig &lt AppConfigBase</strong>
+  ## set (= override) existing values
+  <strong>set</strong> :db_pass          , "pass1"        # set ABSTRACT value
+end
+</pre>
+<p>File: config/app_prod.rb (for production environment)</p>
+<pre class="language-ruby">
+require_relative './app'
+
+## for production environment
+<strong>class AppConfig &lt AppConfigBase</strong>
+  ## set (= override) existing values
+  <strong>set</strong> :db_host          , "db-master"    # override existing value
+  <strong>set</strong> :db_pass          , "passXXX"      # set ABSTRACT value
+  ## error because `:db_name` is not defined in paremnt class.
+  <strong>set</strong> :db_name          , "prod1"        #=&gt; <strong>Benry::ConfigError (not defined)</strong>
+end
+</pre>
+<p>File: config/app.secret (should be ignored by `.gitignore`)</p>
+<pre class="language-ruby">
+## this file should be ignored by '.gitignore', and
+## file permission should be `600`.
+<strong>AppConfig.class_eval do</strong>
+  <strong>set</strong> :session_secret   , "YRjCIAiPlCBvwLUq5mnZ"  # set SECRET value
+end
+</pre>
+<p>File: main.rb</p>
+<pre class="language-ruby">
+## load config files
+app_env = ENV['APP_ENV']  or raise "$APP_ENV required."
+<strong>require "./config/app.rb"</strong>                # define AppConfigBase class
+<strong>require "./config/app_#{app_env}.rb"</strong>     # define AppConfig class
+<strong>load    "./config/app.secret"</strong>            # modify AppConfig class
+## or:
+#load   "./config/app.#{app_env}.secret"
+
+## create a config object
+<strong>$config = AppConfig.new.freeze</strong>
+#
+p $config.db_user             #=&gt; "user1"
+p $config.db_pass             #=&gt; "pass1"
+p $config.session_cookie      #=&gt; "sess"
+p $config.session_secret      #=&gt; "YRjCIAiPlCBvwLUq5mnZ"
+#
+p <strong>$config.defined?</strong>(:db_user)  #=&gt; true
+p <strong>$config.defined?</strong>(:db_pass)  #=&gt; true
+p <strong>$config.defined?</strong>(:db_name)  #=&gt; false
+#
+p <strong>$config.get_all(:db_)</strong>       #=&gt; {:host=&gt;"localhost", :user=&gt;"user1", :pass=&gt;"pass1"}
+p <strong>$config.get_all(:session_)</strong>  #=&gt; {:cookie=&gt;"sess", :secret=&gt;"YRjCIAiPlCBvwLUq5mnZ"}
+#
+<strong>$config.each</strong>  {|k, v| puts "#{k}=#{v.inspect}" }   # hide secret values as "(secret)"
+<strong>$config.each!</strong> {|k, v| puts "#{k}=#{v.inspect}" }   # not hide secret values
+</pre>
+</section>
+<section class="section" id="copyright-and-license">
+<h2>Copyright and License</h2>
+<ul>
+<li>$Copyright: copyright(c) 2016 kwatch@gmail.com $</li>
+<li>$License: MIT License $</li>
+</ul>
+</section>
+</section>
+</main>
+</body>
+</html>

data/doc/css/style.css

@@ -0,0 +1,168 @@
+@charset "UTF-8";
+
+body {
+	font-family: "Helvetica Neue",Arial,"Hiragino Kaku Gothic ProN","Hiragino Sans",Meiryo,sans-serif;
+	color: #333;
+	line-height: 1.42857143;
+	background: #eef0f6;
+	margin-top: 0;
+}
+main {
+	max-width: 830px;
+	margin: 0 auto;
+	font-size: 16px;
+	color: #999;
+}
+
+
+h1 {
+	text-align: center;
+	margin: 0 0 30px 0;
+	padding: 50px 0 30px 0;
+	background: #39c;
+	color: #fff;
+	font-weight: normal;
+	font-size: 280%;
+	border-radius: 0 0 10px 10px;
+}
+h2 {
+	border: solid 0px #39c;
+	border-width: 0 0 0 15px;
+	padding: 20px 0 10px 15px;
+	font-size: 200%;
+	font-weight: normal;
+	color: #39c;
+	margin: 0 0 20px 0;
+}
+h3 {
+	color: #39c;
+	margin-top: 30px;
+	font-size: 180%;
+	font-weight: normal;
+}
+h2 > code, h3 > code {
+	color: #39c;
+	font-weight: bold;
+}
+
+
+section.section {
+	background: #fff;
+	border-radius: 10px;
+	padding: 30px 15px 30px 15px;
+	color: #333;
+	margin: 30px 0 30px 0;
+}
+section.subsection {
+	margin-top: 60px;
+}
+
+
+pre, code, kbd, var, samp {
+	font-family: 'Courier New',Courier,Menlo,Monaco,Consolas,Meiryo,monospace,monospace;
+}
+pre {
+	border: solid 1px #ddd;
+	border-radius: 4px;
+	background: #eee;
+	Xbackground: #f6f6f6;
+	padding: 5px 10px;
+	color: #444;
+	word-break: break-all;
+}
+pre > strong {
+	font-weight: bold;
+	color: #900;
+}
+pre.language-terminal {
+	background: #333;
+	color: #fff;
+	border-color: #000;
+}
+pre.language-terminal > strong {
+	color: #f66;
+}
+code {
+	border: solid 1px #e9e9e9;
+	border-radius: 2px;
+	background: #f6f6f6;
+	padding: 1px 3px;
+	color: #444;
+}
+h2 > code, h3 > code {
+	border: none;
+	background-color: transparent;
+}
+
+
+dt.bold {
+	font-weight: bold;
+}
+
+
+/**
+nav.nav {
+}
+ul.nav {
+	padding: 0;
+	border: solid 1px #39c;
+	border-width: 0 0 6px 0;
+}
+li.nav {
+	display: inline-block;
+	margin-left: 10px;
+	padding: 5px 30px;
+	font-size: large;
+	Xfont-weight: bold;
+	background: #fff;
+	border-radius: 5px 5px 0 0;
+	border: solid 1px #39c;
+	border-width:  1px 1px 0 1px;
+}
+li.nav > a {
+	color: #39c;
+	text-decoration: none;
+}
+li.nav > a:hover {
+	text-decoration: underline;
+}
+li.nav.curr {
+	background: #39c;
+}
+li.nav.curr > a {
+	color: #fff;
+}
+**/
+nav.nav {
+	text-align: center;
+}
+ul.nav {
+	padding-left: 0;
+	display: inline-block;
+	margin: 0;
+	font-size: 0;
+}
+li.nav {
+	display: inline-block;
+	padding: 0 20px;
+	border: solid #39c;
+	border-width: 0 0 0 1px;
+	margin: 0;
+	background: #eef0f6;
+}
+li.nav:first-child {
+	border-width: 0 0 0 0;
+}
+li.nav > a {
+	font-size: large;
+	text-decoration: none;
+	color: #39c;
+	margin: 0;
+}
+li.nav > a:hover {
+	text-decoration: underline;
+}
+li.nav.curr > a {
+	font-weight: bold;
+	text-decoration: underline;
+}

data/examples/config/app.rb

@@ -0,0 +1,13 @@
+require 'benry/config'
+
+class AppConfigBase < Benry::Config
+  ## add names and values
+  add :db_host          , "localhost"
+  add :db_user          , "user1"
+  add :db_pass          , ABSTRACT       # should be set value in subclass
+  add :session_cookie   , "sess"
+  add :session_secret   , SECRET
+  ## or:
+  #add :db_pass         , ABSTRACT['DB_PASS']    # get value from ENV
+  #add :session_secret  , SECRET['SESS_SECRET']  # get secret value from ENV
+end

data/examples/config/app.secret

@@ -0,0 +1,5 @@
+## this file should be ignored by '.gitignore', and
+## file permission should be `600`.
+AppConfig.class_eval do
+  set :session_secret   , "YRjCIAiPlCBvwLUq5mnZ"  # set SECRET value
+end

data/examples/config/app_dev.rb

@@ -0,0 +1,7 @@
+require_relative './app'
+
+## for development environment
+class AppConfig < AppConfigBase
+  ## set (= override) existing values
+  set :db_pass          , "pass1"        # set ABSTRACT value
+end

data/examples/config/app_prod.rb

@@ -0,0 +1,10 @@
+require_relative './app'
+
+## for production environment
+class AppConfig < AppConfigBase
+  ## set (= override) existing values
+  set :db_host          , "db-master"    # override existing value
+  set :db_pass          , "passXXX"      # set ABSTRACT value
+  ## error because `:db_name` is not defined in paremnt class.
+  set :db_name          , "prod1"        #=> Benry::ConfigError (not defined)
+end

data/examples/main.rb

@@ -0,0 +1,25 @@
+## load config files
+app_env = ENV['APP_ENV']  or raise "$APP_ENV required."
+require "./config/app.rb"                # define AppConfigBase class
+require "./config/app_#{app_env}.rb"     # define AppConfig class
+load    "./config/app.secret"            # modify AppConfig class
+## or:
+#load   "./config/app.#{app_env}.secret"
+
+## create a config object
+$config = AppConfig.new.freeze
+#
+p $config.db_user             #=> "user1"
+p $config.db_pass             #=> "pass1"
+p $config.session_cookie      #=> "sess"
+p $config.session_secret      #=> "YRjCIAiPlCBvwLUq5mnZ"
+#
+p $config.defined?(:db_user)  #=> true
+p $config.defined?(:db_pass)  #=> true
+p $config.defined?(:db_name)  #=> false
+#
+p $config.get_all(:db_)       #=> {:host=>"localhost", :user=>"user1", :pass=>"pass1"}
+p $config.get_all(:session_)  #=> {:cookie=>"sess", :secret=>"YRjCIAiPlCBvwLUq5mnZ"}
+#
+$config.each  {|k, v| puts "#{k}=#{v.inspect}" }   # hide secret values as "(secret)"
+$config.each! {|k, v| puts "#{k}=#{v.inspect}" }   # not hide secret values