minimapper 0.8.0 → 0.9.0

data/Gemfile

@@ -2,7 +2,10 @@ source 'https://rubygems.org'
 
 # We don't require active_record to use minimapper, only to
 # use minimapper/mapper/ar. We do require it for the tests though :)
-gem "activerecord"
+#
+# Also locked to below rails 4.0 as our specs use rails 3 features. Need to look into
+# if there are any issues with rails 4.
+gem "activerecord", "< 4.0"
 gem "rspec"
 
 platforms :ruby do

data/README.md

@@ -113,7 +113,7 @@ Repository = Minimapper::Repository.build({
 
 user = User.new(:name => "Joe")
 Repository.users.create(user)
-p repository.users.find(user.id).name # => Joe
+p Repository.users.find(user.id).name # => Joe
 Repository.users.delete_all
 
 ## Using ActiveModel validations
@@ -168,7 +168,7 @@ end
 
 `entity_for` returns nil for nil.
 
-It takes an optional second argument if you want a different entity class than the mapper's:
+`entity_for` and `entities_for` take an optional second argument if you want a different entity class than the mapper's:
 
 ```
 class ProjectMapper < Minimapper::AR
@@ -186,15 +186,15 @@ If you specify type, Minimapper will only allow values of that type, or strings
 The latter means that it can accept e.g. string integers directly from a form.
 Minimapper aims to be much less of a form value parser than ActiveRecord, but we'll allow ourselves conveniences like this.
 
-Supported types: Integer and DateTime (`:integer` and `:date_time`).
+Supported types: Integer and DateTime.
 
 ``` ruby
 class User
   include Minimapper::Entity
-  attributes [ :profile_id, :integer ]
+  attributes [ :profile_id, Integer ]
 
   # Or for single attributes:
-  # attribute :profile_id, :integer
+  # attribute :profile_id, Integer
 end
 
 User.new(:profile_id => "10").profile_id      # => 10
@@ -226,6 +226,8 @@ User.new(:reminder_on => "2012-01-01").reminder # => #<Date: 2012-01-01 ...>
 
 Minimapper only calls #convert on non-empty strings. When the value is blank or nil, the attribute is set to nil.
 
+(FIXME? We're considering changing this so Minimapper core can only enforce type, and there's some `Minimapper::FormObject` mixin to parse string values.)
+
 ### Overriding attribute accessors
 
 Attribute readers and writers are implemented so that you can override them with inheritance:
@@ -277,6 +279,35 @@ class ProjectMapper < Minimapper::AR
 end
 ```
 
+### Deletion
+
+When you do `mapper.delete(entity)`, it will use [ActiveRecord's `delete`](http://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-destroy), which means that no destroy callbacks or `:dependent` association options are honored.
+
+(FIXME?: Should we support `destroy` instead or as well?)
+
+### Exceptions and status 404
+
+Code like `UserMapper.find(123)` will raise `Minimapper::EntityNotFound` if there's no such record.
+
+Rails treats the similar `ActiveRecord::RecordNotFound` exception as a 404 error, using that status code with the error backtrace in development and test, and showing the 404 page in production.
+
+If you want the same for Minimapper, you can add a `config/initializers/minimapper.rb` containing:
+
+``` ruby
+# For 404 status with the dev/test backtrace, and a 404 page in production.
+ActionDispatch::ExceptionWrapper.rescue_responses.merge!(
+  "Minimapper::EntityNotFound" => :not_found
+)
+```
+
+You may also want to ignore those errors in your error logger. With [Honeybadger](https://www.honeybadger.io), you do:
+
+``` ruby
+Honeybadger.configure do |config|
+  config.ignore << "Minimapper::EntityNotFound"
+end
+```
+
 ### Custom entity class
 
 [Minimapper::Entity](https://github.com/joakimk/minimapper/blob/master/lib/minimapper/entity.rb) adds some convenience methods for when a model is used within a Rails application. If you don't need that you can just include the core API from the [Minimapper::Entity::Core](https://github.com/joakimk/minimapper/blob/master/lib/minimapper/entity/core.rb) module (or implement your own version that behaves like [Minimapper::Entity::Core](https://github.com/joakimk/minimapper/blob/master/lib/minimapper/entity/core.rb)).

data/lib/minimapper/entity.rb

@@ -21,9 +21,9 @@ module Minimapper
       klass.send(:include, Minimapper::Entity::Validation)
       klass.send(:include, Minimapper::Entity::Rails)
       klass.attributes(
-        [ :id, :integer ],
-        [ :created_at, :date_time ],
-        [ :updated_at, :date_time ]
+        [ :id, Integer ],
+        [ :created_at, DateTime ],
+        [ :updated_at, DateTime ]
       )
     end
   end

data/lib/minimapper/entity/convert.rb

@@ -14,8 +14,8 @@ module Minimapper
         @@converters[type] = converter
       end
 
-      register_converter :integer,   ToInteger.new
-      register_converter :date_time, ToDateTime.new
+      register_converter Integer,   ToInteger.new
+      register_converter DateTime, ToDateTime.new
 
       def to(type)
         return nil   if     value != false && value.blank?

data/lib/minimapper/entity/core.rb

@@ -30,6 +30,18 @@ module Minimapper
         @mapper_errors = list
       end
 
+      def persisted?
+        @entity_is_persisted
+      end
+
+      def mark_as_persisted
+        @entity_is_persisted = true
+      end
+
+      def mark_as_not_persisted
+        @entity_is_persisted = false
+      end
+
       private
 
       def symbolize_keys(hash)

data/lib/minimapper/entity/rails.rb

@@ -9,12 +9,13 @@ module Minimapper
         id
       end
 
+      # Implemented in core.
       def persisted?
-        id
+        super
       end
 
       def new_record?
-        !id
+        !persisted?
       end
 
       def to_model

data/lib/minimapper/mapper.rb

@@ -14,6 +14,7 @@ module Minimapper
 
       if entity.valid?
         record.save!
+        entity.mark_as_persisted
         entity.id = record.id
         entity.id
       else
@@ -67,7 +68,7 @@ module Minimapper
 
     def delete(entity)
       delete_by_id(entity.id)
-      entity.id = nil
+      entity.mark_as_not_persisted
     end
 
     def delete_by_id(id)
@@ -122,14 +123,15 @@ module Minimapper
         raise(EntityNotFound, entity.inspect)
     end
 
-    def entities_for(records)
-      records.map { |record| entity_for(record) }
+    def entities_for(records, klass = entity_class)
+      records.map { |record| entity_for(record, klass) }
     end
 
     def entity_for(record, klass = entity_class)
       if record
         entity = klass.new
         entity.id = record.id
+        entity.mark_as_persisted
         entity.attributes = record.attributes.symbolize_keys
 
         if klass == entity_class

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/spec/support/shared_examples/mapper.rb

@@ -18,6 +18,13 @@ shared_examples :mapper do
       entity2.id.should == entity1.id + 1
     end
 
+    it "marks the entity as persisted" do
+      entity1 = build_valid_entity
+      entity1.should_not be_persisted
+      mapper.create(entity1)
+      entity1.should be_persisted
+    end
+
     it "returns the id" do
       id = mapper.create(build_valid_entity)
       id.should be_kind_of(Fixnum)
@@ -70,6 +77,13 @@ shared_examples :mapper do
       found_entity = mapper.find(entity.id)
     end
 
+    it "returns an entity marked as persisted" do
+      entity = build_valid_entity
+      mapper.create(entity)
+      found_entity = mapper.find(entity.id)
+      found_entity.should be_persisted
+    end
+
     it "fails when an entity can not be found" do
       lambda { mapper.find(-1) }.should raise_error(Minimapper::EntityNotFound)
     end
@@ -228,12 +242,12 @@ shared_examples :mapper do
       mapper.first.id.should_not == removed_entity_id
     end
 
-    it "clears the entity id" do
+    it "marks the entity as no longer persisted" do
       entity = build_valid_entity
       mapper.create(entity)
-      entity.id.should_not be_nil
+      entity.should be_persisted
       mapper.delete(entity)
-      entity.id.should be_nil
+      entity.should_not be_persisted
     end
 
     it "fails when the entity does not have an id" do

data/unit/entity/attributes_spec.rb

@@ -5,7 +5,7 @@ module Attribute
   class User
     include Minimapper::Entity::Core
     include Minimapper::Entity::Attributes
-    attribute :id, :integer
+    attribute :id, Integer
     attribute  :name
   end
 
@@ -23,7 +23,7 @@ module Attribute
     include Minimapper::Entity::Core
     include Minimapper::Entity::Attributes
 
-    attribute :due_at, :date_time
+    attribute :due_at, DateTime
   end
 
   class OverridingUser

data/unit/entity/convert_spec.rb

@@ -1,34 +1,34 @@
 require 'minimapper/entity/convert'
 
 describe Minimapper::Entity::Convert do
-  describe ":integer" do
+  describe "Integer" do
     it "allows integers" do
-      described_class.new(10).to(:integer).should == 10
+      described_class.new(10).to(Integer).should == 10
     end
 
     it "converts strings into integers" do
-      described_class.new('10').to(:integer).should == 10
-      described_class.new(' 10 ').to(:integer).should == 10
+      described_class.new('10').to(Integer).should == 10
+      described_class.new(' 10 ').to(Integer).should == 10
     end
 
     it "makes it nil when it can't convert" do
-      described_class.new(' ').to(:integer).should be_nil
-      described_class.new('garbage').to(:integer).should be_nil
+      described_class.new(' ').to(Integer).should be_nil
+      described_class.new('garbage').to(Integer).should be_nil
     end
   end
 
-  describe ":date_time" do
+  describe "DateTime" do
     it "allows DateTimes" do
-      described_class.new(DateTime.new(2013, 6, 1)).to(:date_time).should == DateTime.new(2013, 6, 1)
+      described_class.new(DateTime.new(2013, 6, 1)).to(DateTime).should == DateTime.new(2013, 6, 1)
     end
 
     it "converts datetime strings into datetimes" do
-      described_class.new('2012-01-01 20:57').to(:date_time).should == DateTime.new(2012, 01, 01, 20, 57)
+      described_class.new('2012-01-01 20:57').to(DateTime).should == DateTime.new(2012, 01, 01, 20, 57)
     end
 
     it "makes it nil when it can't convert" do
-      described_class.new(' ').to(:date_time).should be_nil
-      described_class.new('garbage').to(:date_time).should be_nil
+      described_class.new(' ').to(DateTime).should be_nil
+      described_class.new('garbage').to(DateTime).should be_nil
     end
   end
 

data/unit/entity/rails_spec.rb

@@ -9,20 +9,21 @@ end
 describe Minimapper::Entity::Rails do
   it "responds to new_record?" do
     entity = RailsEntity.new
-    entity.should be_new_record
-    entity.id = 5
-    entity.should_not be_new_record
+    entity.new_record?.should be_true
+    entity.mark_as_persisted
+    entity.new_record?.should be_false
   end
 
-  it "resonds to to_model" do
+  it "responds to to_model" do
     entity = RailsEntity.new
     entity.to_model.should == entity
   end
 
   it "responds to to_key" do
     entity = RailsEntity.new
-    entity.to_key.should be_nil
     entity.id = 5
+    entity.to_key.should be_nil
+    entity.mark_as_persisted
     entity.to_key.should == [ 5 ]
   end
 
@@ -37,7 +38,7 @@ describe Minimapper::Entity::Rails do
   it "responds to persisted?" do
     entity = RailsEntity.new
     entity.should_not be_persisted
-    entity.id = 5
+    entity.mark_as_persisted
     entity.should be_persisted
   end
 end

data/unit/repository_spec.rb

@@ -25,8 +25,8 @@ describe Minimapper::Repository, "self.build" do
   end
 
   it "does not leak between instances" do
-    mapper1 = mock.as_null_object
-    mapper2 = mock.as_null_object
+    mapper1 = double.as_null_object
+    mapper2 = double.as_null_object
     repository1 = described_class.build(:projects => mapper1)
     repository2 = described_class.build(:projects => mapper2)
     repository1.projects.should == mapper1
@@ -36,8 +36,8 @@ end
 
 describe Minimapper::Repository, "#delete_all!" do
   it "removes all records by calling delete_all on all mappers" do
-    project_mapper = mock.as_null_object
-    user_mapper = mock.as_null_object
+    project_mapper = double.as_null_object
+    user_mapper = double.as_null_object
 
     project_mapper.should_receive(:delete_all)
     user_mapper.should_receive(:delete_all)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70270060752600 !ruby/object:Gem::Requirement
+  requirement: &70096190311420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270060752600
+  version_requirements: *70096190311420
 description: A minimalistic way of separating your models from ActiveRecord.
 email:
 - joakim.kolsjo@gmail.com
@@ -75,12 +75,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2287659495149187599
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2287659495149187599
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5