cogwheels 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5ee70dfbd9dd92d4281567d1ba1ada1a5bb8a02
-  data.tar.gz: 0ce0a29503a912eb6d8f239957b001cee86df9a5
+  metadata.gz: bb919b6dc0b5705ef61dead9251ea9d7102c9d85
+  data.tar.gz: 704d4009e3d5f5264805243f93dfeafda62b6beb
 SHA512:
-  metadata.gz: 5ad807c8cb8d9af9bcbaf71aaa19a7a9fa6687694c159f7d1ffc202297f38884aedd82029a49721bb63cca3143afd3dad99e46a595b6f221765bf0019b37e7d4
-  data.tar.gz: a469ca79dede33cc0b176f29034d49b9e541f2bf598a604e9dfcf9f0f744011713c4768e755246742dc5fd57b24a1969ba984a6b3b0bfec2a5f4aaa39ffbc345
+  metadata.gz: 95848c537772c30137a3658bdaaecd1edecbe98075f2f89aaacf5b4307cb2d021acda197f06608855310bfefc593b7f1d1f0873ee425c5b2fad7c4f5a8bfb2fa
+  data.tar.gz: d5f115a73e99beb1a8cfb9a30f6a6d3ce25013e157aa230d0da1313cbb8f4b5405e9843614201f1bfbece731a5ed767e0030533a63e47bce04f638d8badde5f7

data/LICENSE.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2016 Christopher Lutz
-
-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.
+MIT License
+
+Copyright (c) 2016 Christopher Lutz
+
+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

@@ -1,7 +1,77 @@
-[![Dependency Status](https://gemnasium.com/badges/github.com/chrisblutz/cogwheels.svg)](https://gemnasium.com/github.com/chrisblutz/cogwheels)
-[![Linux Build Status](https://travis-ci.org/chrisblutz/cogwheels.svg?branch=master)](https://travis-ci.org/chrisblutz/cogwheels)
-[![Inline docs](http://inch-ci.org/github/chrisblutz/cogwheels.svg?branch=master)](http://inch-ci.org/github/chrisblutz/cogwheels)
-[![Test Coverage](https://codeclimate.com/github/chrisblutz/cogwheels/badges/coverage.svg)](https://codeclimate.com/github/chrisblutz/cogwheels/coverage)
-[![Code Climate](https://codeclimate.com/github/chrisblutz/cogwheels/badges/gpa.svg)](https://codeclimate.com/github/chrisblutz/cogwheels)
-# Cogwheels
-**Cogwheels** is a work-in-progress configuration-loading library for Ruby.
+[![Gem Version](https://badge.fury.io/rb/cogwheels.svg)](http://badge.fury.io/rb/cogwheels)
+[![Dependency Status](https://gemnasium.com/badges/github.com/chrisblutz/cogwheels.svg)](https://gemnasium.com/github.com/chrisblutz/cogwheels)
+[![Linux Build Status](https://travis-ci.org/chrisblutz/cogwheels.svg?branch=master)](https://travis-ci.org/chrisblutz/cogwheels)
+[![Inline docs](http://inch-ci.org/github/chrisblutz/cogwheels.svg?branch=master)](http://inch-ci.org/github/chrisblutz/cogwheels)
+[![Test Coverage](https://codeclimate.com/github/chrisblutz/cogwheels/badges/coverage.svg)](https://codeclimate.com/github/chrisblutz/cogwheels/coverage)
+[![Code Climate](https://codeclimate.com/github/chrisblutz/cogwheels/badges/gpa.svg)](https://codeclimate.com/github/chrisblutz/cogwheels)
+
+# Cogwheels
+
+**Cogwheels** is a lightweight configuration-loading library for Ruby.
+
+## Installation
+
+To install, use the standard RubyGems syntax:
+```sh
+$ gem install cogwheels
+```
+Or if necessary, you can add it to your `Gemfile`:
+```rb
+gem 'cogwheels'
+```
+As **Cogwheels** is not yet at version `1.0`, it is recommended to use version locking:
+```rb
+gem 'cogwheels', '~> 0.2'
+```
+
+## Usage
+
+Assuming you have already installed the `cogwheels` gem or added it to your `Gemfile`, the first step
+is to require it:
+```rb
+require 'cogwheels'
+```
+You can load the configuration file into a `Cogwheels::Configuration` object using the following:
+```rb
+config = Cogwheels.load('.../file.yml')
+```
+This `config` object uses methods similar to those in a `Hash` object:
+```rb
+config[:key] # Retrieves the value for a key
+
+config.key?(:key) # Checks if a value exists for a key
+
+config[:key] = 'value' # Sets the value for a key
+```
+However, the basic retrieval method (`config[:key]`) also takes a default value as an optional parameter:
+```rb
+config[:key, 'default'] # Retrieves the value for a key, specifying a default value
+```
+If for any reason you need the original `Hash` object, you can call `config.hash` to retrieve it.
+
+### Mutability
+
+By default, `Configuration` instances are *mutable*, which means their values can be altered at any time.  However, you can lock editing on a configuration tree by passing a second parameter to the `load` method:
+```rb
+config = Cogwheels.load('.../file.yml', false)
+```
+Now, whenever an edit is attempted (such as `config[:key] = 'value'`), an `ImmutableConfigurationError` will be raised.
+
+### Symbols As Keys
+
+If needed, `Configuration` objects can be forced to convert *all* of their keys to symbols:
+```rb
+config.to_symbol_keys
+```
+So if this file is passed in:
+```yml
+Test: value
+```
+the value can be retrieved using:
+```rb
+config[:Test]
+```
+
+## Copyright
+
+Copyright (c) 2016 Christopher Lutz.  See [LICENSE.txt](LICENSE.txt) for further details.

data/lib/cogwheels.rb

@@ -1,39 +1,39 @@
-$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
-
-# Internal dependencies
-require 'cogwheels/version'
-
-# Cogwheels allows YAML configuration files to be loaded into Configuration
-# instances for ease of use
-#
-# Cogwheels is licensed under the MIT license:
-#
-# Copyright (c) 2016 Christopher Lutz
-#
-# 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.
-module Cogwheels
-  autoload :Configuration, 'cogwheels/configuration'
-  autoload :Loader, 'cogwheels/loader'
-
-  module_function
-
-  def load(src, mutable = true)
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+# Internal dependencies
+require 'cogwheels/version'
+
+# Cogwheels allows YAML configuration files to be loaded into Configuration
+# instances for ease of use
+#
+# Cogwheels is licensed under the MIT license:
+#
+# Copyright (c) 2016 Christopher Lutz
+#
+# 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.
+module Cogwheels
+  autoload :Configuration, 'cogwheels/configuration'
+  autoload :Loader, 'cogwheels/loader'
+
+  module_function
+
+  def load(src, mutable = true)
     Cogwheels::Loader.load(src, mutable)
-  end
-end
+  end
+end

data/lib/cogwheels/configuration.rb

@@ -7,12 +7,20 @@ module Cogwheels
     attr_reader :mutable
 
     def initialize(hash, mutable = true)
-      @hash = hash
+      @hash = {}
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          value_config = Configuration.new(value, mutable)
+          @hash[key] = value_config
+        else
+          @hash[key] = value
+        end
+      end
       @mutable = mutable
     end
 
-    def [](key)
-      @hash[key]
+    def [](key, default = nil)
+      @hash[key] ||= default
     end
 
     def []=(key, value)
@@ -25,12 +33,40 @@ A modification was attempted on an immutable Configuration instance.
       @hash[key] = value if @mutable
     end
 
+    def key?(key)
+      @hash.key?(key)
+    end
+
+    def keys
+      @hash.keys
+    end
+
+    attr_reader :hash
+
+    def to_symbol_keys
+      @new_hash = {}
+      @hash.each do |key, value|
+        key = key.to_sym
+        @new_hash[key] = if value.is_a?(Cogwheels::Configuration)
+                           value.to_symbol_keys
+                         else
+                           value
+                         end
+      end
+      @hash = @new_hash
+      self
+    end
+
     def to_s
       @hash.to_s
     end
 
     def inspect
-      "Cogwheels::Configuration =>\n#{@hash}"
+      "Cogwheels::Configuration (mutable: #{mutable}) =>\n#{@hash}"
+    end
+
+    def ==(other)
+      hash == other.hash && mutable == other.mutable
     end
   end
 end

data/lib/cogwheels/version.rb

@@ -1,3 +1,3 @@
 module Cogwheels
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cogwheels
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Christopher Lutz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2016-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -24,8 +24,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Cogwheels is a library to load configurations from YAML files into easy-to-use
-  hash-like objects
+description: 'Cogwheels is a lightweight library to load configurations from YAML
+  files into easy-to-use hash-like objects
+
+'
 email:
 - lutzblox@gmail.com
 executables: []
@@ -50,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -58,8 +60,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby configuration-loading library
+summary: A lightweight Ruby configuration-loading library
 test_files: []