minimapper 0.1.0 → 0.1.1

data/README.md

@@ -241,11 +241,11 @@ You need mysql and postgres installed (but they do not have to be running) to be
 
 ### Next
 
+* Make "informal" optional. If you only use minimapper/entity/core there is no need for it as a dependency.
 * Add some way to extend type conversions to keep that part of minimapper small.
 * Extract entity and model class lookup code from the ar-mapper and reuse it in the memory mapper.
 * Change the memory mapper to store entity attributes, not entity instances.
   - Unless this makes it difficult to handle associated data.
-* Make using Minimapper::Entity optional by providing shared examples of the behavior required by the mappers. Test the mappers with an object implementing only this behavior.
 
 ### Ideas
 

data/lib/minimapper/ar.rb

@@ -21,7 +21,7 @@ module Minimapper
     end
 
     def all
-      record_klass.all.map { |record| entity_klass.new(record.attributes) }
+      record_klass.all.map { |record| entity_for(record) }
     end
 
     def first
@@ -74,9 +74,9 @@ module Minimapper
 
     # Will attempt to use Project as the enity class when
     # the mapper class name is AR::ProjectMapper
-    def entity_klass
-      @entity_klass ||= ("::" + self.class.name.split('::').last.gsub(/Mapper/, '')).constantize
-      @entity_klass
+    def entity_class
+      @entity_class ||= ("::" + self.class.name.split('::').last.gsub(/Mapper/, '')).constantize
+      @entity_class
     end
 
     def find_record_safely(id)
@@ -95,7 +95,10 @@ module Minimapper
 
     def entity_for(record)
       if record
-        entity_klass.new(record.attributes)
+        entity = entity_class.new
+        entity.id = record.id
+        entity.attributes = record.attributes.symbolize_keys
+        entity
       else
         nil
       end

data/lib/minimapper/entity/attributes.rb

@@ -0,0 +1,27 @@
+require 'minimapper/entity/convert'
+
+module Minimapper
+  module Entity
+    module Attributes
+      def attributes(*list)
+        list.each do |attribute|
+          type = nil
+
+          if attribute.is_a?(Array)
+            attribute, type = attribute
+          end
+
+          define_method(attribute) do
+            instance_variable_get("@#{attribute}")
+          end
+
+          define_method("#{attribute}=") do |value|
+            value = Convert.new(value).to(type)
+            instance_variable_set("@#{attribute}", value)
+            attributes[attribute] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minimapper/entity/core.rb

@@ -0,0 +1,22 @@
+# The core entity API required by minimapper. If your entity
+# class implements this API, it should work with the data mappers.
+
+module Minimapper
+  module Entity
+    module Core
+      attr_accessor :id
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def attributes=(new_attributes)
+        @attributes = attributes.merge(new_attributes)
+      end
+
+      def valid?
+        true
+      end
+    end
+  end
+end

data/lib/minimapper/entity/rails.rb

@@ -0,0 +1,13 @@
+module Minimapper
+  module Entity
+    module Rails
+      def to_param
+        id
+      end
+
+      def persisted?
+        id
+      end
+    end
+  end
+end

data/lib/minimapper/entity.rb

@@ -1,55 +1,18 @@
-# Minimapper does not require you to use this entity base class. It requires a
-# few methods to be present, like valid?, attributes, attributes=.
-#
-# I plan to add shared examples that cover the API which minimapper depends upon.
-#
-# This class also does some things needed for it to work well with rails.
+# Look at minimapper/entity/core for the required API.
 require 'informal'
-require 'minimapper/entity/convert'
+require 'minimapper/entity/core'
+require 'minimapper/entity/attributes'
+require 'minimapper/entity/rails'
 
 module Minimapper
   module Entity
-    module ClassMethods
-      def attributes(*list)
-        list.each do |attribute|
-          type = nil
-
-          if attribute.is_a?(Array)
-            attribute, type = attribute
-          end
-
-          define_method(attribute) do
-            instance_variable_get("@#{attribute}")
-          end
-
-          define_method("#{attribute}=") do |value|
-            value = Convert.new(value).to(type)
-            instance_variable_set("@#{attribute}", value)
-            attributes[attribute] = value
-          end
-        end
-      end
-    end
-
-    module InstanceMethods
-      def to_param
-        id
-      end
-
-      def persisted?
-        id
-      end
-
-      def attributes
-        @attributes ||= {}
-      end
-    end
+    include Minimapper::Entity::Core
 
     def self.included(klass)
       klass.send(:include, Informal::Model)
-      klass.send(:include, InstanceMethods)
-      klass.send(:extend, ClassMethods)
-      klass.attributes [ :id, :Integer ], [ :created_at, :DateTime ], [ :updated_at, :DateTime ]
+      klass.send(:include, Minimapper::Entity::Rails)
+      klass.send(:extend, Minimapper::Entity::Attributes)
+      klass.attributes([ :id, :Integer ], [ :created_at, :DateTime ], [ :updated_at, :DateTime ])
     end
   end
 end

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/ar_spec.rb

@@ -1,17 +1,15 @@
 require "spec_helper"
-require "minimapper/entity"
+require "minimapper/entity/core"
 require "minimapper/ar"
 
 class TestEntity
-  include Minimapper::Entity
-  attributes :name, :github_url
-  validates :name, :presence => true
+  include Minimapper::Entity::Core
 end
 
 class TestMapper < Minimapper::AR
   private
 
-  def entity_klass
+  def entity_class
     TestEntity
   end
 
@@ -27,7 +25,7 @@ end
 
 describe Minimapper::AR do
   let(:repository) { TestMapper.new }
-  let(:entity_klass) { TestEntity }
+  let(:entity_class) { TestEntity }
 
   include_examples :mapper
 end

data/spec/support/shared_examples/mapper.rb

@@ -1,5 +1,5 @@
 shared_examples :mapper do
-  # expects repository and entity_klass to be defined
+  # expects repository and entity_class to be defined
 
   describe "#create" do
     it "sets an id on the entity" do
@@ -23,11 +23,14 @@ shared_examples :mapper do
       entity = build_valid_entity
       repository.create(entity)
       repository.last.object_id.should_not == entity.object_id
-      repository.last.name.should == "test"
+      repository.last.attributes[:name].should == "test"
     end
 
     it "validates the record before saving" do
-      entity = entity_klass.new
+      entity = entity_class.new
+      def entity.valid?
+        false
+      end
       repository.create(entity).should be_false
     end
   end
@@ -37,9 +40,9 @@ shared_examples :mapper do
       entity = build_valid_entity
       repository.create(entity)
       found_entity = repository.find(entity.id)
-      found_entity.name.should == "test"
+      found_entity.attributes[:name].should == "test"
       found_entity.id.should == entity.id
-      found_entity.should be_kind_of(Minimapper::Entity)
+      found_entity.should be_kind_of(Minimapper::Entity::Core)
     end
 
     it "supports string ids" do
@@ -65,9 +68,9 @@ shared_examples :mapper do
       entity = build_valid_entity
       repository.create(entity)
       found_entity = repository.find_by_id(entity.id)
-      found_entity.name.should == "test"
+      found_entity.attributes[:name].should == "test"
       found_entity.id.should == entity.id
-      found_entity.should be_kind_of(Minimapper::Entity)
+      found_entity.should be_kind_of(Minimapper::Entity::Core)
     end
 
     it "supports string ids" do
@@ -97,7 +100,7 @@ shared_examples :mapper do
       all_entities = repository.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)
+      all_entities.first.should be_kind_of(Minimapper::Entity::Core)
     end
 
     it "does not return the same instances" do
@@ -114,7 +117,7 @@ shared_examples :mapper do
       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_klass)
+      repository.first.should be_kind_of(entity_class)
     end
 
     it "does not return the same instance" do
@@ -135,7 +138,7 @@ shared_examples :mapper do
       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_klass)
+      repository.last.should be_kind_of(entity_class)
     end
 
     it "does not return the same instance" do
@@ -163,21 +166,24 @@ shared_examples :mapper do
       entity = build_valid_entity
       repository.create(entity)
 
-      entity.name = "Updated"
-      repository.last.name.should == "test"
+      entity.attributes = { :name => "Updated" }
+      repository.last.attributes[:name].should == "test"
 
       repository.update(entity)
       repository.last.id.should == entity.id
-      repository.last.name.should == "Updated"
+      repository.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)
-      entity.name = nil
+
+      def entity.valid?
+        false
+      end
 
       repository.update(entity).should be_false
-      repository.last.name.should == "test"
+      repository.last.attributes[:name].should == "test"
     end
 
     it "returns true" do
@@ -219,12 +225,13 @@ shared_examples :mapper do
     end
 
     it "fails when the entity does not have an id" do
-      entity = entity_klass.new
+      entity = entity_class.new
       lambda { repository.delete(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
 
     it "fails when the entity can not be found" do
-      entity = entity_klass.new(:id => -1)
+      entity = entity_class.new
+      entity.id = -1
       lambda { repository.delete(entity) }.should raise_error(Minimapper::Common::CanNotFindEntity)
     end
   end
@@ -255,6 +262,8 @@ shared_examples :mapper do
   private
 
   def build_valid_entity
-    entity_klass.new(:name => 'test')
+    entity = entity_class.new
+    entity.attributes = { :name => 'test' }
+    entity
   end
 end

data/unit/entity/core_spec.rb

@@ -0,0 +1,32 @@
+require 'minimapper/entity/core'
+
+class BasicEntity
+  include Minimapper::Entity::Core
+end
+
+describe Minimapper::Entity::Core do
+  it "can get and set an attributes hash" do
+    entity = BasicEntity.new
+    entity.attributes.should == {}
+    entity.attributes = { :one => 1 }
+    entity.attributes.should == { :one => 1 }
+  end
+
+  it "does not replace the existing hash" do
+    entity = BasicEntity.new
+    entity.attributes = { :one => 1 }
+    entity.attributes = { :two => 2 }
+    entity.attributes.should == { :one => 1, :two => 2 }
+  end
+
+  it "returns true for valid?" do
+    entity = BasicEntity.new
+    entity.should be_valid
+  end
+
+  it "responds to id" do
+    entity = BasicEntity.new
+    entity.id = 10
+    entity.id.should == 10
+  end
+end

data/unit/entity_spec.rb

@@ -4,6 +4,12 @@ class TestEntity
   include Minimapper::Entity
 end
 
+class TestUser
+  include Minimapper::Entity
+  attributes :name
+  validates :name, :presence => true
+end
+
 describe Minimapper::Entity do
   it "handles base attributes" do
     entity = TestEntity.new
@@ -28,11 +34,13 @@ describe Minimapper::Entity do
     entity.id = "10"
     entity.id.should == 10
   end
-end
 
-class TestUser
-  include Minimapper::Entity
-  attributes :name
+  it "applies validations" do
+    user = TestUser.new
+    user.should_not be_valid
+    user.name = "Joe"
+    user.should be_valid
+  end
 end
 
 describe Minimapper::Entity, "attributes without type" do

data/unit/memory_spec.rb

@@ -1,15 +1,13 @@
 require 'minimapper/memory'
-require 'minimapper/entity'
+require 'minimapper/entity/core'
 
-class TestEntity
-  include Minimapper::Entity
-  attributes :name
-  validates :name, :presence => true
+class BasicEntity
+  include Minimapper::Entity::Core
 end
 
 describe Minimapper::Memory do
   let(:repository) { described_class.new }
-  let(:entity_klass) { TestEntity }
+  let(:entity_class) { BasicEntity }
 
   include_examples :mapper
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: informal
-  requirement: &70274943136540 !ruby/object:Gem::Requirement
+  requirement: &70315666068220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274943136540
+  version_requirements: *70315666068220
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70274943135820 !ruby/object:Gem::Requirement
+  requirement: &70315666067440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274943135820
+  version_requirements: *70315666067440
 description: A minimalistic way of separating your models from ORMs like ActiveRecord
   (by implementing the repository pattern)
 email:
@@ -52,7 +52,10 @@ files:
 - lib/minimapper/ar.rb
 - lib/minimapper/common.rb
 - lib/minimapper/entity.rb
+- lib/minimapper/entity/attributes.rb
 - lib/minimapper/entity/convert.rb
+- lib/minimapper/entity/core.rb
+- lib/minimapper/entity/rails.rb
 - lib/minimapper/memory.rb
 - lib/minimapper/repository.rb
 - lib/minimapper/version.rb
@@ -64,6 +67,7 @@ files:
 - spec/support/database_setup.rb
 - spec/support/shared_examples/mapper.rb
 - unit/entity/convert_spec.rb
+- unit/entity/core_spec.rb
 - unit/entity_spec.rb
 - unit/memory_spec.rb
 - unit/repository_spec.rb