toystore 0.13.0 → 0.13.1

data/Changelog.md

@@ -2,6 +2,18 @@
 
 I will do my best to keep this up to date with significant changes here, starting in 0.8.3.
 
+## master
+
+* No longer defaulting uuid to new instance, use :default instead. This allows for nil values for attributes of uuid type.
+
+## 0.14.0
+
+* No longer persisting nil attributes
+* Added Toy::Types::JSON for storing serialized JSON as an attribute value
+* Added #persisted_id and made it public so people can override confidently. It is now used in adapter.write and adapter.delete.
+* Made #persist method public so people can override confidently.
+* Moved Identity to Toy::Store from Toy::Object
+
 ## 0.13.0
 
 * Update to adapter 0.7.0

data/Guardfile

@@ -4,8 +4,8 @@ rspec_options = {
 
 guard 'rspec', rspec_options do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/helper.rb') { "spec" }
 end
 
 guard 'bundler' do

data/README.md

@@ -8,7 +8,7 @@ The project comes with two main includes that you can use -- Toy::Object and Toy
 
 **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::Store** includes Toy::Object and adds identity, persistence and querying through adapters, mass assignment, callbacks, validations and a few simple associations (lists and references).
 
 ### Toy::Object
 
@@ -23,34 +23,34 @@ class Person
 end
 
 # Pretty class inspecting
-puts Person.inspect
+pp Person
 
-john = Person.new(:name => 'John', :age => 30)
+john  = Person.new(:name => 'John',  :age => 30)
 steve = Person.new(:name => 'Steve', :age => 31)
 
 # Pretty inspecting
-puts john.inspect
+pp john
 
 # Attribute dirty tracking
 john.name = 'NEW NAME!'
-puts john.changes.inspect       # {"name"=>["John", "NEW NAME!"], "age"=>[nil, 30]}
-puts john.name_changed?.inspect # true
+pp john.changes       # {"name"=>["John", "NEW NAME!"], "age"=>[nil, 30]}
+pp john.name_changed? # true
 
 # Equality goodies
-puts john.eql?(john)  # true
-puts john.eql?(steve) # false
-puts john == john     # true
-puts john == steve    # false
+pp john.eql?(john)  # true
+pp john.eql?(steve) # false
+pp john == john     # true
+pp john == steve    # false
 
 # Cloning
-puts john.clone.inspect
+pp john.clone
 
 # Inheritance
 class AwesomePerson < Person
 end
 
-puts Person.attributes.keys.sort.inspect          # ["age", "id", "name"]
-puts AwesomePerson.attributes.keys.sort.inspect   # ["age", "id", "name", "type"]
+pp Person.attributes.keys.sort          # ["age", "name"]
+pp AwesomePerson.attributes.keys.sort   # ["age", "name", "type"]
 
 # Serialization
 puts john.to_json
@@ -84,13 +84,12 @@ person = Person.new(:name => 'Hacker', :age => 13, :role => 'admin')
 pp person.role # "guest"
 
 # Querying
-pp Person.get(john.id)
-pp Person.get_multiple([john.id])
-pp Person.get('NOT HERE') # nil
-pp Person.get_or_new('NOT HERE') # new person with id of 'NOT HERE'
+pp Person.read(john.id)
+pp Person.read_multiple([john.id])
+pp Person.read('NOT HERE') # nil
 
 begin
-  Person.get!('NOT HERE')
+  Person.read!('NOT HERE')
 rescue Toy::NotFound
   puts "Could not find person with id of 'NOT HERE'"
 end
@@ -100,15 +99,13 @@ pp john.reload
 
 # Callbacks
 class Person
+  before_create :add_fifty_to_age
+
   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
@@ -151,16 +148,16 @@ pp john.reload.mom_id == mom.id # true
 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
+  pp Person.read(frank.id).equal?(frank)                # true
+  pp Person.read(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
+pp Person.read(frank.id).equal?(frank)                # true
+pp Person.read(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.
@@ -170,25 +167,19 @@ 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)
+    if (record = client.reverse.detect { |row| row[0] == key })
+      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
 
@@ -208,7 +199,7 @@ person.save
 
 pp client
 
-pp Person.get(person.id) # Phil with age 56
+pp Person.read(person.id) # Phil with age 56
 ```
 
 If that doesn't excite you, nothing will. At this point, you are probably wishing for more.

data/examples/attributes_abbreviation.rb

@@ -20,6 +20,6 @@ user = User.create({
   :my_really_long_field_name => 'something',
 })
 
-pp Marshal.load(User.adapter.client[user.id])
+pp User.adapter.client[user.id]
 # Abbreviated attributes are stored in the database as the abbreviation for when you want to conserve space. The abbreviation and the full attribute name work exactly the same in Ruby, the only difference is how they get persisted.
-# {"my"=>"something", "email"=>"nunemaker@gmail.com"}
+# {"my"=>"something", "email"=>"nunemaker@gmail.com"}

data/examples/attributes_virtual.rb

@@ -35,6 +35,6 @@ user = User.create({
   :password_confirmation => 'testing',
 })
 
-pp Marshal.load(User.adapter.client[user.id])
+pp User.adapter.client[user.id]
 # Virtual attributes are never persisted. In the data store, only email and crypted_password are stored.
-# {"crypted_password"=>"testing", "email"=>"nunemaker@gmail.com"}
+# {"crypted_password"=>"testing", "email"=>"nunemaker@gmail.com"}

data/examples/identity_map.rb

@@ -28,12 +28,12 @@ user = User.create(:name => 'John')
 #   {"name"=>"John"}
 # ToyStore IMS User "08a1c54c-3393-11e0-8b37-89da41d2f675"
 
-puts "With identity map - User.get(user.id).equal?(user): #{User.get(user.id).equal?(user)}"
+puts "With identity map - User.read(user.id).equal?(user): #{User.read(user.id).equal?(user)}"
 # User is retrieved from identity map instead of querying
 # ToyStore IMG User "08a1c54c-3393-11e0-8b37-89da41d2f675"
 
 Toy::IdentityMap.without do
-  puts "Without identity map - User.get(user.id).equal?(user): #{User.get(user.id).equal?(user)}"
+  puts "Without identity map - User.read(user.id).equal?(user): #{User.read(user.id).equal?(user)}"
   # User is queried from database
   # ToyStore GET User :memory "08a1c54c-3393-11e0-8b37-89da41d2f675"
   #   {"name"=>"John"}

data/examples/memcached.rb

@@ -18,8 +18,8 @@ end
 list = GameList.create(:source => {'foo' => 'bar'})
 
 pp list
-pp GameList.get(list.id)
+pp GameList.read(list.id)
 
 list.destroy
 
-pp GameList.get(list.id)
+pp GameList.read(list.id)

data/examples/memory.rb

@@ -18,8 +18,8 @@ end
 user = User.create(:name => 'John')
 
 pp user
-pp User.get(user.id)
+pp User.read(user.id)
 
 user.destroy
 
-pp User.get(user.id)
+pp User.read(user.id)

data/examples/mongo.rb

@@ -18,8 +18,8 @@ end
 user = User.create(:name => 'John')
 
 pp user
-pp User.get(user.id)
+pp User.read(user.id)
 
 user.destroy
 
-pp User.get(user.id)
+pp User.read(user.id)

data/examples/namespacing_keys.rb

@@ -33,4 +33,4 @@ class Game
   include Toy::Store
 end
 
-puts Game.new.id # Game:some_uuid
+puts Game.new.id # Game:some_uuid

data/examples/plain_old_object.rb

@@ -46,8 +46,8 @@ pp john.clone
 class AwesomePerson < Person
 end
 
-pp Person.attributes.keys.sort          # ["age", "id", "name"]
-pp AwesomePerson.attributes.keys.sort   # ["age", "id", "name", "type"]
+pp Person.attributes.keys.sort          # ["age", "name"]
+pp AwesomePerson.attributes.keys.sort   # ["age", "name", "type"]
 
 # Serialization
 puts john.to_json

data/examples/plain_old_object_on_roids.rb

@@ -33,13 +33,12 @@ person = Person.new(:name => 'Hacker', :age => 13, :role => 'admin')
 pp person.role # "guest"
 
 # Querying
-pp Person.get(john.id)
-pp Person.get_multiple([john.id])
-pp Person.get('NOT HERE') # nil
-pp Person.get_or_new('NOT HERE') # new person with id of 'NOT HERE'
+pp Person.read(john.id)
+pp Person.read_multiple([john.id])
+pp Person.read('NOT HERE') # nil
 
 begin
-  Person.get!('NOT HERE')
+  Person.read!('NOT HERE')
 rescue Toy::NotFound
   puts "Could not find person with id of 'NOT HERE'"
 end
@@ -49,15 +48,13 @@ pp john.reload
 
 # Callbacks
 class Person
+  before_create :add_fifty_to_age
+
   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
@@ -100,16 +97,16 @@ pp john.reload.mom_id == mom.id # true
 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
+  pp Person.read(frank.id).equal?(frank)                # true
+  pp Person.read(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
+pp Person.read(frank.id).equal?(frank)                # true
+pp Person.read(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.
@@ -119,25 +116,19 @@ 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)
+    if (record = client.reverse.detect { |row| row[0] == key })
+      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
 
@@ -157,4 +148,4 @@ person.save
 
 pp client
 
-pp Person.get(person.id) # Phil with age 56
+pp Person.read(person.id) # Phil with age 56

data/examples/redis.rb

@@ -18,8 +18,8 @@ end
 user = User.create(:name => 'John')
 
 pp user
-pp User.get(user.id)
+pp User.read(user.id)
 
 user.destroy
 
-pp User.get(user.id)
+pp User.read(user.id)

data/examples/riak.rb

@@ -18,8 +18,8 @@ end
 list = GameList.create(:source => {'foo' => 'bar'})
 
 pp list
-pp GameList.get(list.id)
+pp GameList.read(list.id)
 
 list.destroy
 
-pp GameList.get(list.id)
+pp GameList.read(list.id)

data/lib/toy.rb

@@ -68,6 +68,10 @@ module Toy
   autoload 'References',              'toy/references'
   autoload 'Identity',                'toy/identity'
 
+  module Types
+    autoload 'JSON',                  'toy/types/json'
+  end
+
   module Identity
     autoload 'AbstractKeyFactory',    'toy/identity/abstract_key_factory'
     autoload 'UUIDKeyFactory',        'toy/identity/uuid_key_factory'

data/lib/toy/attributes.rb

@@ -4,8 +4,6 @@ module Toy
     include ActiveModel::AttributeMethods
 
     included do
-      include Identity
-
       # blank suffix is no longer needed in 3.2+
       # open to suggestions on how to do this better
       if ActiveSupport::VERSION::MAJOR == 3 && ActiveSupport::VERSION::MINOR < 2
@@ -22,10 +20,11 @@ module Toy
       end
 
       def defaulted_attributes
-        attributes.values.select(&:default?)
+        @defaulted_attributes ||= attributes.values.select(&:default?)
       end
 
       def attribute(key, type, options = {})
+        @defaulted_attributes = nil
         attribute = Attribute.new(self, key, type, options)
         define_attribute_methods [attribute.name]
         attribute
@@ -39,26 +38,12 @@ module Toy
     def initialize(attrs={})
       initialize_attributes
       self.attributes = attrs
-      write_attribute :id, self.class.next_key(self) unless id?
-    end
-
-    def id
-      read_attribute(:id)
     end
 
     def attributes
       @attributes
     end
 
-    def persisted_attributes
-      {}.tap do |attrs|
-        self.class.attributes.except('id').each do |name, attribute|
-          next if attribute.virtual?
-          attrs[attribute.persisted_name] = attribute.to_store(read_attribute(attribute.name))
-        end
-      end
-    end
-
     def attributes=(attrs, *)
       return if attrs.nil?
       attrs.each do |key, value|
@@ -86,10 +71,8 @@ module Toy
 
     def write_attribute(key, value)
       key = key.to_s
-      attribute = self.class.attributes.fetch(key) {
-        raise AttributeNotDefined, "#{self.class} does not have attribute #{key}"
-      }
-      @attributes[key.to_s] = attribute.from_store(value)
+      attribute = attribute_instance(key)
+      @attributes[key] = attribute.from_store(value)
     end
 
     def attribute_method?(key)
@@ -108,6 +91,12 @@ module Toy
       read_attribute(key).present?
     end
 
+    def attribute_instance(key)
+      self.class.attributes.fetch(key) {
+        raise AttributeNotDefined, "#{self.class} does not have attribute #{key}"
+      }
+    end
+
     def initialize_attributes
       @attributes ||= {}
       self.class.defaulted_attributes.each do |attribute|