perpetuity 0.7.3 → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2244d23d7746c76519f66795e7799800d7ed84f5
-  data.tar.gz: f3aa364123d96e1477e64eeda2676e616a712515
+  metadata.gz: 7e6705adfb6aafad45d73afe6fd8fc8da9ecb7d0
+  data.tar.gz: c7bb3bc720c641e4b5951188591279b4fda33baa
 SHA512:
-  metadata.gz: 4baa0facacc3099d0f8c8e36e0fb283ee1dd319067a6249ef2d6ffbdad6afddca95d70779bd8b140b713b6717778182afcfccb26661113e22401aa2cf18aed62
-  data.tar.gz: fea3b1c06ef2b0f90738d53d9f1783024527582f5c49bd4869233a71882e248623c7b5980b7679701d6e1c1f61f0bb78886807fd861570017e2710f21a4916df
+  metadata.gz: 94d4440cfb7076313402de2f8055d81fc7151504dacc1bc3e7004549ab60605f04f3cf6342dcd56893dd85e4714d39327ffe240b31fd51ebe9cb2342261c4941
+  data.tar.gz: 8d868e8b3ba8a5fdc63b9a8ac2e32ff24bcac8b09275cadff37262be8e7ef1e39586b7c067e50627247131249a3692f467e635855332cf1350a617192d03bbf6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Version 1.0.0.beta
+
+- Duplicate objects properly for the identity map. The identity map holds references to objects pulled out of the DB. We need to duplicate these references on insertion and retrieval from the identity map to make sure that modifications to an object do not pollute the version in the identity map.
+- Add support for the [Amazon DynamoDB adapter](https://github.com/cardspring/perpetuity-dynamodb) by [Cardspring](https://github.com/cardspring). This adapter is still in very early development.
+- Allow passing in the type of the `id` attribute for databases that enforce column/field types. This allows us to say `id(String) { ... }`, telling the database that `id` needs to be a String.
+- Use hashes for AttributeSets to reduce serialization time.
+- Extract all database-specific logic to their own gems. The existing MongoDB adapter has been moved to the `perpetuity-mongodb` gem and there is a PostgreSQL adapter that lives under `perpetuity-postgres`.
+- Allow specs to be run on top of `perpetuity-postgres`
+- Remove validations.
+
 ## Version 0.7.3
 
 - Only save attributes which have changed

data/Gemfile

@@ -1,3 +1,6 @@
 source "http://rubygems.org"
 
+gem "perpetuity-postgres", github: "jgaskins/perpetuity-postgres"
+gem "perpetuity-mongodb", github: "jgaskins/perpetuity-mongodb"
+
 gemspec

data/README.md

@@ -2,7 +2,7 @@
 
 Perpetuity is a simple Ruby object persistence layer that attempts to follow Martin Fowler's Data Mapper pattern, allowing you to use plain-old Ruby objects in your Ruby apps in order to decouple your domain logic from the database as well as speed up your tests. There is no need for your model classes to inherit from another class or even include a mix-in.
 
-Your objects will hopefully eventually be able to be persisted into whichever database you like. Right now, only MongoDB is supported. Other persistence solutions will come later.
+Your objects will hopefully eventually be able to be persisted into whichever database you like. Right now, only MongoDB is supported. There is also a [PostgreSQL adapter](https://github.com/jgaskins/perpetuity-postgres) under heavy development (nearly up-to-date with the [MongoDB adapter](https://github.com/jgaskins/perpetuity-mongodb)). Other persistence solutions will come later.
 
 ## How it works
 
@@ -16,15 +16,25 @@ Add the following to your Gemfile and run `bundle` to install it.
 gem 'perpetuity'
 ```
 
+**NOTE:** In version 1.0, you will need to install the Perpetuity database adapter, which will pull in the core Perpetuity gem:
+
+```ruby
+gem 'perpetuity/mongodb'  # if using MongoDB
+gem 'perpetuity/postgres' # if using Postgres
+```
+
 ## Configuration
 
-The only currently supported persistence method is MongoDB. Other schemaless solutions can probably be implemented easily. The simplest configuration is with the following line:
+The only currently supported persistence method is MongoDB, but stay tuned for the [Postgres adapter](https://github.com/jgaskins/perpetuity-postgres). Other schemaless solutions can probably be implemented easily. The simplest configuration is with the following line:
 
 ```ruby
-Perpetuity.data_source :mongodb, 'my_database'
+Perpetuity.data_source :mongodb, 'my_mongo_database'
+Perpetuity.data_source :postgres, 'my_pg_database'
 ```
 
-If your database is on another server or you need authentication, you can specify those as options:
+*Note:* You cannot use different databases in the same app like that. At least, not yet. :-)
+
+If your database is on another server/port or you need authentication, you can specify those as options:
 
 ```ruby
 Perpetuity.data_source :mongodb, 'my_database', host: 'mongo.example.com',
@@ -129,7 +139,7 @@ Perpetuity.generate_mapper_for Comment do
 end
 ```
 
-In this case, the article has an array of `Comment` objects, which the serializer knows that MongoDB cannot serialize. It will then tell the `Comment` mapper to serialize it and it stores that within the array.
+In this case, the article has an array of `Comment` objects, which the serializer knows that the data source cannot serialize. It will then tell the `Comment` mapper to serialize it and it stores that within the array.
 
 If some of the comments aren't objects of class `Comment`, it will adapt and serialize them according to their class. This works very well for objects that can have attributes of various types, such as a `User` having a profile attribute that can be either a `UserProfile` or `AdminProfile` object. You don't need to declare anything different for this case, just store the appropriate type of object into the `User`'s `profile` attribute and the mapper will take care of the details.
 
@@ -187,7 +197,7 @@ Perpetuity.generate_mapper_for Article do
 end
 ```
 
-Also, MongoDB, as well as some other databases, provide the ability to specify an order for the index. For example, if you want to query your blog with articles in descending order, you can specify a descending-order index on the timestamp for increased query performance.
+Also, some databases provide the ability to specify an order for the index. For example, if you want to query your blog with articles in descending order, you can specify a descending-order index on the timestamp for increased query performance.
 
 ```ruby
 Perpetuity.generate_mapper_for Article do
@@ -197,7 +207,7 @@ end
 
 ### Applying indexes
 
-It's very important to keep in mind that specifying an index does not create it on the database immediately. If you did this, you could potentially introduce downtime every time you specify a new index and deploy your application.
+It's very important to keep in mind that specifying an index does not create it on the database immediately. If you did this, you could potentially introduce downtime every time you specify a new index and deploy your application. Additionally, if a unique index fails to apply, you would not be able to start your app.
 
 In order to apply indexes to the database, you must send `reindex!` to the mapper. For example:
 
@@ -221,7 +231,7 @@ Let's face it, most Ruby apps run on Rails, so we need to be able to support it.
 
 Previous versions of Perpetuity would break when Rails reloaded your models in development mode due to class objects being different. It now reloads mappers dynamically based on whether the class has been reloaded.
 
-In order for this to work, your mapper files need to be named `*_mapper.rb` and be stored anywhere inside your project's `app` directory.
+In order for this to work, your mapper files need to be named `*_mapper.rb` and be stored anywhere inside your project's `app` directory. Usually, this would be `app/mappers`, but this is not enforced.
 
 ### ActiveModel-compliant API
 

data/lib/perpetuity.rb

@@ -1,5 +1,4 @@
 require "perpetuity/version"
-require "perpetuity/mongodb"
 require "perpetuity/config"
 require "perpetuity/mapper"
 require "perpetuity/mapper_registry"
@@ -9,7 +8,7 @@ module Perpetuity
     detect_rails
     configuration.instance_exec(&block)
   end
-  
+
   def self.configuration
     @configuration ||= Configuration.new
   end
@@ -29,9 +28,10 @@ module Perpetuity
   end
 
   def self.data_source adapter, db_name, options={}
-    adapters = { mongodb: MongoDB }
+    adapters = { dynamodb: 'DynamoDB', mongodb: 'MongoDB', postgres: 'Postgres' }
+    adapter_class = const_get(adapters[adapter])
 
-    configure { data_source adapters[adapter].new(options.merge(db: db_name)) }
+    configure { data_source adapter_class.new(options.merge(db: db_name)) }
   end
 
   # Necessary to be able to check whether Rails is loaded and initialized

data/lib/perpetuity/attribute.rb

@@ -5,11 +5,20 @@ module Perpetuity
       @name = name
       @type = type
 
+      @_options = options.dup
       options.each do |option, value|
         instance_variable_set "@#{option}", value
       end
     end
 
+    def options option=nil
+      if option
+        instance_variable_get("@#{option}")
+      else
+        @_options
+      end
+    end
+
     def embedded?
       @embedded ||= false
     end

data/lib/perpetuity/attribute_set.rb

@@ -1,23 +1,21 @@
-require 'set'
-
 module Perpetuity
   class AttributeSet
     include Enumerable
 
     def initialize
-      @attributes = Set.new
+      @attributes = {}
     end
 
     def << attribute
-      @attributes << attribute
+      @attributes[attribute.name] = attribute
     end
 
     def [] name
-      @attributes.find { |attr| attr.name == name }
+      @attributes[name]
     end
 
     def each &block
-      @attributes.each(&block)
+      @attributes.each_value(&block)
     end
   end
 end

data/lib/perpetuity/data_injectable.rb

@@ -5,7 +5,7 @@ module Perpetuity
     end
 
     def inject_data object, data
-      data.each_pair do |attribute,value|
+      data.each do |attribute,value|
         inject_attribute object, attribute, value
       end
       give_id_to object if object.instance_variables.include?(:@id)

data/lib/perpetuity/duplicator.rb

@@ -0,0 +1,27 @@
+module Perpetuity
+  class Duplicator
+    attr_reader :object
+    def initialize object
+      if object.is_a? Array
+        @object = object.map { |i| Duplicator.new(i).object }
+      else
+        @object = object.dup rescue object
+      end
+      @object.instance_variables.each do |ivar|
+        duplicate_attribute ivar
+      end
+    end
+
+    def attribute ivar
+      object.instance_variable_get ivar
+    end
+
+    def set_attribute ivar, value
+      object.instance_variable_set ivar, value
+    end
+
+    def duplicate_attribute ivar
+      set_attribute ivar, Duplicator.new(attribute(ivar)).object
+    end
+  end
+end

data/lib/perpetuity/mapper.rb

@@ -1,9 +1,9 @@
 require 'perpetuity/attribute_set'
 require 'perpetuity/attribute'
-require 'perpetuity/validations'
 require 'perpetuity/data_injectable'
 require 'perpetuity/dereferencer'
 require 'perpetuity/retrieval'
+require 'perpetuity/duplicator'
 
 module Perpetuity
   class Mapper
@@ -71,11 +71,10 @@ module Perpetuity
     end
 
     def insert object
-      raise "#{object} is invalid and cannot be persisted." unless self.class.validations.valid?(object)
       objects = Array(object)
       serialized_objects = objects.map { |obj| serialize(obj) }
 
-      new_ids = data_source.insert(mapped_class, serialized_objects)
+      new_ids = data_source.insert(mapped_class, serialized_objects, attribute_set)
       objects.each_with_index do |obj, index|
         give_id_to obj, new_ids[index]
       end
@@ -139,7 +138,7 @@ module Perpetuity
         result = select { |object| object.id == id }.first
 
         if cache_result and !result.nil?
-          identity_map << result
+          identity_map << Duplicator.new(result).object
         end
 
         result
@@ -174,9 +173,13 @@ module Perpetuity
       end
     end
 
-    def self.id &block
+    def self.id type=nil, &block
       if block_given?
         @id = block
+        if type
+          attribute :id, type: type
+        end
+        nil
       else
         @id ||= -> { nil }
       end
@@ -222,14 +225,6 @@ module Perpetuity
       object.instance_variable_get(:@id) if persisted?(object)
     end
 
-    def self.validate &block
-      validations.instance_exec(&block)
-    end
-
-    def self.validations
-      @validations ||= ValidationSet.new
-    end
-
     def data_source
       self.class.data_source
     end
@@ -237,7 +232,7 @@ module Perpetuity
     def serialize object
       attributes = data_source.serialize(object, self)
       if o_id = generate_id_for(object)
-        attributes[:id] = o_id
+        attributes['id'] = o_id
       end
 
       attributes

data/lib/perpetuity/version.rb

@@ -1,3 +1,3 @@
 module Perpetuity
-  VERSION = "0.7.3"
+  VERSION = "1.0.0.beta"
 end

data/perpetuity.gemspec

@@ -20,5 +20,4 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 2.13"
-  s.add_runtime_dependency "moped"
 end

data/spec/integration/associations_spec.rb

@@ -2,16 +2,12 @@ require 'spec_helper'
 require 'support/test_classes'
 
 describe 'associations with other objects' do
-  let(:user) { User.new }
-  let(:topic) { Topic.new }
+  let(:user) { User.new('Flump') }
+  let(:topic) { Topic.new('Title', user) }
   let(:user_mapper) { Perpetuity[User] }
   let(:topic_mapper) { Perpetuity[Topic] }
 
   before do
-    user.name = 'Flump'
-    topic.creator = user
-    topic.title = 'Title'
-
     user_mapper.insert user
     topic_mapper.insert topic
   end

data/spec/integration/indexing_spec.rb

@@ -24,7 +24,7 @@ describe 'indexing' do
   let(:db_name) { Perpetuity.configuration.data_source.db }
 
   before do
-    Perpetuity.data_source :mongodb, db_name
+    load './spec/spec_helper.rb'
     mapper.data_source.drop_collection Object
   end
   after { mapper.data_source.drop_collection Object }

data/spec/integration/persistence_spec.rb

@@ -1,13 +1,14 @@
 require 'spec_helper'
 require 'support/test_classes'
+require 'securerandom'
 
 describe 'Persistence' do
   let(:mapper) { Perpetuity[Article] }
 
   it "persists an object" do
     article = Article.new 'I have a title'
-    expect { mapper.insert article }.
-      to change { mapper.count }.by 1
+    mapper.serialize article
+    expect { mapper.insert article }.to change { mapper.count }.by 1
     mapper.find(mapper.id_for(article)).title.should eq 'I have a title'
   end
 

data/spec/integration/retrieval_spec.rb

@@ -195,22 +195,14 @@ describe "retrieval" do
     end
   end
 
-  it 'selects objects with nested data' do
-    user = User.new(first_name: 'foo', last_name: 'bar')
-    mapper = Perpetuity[User]
-    mapper.insert user
-    users = mapper.select { |u| u.name.first_name == 'foo' }
-    ids = users.map { |retrieved_user| mapper.id_for(retrieved_user) }
-    ids.should include mapper.id_for(user)
-  end
-
   it 'skips a specified number of objects' do
-    author = SecureRandom.hex
-    articles = 3.times.map { Article.new(SecureRandom.hex, nil, author) }.sort_by(&:title)
+    title = SecureRandom.hex
+    articles = 3.times.map { Article.new(title) }.sort_by { |article| mapper.id_for(article) }
     articles.each { |article| mapper.insert article }
 
-    ret = mapper.select { |article| article.author == author }.drop(2).sort(:title).first
-    ret.should == articles.last
+    ret = mapper.select { |article| article.title == title }.drop(2).sort(:id).to_a
+    ret.should have(1).items
+    ret.first.should == articles.last
   end
 
   describe 'selecting random objects' do

data/spec/perpetuity/attribute_set_spec.rb

@@ -3,7 +3,7 @@ require 'perpetuity/attribute_set'
 module Perpetuity
   describe AttributeSet do
     it 'contains attributes' do
-      attribute = double('Attribute')
+      attribute = double('Attribute', name: :foo)
       subject << attribute
 
       subject.first.should eq attribute

data/spec/perpetuity/attribute_spec.rb

@@ -2,7 +2,7 @@ require 'perpetuity/attribute'
 
 module Perpetuity
   describe Attribute do
-    let(:attribute) { Attribute.new :article, Object }
+    let(:attribute) { Attribute.new :article, Object, default: 1 }
     subject { attribute }
 
     it 'has a name' do
@@ -13,6 +13,11 @@ module Perpetuity
       subject.type.should == Object
     end
 
+    it 'can get extra options' do
+      attribute.options.should == { default: 1 }
+      attribute.options(:default).should == 1
+    end
+
     it 'can be embedded' do
       attribute = Attribute.new :article, Object, embedded: true
       attribute.should be_embedded

data/spec/perpetuity/duplicator_spec.rb

@@ -0,0 +1,35 @@
+require 'perpetuity/duplicator'
+require 'support/test_classes/book'
+require 'support/test_classes/user'
+
+module Perpetuity
+  describe Duplicator do
+    let(:authors) { [User.new('Dave'), User.new('Andy')] }
+    let(:book) { Book.new('Title', authors) }
+    let(:duper) { Duplicator.new(book) }
+
+    it 'duplicates an object' do
+      duper.object.should be_a Book
+      duper.object.should_not be book
+    end
+
+    it 'duplicates attributes inside an object' do
+      duped_book = duper.object
+      duped_book.title.should be_a String
+      duped_book.title.should == book.title
+      duped_book.title.should_not be book.title
+    end
+
+    it 'does not duplicate non-duplicable attributes' do
+      # Symbols cannot be duped
+      book = Book.new(:foo)
+      duper = Duplicator.new(book)
+      duper.object.title.should be :foo
+    end
+
+    it 'duplicates objects contained within array attributes' do
+      duper.object.authors.first.should be_a User
+      duper.object.authors.first.should_not be authors.first
+    end
+  end
+end