minimapper 0.4.0 → 0.5.1

data/README.md

@@ -19,7 +19,7 @@ The API may not be entirely stable yet and there are probably edge cases that ar
 
 ### Compatibility
 
-This gem is tested against all major rubies in both 1.8 and 1.9, see [.travis.yml](https://github.com/joakimk/minimapper/blob/master/.travis.yml). For each ruby version, the SQL mappers are tested against SQLite3, PostgreSQL and MySQL.
+This gem is tested against all major rubies in 1.8, 1.9 and 2.0, see [.travis.yml](https://github.com/joakimk/minimapper/blob/master/.travis.yml). For each ruby version, the SQL mappers are tested against SQLite3, PostgreSQL and MySQL.
 
 ### Only the most basic API
 
@@ -44,6 +44,8 @@ Or install it yourself as:
 
     $ gem install minimapper
 
+You also need the `activemodel` gem if you use Minimapper::Entity and not only Minimapper::Entity::Core.
+
 Please avoid installing directly from the github repository. Code will be pushed there that might fail in [CI](https://travis-ci.org/#!/joakimk/minimapper/builds) (because testing all permutations of ruby versions and databases locally isn't practical). Gem releases are only done when CI is green.
 
 ## Usage
@@ -142,7 +144,7 @@ Validations on uniqueness can't be implemented on the entity, because they need
 
 Therefore, the ActiveRecord mapper will copy over any record errors to the entity when attempting to create or update.
 
-You would add these validations to the record itself, like:
+Add these validations to the record itself, like:
 
 ``` ruby
 class User < ActiveRecord::Base
@@ -150,7 +152,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-Note that calling `valid?` on the entity will not access the database. Errors copied over from the record will remain until the next attempt to create or update.
+Note that just calling `valid?` on the entity will not access the database. Errors copied over from the record will remain until the next attempt to create or update.
 
 So an entity that wouldn't be unique in the database will be `valid?` before you attempt to create it. And after you attempt to create it, the entity will not be `valid?` even after assigning a new value, until you attempt to create it again.
 
@@ -280,6 +282,7 @@ Robert "Uncle Bob" Martin:
 
 ### Apps
 
+* About 4 people at [Barsoom](http://barsoom.se/) are currently working full time on building a rails app that uses minimapper. We'll be extending minimapper as we go.
 * The deploy status app that minimapper was extracted from: [https://github.com/joakimk/deployer](https://github.com/joakimk/deployer)
 
 ## Contributing

data/lib/minimapper/entity/core.rb

@@ -1,5 +1,9 @@
-# The core entity API required by minimapper. If your entity
-# class implements this API, it should work with the data mappers.
+# The core entity API required by minimapper. If your entity class implements
+# this API, it should work with the data mappers.
+
+# IMPORTANT: This module should only implement the minimal interface needed
+# to talk to the data mappers. If a method isn't used by the mappers it should
+# not be in this file.
 
 module Minimapper
   module Entity

data/lib/minimapper/entity/rails.rb

@@ -12,8 +12,8 @@ module Minimapper
           extend  ActiveModel::Naming
           include ActiveModel::Validations
 
-          # Must be later than ActiveModel::Validations so
-          # it can call it with super.
+          # Must be added after ActiveModel::Validations so our
+          # validations can call ActiveModel's with `super`.
           include ValidationsWithMapperErrors
         end
       end

data/lib/minimapper/entity.rb

@@ -16,6 +16,14 @@ module Minimapper
       new_attributes.each_pair { |name, value| self.send("#{name}=", value) }
     end
 
+    def ==(other)
+      super || (
+        other.instance_of?(self.class) &&
+        self.id &&
+        other.id == self.id
+      )
+    end
+
     def self.included(klass)
       klass.send(:include, Minimapper::Entity::Rails)
       klass.send(:extend, Minimapper::Entity::Attributes)

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.4.0"
+  VERSION = "0.5.1"
 end

data/unit/entity/core_spec.rb

@@ -5,6 +5,10 @@ class BasicEntity
   attr_accessor :one, :two
 end
 
+class OtherEntity
+  include Minimapper::Entity::Core
+end
+
 describe Minimapper::Entity::Core do
   it "can get and set an attributes hash" do
     entity = BasicEntity.new
@@ -47,7 +51,7 @@ describe Minimapper::Entity::Core do
   end
 
   describe "#mapper_errors=" do
-    it "makes it invalid if present" do
+    it "makes the mapper invalid if present" do
       entity = BasicEntity.new
       entity.mapper_errors = [ [:one, "bad"] ]
       entity.valid?.should be_false

data/unit/entity_spec.rb

@@ -103,3 +103,40 @@ describe Minimapper::Entity, "self.column_names" do
     TestProject.column_names.should == [ "id", "created_at", "updated_at", "title" ]
   end
 end
+
+describe Minimapper::Entity, "#==" do
+  it "is equal to the exact same instance" do
+    entity = build_entity(TestUser, nil)
+    entity.should == entity
+  end
+
+  it "is equal to another instance if class and id matches" do
+    entity = build_entity(TestUser,  123)
+    other_entity = build_entity(TestUser,  123)
+    entity.should == other_entity
+  end
+
+  it "is not equal to another instance if there is no id" do
+    entity = build_entity(TestUser, nil)
+    other_entity = build_entity(TestUser, nil)
+    entity.should_not == other_entity
+  end
+
+  it "is not equal to another instance if ids do not match" do
+    entity = build_entity(TestUser,  123)
+    other_entity = build_entity(TestUser,  456)
+    entity.should_not == other_entity
+  end
+
+  it "is not equal to another instance if classes do not match" do
+    entity = build_entity(TestUser, 123)
+    other_entity = build_entity(TestProject, 123)
+    entity.should_not == other_entity
+  end
+
+  def build_entity(klass, id)
+    entity = klass.new
+    entity.id = id
+    entity
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70108741422080 !ruby/object:Gem::Requirement
+  requirement: &70153436310520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70108741422080
+  version_requirements: *70153436310520
 description: A minimalistic way of separating your models from ORMs like ActiveRecord.
 email:
 - joakim.kolsjo@gmail.com
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3446705768728463359
+      hash: 3918684014874405558
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3446705768728463359
+      hash: 3918684014874405558
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5