yard

Author: gfowley

.yardoc/checksums

@@ -0,0 +1,2 @@
+lib/iqeo/configuration.rb 0790c6ed002a1b1e69afc4f38e218756c5ac480f
+lib/iqeo/configuration/version.rb dad9c52c1d00b3028d333907df8e3ad45d475d93

.yardoc/object_types

@@ -0,0 +1,2 @@
+{I"Object:EF:
+class

.yardoc/objects/root.dat

@@ -7,7 +7,11 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    json (1.7.1)
     rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
     rspec (2.9.0)
       rspec-core (~> 2.9.0)
       rspec-expectations (~> 2.9.0)
@@ -16,11 +20,15 @@ GEM
     rspec-expectations (2.9.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
+    yard (0.8.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   iqeo-conf!
   rake (~> 0.9.2)
+  rdoc (~> 3.12.0)
+  redcarpet (~> 2.1.1)
   rspec (~> 2.9.0)
+  yard (~> 0.8.1)

.yardoc/proxy_types

@@ -0,0 +1,120 @@
+# Iqeo::Configuration
+
+A DSL representing configuration files.
+
+## Installation
+
+It`s a gem...
+
+    $ gem install iqeo-conf
+
+## Usage
+
+Require 'iqeo/configuration' and optionally include Iqeo namespace:
+
+    require 'iqeo/configuration'
+    include Iqeo
+
+### Create configuration
+
+There are three ways to create configurations; explicit, block DSL, eval DSL.
+
+#### Explicit
+
+Call Configuration#new without a block.
+Explicitly call methods on instance to configure instance.
+
+    conf = Configuration.new
+    conf.alpha   1
+    conf.bravo   2.0
+    conf.charlie :three
+    conf.delta   "four"
+
+#### Block DSL
+
+Call Configuration#new with a block that expects a variable, a new instance will be yielded.
+Within block, call methods on yielded instance to configure.
+
+    conf = Configuration.new do |c|
+      c.alpha   1
+      c.bravo   2.0
+      c.charlie :three
+      c.delta   "four"
+    end
+
+#### Eval DSL
+
+Call Configuration#new with a block that does not expect a variable, contents of the block are eval`d in the context of the new instance.
+Call methods with implied self to configure instance.
+
+    conf = Configuration.new do
+      alpha   1
+      bravo   2.0
+      charlie :three
+      delta   "four"
+    end
+
+### Read configuration
+
+All examples above result in the same configuration.
+Configuration settings can be retrieved directly or indirectly.
+
+#### Directly
+
+##### Named method
+
+    conf.alpha        # => 1
+    conf.bravo        # => 2.0
+    conf.charlie      # => :three
+    conf.delta        # => "four"
+
+##### [ 'string' ]
+
+    conf['alpha']     # => 1
+    conf['bravo']     # => 2.0
+    conf['charlie']   # => :three
+    conf['delta']     # => "four"
+
+##### [ :symbol ]
+
+    conf[:alpha]      # => 1
+    conf[:bravo]      # => 2.0
+    conf[:charlie]    # => :three
+    conf[:delta]      # => "four"
+
+#### Indirectly
+
+The underlying storage is an indifferent hash, so the usual Hash and Enumerable methods work.
+
+##### Hash & Enumerable methods
+
+    conf.size                           # => 4
+    conf.keys                           # => [ 'alpha', 'bravo', 'charlie', 'delta' ]
+    conf.collect { |key,value| value }  # => [ 1, 2.0, :three, 'four' ]
+
+## Features
+
+* settings by named methods
+* settings by '[]' & '[]='
+* settings & locals with '='
+* referencing existing settings
+* nested configurations
+* inheritance & override
+* read from string, at creation, or after - merged & nested
+* load from filename, at creation, or after - merged & nested
+* todo: merge configurations
+* todo: defaults
+* todo: blank slate
+
+## Fancy usage
+
+* Dynamic settings by '[]' & '[]=' & 'self'
+* Multiple configuration files
+* Hierarchial configuration files
+
+## License
+
+Copyright Gerard Fowley ([email protected]).
+
+Licensed under GPL Version 3 license.
+See LICENSE file.

Gemfile.lock

@@ -12,4 +12,11 @@ RDoc::Task.new do |rdoc|
   rdoc.options << "--all" << "--verbose"
 end
 
+require 'yard'
+#require 'yard/rake/yardoc_task'
+YARD::Rake::YardocTask.new do |yard|
+  yard.files   = %w( lib/**/*.rb )
+  yard.options = %w( --main README.md --exclude hash_with_indifferent_access.rb )
+end
+
 task :default => :spec