structure 0.23.1 → 0.24.0

data/lib/structure.rb

@@ -4,8 +4,8 @@ rescue NameError
   require 'json'
 end
 
-# Structure is a key/value container. On the most basic level, it
-# mirrors the functionality of OpenStruct:
+# Structure is a key/value container. On the most basic level, it mirrors the
+# functionality of OpenStruct:
 #
 #    require 'structure'
 #
@@ -42,7 +42,7 @@ end
 #
 #     class Price < Structure
 #       field :cents, Integer
-#       field :currency, :default => "USD"
+#       field :currency, String, :default => "USD"
 #     end
 #
 #     hash = { "cents" => "100" }
@@ -51,11 +51,12 @@ end
 #     puts price.cents    # -> 100
 #     puts price.currency # -> "USD"
 #
-# Alternatively, define a proc to cast or otherwise manipulate assigned
-# values:
+# Alternatively, define a proc to cast or otherwise manipulate values and
+# assign defaults:
 #
 #     class Product < Structure
 #       field :sku, lambda(&:upcase)
+#       field :created_at, String, :default => lambda { Time.now.to_s }
 #     end
 #
 #     product = Product.new(:sku => 'foo-bar')
@@ -96,13 +97,20 @@ class Structure
                           :default => default }
     end
 
-    # Syntactic sugar to create a typed field that defaults to an empty
-    # array.
+    alias key field
+
+    # Syntactic sugar to create a typed field that defaults to an empty array.
     # @param key the name of the field
     def many(key)
       field(key, Array, :default => [])
     end
 
+    # Syntactic sugar to create a field that stands in for another structure.
+    # @param key the name of the field
+    def one(key)
+      field(key, lambda { |v| v.is_a?(Structure) ? v : Structure.new(v) })
+    end
+
     private
 
     def inherited(child)
@@ -115,11 +123,13 @@ class Structure
   # Creates a new structure.
   # @param [Hash] hsh an optional hash to populate fields
   def initialize(hsh = {})
-    # It may have improved performance if I had defined these methods
-    # on the class level, but I decided to privilege consistency here.
-    # Who wouldn't?
     @table = blueprint.inject({}) do |a, (k, v)|
-      default = v[:default].dup rescue v[:default]
+      default = if v[:default].is_a? Proc
+                  v[:default].call
+                else
+                  v[:default].dup rescue v[:default]
+                end
+
       a.merge new_field(k, v[:type]) => default
     end
 
@@ -147,8 +157,7 @@ class Structure
   end
 
   # Provides marshalling support for use by the Marshal library.
-  # @param [Hash] hsh a hash of keys and values to populate the
-  # structure
+  # @param [Hash] hsh a hash of keys and values to populate the structure
   def marshal_load(hsh)
     hsh.each do |k, v|
       self.send("#{new_field(k)}=", v)

data/lib/structure/version.rb

@@ -1,3 +1,3 @@
 class Structure
-  VERSION = '0.23.1'
+  VERSION = '0.24.0'
 end

data/test/structure_with_fields_test.rb

@@ -5,8 +5,10 @@ class Product < Structure
   field :sku, lambda(&:upcase)
   field :cents, Integer
   field :currency, String, :default => 'USD'
-  field :in_stock, :default => true
+  key :in_stock, :default => true
+  field :created_on, :default => lambda { Date.today }
   many :related
+  one :manufacturer
 end
 
 class Foo < Structure
@@ -46,6 +48,7 @@ class TestStructureWithFields < MiniTest::Unit::TestCase
     assert_equal 'USD', @product.currency
     assert_equal true, @product.in_stock
     assert_equal [], @product.related
+    assert_kind_of Date, @product.created_on
   end
 
   def test_recursive_hashes
@@ -64,4 +67,14 @@ class TestStructureWithFields < MiniTest::Unit::TestCase
     assert_equal [related], @product.related
     assert_equal [], @product.related.first.related
   end
+
+  def test_one_to_one
+    hsh = { :name => 'Manufacturer' }
+
+    @product.manufacturer = Structure.new(hsh)
+    assert_equal 'Manufacturer', @product.manufacturer.name
+
+    @product.manufacturer = hsh
+    assert_equal 'Manufacturer', @product.manufacturer.name
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structure
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.24.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000 Z
+date: 2012-01-16 00:00:00.000000000 Z
 dependencies: []
 description: Structure is a key/value container.
 email:
@@ -44,18 +44,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2719962180742855248
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2719962180742855248
 requirements: []
 rubyforge_project: structure
 rubygems_version: 1.8.11
@@ -66,3 +60,4 @@ test_files:
 - test/helper.rb
 - test/structure_test.rb
 - test/structure_with_fields_test.rb
+has_rdoc: