minimapper 0.2.0 → 0.2.1

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://secure.travis-ci.org/joakimk/minimapper.png)](http://travis-ci.org/joakimk/minimapper)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/joakimk/minimapper)
 
 # Minimapper
 
@@ -49,10 +50,10 @@ Please avoid installing directly from the github repository. Code will be pushed
 
 ### Basics
 
-You can use the mappers like this (**it's runnable, try copy and pasting it into a ruby file** or [use this gist](https://gist.github.com/3904952)):
+You can use the mappers like this (<strong>it's runnable, try copy and pasting it into a ruby file</strong> or [use this gist](https://gist.github.com/3904952)):
 
 ``` ruby
-# minimapper_test.rb
+# minimapper_example.rb
 require "rubygems"
 require "minimapper"
 require "minimapper/entity"
@@ -75,20 +76,20 @@ user_mapper.create(user)
 
 ## Finding
 user = user_mapper.find(user.id)
-puts user.name             # => Joe
-puts user_mapper.first.name     # => Joe
+p user.name              # => Joe
+p user_mapper.first.name # => Joe
 
 ## Updating
 user.name = "Joey"
 user_mapper.update(user)
-puts user_mapper.first.name    # => Joey
+p user_mapper.first.name # => Joey
 
 ## Deleting
 old_id = user.id
 user_mapper.delete(user)
-puts user.id                   # => nil
-puts user_mapper.find_by_id(old_id) # => nil
-# user_mapper.find(old_id)          # raises Minimapper::Common::CanNotFindEntity
+p user.id                        # => nil
+p user_mapper.find_by_id(old_id) # => nil
+# user_mapper.find(old_id)       # raises Minimapper::Common::CanNotFindEntity
 # user_mapper.delete_all
 # user_mapper.delete_by_id(1)
 
@@ -102,13 +103,14 @@ repository = Minimapper::Repository.build({
 
 user = User.new(:name => "Joe")
 repository.users.create(user)
-puts repository.users.find(user.id).name # => Joe
+p repository.users.find(user.id).name # => Joe
+repository.users.delete_all
 
 ## Using ActiveModel validations
 user = User.new
 repository.users.create(user)
-puts repository.users.count    # => 0
-puts user.errors.full_messages # Name can't be blank
+p repository.users.count    # => 0
+p user.errors.full_messages # Name can't be blank
 ```
 
 ### ActiveRecord
@@ -165,7 +167,7 @@ And then use it like this:
 ``` ruby
 # repository = Minimapper::Repository.build(...)
 repository.projects.waiting_for_review.each do |project|
-  puts project.name
+  p project.name
 end
 ```
 
@@ -210,6 +212,10 @@ 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.
 
+### Associations
+
+There is no built in support for associations yet, but you can handle them manually (see https://github.com/joakimk/minimapper/issues/3).
+
 ### 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/ar.rb

@@ -2,6 +2,8 @@ require "minimapper/common"
 
 module Minimapper
   class AR
+    include Common
+
     # Create
     def create(entity)
       if entity.valid?

data/lib/minimapper/common.rb

@@ -1,5 +1,7 @@
 module Minimapper
   module Common
     CanNotFindEntity            = Class.new(StandardError)
+
+    attr_accessor :repository
   end
 end

data/lib/minimapper/entity/convert.rb

@@ -13,6 +13,9 @@ module Minimapper
         @@converters[type] = converter
       end
 
+      register_converter :integer,   ToInteger.new
+      register_converter :date_time, ToDateTime.new
+
       def to(type)
         return nil if value.blank?
         return value unless value.is_a?(String)
@@ -20,9 +23,6 @@ module Minimapper
         converter_for(type).convert(value)
       end
 
-      register_converter :integer,  ToInteger.new
-      register_converter :date_time, ToDateTime.new
-
       private
 
       def converter_for(type)

data/lib/minimapper/memory.rb

@@ -2,6 +2,8 @@ require 'minimapper/common'
 
 module Minimapper
   class Memory
+    include Common
+
     def initialize
       @store = []
       @last_id = 0

data/lib/minimapper/repository.rb

@@ -6,6 +6,7 @@ module Minimapper
 
     def initialize(mappers)
       @mappers = mappers
+      assign_repository_instance
       define_mapper_methods
     end
 
@@ -15,6 +16,12 @@ module Minimapper
 
     private
 
+    def assign_repository_instance
+      mappers.each do |name, instance|
+        instance.repository = self
+      end
+    end
+
     def define_mapper_methods
       mappers.each do |name, instance|
         singleton = (class << self; self end)

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/ar_spec.rb

@@ -24,7 +24,7 @@ class TestMapper < Minimapper::AR
 end
 
 describe Minimapper::AR do
-  let(:repository) { TestMapper.new }
+  let(:mapper) { TestMapper.new }
   let(:entity_class) { TestEntity }
 
   include_examples :mapper

data/spec/support/shared_examples/mapper.rb

@@ -1,29 +1,34 @@
 shared_examples :mapper do
-  # expects repository and entity_class to be defined
+  # expects mapper and entity_class to be defined
+
+  it "can set and get repository" do
+    mapper.repository = :repository_instance
+    mapper.repository.should == :repository_instance
+  end
 
   describe "#create" do
     it "sets an id on the entity" do
       entity1 = build_valid_entity
       entity1.id.should be_nil
-      repository.create(entity1)
+      mapper.create(entity1)
       entity1.id.should > 0
 
       entity2 = build_valid_entity
-      repository.create(entity2)
+      mapper.create(entity2)
       entity2.id.should == entity1.id + 1
     end
 
     it "returns the id" do
-      id = repository.create(build_valid_entity)
+      id = mapper.create(build_valid_entity)
       id.should be_kind_of(Fixnum)
       id.should > 0
     end
 
     it "does not store by reference" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.last.object_id.should_not == entity.object_id
-      repository.last.attributes[:name].should == "test"
+      mapper.create(entity)
+      mapper.last.object_id.should_not == entity.object_id
+      mapper.last.attributes[:name].should == "test"
     end
 
     it "validates the record before saving" do
@@ -31,15 +36,15 @@ shared_examples :mapper do
       def entity.valid?
         false
       end
-      repository.create(entity).should be_false
+      mapper.create(entity).should be_false
     end
   end
 
   describe "#find" do
     it "returns an entity matching the id" do
       entity = build_valid_entity
-      repository.create(entity)
-      found_entity = repository.find(entity.id)
+      mapper.create(entity)
+      found_entity = mapper.find(entity.id)
       found_entity.attributes[:name].should == "test"
       found_entity.id.should == entity.id
       found_entity.should be_kind_of(Minimapper::Entity::Core)
@@ -47,27 +52,27 @@ shared_examples :mapper do
 
     it "supports string ids" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.find(entity.id.to_s)
+      mapper.create(entity)
+      mapper.find(entity.id.to_s)
     end
 
     it "does not return the same instance" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.find(entity.id).object_id.should_not == entity.object_id
-      repository.find(entity.id).object_id.should_not == repository.find(entity.id).object_id
+      mapper.create(entity)
+      mapper.find(entity.id).object_id.should_not == entity.object_id
+      mapper.find(entity.id).object_id.should_not == mapper.find(entity.id).object_id
     end
 
     it "fails when an entity can not be found" do
-      lambda { repository.find(-1) }.should raise_error(Minimapper::Common::CanNotFindEntity)
+      lambda { mapper.find(-1) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
   end
 
   describe "#find_by_id" do
     it "returns an entity matching the id" do
       entity = build_valid_entity
-      repository.create(entity)
-      found_entity = repository.find_by_id(entity.id)
+      mapper.create(entity)
+      found_entity = mapper.find_by_id(entity.id)
       found_entity.attributes[:name].should == "test"
       found_entity.id.should == entity.id
       found_entity.should be_kind_of(Minimapper::Entity::Core)
@@ -75,19 +80,19 @@ shared_examples :mapper do
 
     it "supports string ids" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.find_by_id(entity.id.to_s)
+      mapper.create(entity)
+      mapper.find_by_id(entity.id.to_s)
     end
 
     it "does not return the same instance" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.find_by_id(entity.id).object_id.should_not == entity.object_id
-      repository.find_by_id(entity.id).object_id.should_not == repository.find_by_id(entity.id).object_id
+      mapper.create(entity)
+      mapper.find_by_id(entity.id).object_id.should_not == entity.object_id
+      mapper.find_by_id(entity.id).object_id.should_not == mapper.find_by_id(entity.id).object_id
     end
 
     it "returns nil when an entity can not be found" do
-      repository.find_by_id(-1).should be_nil
+      mapper.find_by_id(-1).should be_nil
     end
   end
 
@@ -95,9 +100,9 @@ shared_examples :mapper do
     it "returns all entities in undefined order" do
       first_created_entity = build_valid_entity
       second_created_entity = build_valid_entity
-      repository.create(first_created_entity)
-      repository.create(second_created_entity)
-      all_entities = repository.all
+      mapper.create(first_created_entity)
+      mapper.create(second_created_entity)
+      all_entities = mapper.all
       all_entities.map(&:id).should include(first_created_entity.id)
       all_entities.map(&:id).should include(second_created_entity.id)
       all_entities.first.should be_kind_of(Minimapper::Entity::Core)
@@ -105,103 +110,103 @@ shared_examples :mapper do
 
     it "does not return the same instances" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.all.first.object_id.should_not == entity.object_id
-      repository.all.first.object_id.should_not == repository.all.first.object_id
+      mapper.create(entity)
+      mapper.all.first.object_id.should_not == entity.object_id
+      mapper.all.first.object_id.should_not == mapper.all.first.object_id
     end
   end
 
   describe "#first" do
     it "returns the first entity" do
       first_created_entity = build_valid_entity
-      repository.create(first_created_entity)
-      repository.create(build_valid_entity)
-      repository.first.id.should == first_created_entity.id
-      repository.first.should be_kind_of(entity_class)
+      mapper.create(first_created_entity)
+      mapper.create(build_valid_entity)
+      mapper.first.id.should == first_created_entity.id
+      mapper.first.should be_kind_of(entity_class)
     end
 
     it "does not return the same instance" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.first.object_id.should_not == entity.object_id
-      repository.first.object_id.should_not == repository.first.object_id
+      mapper.create(entity)
+      mapper.first.object_id.should_not == entity.object_id
+      mapper.first.object_id.should_not == mapper.first.object_id
     end
 
     it "returns nil when there is no entity" do
-      repository.first.should be_nil
+      mapper.first.should be_nil
     end
   end
 
   describe "#last" do
     it "returns the last entity" do
       last_created_entity = build_valid_entity
-      repository.create(build_valid_entity)
-      repository.create(last_created_entity)
-      repository.last.id.should == last_created_entity.id
-      repository.last.should be_kind_of(entity_class)
+      mapper.create(build_valid_entity)
+      mapper.create(last_created_entity)
+      mapper.last.id.should == last_created_entity.id
+      mapper.last.should be_kind_of(entity_class)
     end
 
     it "does not return the same instance" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.last.object_id.should_not == entity.object_id
-      repository.last.object_id.should_not == repository.last.object_id
+      mapper.create(entity)
+      mapper.last.object_id.should_not == entity.object_id
+      mapper.last.object_id.should_not == mapper.last.object_id
     end
 
     it "returns nil when there is no entity" do
-      repository.last.should be_nil
+      mapper.last.should be_nil
     end
   end
 
   describe "#count" do
     it "returns the number of entities" do
-      repository.create(build_valid_entity)
-      repository.create(build_valid_entity)
-      repository.count.should == 2
+      mapper.create(build_valid_entity)
+      mapper.create(build_valid_entity)
+      mapper.count.should == 2
     end
   end
 
   describe "#update" do
     it "updates" do
       entity = build_valid_entity
-      repository.create(entity)
+      mapper.create(entity)
 
       entity.attributes = { :name => "Updated" }
-      repository.last.attributes[:name].should == "test"
+      mapper.last.attributes[:name].should == "test"
 
-      repository.update(entity)
-      repository.last.id.should == entity.id
-      repository.last.attributes[:name].should == "Updated"
+      mapper.update(entity)
+      mapper.last.id.should == entity.id
+      mapper.last.attributes[:name].should == "Updated"
     end
 
     it "does not update and returns false when the entity isn't valid" do
       entity = build_valid_entity
-      repository.create(entity)
+      mapper.create(entity)
 
       def entity.valid?
         false
       end
 
-      repository.update(entity).should be_false
-      repository.last.attributes[:name].should == "test"
+      mapper.update(entity).should be_false
+      mapper.last.attributes[:name].should == "test"
     end
 
     it "returns true" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.update(entity).should == true
+      mapper.create(entity)
+      mapper.update(entity).should == true
     end
 
     it "fails when the entity does not have an id" do
       entity = build_valid_entity
-      lambda { repository.update(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
+      lambda { mapper.update(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
 
     it "fails when the entity no longer exists" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.delete_all
-      lambda { repository.update(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
+      mapper.create(entity)
+      mapper.delete_all
+      lambda { mapper.update(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
   end
 
@@ -209,53 +214,53 @@ shared_examples :mapper do
     it "removes the entity" do
       entity = build_valid_entity
       removed_entity_id = entity.id
-      repository.create(entity)
-      repository.create(build_valid_entity)
-      repository.delete(entity)
-      repository.all.size.should == 1
-      repository.first.id.should_not == removed_entity_id
+      mapper.create(entity)
+      mapper.create(build_valid_entity)
+      mapper.delete(entity)
+      mapper.all.size.should == 1
+      mapper.first.id.should_not == removed_entity_id
     end
 
     it "clears the entity id" do
       entity = build_valid_entity
-      repository.create(entity)
+      mapper.create(entity)
       entity.id.should_not be_nil
-      repository.delete(entity)
+      mapper.delete(entity)
       entity.id.should be_nil
     end
 
     it "fails when the entity does not have an id" do
       entity = entity_class.new
-      lambda { repository.delete(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
+      lambda { mapper.delete(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
 
     it "fails when the entity can not be found" do
       entity = entity_class.new
       entity.id = -1
-      lambda { repository.delete(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
+      lambda { mapper.delete(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
   end
 
   describe "#delete_by_id" do
     it "removes the entity" do
       entity = build_valid_entity
-      repository.create(entity)
-      repository.create(build_valid_entity)
-      repository.delete_by_id(entity.id)
-      repository.all.size.should == 1
-      repository.first.id.should_not == entity.id
+      mapper.create(entity)
+      mapper.create(build_valid_entity)
+      mapper.delete_by_id(entity.id)
+      mapper.all.size.should == 1
+      mapper.first.id.should_not == entity.id
     end
 
     it "fails when an entity can not be found" do
-      lambda { repository.delete_by_id(-1) }.should raise_error(Minimapper::Common::CanNotFindEntity)
+      lambda { mapper.delete_by_id(-1) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
   end
 
   describe "#delete_all" do
-    it "empties the repository" do
-      repository.create(build_valid_entity)
-      repository.delete_all
-      repository.all.should == []
+    it "empties the mapper" do
+      mapper.create(build_valid_entity)
+      mapper.delete_all
+      mapper.all.should == []
     end
   end
 

data/unit/entity_spec.rb

@@ -45,6 +45,12 @@ describe Minimapper::Entity do
     entity.id.should == 15
   end
 
+  it "sets blank values to nil" do
+    user = TestUser.new
+    user.name = "  "
+    user.name.should be_nil
+  end
+
   it "symbolizes keys" do
     entity = TestEntity.new
     entity.attributes = { "id" => "15" }

data/unit/memory_spec.rb

@@ -6,7 +6,7 @@ class BasicEntity
 end
 
 describe Minimapper::Memory do
-  let(:repository) { described_class.new }
+  let(:mapper) { described_class.new }
   let(:entity_class) { BasicEntity }
 
   include_examples :mapper

data/unit/repository_spec.rb

@@ -18,18 +18,26 @@ describe Minimapper::Repository, "self.build" do
     repository.projects.object_id.should == repository.projects.object_id
   end
 
+  it "adds a reference to the repository" do
+    mapper = Test::ProjectMapper.new
+    repository = described_class.build(:projects => mapper)
+    mapper.repository.should == repository
+  end
+
   it "does not leak between instances" do
-    repository1 = described_class.build(:projects => :foo)
-    repository2 = described_class.build(:projects => :bar)
-    repository1.projects.should == :foo
-    repository2.projects.should == :bar
+    mapper1 = mock.as_null_object
+    mapper2 = mock.as_null_object
+    repository1 = described_class.build(:projects => mapper1)
+    repository2 = described_class.build(:projects => mapper2)
+    repository1.projects.should == mapper1
+    repository2.projects.should == mapper2
   end
 end
 
 describe Minimapper::Repository, "#delete_all!" do
   it "removes all records by calling delete_all on all mappers" do
-    project_mapper = mock
-    user_mapper = mock
+    project_mapper = mock.as_null_object
+    user_mapper = mock.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.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70328752668500 !ruby/object:Gem::Requirement
+  requirement: &70175304808520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328752668500
+  version_requirements: *70175304808520
 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: -4540271108059572460
+      hash: 899466324574471464
 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: -4540271108059572460
+      hash: 899466324574471464
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5