zen_config 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zen_config.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gauthier Delacroix
+
+MIT License
+
+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,116 @@
+# ZenConfig
+
+ZenConfig is an attempt to rewrite Zend Framework's Zend_Config for Ruby.
+
+It allows easy management of configuration objects and files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zen_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zen_config
+
+## Usage
+
+Instantiate ZenConfig with a configuration hash :
+
+    config_hash = { :foo => "foo value" }
+    MyConfig = ZenConfig.new config_hash
+    MyConfig.foo
+     => "foo value"
+
+By default, ZenConfig is read only :
+
+    MyConfig.foo = "bar value"
+    NoMethodError: undefined method `foo=' for #<ZenConfig:0x00000002ee52f8>
+
+But changes can be allowed on build time :
+
+    MyConfig = ZenConfig.new config_hash, true
+    MyConfig.foo = "bar value"
+     => "bar value"
+    MyConfig.foo
+     => "bar value"
+
+Then the object can be locked to read only again :
+
+    MyConfig.read_only
+    MyConfig.read_only?
+     => true
+    MyConfig.foo = "foo value"
+    NoMethodError: undefined method `foo=' for #<ZenConfig:0x00000002ee52f8>
+
+And there's no way to unlock write.
+This guarantees that ZenConfig data hasn't been altered since read-only lock has been set.
+You should not use unlocked ZenConfig in your application code, since you don't know when and where it has been modified.
+Dynamic persistent writes functions will come in future versions.
+
+Sub configurations can be nested (if ZenConfig object is not locked) :
+
+    MyConfig.new :bar
+    MyConfig.bar.baz = "baz value"
+
+Nested configurations are ZenConfigs. This allow accessing configuration on a specific context :
+
+    MyBarConfig = MyConfig.bar
+    MyBarConfig.class
+     => ZenConfig
+    MyBarConfig.baz
+     => "baz value"
+
+Nested ZenConfigs can access their parent :
+
+    MyBarConfig.parent.foo
+     => "bar value"
+
+Of course, root ZenConfig has no parent :
+
+    MyConfig.parent
+     => nil
+
+You can check if a config key exists :
+
+    MyConfig.foo_exists?
+     => true
+
+Count keys :
+
+    MyConfig.count
+     => 2
+    MyConfig.bar.count
+     => 1
+
+ZenConfigs can be converted to hashs :
+
+    MyConfig.to_hash
+     => {:foo=>"bar value", :bar=>{:baz=>"baz value"}}
+
+And finally, config keys can be deleted (if ZenConfig is unlocked) :
+
+    MyConfig.delete :foo
+    MyConfig.to_hash
+     => {:bar=>{:baz=>"baz value"}}
+
+Note : ZenConfig methods are reserved words that can not be used as config keys.
+They'll probably be renamed with a leading underscore in future versions.
+
+## Goals
+
+- Provide hierarchical configuration objects => Done!
+- Bring a read-only lock mode to guarantee config values haven't been modified => Done!
+- Allow config file loading.
+- Allow config file writing.
+- Provide full unit tests.
+
+## Known bugs
+
+- Nested hashs raise an error on init
+- Merging doesn't always work

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/zen_config/version.rb

@@ -0,0 +1,3 @@
+class ZenConfig
+  VERSION = "0.0.1"
+end

data/lib/zen_config.rb

@@ -0,0 +1,193 @@
+require 'zen_config/version'
+require 'forwardable'
+
+class ZenConfig
+  include Enumerable
+  extend Forwardable
+
+  def_delegators :@data, :each, :<<
+
+  def initialize hash, allow_modifications = false
+    @allow_modifications = !!allow_modifications
+    @loaded_section = nil
+    @index = 0
+    @data = {}
+
+    hash.each do |key, value|
+      key = key.to_sym
+
+      if value.is_a? Hash
+        @data[key] = self.new value, @allow_modifications
+      else
+        @data[key] = value
+      end
+
+      set_key_parent key
+    end
+
+    update_count
+  end
+
+  # Accessors
+
+  def get name, default = nil
+    result = default
+
+    if @data.has_key? name
+      result = @data[name]
+    end
+
+    return result
+  end
+
+  def set key, value
+    if @allow_modifications
+      if value.is_a? Hash
+        @data[key] = self.new value, true
+      else
+        @data[key] = value
+      end
+
+      set_key_parent key
+      update_count
+
+      return value
+    end
+  end
+
+  # Data
+
+  def count
+    @count
+  end
+
+  def delete key
+    if @allow_modifications
+      backup = @data[key]
+      @data.delete key
+      update_count
+      return backup
+    end
+  end
+
+  def exists? key
+    @data.has_key? key
+  end
+
+  def new key, force = false
+    key = key.to_sym
+
+    if @allow_modifications
+      if (!exists? key) || force
+        @data[key] = ZenConfig.new({}, true)
+        set_key_parent key
+      else
+        raise "'#{key}' key already exists."
+      end
+    end
+  end
+
+  #Global
+
+  def merge merge
+    raise "Merged configuration must be a ZenConfig" unless merge.kind_of? ZenConfig
+
+    merge.each do |key, value|
+      if @data.has_key? key
+        if (value.kind_of? ZenConfig) && (@data[key].kind_of? ZenConfig)
+          @data[key] = @data[key].merge(ZenConfig.new value.to_hash, !read_only?)
+        else
+          @data[key] = value
+        end
+      else
+        if value.kind_of? ZenConfig
+          @data[key] = ZenConfig.new value.to_hash, read_only?
+        else
+          @data[key] = value
+        end
+      end
+
+      set_key_parent key
+    end
+
+    return self
+  end
+
+  def method_missing method, *args
+    value = args.first
+
+    # Checks if a key exists
+    if /\A(.*)_exists\?\Z/.match method
+      exists? $1
+
+    # Delete a key
+    elsif /\Adelete_(.*)\Z/.match method
+      delete $1 if exists? $1
+
+    # Writes a key value
+    elsif (method[-1] == '=') && @allow_modifications
+      key = method[0..-2].to_sym
+      set key, value
+
+    # Reads a key value
+    elsif (args.count == 0)
+      get method
+
+    # Unknown method
+    else
+      super
+    end
+  end
+
+  def read_only
+    @allow_modifications = false
+    @data.each do |key, value|
+      if value.kind_of? ZenConfig
+        value.read_only
+      end
+    end
+  end
+
+  def read_only?
+    !@allow_modifications
+  end
+
+  def to_hash
+    hash = {}
+    @data.each do |key, value|
+      if value.kind_of? ZenConfig
+        hash[key] = value.to_hash
+      else
+        hash[key] = value
+      end
+    end
+
+    return hash
+  end
+
+  # Parent
+
+  def parent
+    return @parent
+  end
+
+  def set_key_parent key
+    if @data[key].kind_of? ZenConfig
+      @data[key].set_parent self
+    end
+  end
+
+  def set_parent parent
+    if parent.kind_of? ZenConfig
+      @parent = parent
+    else
+      raise "Parent must be a ZenConfig"
+    end
+  end
+
+  private
+
+  def update_count
+    @count = @data.count
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+require 'zen_config'
+
+RSpec.configure do |config|
+
+end

data/spec/zen_config_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ZenConfig do
+
+end

data/zen_config.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/zen_config/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gauthier Delacroix"]
+  gem.email         = ["gauthier.delacroix@gmail.com"]
+  gem.description   = "Zend_Config translated into Ruby"
+  gem.summary       = "Brings Ruby config objects as with Zend Framework's Zend_Config"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "zen_config"
+  gem.require_paths = ["lib"]
+  gem.version       = ZenConfig::VERSION
+
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: zen_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gauthier Delacroix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Zend_Config translated into Ruby
+email:
+- gauthier.delacroix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/zen_config.rb
+- lib/zen_config/version.rb
+- spec/spec_helper.rb
+- spec/zen_config_spec.rb
+- zen_config.gemspec
+homepage: ''
+licenses: []
+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.21
+signing_key: 
+specification_version: 3
+summary: Brings Ruby config objects as with Zend Framework's Zend_Config
+test_files:
+- spec/spec_helper.rb
+- spec/zen_config_spec.rb