jewelbox 0.0.1 → 0.0.2

data/lib/jewelbox/config.rb

@@ -42,16 +42,47 @@ module Jewelbox
 
   # === Description
   # Configuration object that represents ALL configuration items
-  # to be used by the current service process
+  # to be used by the current process.
   #
   class Config
 
     # === Description 
     # Read the given YAML file, and add its content to Jewelbox.config.
+    # For example, if you had the following in the YAML file:
+    #
+    # ---
+    # section1:
+    #   directive1: true
+    #   directive2: false
+    # section2:
+    #   directive1: "hello"
+    #   directive2: "good-bye"
+    # 
+    # The following config items are available:
+    #
+    # Jewelbox.config.section1.directive1   # => true
+    # Jewelbox.config.section1.directive2   # => true
+    # Jewelbox.config.section1.directive1   # => "hello"
+    # Jewelbox.config.section2.directive2   # => "there"
+    #
+    # === Parameters
+    # yml_path:: [String] absolute or relative path to the YAML file
     #
     def self.load(yml_path)
       abs_path = File.expand_path(yml_path)
       h = YAML::load(File.read(yml_path))
+      load_hash(h)
+    end
+
+    # === Description
+    # Load hash object into the global configuration space.
+    # See Config.load API, which has example hash object.
+    #
+    # === Parameters
+    # h:: [Hash] Hash object that contains 2-level configuration organization
+    #            (section/directive) to load into Jewelbox.config space.
+    #
+    def self.load_hash(h)
       h.each do |section, inner|
         inner.each do |directive, v|
           Jewelbox.config.add(section, directive, v)

data/lib/jewelbox/version.rb

@@ -1,3 +1,3 @@
 module Jewelbox
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jewelbox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &22659880 !ruby/object:Gem::Requirement
+  requirement: &19426280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22659880
+  version_requirements: *19426280
 description: A set of useful Ruby functions to be used when creating a new service
   or rails application
 email:
@@ -58,18 +58,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1874784024432894432
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1874784024432894432
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11