bogo-config 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a46c891352700a77e9ef059c11ddab4982b5ad4
-  data.tar.gz: a55a4a18e70c690a51d78f5cd71a4fbf6ac0dcb7
+  metadata.gz: 1f49c05d8c2034aa1970d1698e22da05f9087cf6
+  data.tar.gz: 31165aaac2b92557f540d524ad9d4ea947662394
 SHA512:
-  metadata.gz: a03fd7ceed2ffbb0a75a8a49c99ec931ce1dcc1cc960142953c6c47d811810e914464efa4392921acd8e21f8ad851a68e394d324d150ef2870cb720cdeb67628
-  data.tar.gz: e5ae238374429a9c21c74b5ff6c6ad5670bf637ffea2c3a822d54efb6e326a828ce6d741299d019149e507e3474e729638e30b4ae751ca2a267f89fcceba30a8
+  metadata.gz: 0d213e98b6b0fc79bff17f96c218f7d9dce072b2e6c7c4f1d19326ca72fc95bd3ec97bdeb7a58e43a8b931af1c36c5e8bafa8d05971a18a03bc53837463c0089
+  data.tar.gz: 4e2763f923be989f93803396b31dbe860a92f99f2f284bf951a3636efb5d23dd2df9a35c964bbf787116e36683be38884b01e7e5930bc52e9dbc8ebacf3d5b6b

data/CHANGELOG.md

@@ -1,2 +1,8 @@
+## v0.1.2
+* Update `Bogo::Config` to behave more like `Smash`
+* Make XML usage more consistent and apply type formats
+* Add `Configuration` class for cleaner struct usage
+* Add test coverage
+
 ## v0.1.0
 * Initial release

data/README.md

@@ -1,6 +1,127 @@
 # Bogo Config
 
-A configuration helper library.
+Hash based application configuration helpers, because
+snowflake configurations are evil.
+
+## Usage
+
+### Direct
+
+Use the `Bogo::Config` directly to store configuration values:
+
+```ruby
+require 'bogo-config'
+
+config = Bogo::Config.new(
+  :bind => {
+    :address => '0.0.0.0',
+    :port => 8080
+  },
+  :run_as => 'www-data'
+)
+
+puts config.get(:bind, :address)
+puts config[:run_as]
+```
+
+### Configuration files
+
+A path to a configuration file can also be provided. Lets
+define the file:
+
+```json
+# /tmp/bogo-config.json
+{
+  "bind": {
+    "address": "0.0.0.0",
+    "port": 8080
+  },
+  "run_as": "www-data"
+}
+```
+
+and now we can load it:
+
+```ruby
+require 'bogo-config'
+
+config = Bogo::Config.new('/tmp/bogo-config.json')
+
+puts config.get(:bind, :address)
+puts config[:run_as]
+```
+
+### Subclassing
+
+Subclassing `Bogo::Config` allows adding some structure
+to the configuration file. The `Bogo::Lazy` module is
+used to provide the `#attribute` method to describe
+the configuration:
+
+```ruby
+require 'bogo-config'
+
+class MyConfig < Bogo::Config
+  attribute :bind, Smash, :coerce => proc{|v| v.to_smash}
+  attribute :run_as, String, :default => 'www-data'
+end
+
+config = MyConfig.new('/tmp/bogo-config.json')
+puts config.get(:bind, :address)
+puts config[:run_as]
+```
+
+### `Configuration` file
+
+Support for `AttributeStruct` configuration files is builtin.
+A helper class is provided as a visual nicety. The above
+JSON example could also be written as:
+
+```ruby
+# /tmp/bogo-config.rb
+Configuration do
+  bind do
+    address '0.0.0.0'
+    port 8080
+  end
+  run_as 'www-data'
+end
+```
+
+### Configuration file support
+
+Currently the following serialization types are supported:
+
+* JSON
+* YAML
+* XML
+* AttributeStruct
+
+Note on XML configuration files: The configuration must
+be contained within a `<configuration>` tag. The above
+example would then look like this:
+
+```xml
+<configuration>
+  <bind>
+    <address>
+      0.0.0.0
+    </address>
+    <port>
+      8080
+    </port>
+  </bind>
+  <run_as>
+    www-data
+  </run_as>
+</configuration>
+```
+
+### Configuration directory
+
+The path provided on initialization can also be a directory.
+The contents of the directory will be read in string sorted
+order and deep merged. Files can be a mix of supported types.
 
 ## Info
 * Repository: https://github.com/spox/bogo-config

data/lib/bogo-config/config.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'multi_xml'
 require 'multi_json'
 require 'attribute_struct'
+require 'forwardable'
 
 require 'bogo-config'
 
@@ -10,9 +11,10 @@ module Bogo
   class Config
 
     include Bogo::Lazy
+    extend Forwardable
 
     # @return [String] configuration path
-    attr_reader :path
+    attr_accessor :path
 
     # Create new instance
     #
@@ -20,20 +22,27 @@ module Bogo
     # @return [self]
     def initialize(path_or_hash=nil)
       if(path_or_hash.is_a?(String))
-        super
+        @path = path_or_hash
+        hash = load!
       else
-        @path = path
-        load! if path
+        hash = path_or_hash
+      end
+      if(hash)
+        load_data(hash)
+        data.replace(hash.to_smash.deep_merge(data))
       end
     end
 
+    # Allow Smash like behavior
+    def_delegators *([:data, :[]] + Smash.public_instance_methods(false))
+
     # Load configuration from file(s)
     #
     # @return [self]
     def load!
       if(path)
         if(File.directory?(path))
-          conf = Dir.glob(File.join(path, '*')).inject(Smash.new) do |memo, file_path|
+          conf = Dir.glob(File.join(path, '*')).sort.inject(Smash.new) do |memo, file_path|
             memo.deep_merge(load_file(file_path))
           end
         elsif(File.file?(path))
@@ -41,13 +50,8 @@ module Bogo
         else
           raise Errno::ENOENT.new path
         end
-        data.replace(
-          self.class.new(
-            conf
-          ).data
-        )
+        conf
       end
-      self
     end
 
     # Load configuration file
@@ -62,14 +66,19 @@ module Bogo
         json_load(file_path)
       when '.xml'
         xml_load(file_path)
+      when '.rb'
+        struct_load(file_path)
       else
-        result = [:struct_load, :json_load, :yaml_load, :xml_load].detect do |loader|
+        result = [:struct_load, :json_load, :yaml_load, :xml_load].map do |loader|
           begin
             send(loader, file_path)
           rescue => e
+            if(ENV['DEBUG'])
+              $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
+            end
             nil
           end
-        end
+        end.compact.first
         unless(result)
           raise "Failed to load configuration from file (#{file_path})"
         end
@@ -99,7 +108,42 @@ module Bogo
     # @return [Smash]
     # @note supar ENTERPRISE
     def xml_load(file_path)
-      MultiXml.parse(File.read(file_path)).to_smash
+      result = MultiXml.parse(File.read(file_path)).to_smash[:configuration]
+      xml_format(result)
+    end
+
+    # Format XML types
+    #
+    # @param result [Smash]
+    # @return [Smash]
+    def xml_format(result)
+      Smash[result.map{|k,v| [k, xml_format_value(v)]}]
+    end
+
+    # Format XML value types
+    #
+    # @param value [Object]
+    # @return [Object]
+    def xml_format_value(value)
+      case value
+      when Hash
+        xml_format(value)
+      when Array
+        value.map{|v| xml_format_value(v)}
+      else
+        value.strip!
+        if(value == 'true')
+          true
+        elsif(value == 'false')
+          false
+        elsif(value.to_i.to_s == value)
+          value.to_i
+        elsif(value.to_f.to_s == value)
+          value.to_f
+        else
+          value
+        end
+      end
     end
 
     # Read and parse AttributeStruct file
@@ -107,7 +151,7 @@ module Bogo
     # @param file_path
     # @return [Smash]
     def struct_load(file_path)
-      result = BasicObject.new.instance_eval(
+      result = Module.new.instance_eval(
         IO.read(file_path), file_path, 1
       )
       result._dump.to_smash

data/lib/bogo-config/configuration.rb

@@ -0,0 +1,5 @@
+require 'bogo-config'
+require 'attribute_struct'
+
+class Configuration < AttributeStruct
+end

data/lib/bogo-config/version.rb

@@ -1,6 +1,6 @@
 module Bogo
   class Config
     # Current library version
-    VERSION = Gem::Version.new('0.1.0')
+    VERSION = Gem::Version.new('0.1.2')
   end
 end

data/lib/bogo-config.rb

@@ -1,6 +1,5 @@
-require 'bogo-config/version'
 require 'bogo'
+require 'bogo-config/config'
+require 'bogo-config/version'
 
-module Bogo
-  autoload :Config, 'bogo-config/config'
-end
+autoload :Configuration, 'bogo-config/configuration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo
@@ -79,6 +79,7 @@ files:
 - bogo-config.gemspec
 - lib/bogo-config.rb
 - lib/bogo-config/config.rb
+- lib/bogo-config/configuration.rb
 - lib/bogo-config/version.rb
 homepage: https://github.com/spox/bogo-config
 licenses: