minimapper 0.10.0 → 0.10.1

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.3-p0-patched@minimapper --create
+rvm ruby-1.9.3-p194-falcon@minimapper --create

data/README.md

@@ -150,9 +150,9 @@ So an entity that wouldn't be unique in the database will be `valid?` before you
 You can write custom queries like this:
 
 ``` ruby
-class ProjectMapper < Minimapper::AR
+class ProjectMapper < Minimapper::Mapper
   def waiting_for_review
-    entities_for record_class.where(waiting_for_review: true).order("id DESC")
+    entities_for query_scope.where(waiting_for_review: true).order("id DESC")
   end
 end
 ```
@@ -166,6 +166,10 @@ Repository.projects.waiting_for_review.each do |project|
 end
 ```
 
+`record_class` is shorthand for ProjectMapper::Record.
+
+`query_scope` is a wrapper around `record_class` to allow you to add custom scopes to all queries.
+
 `entity_for` returns nil for nil.
 
 `entity_for` and `entities_for` take an optional second argument if you want a different entity class than the mapper's:

data/lib/minimapper/entity_invalid.rb

@@ -0,0 +1,14 @@
+module Minimapper
+  class EntityInvalid < StandardError
+    def initialize(entity)
+      @entity = entity
+    end
+
+    def message
+      # As long as the mappers support Minimapper::Entity::Core, we can't expect .errors to exist. I'm thinking of removing core as I don't use it myself and don't know anyone who does.
+      return super unless @entity.respond_to?(:errors)
+
+      @entity.errors.full_messages.join(', ')
+    end
+  end
+end

data/lib/minimapper/mapper.rb

@@ -1,3 +1,5 @@
+require "minimapper/entity_invalid"
+
 module Minimapper
   class Mapper
     attr_accessor :repository
@@ -22,6 +24,10 @@ module Minimapper
       end
     end
 
+    def create!(entity)
+      create(entity) || raise(Minimapper::EntityInvalid.new(entity))
+    end
+
     # Read
 
     def find(id)
@@ -33,15 +39,15 @@ module Minimapper
     end
 
     def all
-      entities_for record_class.all
+      entities_for query_scope.all
     end
 
     def first
-      entity_for(record_class.order("id ASC").first)
+      entity_for(query_scope.order("id ASC").first)
     end
 
     def last
-      entity_for(record_class.order("id ASC").last)
+      entity_for(query_scope.order("id ASC").last)
     end
 
     def reload(entity)
@@ -49,7 +55,7 @@ module Minimapper
     end
 
     def count
-      record_class.count
+      query_scope.count
     end
 
     # Update
@@ -70,6 +76,10 @@ module Minimapper
       end
     end
 
+    def update!(entity)
+      update(entity) || raise(Minimapper::EntityInvalid.new(entity))
+    end
+
     # Delete
 
     def delete(entity)
@@ -82,22 +92,11 @@ module Minimapper
     end
 
     def delete_all
-      record_class.delete_all
+      query_scope.delete_all
     end
 
     private
 
-    # NOTE: Don't memoize the record_class or code reloading will break in rails apps.
-    def record_class
-      "#{self.class.name}::Record".constantize
-    end
-
-    # Will attempt to use Project as the entity class when
-    # the mapper class name is ProjectMapper.
-    def entity_class
-      self.class.name.sub(/Mapper$/, '').constantize
-    end
-
     def accessible_attributes(entity)
       entity.attributes.reject { |k, v| protected_attributes.include?(k.to_s) }
     end
@@ -110,21 +109,25 @@ module Minimapper
       record.attributes = accessible_attributes(entity)
     end
 
+    def copy_attributes_to_entity(record, entity)
+      entity.attributes = record.attributes.symbolize_keys
+    end
+
     def validate_record_and_copy_errors_to_entity(record, entity)
       record.valid?
       entity.mapper_errors = record.errors.map { |k, v| [k, v] }
     end
 
     def find_record_safely(id)
-      record_class.find(id)
+      query_scope.find(id)
     end
 
     def find_record(id)
-      id && record_class.find_by_id(id)
+      id && query_scope.find_by_id(id)
     end
 
     def record_for(entity)
-      record_class.find(entity.id)
+      query_scope.find(entity.id)
     end
 
     def entities_for(records, klass = entity_class)
@@ -136,7 +139,7 @@ module Minimapper
         entity = klass.new
         entity.id = record.id
         entity.mark_as_persisted
-        entity.attributes = record.attributes.symbolize_keys
+        copy_attributes_to_entity(record, entity)
 
         if klass == entity_class
           after_find(entity, record)
@@ -164,6 +167,22 @@ module Minimapper
       result
     end
 
+    # Override to customize default includes etc that apply to all queries
+    def query_scope
+      record_class
+    end
+
+    # NOTE: Don't memoize the record_class or code reloading will break in rails apps.
+    def record_class
+      "#{self.class.name}::Record".constantize
+    end
+
+    # Will attempt to use Project as the entity class when
+    # the mapper class name is ProjectMapper.
+    def entity_class
+      self.class.name.sub(/Mapper$/, '').constantize
+    end
+
     # Hooks
 
     def after_find(entity, record)

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.10.0"
+  VERSION = "0.10.1"
 end

data/spec/mapper_spec.rb

@@ -137,6 +137,22 @@ describe Minimapper::Mapper do
     end
   end
 
+  describe "#create!" do
+    it "can create records" do
+      entity = build_valid_entity
+      mapper.create!(entity)
+      entity.should be_persisted
+    end
+
+    it "raises Minimapper::EntityInvalid when the entity is invalid" do
+      entity = entity_class.new
+      def entity.valid?
+        false
+      end
+      lambda { mapper.create!(entity) }.should raise_error(Minimapper::EntityInvalid)
+    end
+  end
+
   describe "#find" do
     it "returns an entity matching the id" do
       entity = build_valid_entity
@@ -400,6 +416,25 @@ describe Minimapper::Mapper do
     end
   end
 
+  describe "#update!" do
+    it "can update records" do
+      entity = build_valid_entity
+      mapper.create(entity)
+      entity.attributes[:email] = "updated@example.com"
+      mapper.update!(entity)
+      mapper.reload(entity).attributes[:email].should == "updated@example.com"
+    end
+
+    it "raises Minimapper::EntityInvalid when the entity is invalid" do
+      entity = build_valid_entity
+      mapper.create(entity)
+      def entity.valid?
+        false
+      end
+      lambda { mapper.update!(entity) }.should raise_error(Minimapper::EntityInvalid)
+    end
+  end
+
   describe "#delete" do
     it "removes the entity" do
       entity = build_valid_entity

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70186737281960 !ruby/object:Gem::Requirement
+  requirement: &70105129258360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70186737281960
+  version_requirements: *70105129258360
 description: A minimalistic way of separating your models from ActiveRecord.
 email:
 - joakim.kolsjo@gmail.com
@@ -45,6 +45,7 @@ files:
 - lib/minimapper/entity/core.rb
 - lib/minimapper/entity/rails.rb
 - lib/minimapper/entity/validation.rb
+- lib/minimapper/entity_invalid.rb
 - lib/minimapper/mapper.rb
 - lib/minimapper/repository.rb
 - lib/minimapper/version.rb
@@ -76,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -374043645528492869
+      hash: 3246960416648791491
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,10 +86,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -374043645528492869
+      hash: 3246960416648791491
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A minimalistic way of separating your models from ActiveRecord.