structure 0.10.0 → 0.11.0

data/CHANGELOG.md

@@ -11,3 +11,7 @@
 
 * Rename has_one and has_many to embeds_one and embeds_many to make room
   for associations.
+
+# 0.11
+
+* .key now emulates the DataMapper.property method.

data/README.md

@@ -37,14 +37,14 @@ Define a model:
 require 'structure'
 
 class Person < Structure
-  key      :name
-  key      :age, :type => Integer
-  has_many :friends
-  has_one  :partner
+  key         :name, :default => "John Doe"
+  key         :age, Integer
+  embeds_many :friends
+  embeds_one  :partner
 end
 ```
 
-Conjure an object:
+Create an object:
 
 ```ruby
 p1 = Person.new :name => 'Gilles'
@@ -79,11 +79,11 @@ Talk JSON:
 require 'structure/json'
 
 json = p1.to_json
-=> {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":null,"age":null,"friends":[]}],"partner":null}
+=> {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":"John Doe","age":null,"friends":[]}],"partner":null}
 
 person = JSON.parse(json)
 person.friends.first
-=> #<Person:0x0000010107d030 @attributes={:name=>nil, :age=>nil, :friends=>[], :partner=>nil}>
+=> #<Person:0x0000010107d030 @attributes={:name=>"John Doe", :age=>nil, :friends=>[], :partner=>nil}>
 ```
 
 Quack Active Model:

data/lib/structure.rb

@@ -16,33 +16,42 @@ class Structure
     # A shortcut to define an attribute that represents an array of other
     # objects, possibly structures.
     def embeds_many(name)
-      key name, :type => Array, :default => []
+      key name, Array, :default => []
     end
 
     # A shortcut to define an attribute that represents another structure.
     def embeds_one(name)
-      key name, :type => Structure
+      key name, Structure
     end
 
     # Defines an attribute key.
     #
-    # Takes a name and an optional hash of options. Available options are:
+    # Takes a name, an optional type, and an optional hash of options.
+    #
+    # The type can be Array, Boolean, Float, Hash, Integer, String, or
+    # Structure. If none is specified, it defaults to String.
+    #
+    # Available options are:
     #
-    # * :type, which can be Array, Boolean, Float, Hash, Integer, String,
-    # or Structure. If not specified, type defaults to String.
     # * :default, which sets the default value for the attribute.
     #
     #    class Book
-    #      key :title,   :type => String
-    #      key :authors, :type => Array, :default => []
+    #      key :title
+    #      key :authors, Array, :default => []
     #    end
-    def key(name, options={})
+    def key(name, *args)
       name = name.to_sym
+      options = if args.last.is_a? Hash
+                  args.pop
+                else
+                  {}
+                end
+      type = args.shift || String
+
       if method_defined?(name)
         raise NameError, "#{name} is already defined"
       end
 
-      type = options[:type] || String
       unless TYPES.include? type
         raise TypeError, "#{type} is not a valid type"
       end

data/lib/structure/version.rb

@@ -1,3 +1,3 @@
 class Structure
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/spec/models/book.rb

@@ -1,4 +1,4 @@
 class Book < Structure
   key :title
-  key :authors, :type => Array, :value => []
+  key :authors, Array, :value => []
 end

data/spec/models/person.rb

@@ -1,5 +1,5 @@
 class Person < Structure
   key :name
-  key :age, :type => Integer
+  key :age, Integer
   embeds_many :friends
 end

data/spec/structure_spec.rb

@@ -23,7 +23,7 @@ describe Structure do
     context "when an invalid type is specified" do
       it "raises an error" do
         expect do
-          Person.key :location, :type => Object
+          Person.key :location, Object
         end.to raise_error TypeError
       end
     end
@@ -31,7 +31,7 @@ describe Structure do
     context "when default value is not of the specified type" do
       it "raises an error" do
         expect do
-          Person.key :location, :type => String, :default => 0
+          Person.key :location, String, :default => 0
         end.to raise_error TypeError
       end
     end
@@ -88,7 +88,7 @@ describe Structure do
       context "when default value is true" do
         it "does not raise an invalid type error" do
           expect do
-            Person.key :single, :type => Boolean, :default => true
+            Person.key :single, Boolean, :default => true
           end.not_to raise_error
         end
       end
@@ -96,14 +96,14 @@ describe Structure do
       context "when default value is false" do
         it "does not raise an invalid type error" do
           expect do
-            Person.key :married, :type => Boolean, :default => false
+            Person.key :married, Boolean, :default => false
           end.not_to raise_error
         end
       end
 
       context "when typecasting a set value" do
         before(:all) do
-          Person.key :vegetarian, :type => Boolean
+          Person.key :vegetarian, Boolean
         end
 
         it "typecasts 'true' to true" do
@@ -140,7 +140,7 @@ describe Structure do
 
     context "when type is Hash" do
       before(:all) do
-        Person.key :education, :type => Hash
+        Person.key :education, Hash
       end
 
       context "when setting to a value that is not a Hash" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 10
+  - 11
   - 0
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors: 
 - Paper Cavalier