yaml_config 1.0.0

data/Changelog

@@ -0,0 +1,3 @@
+== v.0.1
+
+Initial version: YamlConfig class added.

data/Gemfile

@@ -0,0 +1,5 @@
+source :gemcutter
+
+group :development, :test do
+  gem "rspec", ">=2.5.0"
+end

data/README.rdoc

@@ -0,0 +1,47 @@
+== Description
+
+Simple wrapper for YAML config files.
+
+== Simple example
+
+  # File config/app_config.yml
+  # development:
+  #   app_host:
+  #     name: google.com
+  #     port: 80
+  # End of config/app_config.yml
+  require 'yaml_config'
+
+  config = YamlConfig.new(File.join(Rails.root, "config/app_config.yml"), :root => RAILS_ENV)
+  config.get(:app_host)[:name] # -> "google.com"
+  config.get(:app_host)[:port] # -> 80
+  config.get(:app_host)[:some] # -> NullProperty
+
+== Different initializations
+
+  # using filename
+  filename = File.join(Rails.root, "config/app_config.yml")
+  config = YamlConfig.new(filename, :root => RAILS_ENV)
+  # using open stream
+  File.open(filename, "r") do |file|
+    config = YamlConfig.new(file, :root => RAILS_ENV)
+  end
+  # using data string
+  config = YamlConfig.new(File.read(filename), :root => RAILS_ENV)
+
+== Singleton version
+
+In many cases (rails application is the best example) developer needs only one file for whole project.
+To accomplish this it possible to use singleton version of YamlConfig.
+
+  # environment.rb example:
+  require "yaml_config"
+  ...
+  filename = File.join(Rails.root, "config/app_config.yml")
+  config = AppYamlConfig.instance.init!(filename, :root => RAILS_ENV)
+  ...
+  # Usage
+  config.get(:username)
+
+== Known issues
+

data/init.rb

@@ -0,0 +1 @@
+require 'yaml_config'

data/lib/yaml_config.rb

@@ -0,0 +1,4 @@
+require "yaml_config/null_property"
+require "yaml_config/yaml_config"
+require "yaml_config/app_yaml_config"
+

data/lib/yaml_config/app_yaml_config.rb

@@ -0,0 +1,22 @@
+require "yaml_config/yaml_config"
+require "singleton"
+
+class AppYamlConfig
+  include Singleton
+  
+  def init!(file, options = {})
+    @yaml_config = YamlConfig.new(file, options)
+    self
+  end
+  
+  def respond_to?(name)
+    super || @yaml_config.respond_to?(name)
+  end
+  
+  def method_missing(name, *params)
+    @yaml_config.respond_to?(name) ?
+      @yaml_config.send(name, *params) :
+      super
+  end
+  
+end

data/lib/yaml_config/null_property.rb

@@ -0,0 +1,46 @@
+class NullProperty
+  @@base_values = [{}, [], "", 0, 0.0, nil]
+  
+  def to_s
+    ""
+  end
+
+  def to_i
+    0
+  end
+
+  def to_f
+    0.0
+  end
+
+  def to_a
+    []
+  end
+
+  def nil?
+    true
+  end
+  
+  def ==(val)
+    super || @@base_values.any? { |v| v == val }
+  end
+
+  def [](key)
+    NullProperty.new
+  end
+  
+  def instance_of?(klass)
+    super || @@base_values.any? { |v| v.instance_of?(klass) }
+  end
+
+  def respond_to?(method)
+    super || @@base_values.any? { |v| v.respond_to?(method) }
+  end
+
+  def method_missing(name, *params)
+    @@base_values.each do |val|
+      return val.send(name, *params) if val.respond_to?(name)
+    end
+    super
+  end
+end

data/lib/yaml_config/yaml_config.rb

@@ -0,0 +1,19 @@
+require "yaml_config/null_property"
+
+class YamlConfig
+  def initialize(file, options = {})
+    @root = options.delete(:root).to_s
+    @yaml = if file.respond_to?(:read)
+      YAML.load(file.read)
+    elsif file.is_a?(String)
+      File.exists?(file) ? YAML.load_file(file) : YAML.load(file)
+    end
+    
+    raise Exception.new("File is not valid YAML") unless @yaml.is_a?(Hash)
+    raise NameError.new("Root :#{@root} doesn't exist in given YAML") unless @root.empty? || @yaml.has_key?(@root)
+  end
+
+  def get(key)
+    (@root.empty? ? @yaml[key.to_s] : @yaml[@root][key.to_s]) || NullProperty.new
+  end
+end

data/spec/files/invalid_config.yml

@@ -0,0 +1,2 @@
+development;url;protocol;host;port
+;;"http";"localhost";8080

data/spec/files/valid_config.yml

@@ -0,0 +1,21 @@
+development:
+  url:
+    protocol: "http"
+    host: "localhost"
+    port: 8080
+  username: "Dev"
+  duration: 0.0
+test:
+  url:
+    protocol: "https"
+    host: "test.host"
+    port: 3000
+  username: "Test"
+  duration: 0.1
+production:
+  url:
+    protocol: "http"
+    host: "lunich.com.ua"
+    port: 80
+  username: "Prod"
+  duration: 8.0

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require "yaml_config/null_property"
+require "yaml_config/yaml_config"
+require "yaml_config/app_yaml_config"
+
+shared_examples_for "Yaml without root" do
+  it { config.get(:development).should be_instance_of(Hash) }
+  it { config.get(:development).keys.should == ["duration", "username", "url"] }
+
+  it { config.get(:development)["username"].should be_instance_of(String) }
+  it { config.get(:development)["username"].should == "Dev" }
+  
+  it { config.get(:development)["url"].should be_instance_of(Hash) }
+  it { config.get(:development)["url"]["protocol"].should be_instance_of(String) }
+  it { config.get(:development)["url"]["protocol"].should == "http" }
+  it { config.get(:development)["url"]["host"].should be_instance_of(String) }
+  it { config.get(:development)["url"]["host"].should == "localhost" }
+  it { config.get(:development)["url"]["port"].should be_instance_of(Fixnum) }
+  it { config.get(:development)["url"]["port"].should == 8080 }
+  
+  it { config.get(:development)["duration"].should be_instance_of(Float) }
+  it { config.get(:development)["duration"].should == 0.0 }
+
+  it { config.get(:trunk).should be_instance_of(NullProperty) }
+end
+
+shared_examples_for "Yaml with :root => :test" do
+  it { config.get(:username).should be_instance_of(String) }
+  it { config.get(:username).should == "Test" }
+                   
+  it { config.get(:url).should be_instance_of(Hash) }
+  it { config.get(:url)["protocol"].should be_instance_of(String) }
+  it { config.get(:url)["protocol"].should == "https" }
+  it { config.get(:url)["host"].should be_instance_of(String) }
+  it { config.get(:url)["host"].should == "test.host" }
+  it { config.get(:url)["port"].should be_instance_of(Fixnum) }
+  it { config.get(:url)["port"].should == 3000 }
+                   
+  it { config.get(:duration).should be_instance_of(Float) }
+  it { config.get(:duration).should == 0.1 }
+
+  it { config.get(:trunk).should be_instance_of(NullProperty) }
+end
+

data/spec/yaml_config/app_yaml_config_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AppYamlConfig do
+  describe "should be singleton" do
+    it "have no initialize method" do
+      lambda do
+        AppYamlConfig.new
+      end.should raise_error
+    end
+    it "should have :instance method" do
+      AppYamlConfig.instance.should be_instance_of(AppYamlConfig)
+    end
+  end
+  describe "with valid yaml" do
+    let :filename do
+      File.join(File.dirname(__FILE__), "../files/valid_config.yml")
+    end
+    describe "with data" do
+      let :data do
+        File.read(filename)
+      end
+      describe "without :root" do
+        let :config do
+          AppYamlConfig.instance.init!(data)
+        end
+        it { config.should be_instance_of(AppYamlConfig) }
+        it_should_behave_like "Yaml without root"
+      end
+      describe "with :root => :test" do
+        let :config do
+          AppYamlConfig.instance.init!(data, :root => :test)
+        end
+        it { config.should be_instance_of(AppYamlConfig) }
+        it_should_behave_like "Yaml with :root => :test"
+      end
+      describe "with open file" do
+        let :file do
+          File.open(filename, "r")
+        end
+        describe "without :root" do
+          let :config do
+            AppYamlConfig.instance.init!(file)
+          end
+          it { config.should be_instance_of(AppYamlConfig) }
+          it_should_behave_like "Yaml without root"
+        end
+        describe "with :root => :test" do
+          let :config do
+            AppYamlConfig.instance.init!(file, :root => :test)
+          end
+          it { config.should be_instance_of(AppYamlConfig) }
+          it_should_behave_like "Yaml with :root => :test"
+        end
+      end
+      describe "without :root" do
+        let :config do
+          AppYamlConfig.instance.init!(filename)
+        end
+        it { config.should be_instance_of(AppYamlConfig) }
+        it_should_behave_like "Yaml without root"
+      end
+      describe "with :root => :test" do
+        let :config do
+          AppYamlConfig.instance.init!(filename, :root => :test)
+        end
+        it { config.should be_instance_of(AppYamlConfig) }
+        it_should_behave_like "Yaml with :root => :test"
+      end
+      describe "with invalid root" do
+        it "should raise error" do
+          lambda do
+            AppYamlConfig.instance.init!(filename, :root => :demo)
+          end.should raise_exception(NameError)
+        end
+      end
+    end
+    describe "with invalid yaml" do
+      let :filename do
+        File.join(File.dirname(__FILE__), "../files/invalid_config.yml")
+      end
+      it "should raise error" do
+        lambda do
+          AppYamlConfig.instance.init!(filename, :root => :demo)
+        end.should raise_exception(Exception)
+      end
+    end
+  end
+end

data/spec/yaml_config/null_preperty_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe NullProperty do
+  let :property do
+    NullProperty.new
+  end
+  [{}, [], "", 0, 0.0, nil].each do |obj|
+    describe "as #{obj.class} object" do
+      it { property.should == obj }
+      it { property.should be_instance_of(obj.class) }
+      obj.methods.each do |method|
+        it { property.should respond_to(method) }
+      end
+    end
+  end
+  describe "[] method" do
+    describe "should return NullProperty object" do
+      it "with string key" do
+        property["property"].should be_instance_of(NullProperty)
+      end
+      it "with symbol key" do
+        property[:property].should be_instance_of(NullProperty)
+      end
+      it "with integer key" do
+        property[0].should be_instance_of(NullProperty)
+      end
+    end
+  end
+  it { property.to_s.should == "" }
+  it { property.to_f.should == 0.0 }
+  it { property.to_i.should == 0 }
+  it { property.to_a.should == [] }
+  it { property.should be_nil }
+  it { property.should be_empty }
+end

data/spec/yaml_config/yaml_config_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YamlConfig do
+  describe "with valid yaml" do
+    let :filename do
+      File.join(File.dirname(__FILE__), "../files/valid_config.yml")
+    end
+    describe "with data" do
+      let :data do
+        File.read(filename)
+      end
+      describe "without :root" do
+        let :config do
+          YamlConfig.new(data)
+        end
+        it_should_behave_like "Yaml without root"
+      end
+      describe "with :root => :test" do
+        let :config do
+          YamlConfig.new(data, :root => :test)
+        end
+        it_should_behave_like "Yaml with :root => :test"
+      end
+    end
+    describe "with open file" do
+      let :file do
+        File.open(filename, "r")
+      end
+      describe "without :root" do
+        let :config do
+          YamlConfig.new(file)
+        end
+        it_should_behave_like "Yaml without root"
+      end
+      describe "with :root => :test" do
+        let :config do
+          YamlConfig.new(file, :root => :test)
+        end
+        it_should_behave_like "Yaml with :root => :test"
+      end
+    end
+    describe "without :root" do
+      let :config do
+        YamlConfig.new(filename)
+      end
+      it_should_behave_like "Yaml without root"
+    end
+    describe "with :root => :test" do
+      let :config do
+        YamlConfig.new(filename, :root => :test)
+      end
+      it_should_behave_like "Yaml with :root => :test"
+    end
+    describe "with invalid root" do
+      it "should raise error" do
+        lambda do
+          YamlConfig.new(filename, :root => :demo)
+        end.should raise_exception(NameError)
+      end
+    end
+  end
+  describe "with invalid yaml" do
+    let :filename do
+      File.join(File.dirname(__FILE__), "../files/invalid_config.yml")
+    end
+    it "should raise error" do
+      lambda do
+        YamlConfig.new(filename, :root => :demo)
+      end.should raise_exception(Exception)
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: yaml_config
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dima Lunich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This gem reads and manage YAML config files
+email: 
+- dima.lunich@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/yaml_config/app_yaml_config.rb
+- lib/yaml_config/null_property.rb
+- lib/yaml_config/yaml_config.rb
+- lib/yaml_config.rb
+- spec/files/invalid_config.yml
+- spec/files/valid_config.yml
+- spec/spec_helper.rb
+- spec/yaml_config/app_yaml_config_spec.rb
+- spec/yaml_config/null_preperty_spec.rb
+- spec/yaml_config/yaml_config_spec.rb
+- README.rdoc
+- Changelog
+- Gemfile
+- init.rb
+has_rdoc: true
+homepage: http://github.com/lunich/yaml_config
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: yaml_config-1.0.0
+test_files: 
+- spec/files/invalid_config.yml
+- spec/files/valid_config.yml
+- spec/spec_helper.rb
+- spec/yaml_config/app_yaml_config_spec.rb
+- spec/yaml_config/null_preperty_spec.rb
+- spec/yaml_config/yaml_config_spec.rb