toystore 0.8.3 → 0.9.0

data/.gitignore

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

data/Changelog.md

@@ -0,0 +1,9 @@
+I will do my best to keep this up to date with significant changes here, starting in 0.8.3.
+
+* 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)

data/Gemfile

@@ -2,6 +2,11 @@ source :rubygems
 gemspec
 
 group(:development) do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'growl'
+
   gem 'rake',       '~> 0.8.7'
   gem 'rspec',      '~> 2.3'
   gem 'timecop',    '~> 0.3.5'

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    toystore (0.8.3)
+      activemodel (~> 3.0, < 3.2)
+      activesupport (~> 3.0, < 3.2)
+      adapter (~> 0.5.1)
+      simple_uuid (~> 0.1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    adapter (0.5.2)
+    bson (1.5.2)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    growl (1.0.3)
+    guard (1.0.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    i18n (0.6.0)
+    log_buddy (0.5.0)
+    multi_json (1.0.4)
+    rack (1.4.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simple_uuid (0.1.2)
+    thor (0.14.6)
+    timecop (0.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson
+  bson_ext
+  growl
+  guard
+  guard-bundler
+  guard-rspec
+  log_buddy (~> 0.5.0)
+  rack-test
+  rake (~> 0.8.7)
+  rspec (~> 2.3)
+  timecop (~> 0.3.5)
+  toystore!
+  tzinfo (~> 0.3.23)

data/Guardfile

@@ -0,0 +1,15 @@
+rspec_options = {
+  :all_after_pass => false,
+  :all_on_start   => false,
+}
+
+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" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -0,0 +1,28 @@
+# 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.
+
+## ToyStore Power User Guides
+
+* [Wiki Home](https://github.com/jnunemaker/toystore/wiki)
+* [Identity](https://github.com/jnunemaker/toystore/wiki/Identity)
+* [Types](https://github.com/jnunemaker/toystore/wiki/Types)
+* [Exceptions](https://github.com/jnunemaker/toystore/wiki/Exceptions)
+
+## Changelog
+
+As of 0.8.3, I started keeping a [changelog](https://github.com/jnunemaker/toystore/blob/master/Changelog.md). All significant updates will be summarized there.
+
+## Mailing List
+
+https://groups.google.com/forum/#!forum/toystoreadapter
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix in a topic branch.
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or changelog. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)
+* Send a pull request.

data/examples/attributes_abbreviation.rb

@@ -10,7 +10,6 @@ require 'toystore'
 
 class User
   include Toy::Store
-  store :memory, {}
 
   attribute :email, String
   attribute :my_really_long_field_name, String, :abbr => :my
@@ -21,6 +20,6 @@ user = User.create({
   :my_really_long_field_name => 'something',
 })
 
-pp Marshal.load(User.store.client[user.id])
+pp Marshal.load(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"}

data/examples/attributes_virtual.rb

@@ -10,7 +10,6 @@ require 'toystore'
 
 class User
   include Toy::Store
-  store :memory, {}
 
   attribute :email, String
   attribute :crypted_password, String
@@ -36,6 +35,6 @@ user = User.create({
   :password_confirmation => 'testing',
 })
 
-pp Marshal.load(User.store.client[user.id])
+pp Marshal.load(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"}

data/examples/identity_map.rb

@@ -8,17 +8,16 @@ lib_path  = root_path.join('lib')
 $:.unshift(lib_path)
 require 'toystore'
 
-# Identity map is turned on by default for Toystore. To turn it off for an entire model, just call identity_map_off.
-#
 # More Reading...
 # http://martinfowler.com/eaaCatalog/identityMap.html
 # http://en.wikipedia.org/wiki/Identity_map
 
+# Identity map is turned off by default for Toystore so let's turn it on
+Toy::IdentityMap.enabled = true
+puts 'Identity map enabled'
+
 class User
   include Toy::Store
-  store :memory, {}
-
-  # identity_map_off # if uncommented, User would not use identity map
 
   attribute :name, String
 end
@@ -29,17 +28,13 @@ user = User.create(:name => 'John')
 #   {"name"=>"John"}
 # ToyStore IMS User "08a1c54c-3393-11e0-8b37-89da41d2f675"
 
-User.get(user.id)
+puts "With identity map - User.get(user.id).equal?(user): #{User.get(user.id).equal?(user)}"
 # User is retrieved from identity map instead of querying
 # ToyStore IMG User "08a1c54c-3393-11e0-8b37-89da41d2f675"
 
-User.without_identity_map do
-  User.get(user.id)
+Toy::IdentityMap.without do
+  puts "Without identity map - User.get(user.id).equal?(user): #{User.get(user.id).equal?(user)}"
   # User is queried from database
   # ToyStore GET User :memory "08a1c54c-3393-11e0-8b37-89da41d2f675"
   #   {"name"=>"John"}
 end
-
-User.get(user.id)
-# User is retrieved from identity map instead of querying
-# ToyStore IMG User "08a1c54c-3393-11e0-8b37-89da41d2f675"

data/examples/memcached.rb

@@ -10,7 +10,7 @@ require 'toystore'
 
 class GameList
   include Toy::Store
-  store :memcached, Memcached.new
+  adapter :memcached, Memcached.new
 
   attribute :source, Hash
 end

data/examples/memory.rb

@@ -10,7 +10,7 @@ require 'toystore'
 
 class User
   include Toy::Store
-  store :memory, {}
+  adapter :memory, {}
 
   attribute :name, String
 end

data/examples/mongo.rb

@@ -10,7 +10,7 @@ require 'toystore'
 
 class User
   include Toy::Store
-  store :mongo, Mongo::Connection.new.db('adapter')['testing']
+  adapter :mongo, Mongo::Connection.new.db('adapter')['testing']
 
   attribute :name, String
 end

data/examples/redis.rb

@@ -10,7 +10,7 @@ require 'toystore'
 
 class User
   include Toy::Store
-  store :redis, Redis.new
+  adapter :redis, Redis.new
 
   attribute :name, String
 end

data/examples/riak.rb

@@ -10,7 +10,7 @@ require 'toystore'
 
 class GameList
   include Toy::Store
-  store :riak, Riak::Client.new['adapter_example']
+  adapter :riak, Riak::Client.new['adapter_example']
 
   attribute :source, Hash
 end

data/lib/toy.rb

@@ -5,15 +5,11 @@ require 'digest/sha1'
 
 root_path = Pathname(__FILE__).dirname.join('..').expand_path
 
-require 'adapter'
+require 'adapter/memory'
 require 'simple_uuid'
 require 'active_model'
 require 'active_support/json'
-require 'active_support/core_ext/object'
-require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/class/inheritable_attributes'
-require 'active_support/core_ext/string/conversions'
-require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext'
 
 extensions_path = root_path.join('lib', 'toy', 'extensions')
 Dir[extensions_path + '**/*.rb'].each { |file| require(file) }
@@ -24,12 +20,12 @@ module Toy
   # Resets all tracking of things in memory. Useful for running
   # before each request in development mode with Rails and such.
   def reset
-    identity_map.clear
+    IdentityMap.clear
     plugins.clear
     models.clear
   end
 
-  # Clears all the stores for all the models. Useful in specs/tests/etc.
+  # Clears all the adapters for all the models. Useful in specs/tests/etc.
   # Do not use in production, harty harr harr.
   #
   # Note: that if your models are auto-loaded like in Rails, you will need
@@ -37,9 +33,9 @@ module Toy
   # not be aware of their existence.
   def clear
     models.each do |model|
-      model.store.clear         if model.has_store?
-      model.identity_map.clear  if model.identity_map_on?
+      model.adapter.clear
     end
+    IdentityMap.clear
   end
 
   def logger
@@ -65,38 +61,43 @@ module Toy
   module Middleware
     autoload 'IdentityMap', 'toy/middleware/identity_map'
   end
+
+  autoload 'Attribute',               'toy/attribute'
+  autoload 'Attribute',               'toy/attribute'
+  autoload 'Attributes',              'toy/attributes'
+  autoload 'Caching',                 'toy/caching'
+  autoload 'Callbacks',               'toy/callbacks'
+  autoload 'Dirty',                   'toy/dirty'
+  autoload 'DirtyStore',              'toy/dirty_store'
+  autoload 'Cloneable',               'toy/cloneable'
+  autoload 'Equality',                'toy/equality'
+  autoload 'Inspect',                 'toy/inspect'
+  autoload 'Logger',                  'toy/logger'
+  autoload 'MassAssignmentSecurity',  'toy/mass_assignment_security'
+  autoload 'Persistence',             'toy/persistence'
+  autoload 'Querying',                'toy/querying'
+  autoload 'Reloadable',              'toy/reloadable'
+  autoload 'Serialization',           'toy/serialization'
+  autoload 'Timestamps',              'toy/timestamps'
+  autoload 'Validations',             'toy/validations'
+
+  autoload 'Collection',              'toy/collection'
+  autoload 'List',                    'toy/list'
+  autoload 'Lists',                   'toy/lists'
+  autoload 'Reference',               'toy/reference'
+  autoload 'References',              'toy/references'
+  autoload 'Identity',                'toy/identity'
+
+  module Identity
+    autoload 'AbstractKeyFactory', 'toy/identity/abstract_key_factory'
+    autoload 'UUIDKeyFactory',     'toy/identity/uuid_key_factory'
+  end
 end
 
+require 'toy/identity_map'
 require 'toy/exceptions'
-require 'toy/attribute'
-require 'toy/attributes'
-require 'toy/callbacks'
-require 'toy/dirty'
-require 'toy/dolly'
-require 'toy/equality'
-require 'toy/inspect'
-require 'toy/persistence'
-require 'toy/mass_assignment_security'
 require 'toy/plugins'
+require 'toy/object'
 require 'toy/store'
-require 'toy/serialization'
-require 'toy/timestamps'
-require 'toy/validations'
-require 'toy/querying'
-require 'toy/identity_map'
 
-require 'toy/collection'
-require 'toy/embedded_list'
-require 'toy/embedded_lists'
-require 'toy/list'
-require 'toy/lists'
-require 'toy/reference'
-require 'toy/references'
-
-require 'toy/index'
-require 'toy/indices'
-require 'toy/identity/abstract_key_factory'
-require 'toy/identity/uuid_key_factory'
-require 'toy/identity'
-require 'toy/caching'
-require 'toy/logger'
+Toy::IdentityMap.enabled = false

data/lib/toy/attribute.rb

@@ -3,7 +3,7 @@ module Toy
     attr_reader :model, :name, :type, :options
 
     def initialize(model, name, type, options={})
-      options.assert_valid_keys(:default, :embedded_list, :virtual, :abbr)
+      options.assert_valid_keys(:default, :virtual, :abbr)
 
       @model, @name, @type, @options = model, name.to_s, type, options
       @virtual = options.fetch(:virtual, false)
@@ -58,11 +58,6 @@ module Toy
       abbr? ? abbr : name
     end
 
-    # Stores reference to related embedded list
-    def embedded_list
-      options[:embedded_list]
-    end
-
     def eql?(other)
       self.class.eql?(other.class) &&
         model == other.model &&

data/lib/toy/attributes.rb

@@ -4,6 +4,7 @@ module Toy
     include ActiveModel::AttributeMethods
 
     included do
+      include Identity
       attribute_method_suffix('', '=', '?')
     end
 
@@ -25,114 +26,84 @@ module Toy
       end
     end
 
-    module InstanceMethods
-      def initialize(attrs={})
-        @_new_record = true unless defined?(@_new_record)
-        initialize_attributes_with_defaults
-        send(:attributes=, attrs, @_new_record)
-        write_attribute :id, self.class.next_key(self) unless id?
-      end
-
-      def initialize_from_database(attrs={})
-        @_new_record = false
-        send(:initialize, attrs)
-        self
-      end
-
-      def reload
-        if attrs = store.read(id)
-          attrs['id'] = id
-          instance_variables.each        { |ivar| instance_variable_set(ivar, nil) }
-          initialize_attributes_with_defaults
-          send(:attributes=, attrs, new_record?)
-          self.class.lists.each_key      { |name| send(name).reset }
-          self.class.references.each_key { |name| send(name).reset }
-        else
-          raise NotFound.new(id)
-        end
-        self
-      end
-
-      def id
-        read_attribute(:id)
-      end
+    def initialize(attrs={})
+      initialize_attributes_with_defaults
+      self.attributes = attrs
+      write_attribute :id, self.class.next_key(self) unless id?
+    end
 
-      def attributes
-        @attributes
-      end
+    def id
+      read_attribute(:id)
+    end
 
-      def persisted_attributes
-        {}.tap do |attrs|
-          self.class.attributes.each do |name, attribute|
-            next if attribute.virtual?
-            attrs[attribute.persisted_name] = attribute.to_store(read_attribute(attribute.name))
-          end
-        end.merge(embedded_attributes)
-      end
+    def attributes
+      @attributes
+    end
 
-      def embedded_attributes
-        {}.tap do |attrs|
-          self.class.embedded_lists.each_key do |name|
-            attrs[name.to_s] = send(name).map(&:persisted_attributes)
-          end
+    def persisted_attributes
+      {}.tap do |attrs|
+        self.class.attributes.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|
-          if attribute_method?(key)
-            write_attribute(key, value)
-          elsif respond_to?("#{key}=")
-            send("#{key}=", value)
-          end
+    def attributes=(attrs, *)
+      return if attrs.nil?
+      attrs.each do |key, value|
+        if attribute_method?(key)
+          write_attribute(key, value)
+        elsif respond_to?("#{key}=")
+          send("#{key}=", value)
         end
       end
+    end
 
-      def [](key)
-        read_attribute(key)
-      end
+    def [](key)
+      read_attribute(key)
+    end
 
-      def []=(key, value)
-        write_attribute(key, value)
-      end
+    def []=(key, value)
+      write_attribute(key, value)
+    end
 
-      private
-        def read_attribute(key)
-          @attributes ||= {}
-          @attributes[key.to_s]
-        end
+    private
 
-        def write_attribute(key, value)
-          @attributes[key.to_s] = attribute_definition(key).try(:from_store, value)
-        end
+    def read_attribute(key)
+      @attributes ||= {}
+      @attributes[key.to_s]
+    end
 
-        def attribute_definition(key)
-          self.class.attributes[key.to_s]
-        end
+    def write_attribute(key, value)
+      @attributes[key.to_s] = attribute_definition(key).try(:from_store, value)
+    end
 
-        def attribute_method?(key)
-          self.class.attribute?(key)
-        end
+    def attribute_definition(key)
+      self.class.attributes[key.to_s]
+    end
 
-        def attribute(key)
-          read_attribute(key)
-        end
+    def attribute_method?(key)
+      self.class.attribute?(key)
+    end
 
-        def attribute=(key, value)
-          write_attribute(key, value)
-        end
+    def attribute(key)
+      read_attribute(key)
+    end
 
-        def attribute?(key)
-          read_attribute(key).present?
-        end
+    def attribute=(key, value)
+      write_attribute(key, value)
+    end
 
-        def initialize_attributes_with_defaults
-          @attributes ||= {}
-          self.class.defaulted_attributes.each do |attribute|
-            @attributes[attribute.name.to_s] = attribute.default
-          end
-        end
+    def attribute?(key)
+      read_attribute(key).present?
+    end
+
+    def initialize_attributes_with_defaults
+      @attributes ||= {}
+      self.class.defaulted_attributes.each do |attribute|
+        @attributes[attribute.name.to_s] = attribute.default
+      end
     end
   end
 end