benry-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3370f1b72911ca0f9a74d6240b1025a792166d3d
+  data.tar.gz: a4b2152cb0e4f51f4b3c36e25fccd66bf210f5e3
+SHA512:
+  metadata.gz: 7f81be992cc07abe26b2680940cf618daa2f5f4047ac91748e3ad16286d54d6c64a527a543e68e2fa50bcd7114307d3dfb4ac202d977b54ad5720651db3a3913
+  data.tar.gz: 1939f9f82a48c679ae927ea9f34f0e34d75bfb08e3909984b6e68a07267fb24f959a2a588e8bf2210a4721a96efef152bde1ebd4636089708b691d5e7b213021

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kuwata-lab.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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+benry-config
+============
+
+($Release: 0.1.0 $)
+
+
+Overview
+--------
+
+Utility class to support configuration.
+
+* 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.
+
+
+Example
+-------
+
+```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
+end
+
+#----- config/development.rb -----
+require 'config/common'
+class Config < CommonConfig
+  set :db_pass            , "pass1"
+end
+
+#----- config/development.private -----
+Config.class_eval do
+  set :session_secret     , "abc123"
+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"
+#
+$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.get_all(:db_)       #=> {:user=>"user1", :pass=>"pass1"}
+p $config.get_all(:session_)  #=> {:cookie=>"sess", :secret=>"abc123"}
+```
+
+
+Copyright and License
+---------------------
+
+$Copyright: copyright(c) 2016 kuwata-lab.com all rights reserved $
+
+$License: MIT License $

data/Rakefile

@@ -0,0 +1,83 @@
+# -*- 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

data/lib/benry/config.rb

@@ -0,0 +1,140 @@
+# -*- coding: utf-8 -*-
+
+###
+### $Release: 0.1.0 $
+### $Copyright: copyright(c) 2016 kuwata-lab.com all rights reserved $
+### $License: MIT License $
+###
+
+
+module Benry
+
+
+  class ConfigError < StandardError
+  end
+
+
+  ##
+  ## Configuration class.
+  ##
+  ## ex:
+  ##
+  ##     #----- 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
+  ##     end
+  ##
+  ##     #----- config/development.rb -----
+  ##     require 'config/common'
+  ##     class Config < TestCommonConfig
+  ##       set :db_pass            , "pass1"
+  ##     end
+  ##
+  ##     #----- config/development.private -----
+  ##     class Config
+  ##       set :session_secret     , "abc123"
+  ##     end
+  ##
+  ##     #----- main.rb -----
+  ##     rack_env = ENV['RACK_ENV']  or raise "$RACK_ENV required."
+  ##     require "./config/#{rack_env}.rb"
+  ##     load    "./config/#{rack_env}.private"
+  ##     #
+  ##     $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.get_all(:db_)       #=> {:user=>"user1", :pass=>"pass1"}
+  ##     p $config.get_all(:session_)  #=> {:cookie=>"SESS", :secret=>"abc123"}
+  ##
+  class BaseConfig
+
+    class AbstractValue
+    end
+
+    ABSTRACT = AbstractValue.new  # represents 'should be set in subclass'
+    SECRET   = AbstractValue.new  # represents 'should be set in private config file'
+
+    def initialize
+      #; [!7rdq4] traverses parent class and gathers config values.
+      pr = proc {|cls|
+        pr.call(cls.superclass) if cls.superclass
+        d = cls.instance_variable_get('@__dict')
+        d.each {|k, v| instance_variable_set("@#{k}", v) } if d
+      }
+      pr.call(self.class)
+      #; [!z9mno] raises ConfigError when ABSTRACT or SECRET is not overriden.
+      instance_variables().each do |ivar|
+        val = instance_variable_get(ivar)
+        ! val.is_a?(AbstractValue)  or
+          raise ConfigError.new("config ':#{ivar.to_s[1..-1]}' should be set, but not.")
+      end
+    end
+
+    ## Add new config. Raises ConfigError when already defined.
+    def self.add(key, value, desc=nil)
+      #; [!m7w96] raises ConfigError when already added.
+      ! self.method_defined?(key)  or
+        raise ConfigError.new("add #{key.inspect} : already defined (use set() instead).")
+      #; [!s620t] adds new key and value.
+      (@__dict ||= {})[key] = value
+      #; [!o0ts4] defines getter method.
+      attr_reader key
+      value
+    end
+
+    ## Set existing config. Raises ConfigError when key not defined.
+    def self.set(key, value, desc=nil)
+      #; [!fxc4h] raises ConfigError when not defined yet.
+      self.method_defined?(key)  or
+        raise ConfigError.new("set #{key.inspect} : not defined (use add() instead).")
+      #; [!cv8iz] overrides existing value.
+      (@__dict ||= {})[key] = value
+      value
+    end
+
+    ## Add or set config. Raises nothing whether defined or not.
+    def self.put(key, value, desc=nil)
+      #; [!abd3f] raises nothing whener defined or not.
+      #; [!gu2f0] sets key and value.
+      (@__dict ||= {})[key] = value
+      #; [!84kbr] defines getter method.
+      attr_reader key
+      value
+    end
+
+    ## Return config value.
+    def [](key)
+      #; [!z9r30] returns config value.
+      return self.__send__(key)
+    end
+
+    ## Gathers related configs starting with prefix specified.
+    def get_all(prefix_key)
+      #; [!85z23] gathers configs which name starts with specified prefix.
+      prefix = "@#{prefix_key}"
+      symbol_p = prefix_key.is_a?(Symbol)
+      range = prefix.length..-1
+      d = {}
+      self.instance_variables.each do |ivar|
+        if ivar.to_s.start_with?(prefix)
+          val = self.instance_variable_get(ivar)
+          key = ivar[range]
+          #; [!b72fr] if prefix is a string, then keys returend will also be string.
+          key = key.intern if symbol_p
+          d[key] = val
+        end
+      end
+      return d
+    end
+
+  end
+
+
+end

data/test/config_test.rb

@@ -0,0 +1,182 @@
+# -*- coding: utf-8 -*-
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/ok'
+
+require 'benry/config'
+
+
+
+
+class TestCommonConfig < Benry::BaseConfig
+  add :db_name            , "db1"
+  add :db_user            , "user1"
+  add :db_pass            , ABSTRACT
+  add :session_secret     , SECRET
+end
+
+class TestConfig < TestCommonConfig
+  set :db_pass            , "pass1"
+  set :session_secret     , "abc123"
+end
+
+class TestConfig2 < TestCommonConfig
+  #set :db_pass            , "pass1"
+  set :session_secret     , "abc123"
+end
+
+class TestConfig3 < TestCommonConfig
+  set :db_pass            , "pass1"
+  #set :session_secret     , "abc123"
+end
+
+
+
+describe Benry::BaseConfig 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"
+    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."
+    end
+
+  end
+
+
+  describe '.add()' do
+
+    it "[!m7w96] raises ConfigError when already added." do
+      pr = proc do
+        TestCommonConfig.class_eval do
+          add :db_name,  "db9"
+        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
+
+    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
+
+
+  describe '.set()' do
+
+    it "[!fxc4h] raises ConfigError when not defined yet." do
+      pr = proc do
+        TestCommonConfig.class_eval do
+          set :db_port,  5432
+        end
+      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"
+    end
+
+  end
+
+
+  describe '.put()' do
+
+    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
+        end
+      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
+      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
+      end
+      ok {cls}.method_defined?(:db_name)
+      ok {cls}.method_defined?(:db_port)
+    end
+
+  end
+
+
+  describe '#[]' do
+
+    it "[!z9r30] returns config value." do
+      config = TestConfig.new()
+      ok {config[:db_user]} == "user1"
+      ok {config[:db_pass]} == "pass1"
+    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"}
+    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"}
+    end
+
+  end
+
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: benry-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- makoto kuwata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !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.
+
+'
+email:
+- kwa(at)kuwata-lab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- lib/benry/config.rb
+- test/config_test.rb
+homepage: https://github.com/kwatch/benry/tree/ruby/benry-config
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: useful configuration class
+test_files: []