yaml_properties 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Burns
+
+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,39 @@
+# YamlProperties
+
+If you find yourself often setting app config in yaml files for different
+environments etc. Then this can be quite useful to simply access those variables.
+
+
+```ruby
+YamlProperties.redis_port
+```
+
+Will by default read a value from a YAML file in `config/properties.yml`
+
+```yaml
+redis_port: 1369
+```
+
+Also can be added to a module or class like
+
+```ruby
+module Shutl
+  extend YamlProperties
+end
+
+```
+
+#Override filename like this
+
+```ruby
+module Shutl
+  extend YamlProperties
+  def self.yaml_file
+    ENV['SINATRA_ENV'] == 'development' ? 'config/properties.yml' : 'config/properties_production.yml'
+  end
+end
+```
+#Yadayada
+gem 'yaml_config'
+
+Usual gem/bundler usage/contribution guidelines

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yaml_properties/version.rb

@@ -0,0 +1,3 @@
+module YamlProperties
+  VERSION = "0.0.1"
+end

data/lib/yaml_properties.rb

@@ -0,0 +1,30 @@
+require "yaml_properties/version"
+require "active_support/core_ext/hash"
+
+module YamlProperties
+  def properties
+    @properties ||= load_properties.with_indifferent_access
+  end
+
+  def reset_properties
+    @properties = nil
+  end
+
+  def method_missing(key, *args, &block)
+    return properties[key] if properties.keys.include? key.to_s
+
+    super key, *args, &block
+  end
+
+  private
+
+  def yaml_file
+    File.join %w(config properties.yml)
+  end
+
+  def load_properties
+    YAML.load File.open(yaml_file)
+  end
+
+  extend self
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/test.yml

@@ -0,0 +1 @@
+life_the_universe_and_everything: "Nobody knows"

data/spec/yaml_config_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path('spec/spec_helper')
+require './lib/yaml_properties'
+
+describe YamlProperties do
+  context "in general" do
+    before do
+      File.stub(:open)
+
+      YAML.stub(:load).and_return properties
+    end
+
+    let(:properties) do
+      {
+        "life_the_universe_and_everything" => 42,
+        "some_string_value"                => "something",
+        "a boolean"                        => true,
+        "parent"                           => {
+         "child"=>"Egg"}
+      }
+    end
+
+    specify do
+      YamlProperties.properties.should == properties
+    end
+    specify do
+      YamlProperties.life_the_universe_and_everything.should == 42
+    end
+
+    specify do
+      YamlProperties.some_string_value.should == "something"
+    end
+
+    specify do
+      YamlProperties.send("a boolean").should == true
+    end
+
+    specify do
+      YamlProperties.parent.should == {"child" => "Egg"}
+    end
+
+    context "extending a module" do
+      module Acme
+        extend YamlProperties
+      end
+
+      specify do
+        Acme.life_the_universe_and_everything.should == 42
+      end
+    end
+  end
+
+  context "overriding yaml_file default" do
+    module Mystery
+      extend YamlProperties
+
+      def self.yaml_file
+        "./spec/test.yml"
+      end
+    end
+
+    specify do
+      Mystery.life_the_universe_and_everything.should == "Nobody knows"
+    end
+  end
+end

data/yaml_properties.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml_properties/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "yaml_properties"
+  gem.version       = YamlProperties::VERSION
+  gem.authors       = ["Mark Burns"]
+  gem.email         = ["markthedeveloper@gmail.com"]
+  gem.description   = %q{Easily add configurable variables for app config using YAML files}
+  gem.summary       = <<-DESCRIPTION.gsub(/^\s{4}/, '')
+    Example:
+
+      YamlProperties.life_the_universe_and_everything
+      #=> 42
+
+    In config/properties.yml
+
+      life_the_universe_and_everything: 42
+  DESCRIPTION
+
+  gem.homepage      = ""
+
+  gem.add_dependency  'active_support'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'debugger'
+
+  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.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: yaml_properties
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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: Easily add configurable variables for app config using YAML files
+email:
+- markthedeveloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/properties.yml
+- lib/yaml_properties.rb
+- lib/yaml_properties/version.rb
+- spec/spec_helper.rb
+- spec/test.yml
+- spec/yaml_config_spec.rb
+- yaml_properties.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.24
+signing_key: 
+specification_version: 3
+summary: ! 'Example: YamlProperties.life_the_universe_and_everything #=> 42 In config/properties.yml
+  life_the_universe_and_everything: 42'
+test_files:
+- spec/spec_helper.rb
+- spec/test.yml
+- spec/yaml_config_spec.rb
+has_rdoc: