structure 0.5.0 → 0.6.0

data/README.md

@@ -3,7 +3,7 @@ Structure
 
 Structure is a better Struct.
 
-It does wonders when modeling ephemeral data fed in from an API.
+It works great when modeling ephemeral data fed in from an API.
 
     #_                                                                       d
     ##_                                                                     d#
@@ -38,10 +38,10 @@ Require:
 Define a model:
 
     class Person < Structure
-      key :name
-      key :age,     :type => Integer
-      key :friends, :type => Array, :default => []
-      key :partner, :type => Structure
+      key      :name
+      key      :age, :type => Integer
+      has_many :friends
+      has_one  :partner
     end
 
 Conjure an object:
@@ -54,27 +54,24 @@ Typecast values:
     p1.age
     => 28
 
-Boast ORM-esque association idioms:
+Use ORM-esque association idioms:
 
-    p2 = Person.new :name => 'Michel'
-    p1.friends << p2 # has many
+    p2 = Person.new
+    p1.friends << p2
 
-    p3 = Person.new :name => 'Félix'
-    p1.partner = p3 # has one
-
-Dump good-looking JSON:
+Dump well-structured JSON:
 
     require 'structure/json'
 
     json = p1.to_json
-    => {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name": "Jane","age":null,"friends":[]}]}
+    => {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":null,"age":null,"friends":[]}],"partner":null}
 
-Load the JSON elsewhere back into Ruby seamlessly, provided you have the same
+Load the JSON elsewhere into Ruby seamlessly, provided you have the same
 models set up:
 
     person = JSON.parse(json)
     person.friends.first
-    => #<Person:0x0000010107d030 @attributes={:name=>"Jane", :age=>nil, :friends=>[#<Person:0x0000010107d030 ...>]}, @modifiable=true>
+    => #<Person:0x0000010107d030 @attributes={:name=>nil, :age=>nil, :friends=>[], :partner=>nil}, @modifiable=true>
 
 Throw in some Active Model modules...
 
@@ -84,7 +81,6 @@ Throw in some Active Model modules...
       include ActiveModel::Validations
 
       key :title
-      key :authors, :type => Array, :default => []
 
       validates_presence_of :title
     end

data/lib/structure.rb

@@ -11,12 +11,23 @@ class Structure
 
   TYPES = [Array, Boolean, Float, Hash, Integer, String, Structure]
 
+  # A shortcut to define an attribute that corresponds to an array of other
+  # objects, possibly Structures.
+  def self.has_many(name)
+    key name, :type => Array, :default => []
+  end
+
+  # A shortcut to define an attribute that corresponds to another Structure.
+  def self.has_one(name)
+    key name, :type => Structure
+  end
+
   # Defines an attribute key.
   #
   # Takes a name and an optional hash of options. Available options are:
   #
-  # * :type, which can be Array, Boolean, Float, Integer, JSON, Pathname,
-  # String, or URI. If not specified, type defaults to String.
+  # * :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
@@ -58,6 +69,9 @@ class Structure
             end
           end
         elsif [Hash, Structure].include? type
+
+          # Raise an exception rather than typecast if type is Hash or
+          # Structure.
           lambda do |value|
             unless value.is_a? type
               raise TypeError, "#{value} is not a #{type}"
@@ -73,7 +87,7 @@ class Structure
 
       # Define a setter.
       define_method("#{name}=") do |value|
-        modifiable[name] = value.nil? ? nil : typecast.call(value)
+        @attributes[name] = value.nil? ? nil : typecast.call(value)
       end
     end
   end
@@ -123,13 +137,4 @@ class Structure
         attributes
       end
   end
-
-  def modifiable
-    begin
-      @modifiable = true
-    rescue
-      raise TypeError, "can't modify frozen #{self.class}"
-    end
-    @attributes
-  end
 end

data/lib/structure/version.rb

@@ -1,3 +1,3 @@
 class Structure
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/models/person.rb

@@ -1,5 +1,5 @@
 class Person < Structure
   key :name
   key :age, :type => Integer
-  key :friends, :type => Array, :default => []
+  has_many :friends
 end

data/spec/structure_spec.rb

@@ -154,7 +154,7 @@ describe Structure do
 
     context "when type is Structure" do
       before(:all) do
-        Person.key :father, :type => Structure
+        Person.has_one :father
       end
 
       context "when setting to a value that is not a Structure" do
@@ -179,18 +179,6 @@ describe Structure do
       end
     end
 
-    context "when frozen" do
-      before do
-        person.freeze
-      end
-
-      it "raises an error" do
-        expect do
-          person.name = 'Joe'
-        end.to raise_error TypeError
-      end
-    end
-
     context "when setting the value of an attribute to nil" do
       it "does not typecast the value" do
         person.age = nil

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-27 00:00:00 +01:00
+date: 2011-05-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency