construct 0.1.0 → 0.1.2

data/README

@@ -13,7 +13,8 @@ making documentation easy. That's where Construct comes in.
 
   config = Construct.new
 
-Hey, we have a configuration object. Let's describe a web site. Keys are always symbols, but can be accessed via methods just like an OpenStruct.
+Hey, we have a configuration object. Let's describe a web site. Keys are always
+symbols, but can be accessed via methods just like an OpenStruct.
 
   config.name = "Aphyr"
   config.base_url = "http://aphyr.com"
@@ -23,7 +24,8 @@ And getting at them is easy, too.
   config.name
     => "Aphyr"
 
-If the key you want is already a method, just use config#[] and config#[]=. Construct converts strings to symbols for you..
+If the key you want is already a method, just use config#[] and config#[]=.
+Construct converts strings to symbols for you..
 
 How about a database connection? Those parameters all belong together.
 
@@ -40,10 +42,10 @@ methods to easily access nested options.
 
 Databases need a host. Let's define a host field.
 
-  config.db.schema[:host] = {
+  config.db.define(:host,
     :default => '127.0.0.1',
     :desc => 'The host the database adapter connects to.'
-  }
+  )
   config.db.host
     => '127.0.0.1'
 
@@ -53,7 +55,11 @@ You can override this, naturally.
   config.db.host
     => 'db.aphyr.com'
 
-And it serializes neatly to YAML. Keys are expressed as strings, to save typing and make things look clean.
+The schema is accessible as a hash via #schema, so you can easily pump out
+configuration docs, HTML forms, whatever.
+
+Construct serializes neatly to YAML. Keys are expressed as strings, to save
+typing and make things look clean.
 
   config.to_yaml =>
   --- 
@@ -67,12 +73,29 @@ Hey, this is easy! Now let's load that configuration from a string.
 
   config = Construct.load yaml
 
-Maybe you need to implement extra logic in your config--perhaps you can specify either a db hash as shown above, or a connection string. Just subclass Construct::Construct or define methods directly on the construct.
+Maybe you need to implement extra logic in your config--perhaps you can specify
+either a db hash as shown above, or a connection string. Just subclass
+Construct::Construct or define methods directly on the construct.
 
-  class DBConfig < Construct::Construct
+  class DBConfig < Construct
     def db_str
       self[:db_str] || make_db_string_from_hash(db)
     end
   end
 
-Problem solved. Now get back to having fun instead of worrying about configuration!
+Defining schemas at the class level, as opposed to creating a Construct
+instance and operating on its schema is easy. Just use Construct.define to
+operate on the class schema. When you create an instance of that class, the class schema is used as a default for the instance.
+
+  class UserConfig < Construct
+    define :state,
+      :desc => "The user's home state"
+      :default => "Oregon"
+    end
+  end
+
+  conf = UserConfig.new
+  conf.state # => "Oregon"
+
+Problem solved. Now get back to having fun instead of worrying about
+configuration!

data/lib/construct.rb

@@ -3,7 +3,7 @@ class Construct
   # Ruby and humans with text editors.
  
   APP_NAME = 'Construct'
-  APP_VERSION = '0.1.0'
+  APP_VERSION = '0.1.2'
   APP_AUTHOR = 'Kyle Kingsbury'
   APP_EMAIL = 'aphyr@aphyr.com'
   APP_URL = 'http://aphyr.com'
@@ -18,12 +18,28 @@ class Construct
   yaml_as "tag:aphyr.com,2009:construct"
   yaml_as "tag:yaml.org,2002:map"
 
+  class << self
+    attr_writer :schema
+  end
+
+  # Define a schema for a key on the class. The class schema is used as the
+  # defaults on initialization of a new instance.
+  def self.define(key, schema)
+    key = key.to_sym if String === key
+    @schema[key] = schema
+  end 
+
   # Load a construct from a YAML string
   def self.load(yaml)
     hash = YAML::load(yaml)
     new(hash)
   end
 
+  # Returns the class schema
+  def self.schema
+    @schema ||= {}
+  end
+
   attr_accessor :schema, :data
 
   def initialize(data = {}, schema = {})
@@ -31,7 +47,7 @@ class Construct
     data.each do |key, value|
       self[key] = value
     end
-    @schema = schema
+    @schema = self.class.schema.merge(schema)
   end
 
   def ==(other)
@@ -43,7 +59,7 @@ class Construct
 
     if @data.include? key
       @data[key]
-    elsif @schema.include? key
+    elsif @schema.include? key and @schema[key].include? :default
       @schema[key][:default]
     end 
   end
@@ -94,7 +110,7 @@ class Construct
   # Returns true if the construct has a value set for, or the schema defines,
   # the key.
   def include?(*args)
-    @data.include?(*args) or @schema.include?(*args)
+    @data.include?(*args) or (@schema.include?(*args) and @schema[*args].include? :default)
   end
 
   # Returns the keys, both set in the construct and specified in the schema.
@@ -117,7 +133,7 @@ class Construct
     elsif include? meth
       self[meth]
     else
-      raise NoMethodError.new('no such key in construct')
+      raise NoMethodError.new("no such key #{meth} in construct")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: construct
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - Kyle Kingsbury
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 -05:00
+date: 2009-07-15 00:00:00 -05:00
 default_executable: 
 dependencies: []