foundry 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9da30abaa99f3fd6c765f67591499dc5cca98f12
-  data.tar.gz: 6df1988b72d7e206e11253cd80e6d1eed20ac506
+  metadata.gz: fb2577df8898406d373fe649df69d6fcb30f9688
+  data.tar.gz: 1bf538e9a2cefd8a68a474ac36c73a18afd3b10c
 SHA512:
-  metadata.gz: 4e427ccece01e33d3b1387246a92a73ff9c4d316ad5d77651fd1d67df0a95fbeddabd94bd2b152110f4d3f6e4aba8f2f374b2cb0c873bef1d7a975aadd1cd141
-  data.tar.gz: 1fab1178b3d77026e47e205a004ddb0c430172853e6b334c5b648cfeb642b3eef2b8f2a31a1a2480737f5041a74aaa377c6c2dca33dde602a4d7d743b59db310
+  metadata.gz: 0b7c6975739a40247f16b952dcc2623c1fd35fbfdb7a6e10adc3892cb4fec25cc6715593314d2e21f4054493a1f5c517102b12ea15a7beceac5d5bdee05a5b8a
+  data.tar.gz: a666555baaae3f83aba7a2aa881bb94ab11fbf8a7c52d45fff7b25d76f81a1991ea21ab333ccef254e190b5bf0cd3a563f9abbcefdc903b40fa2a8cfcde9da93

data/README.md

@@ -5,6 +5,18 @@
 
 An application configuration gem that aims to keep it simple
 
+Let's face it, there are a number of problems when application/environment
+configuration logic is too tightly coupled with the configuration-data itself.
+This gem aims to keep it simple and fully decouple the two concerns.
+
+Features:
+
+* Can load YAML from a local-file
+* Can load YAML from a HTTP/HTTPS endpoint
+* Supports Basic Authentication for HTTP{,S} endpoints
+* Supports ERB interpolation
+* Returns an easy to navigate object-graph
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,25 +36,42 @@ Or install it yourself as:
 Loading from a local-file:
 
 ```ruby
-Foundry::Configurator.configure(:file_name => 'path-to-local-file')
+config = Foundry::Configurator.configure(:file_name => 'path-to-local-file')
 ```
 
 Loading from a HTTP/HTTPS endpoint:
 
 ```ruby
-Foundry::Configurator.configure(:uri => 'http-or-https-endpoint')
+config = Foundry::Configurator.configure(:uri => 'http-or-https-endpoint')
 ```
 
 Loading from a HTTP/HTTPS endpoint using "Basic Authentication":
 
 ```ruby
-Foundry::Configurator.configure(
+config = Foundry::Configurator.configure(
   :uri => 'http-or-https-endpoint',
   :username => 'basic-auth-username',
   :password => 'basic-auth-password'
 )
 ```
 
+Using the "config" object (defined above):
+
+```ruby
+# The examples below assume that the following YAML was loaded by a call to
+# "Foundry::Configurator.configure" and into a variable named "config"
+#
+# ---
+# some_key:
+#   some_nested_key: value
+
+# Fetch a value using dot-notation
+value = config.some_key.some_nested_key
+
+# Fetch a value by key
+value = config['some_key']['some_nested_key']
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/jzaleski/foundry/fork )

data/TODO

@@ -1,2 +1 @@
-* Consider using `Hashie` instead of `OpenStruct`
 * Add support for other source-file types (JSON? XML (::shiver::)?)

data/foundry.gemspec

@@ -8,20 +8,12 @@ Gem::Specification.new do |gem|
   gem.version = Foundry::VERSION
   gem.authors = ['Jonathan W. Zaleski']
   gem.email = ['JonathanZaleski@gmail.com']
-  gem.summary = %{An application configuration gem that aims to keep it simple}
-  gem.description = <<-EOL
+  gem.summary = 'An application configuration gem that aims to keep it simple'
+  gem.description = <<-DESCRIPTION
   Let's face it, there are a number of problems when application/environment
   configuration logic is too tightly coupled with the configuration-data itself.
   This gem aims to keep it simple and fully decouple the two concerns.
-
-  Features:
-
-  * Can load YAML from a local-file
-  * Can load YAML from a HTTP/HTTPS endpoint
-  * Supports Basic Authentication for HTTP{,S} endpoints
-  * Supports ERB interpolation
-  * Returns an easy to navigate object-graph
-  EOL
+  DESCRIPTION
   gem.homepage = 'https://github.com/jzaleski/foundry'
   gem.license = 'MIT'
 

data/lib/foundry/configurator.rb

@@ -2,7 +2,7 @@ module Foundry
   class Configurator
     class << self
       def configure(opts={})
-        ostructify(
+        structify(
           load_yaml(
             evaluate_erb(
               load_by_filename_or_uri(opts)
@@ -31,16 +31,16 @@ module Foundry
         YAML.load(str)
       end
 
-      def ostructify(object)
+      def structify(object)
         case object
         when Array
           object.map do |value|
-            ostructify(value)
+            structify(value)
           end
         when Hash
-          OpenStruct.new.tap do |ostruct|
+          Foundry::HashStruct.new.tap do |hash_struct|
             object.each do |key, value|
-              ostruct.public_send("#{key}=", ostructify(value))
+              hash_struct[key] = structify(value)
             end
           end
         else

data/lib/foundry/hash_struct.rb

@@ -0,0 +1,10 @@
+module Foundry
+  class HashStruct < OpenStruct
+    def [](key)
+      public_send(key.to_sym)
+    end
+    def []=(key, value)
+      public_send("#{key.to_sym}=", value)
+    end
+  end
+end

data/lib/foundry/version.rb

@@ -1,3 +1,3 @@
 module Foundry
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/lib/foundry.rb

@@ -6,6 +6,7 @@ require 'uri'
 require 'yaml'
 
 require 'foundry/configurator'
+require 'foundry/hash_struct'
 require 'foundry/loaders/file'
 require 'foundry/loaders/uri'
 require 'foundry/version'

data/spec/configurator_spec.rb

@@ -42,8 +42,8 @@ describe Foundry::Configurator do
     YAML
     }
     expect(subject.configure(:file_name => '')).to eq(
-      OpenStruct.new(
-        'root' => OpenStruct.new(
+      Foundry::HashStruct.new(
+        'root' => Foundry::HashStruct.new(
           'erb' => 6,
           'float' => 123.0,
           'integer' =>  42,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foundry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jonathan W. Zaleski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,14 +70,6 @@ description: |2
     Let's face it, there are a number of problems when application/environment
     configuration logic is too tightly coupled with the configuration-data itself.
     This gem aims to keep it simple and fully decouple the two concerns.
-
-    Features:
-
-    * Can load YAML from a local-file
-    * Can load YAML from a HTTP/HTTPS endpoint
-    * Supports Basic Authentication for HTTP{,S} endpoints
-    * Supports ERB interpolation
-    * Returns an easy to navigate object-graph
 email:
 - JonathanZaleski@gmail.com
 executables: []
@@ -94,6 +86,7 @@ files:
 - foundry.gemspec
 - lib/foundry.rb
 - lib/foundry/configurator.rb
+- lib/foundry/hash_struct.rb
 - lib/foundry/loaders/file.rb
 - lib/foundry/loaders/uri.rb
 - lib/foundry/version.rb
@@ -121,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: An application configuration gem that aims to keep it simple