structure 0.9.0 → 0.10.0

data/CHANGELOG.md

@@ -2,3 +2,12 @@
 
 * Make JSON patch compatible with Active Support.
 * Remove URI from list of types.
+
+# 0.9
+
+* Add presence method.
+
+# 0.10
+
+* Rename has_one and has_many to embeds_one and embeds_many to make room
+  for associations.

data/README.md

@@ -1,12 +1,9 @@
 Structure
 =========
 
-Structure is a Struct-like key/value container for modeling ephemeral data in
-Ruby.
+Structure is a key/value container for modeling ephemeral data in Ruby.
 
-Structure typecasts, uses basic association idioms, and converts to and from
-JSON seamlessly, even when nested in structures or other structure-like
-objects.
+Structure typecasts, nests other structures, and talks flawless JSON.
 
     #_                                                                       d
     ##_                                                                     d#
@@ -34,73 +31,83 @@ objects.
 Usage
 -----
 
-Require:
-
-    require 'structure'
-
 Define a model:
 
-    class Person < Structure
-      key      :name
-      key      :age, :type => Integer
-      has_many :friends
-      has_one  :partner
-    end
+```ruby
+require 'structure'
+
+class Person < Structure
+  key      :name
+  key      :age, :type => Integer
+  has_many :friends
+  has_one  :partner
+end
+```
 
 Conjure an object:
 
-    p1 = Person.new :name => 'Gilles'
+```ruby
+p1 = Person.new :name => 'Gilles'
+```
 
 Typecast:
 
-    p1.age = '28'
-    p1.age
-    => 28
+```ruby
+p1.age = '28'
+p1.age
+=> 28
+```
 
 Check for presence:
-    p1.age?
-    => true
 
-Embed other structures:
+```ruby
+p1.age?
+=> true
+```
 
-    p2 = Person.new
-    p1.friends << p2
 
-Dump well-structured JSON:
+Embed other structures:
 
-    require 'structure/json'
+```ruby
+p2 = Person.new
+p1.friends << p2
+```
 
-    json = p1.to_json
-    => {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":null,"age":null,"friends":[]}],"partner":null}
+Talk JSON:
 
-Load the JSON seamlessly back into Ruby:
+```ruby
+require 'structure/json'
 
-    person = JSON.parse(json)
-    person.friends.first
-    => #<Person:0x0000010107d030 @attributes={:name=>nil, :age=>nil, :friends=>[], :partner=>nil}>
+json = p1.to_json
+=> {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":null,"age":null,"friends":[]}],"partner":null}
 
-Throw in some Active Model modules:
+person = JSON.parse(json)
+person.friends.first
+=> #<Person:0x0000010107d030 @attributes={:name=>nil, :age=>nil, :friends=>[], :partner=>nil}>
+```
 
-    require 'active_model'
+Quack Active Model:
 
-    class Book < Structure
-      include ActiveModel::Validations
+```ruby
+require 'active_model'
 
-      key :title
+class Book < Structure
+  include ActiveModel::Validations
 
-      validates_presence_of :title
-    end
+  key :title
 
-... and make your model quack like ActiveRecord:
+  validates_presence_of :title
+end
 
-    book = Book.new
-    book.valid?
-    => false
-    book.errors
-    => {:title=>["can't be blank"]}
-    book.title = "Society of the Spectacle"
-    book.valid?
-    => true
+book = Book.new
+book.valid?
+=> false
+book.errors
+=> {:title=>["can't be blank"]}
+book.title = "Society of the Spectacle"
+book.valid?
+=> true
+```
 
 Types
 -----

data/lib/structure.rb

@@ -15,12 +15,12 @@ class Structure
 
     # A shortcut to define an attribute that represents an array of other
     # objects, possibly structures.
-    def has_many(name)
+    def embeds_many(name)
       key name, :type => Array, :default => []
     end
 
     # A shortcut to define an attribute that represents another structure.
-    def has_one(name)
+    def embeds_one(name)
       key name, :type => Structure
     end
 

data/lib/structure/version.rb

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

data/spec/models/person.rb

@@ -1,5 +1,5 @@
 class Person < Structure
   key :name
   key :age, :type => Integer
-  has_many :friends
+  embeds_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.has_one :father
+        Person.embeds_one :father
       end
 
       context "when setting to a value that is not a Structure" do

data/structure.gemspec

@@ -9,10 +9,9 @@ Gem::Specification.new do |s|
   s.authors     = ["Paper Cavalier"]
   s.email       = ["code@papercavalier.com"]
   s.homepage    = "http://rubygems.com/gems/structure"
-  s.summary     = "Struct-like key/value container in Ruby"
+  s.summary     = "A key/value container for modeling ephemeral data"
   s.description = <<-END_OF_DESCRIPTION.strip
-    Structure is a Struct-like key/value container for modeling ephemeral data
-    in Ruby.
+    Structure is a key/value container for modeling ephemeral data.
     END_OF_DESCRIPTION
 
   s.rubyforge_project = "structure"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 9
+  - 10
   - 0
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 +01:00
+date: 2011-07-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,9 +60,7 @@ dependencies:
         version: 0.11.6
   type: :development
   version_requirements: *id003
-description: |-
-  Structure is a Struct-like key/value container for modeling ephemeral data
-      in Ruby.
+description: Structure is a key/value container for modeling ephemeral data.
 email: 
 - code@papercavalier.com
 executables: []
@@ -120,7 +118,7 @@ rubyforge_project: structure
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Struct-like key/value container in Ruby
+summary: A key/value container for modeling ephemeral data
 test_files: 
 - spec/models/book.rb
 - spec/models/person.rb