perpetuity 0.1

data/spec/perpetuity/validations/presence_spec.rb

@@ -0,0 +1,30 @@
+require 'perpetuity/validations/presence'
+
+module Perpetuity
+  module Validations
+    describe Presence do
+      let(:presence) { Presence.new :to_s }
+      let(:valid) { double('valid object') }
+      let(:invalid) { double('invalid object') }
+
+      it 'validates values that are present' do
+        presence.pass?(valid).should be_true
+      end
+
+      it 'invalidates nil values' do
+        invalid.stub(to_s: nil)
+        presence.pass?(invalid).should be_false
+      end
+
+      it 'invalidates empty strings' do
+        invalid.stub(to_s: '')
+        presence.pass?(invalid).should be_false
+      end
+
+      it 'invalidates strings with only whitespace' do
+        invalid.stub(to_s: ' ')
+        presence.pass?(invalid).should be_false
+      end
+    end
+  end
+end

data/spec/perpetuity/validations_spec.rb

@@ -0,0 +1,87 @@
+require 'perpetuity/validations'
+
+module Perpetuity
+  describe ValidationSet do
+    let(:validation_set) { ValidationSet.new }
+    it 'is empty when created' do
+      validation_set.should be_empty
+    end
+
+    it 'can add validations' do
+      v = double('validation')
+      validation_set << v
+
+      validation_set.first.should == v
+    end
+
+    it 'validates an object' do
+      v = double('validation')
+      v.stub(pass?: true)
+      validation_set << v
+
+      validation_set.should be_valid(double('object'))
+    end
+
+    it 'invalidates an object' do
+      v = double('validation')
+      v.stub(pass?: false)
+      validation_set << v
+
+      validation_set.should_not be_valid(double('object'))
+    end
+
+    describe 'validation types' do
+      let(:valid_object) { double('valid object') }
+      let(:invalid_object) { double('invalid object') }
+
+      it 'validates presence of an attribute' do
+        valid_object.stub(email: 'me@example.com')
+        validation_set.present :email
+
+        validation_set.count.should eq 1
+        validation_set.should be_valid(valid_object)
+      end
+
+      it 'validates length of an attribute' do
+        valid_object.stub(email: 'me@example.com')
+        validation_set.length :email, at_most: 14
+        validation_set.length :email, at_least: 14
+
+        validation_set.count.should eq 2
+        validation_set.should be_valid(valid_object)
+      end
+
+      it 'validates length within a range' do
+        valid_object.stub(email: 'me@example.com')
+        validation_set.length :email, between: (14..14)
+
+        validation_set.should have(1).items
+        validation_set.should be_valid(valid_object)
+      end
+
+      it 'invalidates length within a range' do
+        invalid_object.stub(email: 'me@example.com')
+        validation_set.length :email, between: (0..13)
+
+        validation_set.should have(1).items
+        validation_set.should be_invalid(invalid_object)
+      end
+
+      it 'invalidates when attribute is too short' do
+        invalid_object.stub(email: 'foo')
+        validation_set.length :email, at_least: 4
+
+        validation_set.count.should eq 1
+        validation_set.should be_invalid(invalid_object)
+      end
+
+      it 'invalidates when attribute is too long' do
+        invalid_object.stub(email: 'me@example.com')
+        subject.length :email, at_most: 4
+
+        subject.count.should eq 1
+        subject.should be_invalid(invalid_object)
+      end
+    end
+  end
+end

data/spec/perpetuity_spec.rb

@@ -0,0 +1,293 @@
+require 'perpetuity'
+require 'test_classes'
+
+describe Perpetuity do
+  before(:all) do
+    # Use MongoDB for now as its the only one supported.
+    mongodb = Perpetuity::MongoDB.new db: 'perpetuity_gem_test'
+    Perpetuity.configure { data_source mongodb }
+  end
+
+  describe 'mapper generation' do
+    it 'generates mappers' do
+      mapper = Perpetuity.generate_mapper_for Object
+      Perpetuity[Object].should be_a Perpetuity::Mapper
+      Perpetuity[Object].should be == mapper
+    end
+  end
+
+  describe 'persistence' do
+    it "persists an object" do
+      article = Article.new 'I have a title'
+      expect { Perpetuity::Mapper[Article].insert article }.
+        to change { Perpetuity::Mapper[Article].count }.by 1
+      Perpetuity::Mapper[Article].find(article.id).title.should eq 'I have a title'
+    end
+
+    it 'returns the id of the persisted object' do
+      article = Article.new
+      Perpetuity::Mapper[Article].insert(article).should eq article.id
+    end
+
+    it "gives an id to objects" do
+      article = Article.new
+      Perpetuity::Mapper[Article].give_id_to article, 1
+
+      article.id.should eq 1
+    end
+
+    describe 'id injection' do
+      let(:article) { Article.new }
+
+      it 'assigns an id to the inserted object' do
+        Perpetuity::Mapper[Article].insert article
+        article.should respond_to :id
+      end
+
+      it "assigns an id using Mapper.first" do
+        Perpetuity::Mapper[Article].first.should respond_to :id
+      end
+
+      it 'assigns an id using Mapper.retrieve.first' do
+        Perpetuity::Mapper[Article].retrieve.first.should respond_to :id
+      end
+
+      it 'assigns an id using Mapper.all.first' do
+        Perpetuity::Mapper[Article].all.first.should respond_to :id
+      end
+    end
+
+    describe 'persisting arrays' do
+      let(:article) { Article.new }
+
+      it 'persists arrays' do
+        article.comments << 1 << 2 << 3
+        Perpetuity::Mapper[Article].insert article
+        Perpetuity::Mapper[Article].find(article.id).comments.should eq [1, 2, 3]
+      end
+
+      it 'persists arrays with unserializable objects in them' do
+        comment = Comment.new('my comment')
+        article.comments << comment
+        Perpetuity::Mapper[Article].insert article
+        Perpetuity::Mapper[Article].find(article.id).comments.first.tap do |persisted_comment|
+          persisted_comment.should be_a Comment
+          persisted_comment.body.should eq comment.body
+        end
+      end
+    end
+
+    it "allows mappers to set the id field" do
+      book = Book.new('My Title')
+
+      Perpetuity::Mapper[Book].insert book
+      book.id.should eq 'my-title'
+    end
+  end
+
+  describe "deletion" do
+    it 'deletes an object' do
+      2.times { Perpetuity::Mapper[Article].insert Article.new }
+      expect { Perpetuity::Mapper[Article].delete Perpetuity::Mapper[Article].first }.to change { Perpetuity::Mapper[Article].count }.by(-1)
+    end
+
+    it 'deletes an object with a given id' do
+      article_id = Perpetuity::Mapper[Article].insert Article.new
+      expect {
+        Perpetuity::Mapper[Article].delete article_id
+      }.to change { Perpetuity::Mapper[Article].count }.by(-1)
+    end
+    
+    describe "#delete_all" do
+      it "should delete all objects of a certain class" do
+        Perpetuity::Mapper[Article].insert Article.new
+        Perpetuity::Mapper[Article].delete_all
+        Perpetuity::Mapper[Article].count.should eq 0
+      end
+    end
+  end
+
+  describe "retrieval" do
+    it "gets all the objects of a class" do
+      expect { Perpetuity::Mapper[Article].insert Article.new }.
+        to change { Perpetuity::Mapper[Article].all.count }.by 1
+    end
+    
+    it "has an ID when retrieved" do
+      Perpetuity::Mapper[Article].insert Article.new
+      Perpetuity::Mapper[Article].first.should respond_to :id
+    end
+    
+    it "returns a Perpetuity::Retrieval object" do
+      Perpetuity::Mapper[Article].retrieve(id: 1).should be_an_instance_of Perpetuity::Retrieval
+    end
+
+    it "gets an item with a specific ID" do
+      article = Article.new
+      Perpetuity::Mapper[Article].insert article
+      retrieved = Perpetuity::Mapper[Article].find(article.id)
+
+      retrieved.id.should eq article.id
+      retrieved.title.should eq article.title
+      retrieved.body.should eq article.body
+    end
+
+    it "gets an item by its attributes" do
+      article = Article.new
+      Perpetuity::Mapper[Article].insert article
+      retrieved = Perpetuity::Mapper[Article].retrieve(title: article.title)
+
+      retrieved.to_a.should_not be_empty
+      retrieved.first.title.should eq article.title
+    end
+
+    describe "Array-like syntax" do
+      let(:draft) { Article.new 'Draft', 'draft content', nil, Time.now + 30 }
+      let(:published) { Article.new 'Published', 'content', nil, Time.now - 30, 3 }
+      before do
+        Perpetuity::Mapper[Article].insert draft
+        Perpetuity::Mapper[Article].insert published
+      end
+
+      it 'selects objects using equality' do
+        selected = Perpetuity::Mapper[Article].select { title == 'Published' }
+        selected.map(&:id).should include published.id
+        selected.map(&:id).should_not include draft.id
+      end
+
+      it 'selects objects using greater-than' do
+        selected = Perpetuity::Mapper[Article].select { published_at < Time.now }
+        ids = selected.map(&:id)
+        ids.should include published.id
+        ids.should_not include draft.id
+      end
+
+      it 'selects objects using greater-than-or-equal' do
+        selected = Perpetuity::Mapper[Article].select { views >= 3 }
+        ids = selected.map(&:id)
+        ids.should include published.id
+        ids.should_not include draft.id
+      end
+
+      it 'selects objects using less-than' do
+        selected = Perpetuity::Mapper[Article].select { views < 3 }
+        ids = selected.map(&:id)
+        ids.should include draft.id
+        ids.should_not include published.id
+      end
+
+      it 'selects objects using less-than-or-equal' do
+        selected = Perpetuity::Mapper[Article].select { views <= 0 }
+        ids = selected.map(&:id)
+        ids.should include draft.id
+        ids.should_not include published.id
+      end
+
+      it 'selects objects using inequality' do
+        selected = Perpetuity::Mapper[Article].select { title.not_equal? 'Draft' }
+        ids = selected.map(&:id)
+        ids.should_not include draft.id
+        ids.should include published.id
+      end
+
+      it 'selects objects using regular expressions' do
+        selected = Perpetuity::Mapper[Article].select { title =~ /Pub/ }
+        ids = selected.map(&:id)
+        ids.should include published.id
+        ids.should_not include draft.id
+      end
+
+      it 'selects objects using inclusion' do
+        selected = Perpetuity::Mapper[Article].select { title.in %w( Published ) }
+        ids = selected.map(&:id)
+        ids.should include published.id
+        ids.should_not include draft.id
+      end
+    end
+  end
+
+  describe 'pagination' do
+    it 'specifies the page we want' do
+      Perpetuity::Mapper[Article].retrieve.should respond_to :page
+    end
+
+    it 'specify the quantity per page' do
+      Perpetuity::Mapper[Article].retrieve.should respond_to :per_page
+    end
+
+    it 'returns an empty set when there is no data for that page' do
+      data = Perpetuity::Mapper[Article].retrieve.page(2)
+      data.should be_empty
+    end
+
+    it 'specifies per-page quantity' do
+      Perpetuity::Mapper[Article].delete_all
+      5.times { |i| Perpetuity::Mapper[Article].insert Article.new i }
+      data = Perpetuity::Mapper[Article].retrieve.page(3).per_page(2)
+      data.should have(1).item
+    end
+  end
+
+  describe 'associations with other objects' do
+    let(:user) { User.new }
+    let(:topic) { Topic.new }
+    let(:user_mapper) { Perpetuity::Mapper[User] }
+    let(:topic_mapper) { Perpetuity::Mapper[Topic] }
+
+    before do
+      user.name = 'Flump'
+      topic.creator = user
+      topic.title = 'Title'
+
+      user_mapper.insert user
+      topic_mapper.insert topic
+    end
+
+    it 'can reference other objects' do
+      topic_mapper.find(topic.id).creator.should eq user.id
+    end
+
+    it 'can retrieve associated objects' do
+      retrieved_topic = topic_mapper.first
+
+      topic_mapper.load_association! retrieved_topic, :creator
+      retrieved_topic.creator.name.should eq 'Flump'
+    end
+  end
+
+  describe 'updating' do
+    let(:article) { Article.new }
+    before do
+      Perpetuity::Mapper[Article].insert article
+    end
+
+    it 'updates an object in the database' do
+      Perpetuity::Mapper[Article].update article, title: 'I has a new title!'
+      Perpetuity::Mapper[Article].find(article.id).title.should eq 'I has a new title!'
+    end
+  end
+
+  describe 'validations' do
+    let(:car_mapper) { Perpetuity::Mapper[Car] }
+
+    it 'raises an exception when inserting an invalid object' do
+      car = Car.new
+      expect { car_mapper.insert car }.to raise_error
+    end
+
+    it 'does not raise an exception when validations are met' do
+      car = Car.new
+      car.make = "Volkswagen"
+      expect { car_mapper.insert car }.not_to raise_error
+    end
+  end
+
+  # The Message class stores its data members differently internally than it receives them
+  it 'uses accessor methods to read/write data' do
+    message = Message.new 'My Message!'
+    Perpetuity::Mapper[Message].insert message
+    saved_message = Perpetuity::Mapper[Message].find(message.id)
+    saved_message.instance_variable_get(:@text).should eq 'My Message!'.reverse
+    saved_message.text.should eq 'My Message!'
+  end
+end

data/spec/test_classes.rb

@@ -0,0 +1,93 @@
+class Article
+  attr_accessor :title, :body, :comments, :published_at, :views
+  def initialize title="Title", body="Body", author=nil, published_at=Time.now, views=0
+    @title = title
+    @body = body
+    @comments = []
+    @published_at = published_at
+    @views = views
+  end
+end
+
+Perpetuity.generate_mapper_for(Article) do
+  attribute :title, String
+  attribute :body, String
+  attribute :comments, Array, embedded: true
+  attribute :published_at, Time
+  attribute :views, Integer
+end
+
+class Comment
+  attr_reader :body
+  def initialize body='Body'
+    @body = body
+  end
+end
+
+Perpetuity.generate_mapper_for(Comment) do
+  attribute :body, String
+end
+
+class User
+  attr_accessor :name
+  def initialize name="Foo"
+    @name = name
+  end
+end
+
+Perpetuity.generate_mapper_for User do
+  attribute :name, String
+end
+
+class Book
+  attr_accessor :title
+  def initialize title="Foo Bar"
+    @title = title
+  end
+end
+
+Perpetuity.generate_mapper_for Book do
+  id { title.gsub(/\W+/, '-').downcase }
+  attribute :title, String
+end
+
+class Message
+  def initialize text="My Message!"
+    self.text = text
+  end
+
+  def text
+    @text.reverse
+  end
+
+  def text= new_text
+    @text = new_text.reverse
+  end
+end
+
+Perpetuity.generate_mapper_for Message do
+  attribute :text, String
+end
+
+class Topic
+  attr_accessor :title, :creator
+end
+
+Perpetuity.generate_mapper_for(Topic) do
+  attribute :title, String
+  attribute :creator, User
+end
+
+class Car
+  attr_accessor :make, :model, :seats
+end
+
+Perpetuity.generate_mapper_for(Car) do
+  attribute :make, String
+  attribute :model, String
+  attribute :seats, Integer
+
+  validate do
+    present :make
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: perpetuity
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Persistence library allowing persistence of Ruby objects without adding
+  persistence concerns to domain objects.
+email:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/perpetuity.rb
+- lib/perpetuity/attribute.rb
+- lib/perpetuity/attribute_set.rb
+- lib/perpetuity/config.rb
+- lib/perpetuity/data_injectable.rb
+- lib/perpetuity/mapper.rb
+- lib/perpetuity/mongodb.rb
+- lib/perpetuity/mongodb/query.rb
+- lib/perpetuity/mongodb/query_attribute.rb
+- lib/perpetuity/mongodb/query_expression.rb
+- lib/perpetuity/retrieval.rb
+- lib/perpetuity/validations.rb
+- lib/perpetuity/validations/length.rb
+- lib/perpetuity/validations/presence.rb
+- lib/perpetuity/validations/validation_set.rb
+- lib/perpetuity/version.rb
+- perpetuity.gemspec
+- spec/perpetuity/attribute_set_spec.rb
+- spec/perpetuity/attribute_spec.rb
+- spec/perpetuity/config_spec.rb
+- spec/perpetuity/data_injectable_spec.rb
+- spec/perpetuity/mapper_spec.rb
+- spec/perpetuity/mongodb/query_attribute_spec.rb
+- spec/perpetuity/mongodb/query_expression_spec.rb
+- spec/perpetuity/mongodb/query_spec.rb
+- spec/perpetuity/mongodb_spec.rb
+- spec/perpetuity/retrieval_spec.rb
+- spec/perpetuity/validations/length_spec.rb
+- spec/perpetuity/validations/presence_spec.rb
+- spec/perpetuity/validations_spec.rb
+- spec/perpetuity_spec.rb
+- spec/test_classes.rb
+homepage: https://github.com/jgaskins/perpetuity.git
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Persistence library allowing persistence of Ruby objects
+test_files:
+- spec/perpetuity/attribute_set_spec.rb
+- spec/perpetuity/attribute_spec.rb
+- spec/perpetuity/config_spec.rb
+- spec/perpetuity/data_injectable_spec.rb
+- spec/perpetuity/mapper_spec.rb
+- spec/perpetuity/mongodb/query_attribute_spec.rb
+- spec/perpetuity/mongodb/query_expression_spec.rb
+- spec/perpetuity/mongodb/query_spec.rb
+- spec/perpetuity/mongodb_spec.rb
+- spec/perpetuity/retrieval_spec.rb
+- spec/perpetuity/validations/length_spec.rb
+- spec/perpetuity/validations/presence_spec.rb
+- spec/perpetuity/validations_spec.rb
+- spec/perpetuity_spec.rb
+- spec/test_classes.rb