toystore 0.9.0 → 0.10.0

data/.gitignore

@@ -4,4 +4,5 @@ testing/
 log
 tmp
 pkg
-.bundle
+.bundle
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+notifications:
+  email: false
+bundler_args: --without guard

data/Changelog.md

@@ -1,9 +1,18 @@
 I will do my best to keep this up to date with significant changes here, starting in 0.8.3.
 
+* 0.10.0
+  * [Reference proxy api changes](https://github.com/jnunemaker/toystore/pull/5) thanks to jakehow
+  * [Support for inheritance](https://github.com/jnunemaker/toystore/pull/4)
+  * [Pass model class to callable default](https://github.com/jnunemaker/toystore/commit/45eff74fb712e5b2a437e3c09b382421fc05539d)
+  * [Added #hash](https://github.com/jnunemaker/toystore/commit/0769f548be669ad1b456cb1b8e11e394e0fee303)
+  * [Added pretty inspect for classes](https://github.com/jnunemaker/toystore/commit/2fdc18b8d8428a932c1e5eeafa6a4db2269f1473)
+  * [Always show id first in #inspect](https://github.com/jnunemaker/toystore/commit/145312b961a519ab84b010d37be075d85fa290a2)
+  * [Moved object serialization into Toy::Object](https://github.com/jnunemaker/toystore/commit/d9431557f0f12c4e171fc888f3eb846fb631d4aa)
+
 * 0.8.3 => 0.9.0
   * [Changed from `store` to `adapter`](https://github.com/jnunemaker/toystore/pull/1)
   * [Embedded objects were removed](https://github.com/jnunemaker/toystore/pull/2)
   * [Defaulted `adapter` to memory and removed `has_adapter?`](https://github.com/jnunemaker/toystore/commit/64268705fcb22d82eb7ac3e934508770ceb1f101)
   * [Introduced Toy::Object](https://github.com/jnunemaker/toystore/commit/f22fddff96b388db3bd22f36cc1cc29b28d0ae5e).
   * [Default Identity Map to off](https://github.com/jnunemaker/toystore/compare/02b652b4dbd4a652bf3d788fbf8cf7d0bae805f6...5cec60be60f9bf749964d5c2d437189287d6d837)
-  * Removed several class methods related to identity map as well (identity_map_on/off/on?/off?/etc)
+  * Removed several class methods related to identity map as well (identity_map_on/off/on?/off?/etc)

data/Gemfile

@@ -1,19 +1,20 @@
 source :rubygems
 gemspec
 
-group(:development) do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-bundler'
-  gem 'growl'
+gem 'rake',       '~> 0.9.0'
+gem 'oj',         '~> 1.0.0'
+gem 'multi_json', '~> 1.3.2'
 
-  gem 'rake',       '~> 0.8.7'
-  gem 'rspec',      '~> 2.3'
-  gem 'timecop',    '~> 0.3.5'
-  gem 'tzinfo',     '~> 0.3.23'
-  gem 'log_buddy',  '~> 0.5.0'
-  gem 'rack-test'
+group(:guard) do
+  gem 'guard',          '~> 1.0.0'
+  gem 'guard-rspec',    '~> 0.6.0'
+  gem 'guard-bundler',  '~> 0.1.0'
+  gem 'growl',          '~> 1.0.0'
+end
 
-  gem 'bson'
-  gem 'bson_ext'
+group(:test) do
+  gem 'rspec',      '~> 2.8.0'
+  gem 'timecop',    '~> 0.3.0'
+  gem 'tzinfo',     '~> 0.3.0'
+  gem 'rack-test',  '~> 0.6.0'
 end

data/README.md

@@ -1,8 +1,219 @@
-# Toystore
+# Toystore [![Build Status](https://secure.travis-ci.org/jnunemaker/toystore.png)](http://travis-ci.org/jnunemaker/toystore)
 
 An object mapper for any [adapter](https://github.com/jnunemaker/adapter) that can read, write, delete, and clear data.
 
-See [examples/](https://github.com/jnunemaker/toystore/tree/master/examples) for potential direction.
+## Examples
+
+The project comes with two main includes that you can use -- Toy::Object and Toy::Store.
+
+**Toy::Object** comes with all the goods you need for plain old ruby objects -- attributes, dirty attribute tracking, equality, inheritance, serialization, cloning, logging and pretty inspecting.
+
+**Toy::Store** includes Toy::Object and adds persistence through adapters, mass assignment, querying, callbacks, validations and a few simple associations (lists and references).
+
+### Toy::Object
+
+First, join me in a whirlwind tour of Toy::Object.
+
+```ruby
+class Person
+  include Toy::Object
+
+  attribute :name, String
+  attribute :age,  Integer
+end
+
+# Pretty class inspecting
+puts Person.inspect
+
+john = Person.new(:name => 'John', :age => 30)
+steve = Person.new(:name => 'Steve', :age => 31)
+
+# Pretty inspecting
+puts john.inspect
+
+# Attribute dirty tracking
+john.name = 'NEW NAME!'
+puts john.changes.inspect       # {"name"=>["John", "NEW NAME!"], "age"=>[nil, 30]}
+puts john.name_changed?.inspect # true
+
+# Equality goodies
+puts john.eql?(john)  # true
+puts john.eql?(steve) # false
+puts john == john     # true
+puts john == steve    # false
+
+# Cloning
+puts john.clone.inspect
+
+# Inheritance
+class AwesomePerson < Person
+end
+
+puts Person.attributes.keys.sort.inspect          # ["age", "id", "name"]
+puts AwesomePerson.attributes.keys.sort.inspect   # ["age", "id", "name", "type"]
+
+# Serialization
+puts john.to_json
+puts john.to_xml
+```
+
+Ok, that was definitely awesome. Please continue on your personal journey to a blown mind (very similar to a beautiful mind).
+
+### Toy::Store
+
+Toy::Store is a unique bird that builds on top of Toy::Object. Below is a quick sample of what it can do.
+
+```ruby
+class Person
+  include Toy::Store
+
+  attribute :name, String
+  attribute :age,  Integer, :default => 0
+end
+
+# Persistence
+john = Person.create(:name => 'John', :age => 30)
+pp john
+pp john.persisted?
+
+# Mass Assignment Security
+Person.attribute :role, String, :default => 'guest'
+Person.attr_accessible :name, :age
+
+person = Person.new(:name => 'Hacker', :age => 13, :role => 'admin')
+pp person.role # "guest"
+
+# Querying
+pp Person.get(john.id)
+pp Person.get_multi(john.id)
+pp Person.get('NOT HERE') # nil
+pp Person.get_or_new('NOT HERE') # new person with id of 'NOT HERE'
+
+begin
+  Person.get!('NOT HERE')
+rescue Toy::NotFound
+  puts "Could not find person with id of 'NOT HERE'"
+end
+
+# Reloading
+pp john.reload
+
+# Callbacks
+class Person
+  def add_fifty_to_age
+    self.age += 50
+  end
+end
+
+class Person
+  before_create :add_fifty_to_age
+end
+
+pp Person.create(:age => 10).age # 60
+
+# Validations
+class Person
+  validates_presence_of :name
+end
+
+person = Person.new
+pp person.valid?        # false
+pp person.errors[:name] # ["can't be blank"]
+
+# Lists (array key stored as attribute)
+class Skill
+  include Toy::Store
+
+  attribute :name, String
+  attribute :truth, Boolean
+end
+
+class Person
+  list :skills, Skill
+end
+
+john.skills = [Skill.create(:name => 'Programming', :truth => true)]
+john.skills << Skill.create(:name => 'Mechanic', :truth => false)
+
+pp john.skills.map(&:id) == john.skill_ids # true
+
+# References (think foreign keyish)
+class Person
+  reference :mom, Person
+end
+
+mom = Person.create(:name => 'Mum')
+john.mom = mom
+john.save
+pp john.reload.mom_id == mom.id # true
+
+# Identity Map
+Toy::IdentityMap.use do
+  frank = Person.create(:name => 'Frank')
+
+  pp Person.get(frank.id).equal?(frank)                # true
+  pp Person.get(frank.id).object_id == frank.object_id # true
+end
+
+# Or you can turn it on globally
+Toy::IdentityMap.enabled = true
+frank = Person.create(:name => 'Frank')
+
+pp Person.get(frank.id).equal?(frank)                # true
+pp Person.get(frank.id).object_id == frank.object_id # true
+
+# All persistence runs through an adapter.
+# All of the above examples used the default in-memory adapter.
+# Looks something like this:
+Person.adapter :memory, {}
+
+puts "Adapter: #{Person.adapter.inspect}"
+
+# You can make a new adapter to your awesome new/old data store
+# Always use #key_for, #encode, and #decode. Feel free to override
+# them if you like, but always use them. Default encode/decode is
+# most likely marshaling, but you can use anything.
+Adapter.define(:append_only_array) do
+  def read(key)
+    if (record = client.reverse.detect { |row| row[0] == key_for(key) })
+      decode(record)
+    end
+  end
+
+  def write(key, value)
+    key   = key_for(key)
+    value = encode(value)
+    client << [key, value]
+    value
+  end
+
+  def delete(key)
+    key = key_for(key)
+    client.delete_if { |row| row[0] == key }
+  end
+
+  def clear
+    client.clear
+  end
+end
+
+client = []
+Person.adapter :append_only_array, client
+
+pp "Client: #{Person.adapter.client.equal?(client)}"
+
+person = Person.create(:name => 'Phil', :age => 55)
+person.age = 56
+person.save
+
+pp client
+
+pp Person.get(person.id) # Phil with age 56
+```
+
+If that doesn't excite you, nothing will. At this point, you are probably wishing for more.
+
+Luckily, there is an entire directory full of [examples](https://github.com/jnunemaker/toystore/tree/master/examples) and I created a few power user guides, which I will kindly link next.
 
 ## ToyStore Power User Guides
 

data/examples/plain_old_object.rb

@@ -0,0 +1,54 @@
+require 'pp'
+require 'pathname'
+require 'rubygems'
+require 'adapter/memory'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
+##################################################################
+# An example of all the goodies you get by including Toy::Object #
+##################################################################
+
+class Person
+  include Toy::Object
+
+  attribute :name, String
+  attribute :age,  Integer
+end
+
+# Pretty class inspecting
+pp Person
+
+john  = Person.new(:name => 'John',  :age => 30)
+steve = Person.new(:name => 'Steve', :age => 31)
+
+# Pretty inspecting
+pp john
+
+# Attribute dirty tracking
+john.name = 'NEW NAME!'
+pp john.changes       # {"name"=>["John", "NEW NAME!"], "age"=>[nil, 30]}
+pp john.name_changed? # true
+
+# Equality goodies
+pp john.eql?(john)  # true
+pp john.eql?(steve) # false
+pp john == john     # true
+pp john == steve    # false
+
+# Cloning
+pp john.clone
+
+# Inheritance
+class AwesomePerson < Person
+end
+
+pp Person.attributes.keys.sort          # ["age", "id", "name"]
+pp AwesomePerson.attributes.keys.sort   # ["age", "id", "name", "type"]
+
+# Serialization
+puts john.to_json
+puts john.to_xml

data/examples/plain_old_object_on_roids.rb

@@ -0,0 +1,160 @@
+require 'pp'
+require 'pathname'
+require 'rubygems'
+require 'adapter/memory'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
+#################################################################
+# An example of all the goodies you get by including Toy::Store #
+# Note that you also get all of the goodies in Toy::Object.     #
+#################################################################
+
+class Person
+  include Toy::Store
+
+  attribute :name, String
+  attribute :age,  Integer, :default => 0
+end
+
+# Persistence
+john = Person.create(:name => 'John', :age => 30)
+pp john
+pp john.persisted?
+
+# Mass Assignment Security
+Person.attribute :role, String, :default => 'guest'
+Person.attr_accessible :name, :age
+
+person = Person.new(:name => 'Hacker', :age => 13, :role => 'admin')
+pp person.role # "guest"
+
+# Querying
+pp Person.get(john.id)
+pp Person.get_multi(john.id)
+pp Person.get('NOT HERE') # nil
+pp Person.get_or_new('NOT HERE') # new person with id of 'NOT HERE'
+
+begin
+  Person.get!('NOT HERE')
+rescue Toy::NotFound
+  puts "Could not find person with id of 'NOT HERE'"
+end
+
+# Reloading
+pp john.reload
+
+# Callbacks
+class Person
+  def add_fifty_to_age
+    self.age += 50
+  end
+end
+
+class Person
+  before_create :add_fifty_to_age
+end
+
+pp Person.create(:age => 10).age # 60
+
+# Validations
+class Person
+  validates_presence_of :name
+end
+
+person = Person.new
+pp person.valid?        # false
+pp person.errors[:name] # ["can't be blank"]
+
+# Lists (array key stored as attribute)
+class Skill
+  include Toy::Store
+
+  attribute :name, String
+  attribute :truth, Boolean
+end
+
+class Person
+  list :skills, Skill
+end
+
+john.skills = [Skill.create(:name => 'Programming', :truth => true)]
+john.skills << Skill.create(:name => 'Mechanic', :truth => false)
+
+pp john.skills.map(&:id) == john.skill_ids # true
+
+# References (think foreign keyish)
+class Person
+  reference :mom, Person
+end
+
+mom = Person.create(:name => 'Mum')
+john.mom = mom
+john.save
+pp john.reload.mom_id == mom.id # true
+
+# Identity Map
+Toy::IdentityMap.use do
+  frank = Person.create(:name => 'Frank')
+
+  pp Person.get(frank.id).equal?(frank)                # true
+  pp Person.get(frank.id).object_id == frank.object_id # true
+end
+
+# Or you can turn it on globally
+Toy::IdentityMap.enabled = true
+frank = Person.create(:name => 'Frank')
+
+pp Person.get(frank.id).equal?(frank)                # true
+pp Person.get(frank.id).object_id == frank.object_id # true
+
+# All persistence runs through an adapter.
+# All of the above examples used the default in-memory adapter.
+# Looks something like this:
+Person.adapter :memory, {}
+
+puts "Adapter: #{Person.adapter.inspect}"
+
+# You can make a new adapter to your awesome new/old data store
+# Always use #key_for, #encode, and #decode. Feel free to override
+# them if you like, but always use them. Default encode/decode is
+# most likely marshaling, but you can use anything.
+Adapter.define(:append_only_array) do
+  def read(key)
+    if (record = client.reverse.detect { |row| row[0] == key_for(key) })
+      decode(record)
+    end
+  end
+
+  def write(key, value)
+    key   = key_for(key)
+    value = encode(value)
+    client << [key, value]
+    value
+  end
+
+  def delete(key)
+    key = key_for(key)
+    client.delete_if { |row| row[0] == key }
+  end
+
+  def clear
+    client.clear
+  end
+end
+
+client = []
+Person.adapter :append_only_array, client
+
+pp "Client: #{Person.adapter.client.equal?(client)}"
+
+person = Person.create(:name => 'Phil', :age => 55)
+person.age = 56
+person.save
+
+pp client
+
+pp Person.get(person.id) # Phil with age 56