appconf 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb7352ca6239bfa42d001bcae82df50058bffc31
+  data.tar.gz: 86db299e039e5827d83cc00c2e2a9f6d58dd6f07
+SHA512:
+  metadata.gz: fe89508179aa1b42c26dc96fae13b96b8ad0ac0dc7d085b6f33be5850c8a569831466d06486c6a8fd1059cd79065261c57ffe155b77a703cecbf5c292ff6f1d7
+  data.tar.gz: 61f7bcc7d2fd63645e180ece90bf75377ea586e503ffeebaa938a6e24acca19fce2a4fb07f208b2492980466a20c13f5e0d9ac7f32fa21cc57c12af4ca5af651

data/README.md

@@ -14,36 +14,40 @@ gem install appconf
 
 **AppConf** loads and parses a series of YAML configuration files in priority, which means if multiple configuration items with the same path name exist in different files, then the value of the item in the highest priority file will be selected as query result.
 
-**AppConf** will loads all these YAML configuration files, if exist, in priority highest to lowest:
+After below setup code:
+```ruby
+AppConfig.setup 'myapp', '/root-dir/of/myapp', '/deployment/dir'
+```
+**AppConf** will try to load and parse all these YAML configuration files, if exist, in priority highest to lowest:
 
-- *`/path/to/specified/deployment/dir`*/*`myapp`*.*`ruby-platform`*.yaml
-- *`/path/to/specified/deployment/dir`*/*`myapp`*.yaml
-- *`/home/username`*/*`.myapp`*/*`myapp`*.*`ruby-platform`*.yaml
-- *`/home/username`*/*`.myapp`*/*`myapp`*.yaml
-- /etc/*`myapp`*/*`myapp`*.*`ruby-platform`*.yaml
-- /etc/*`myapp`*/*`myapp`*.yaml
-- *`/path/to/myapp`*/conf/*`myapp`*.*`ruby-platform`*.yaml
-- *`/path/to/myapp`*/conf/*`myapp`*.yaml
+- `/deployment/dir/myapp.`*ruby-platform*`.config.yaml`
+- `/deployment/dir/myapp.config.yaml`
+- */home/username*`/.myapp/myapp.`*ruby-platform*`.config.yaml`
+- */home/username*`/.myapp/myapp.config.yaml`
+- `/etc/myapp/myapp.`*ruby-platform*`.config.yaml`
+- `/etc/myapp/myapp.config.yaml`
+- `/root-dir/of/myapp/config/myapp.`*ruby-platform*`.config.yaml`
+- `/root-dir/of/myapp/config/myapp.config.yaml`
 
 Where:
 
-- *`/path/to/specified/deployment/dir`*: The directory where you app is deployed, use AppConfig::setup to tell the gem where it is.
+- `/deployment/dir/`: The directory where you app is deployed, use AppConfig::setup to tell the gem where it is. When this dir is not specified or is nil, *AppConf* will try to use dir specified by environment variable: *MYAPP*_CONF_DIR. In this case, *MYAPP* part of the environment variable name is the uppercase of first argument value of AppConfig::setup function. If this is still nil, deployment config files will not be used.
 
 
-- *`myapp`*: The name of the configuration file you requested via AppConfig::get_conf, or the name of your app when nil is used for configuration file name. The app name is setup via AppConfig::setup.
-- *`.myapp`*: Note that there is a **dot** before `myapp` for the name of this directory, which holds user level configuration file. While on Windows, there is **no** such dot.
+- `myapp`: The name of the configuration file you requested via AppConfig::get_conf, or the name of your app when nil is used for configuration file name. The app name is setup via AppConfig::setup.
+- `.myapp`: Note that there is a **dot** before `myapp` for the name of this directory, which holds user level configuration file. While on Windows, there is **no** such dot.
 
 
-- *`ruby-platform`*: The platform of the ruby is running on. For jruby, it is `java`.
+- `ruby-platform`: The platform name (i.e. value of the global variable `RUBY_PLATFORM`) of the ruby is running on. e.g. for jruby, it is `java`.
 
 
-- *`/home/username`*: The home directory of the user who is running your app. In Windows, it's `ENV['USERPROFILE']`, for POSIX, `ENV['HOME']` is used.  
+- `/home/username`: The home directory of the user who is running your app. In Windows, it's `ENV['USERPROFILE']`, for POSIX, `ENV['HOME']` is used.  
 
 
 - `/etc`: In Windows, `ENV['ALLUSERSPROFILE']` is used. 
 
 
-- *`/path/to/myapp`*: The root directory where your app resides in.
+- `/root-dir/of/myapp`: The root directory where your app resides in.
 
 ## Why YAML?
 
@@ -51,7 +55,7 @@ XML is heavy and verbose, JSON has no comments, that's it.
 
 ## Usage
 
-Say you have a ruby app named `awsome`, need a default configuration file located in `conf` directory under your app's root path, named `awsome.yaml` like this (in YAML):
+Say you have a ruby app named `awsome`, need a default configuration file located in `config` directory under your app's root path, named `awsome.config.yaml` like this (in YAML):
 
 ```yaml
 ---
@@ -60,7 +64,7 @@ db:
 	conection: sqlite://awsome.db
 ```
 
-While when you are testing you app on your development machine, you want to use a specific sqlite database file located at `/home/arloan/awsome-db/test-2016.db`, how can I do? It's simple, place a file named `awsome.yaml` under `/home/arloan/.awsome/`, with the contents:
+While when you are testing you app on your development machine, you may want to use a specific sqlite database file located at `/home/arloan/awsome-db/test-2016.db`. That is simple, just place a file named `awsome.config.yaml` under `/home/arloan/.awsome/`, with the contents:
 
 ```yaml
 ---
@@ -68,7 +72,7 @@ db:
 	connection: sqlite:///home/arloan/awsome-db/test-2016.db
 ```
 
-In addition, you want your app to be compatible with jruby, and want to use a different, jruby specific database connection method when running under jruby, then you can create a configuration file named `awsome.java.yaml`  and place it along with your default `awsome.yaml`, in  `conf` directory under your app's root path, with the contents:
+In addition, you want your app to be compatible with jruby, and want to use a different, jruby specific database connection method when running under jruby, then you can create a configuration file named `awsome.java.config.yaml`  and place it along with your default `awsome.config.yaml`, in  `config` directory under your app's root path, with the contents:
 
 ```yaml
 ---
@@ -89,7 +93,7 @@ AppConfig.setup 'Awsome', # app name, will be converted to lower case automatica
 # default config with app name and deployment directory
 default_config = AppConfig.get_config
 
-# use another series of configuration files with new name, use 'new-name.yaml' series
+# use another series of configuration files with new name, use 'new-name.config.yaml' series
 another_config = AppConfig.get_config 'new-name'
 
 # you can overwrite deployment directory when get a config serie

data/lib/appconf.rb

@@ -57,7 +57,7 @@ class AppConfig
 	end
 	def self.get_config config_name = nil, config_dir = nil
 		raise ConfigError, ('please call %s::setup() before getting a config instance' % self.name) if @@app_name.nil?
-		self.new config_dir, config_name
+		self.new config_name, config_dir
 	end
 
 	def [] key

data/lib/appconf_version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class AppConfig
-	VERSION = '0.0.3'
-end
+	VERSION = '0.1.0'
+end

data/test/test_appconf.rb

@@ -18,7 +18,10 @@ class AppConfigTest < MiniTest::Unit::TestCase
 	TEST_CONFIG_NAME		= 'foo.bar'
 
 	# a new TestCase object created for every test method testing
-	AppConfig.setup 'Test', File.dirname(__FILE__), ENV['TMP']
+	dd = File.join(ENV['TMP'] || ENV['TMPDIR'] || ENV['HOME'], 'appconf.tmp')
+	Dir.mkdir dd unless File.exist?(dd)
+	puts 'deploy dir: ' + dd
+	AppConfig.setup 'Test', File.dirname(__FILE__), dd
 	@@config = AppConfig.get_config
 
 	def self.clean
@@ -80,7 +83,11 @@ class AppConfigTest < MiniTest::Unit::TestCase
 		assert_equal DIST_VALUE, query_config_value
 	end
 	def test_i_non_exist_value
-		assert_equal nil, @@config['non.exist.config.item']
+		assert_nil @@config['non.exist.config.item']
+	end
+	def test_j_named_config
+		@@config = AppConfig.get_config 'test'
+		assert_equal DEPLOY_PLATFORM_VALUE, query_config_value
 	end
 
 	def test_z_clean

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appconf
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Arloan Bone
@@ -11,41 +10,41 @@ bindir: bin
 cert_chain: []
 date: 2016-04-09 00:00:00.000000000 Z
 dependencies: []
-description: Query config values from one or more series of YAML files in priority.
+description: Query config values from one or more series of YAML configuration files
+  in priority.
 email: arloan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
 - lib/appconf.rb
 - lib/appconf_version.rb
 - test/test_appconf.rb
-- Rakefile
-- LICENSE
-- README.md
 homepage: https://github.com/arloan/appconf
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
-summary: App YAML Config in Priority
+specification_version: 4
+summary: Access YAML Config files in Priority
 test_files: []