minimapper 0.0.5 → 0.1.0

data/README.md

@@ -61,7 +61,8 @@ require "minimapper"
 require "minimapper/entity"
 require "minimapper/memory"
 
-class User < Minimapper::Entity
+class User
+  include Minimapper::Entity
   attributes :name, :email
   validates :name, :presence => true
 end
@@ -178,7 +179,8 @@ It gets simpler to maintain if you use shared tests to test both implementations
 # Supported types: Integer, DateTime
 # TODO: Will probably not support more types, but instead provide a way to add custom conversions.
 
-class User < Minimapper::Entity
+class User
+  include Minimapper::Entity
   attributes [ :profile_id, Integer ]
 end
 
@@ -243,7 +245,6 @@ You need mysql and postgres installed (but they do not have to be running) to be
 * 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 Minimapper::Entity a module so you won't have to inherit from it.
 * 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/entity/convert.rb

@@ -1,5 +1,5 @@
 module Minimapper
-  class Entity
+  module Entity
     class Convert
       def initialize(value)
         @value = value

data/lib/minimapper/entity.rb

@@ -1,52 +1,55 @@
 # 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 convert this to a module and add shared examples that cover
-# the API which minimapper depends upon.
+# 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.
 require 'informal'
 require 'minimapper/entity/convert'
 
 module Minimapper
-  class Entity
-    include Informal::Model
-
-    def self.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
+  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
 
-    def initialize(*opts)
-      @attributes = {}
-      super(*opts)
-    end
+    module InstanceMethods
+      def to_param
+        id
+      end
 
-    def to_param
-      id
-    end
+      def persisted?
+        id
+      end
 
-    def persisted?
-      id
+      def attributes
+        @attributes ||= {}
+      end
     end
 
-    attributes [ :id, Integer ], [ :created_at, DateTime ], [ :updated_at, DateTime ]
-
-    attr_reader :attributes
+    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 ]
+    end
   end
 end

data/lib/minimapper/version.rb

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

data/spec/ar_spec.rb

@@ -2,7 +2,8 @@ require "spec_helper"
 require "minimapper/entity"
 require "minimapper/ar"
 
-class TestEntity < Minimapper::Entity
+class TestEntity
+  include Minimapper::Entity
   attributes :name, :github_url
   validates :name, :presence => true
 end

data/unit/entity_spec.rb

@@ -1,27 +1,37 @@
 require 'minimapper/entity'
 
+class TestEntity
+  include Minimapper::Entity
+end
+
 describe Minimapper::Entity do
   it "handles base attributes" do
-    base = described_class.new
-    base.id = 5
-    base.id.should == 5
+    entity = TestEntity.new
+    entity.id = 5
+    entity.id.should == 5
 
     time = Time.now
-    base.created_at = time
-    base.created_at.should == time
+    entity.created_at = time
+    entity.created_at.should == time
+
+    entity.updated_at = time
+    entity.updated_at.should == time
+  end
 
-    base.updated_at = time
-    base.updated_at.should == time
+  it "can access attributes set at construction time" do
+    entity = TestEntity.new(:id => 5)
+    entity.id.should == 5
   end
 
   it "converts typed attributes" do
-    base = described_class.new
-    base.id = "10"
-    base.id.should == 10
+    entity = TestEntity.new
+    entity.id = "10"
+    entity.id.should == 10
   end
 end
 
-class TestUser < Minimapper::Entity
+class TestUser
+  include Minimapper::Entity
   attributes :name
 end
 
@@ -37,25 +47,25 @@ end
 
 describe Minimapper::Entity, "attributes" do
   it "returns the attributes" do
-    base = described_class.new(:id => 5)
+    entity = TestEntity.new(:id => 5)
     time = Time.now
-    base.created_at = time
-    base.attributes.should == { :id => 5, :created_at => time }
+    entity.created_at = time
+    entity.attributes.should == { :id => 5, :created_at => time }
   end
 end
 
 describe Minimapper::Entity, "to_param" do
   it "responds with the id to be compatible with rails link helpers" do
-    base = described_class.new(:id => 5)
-    base.to_param.should == 5
+    entity = TestEntity.new(:id => 5)
+    entity.to_param.should == 5
   end
 end
 
 describe Minimapper::Entity, "persisted?" do
   it "responds true when there is an id (to be compatible with rails form helpers)" do
-    base = described_class.new
-    base.should_not be_persisted
-    base.id = 5
-    base.should be_persisted
+    entity = TestEntity.new
+    entity.should_not be_persisted
+    entity.id = 5
+    entity.should be_persisted
   end
 end

data/unit/memory_spec.rb

@@ -1,7 +1,8 @@
 require 'minimapper/memory'
 require 'minimapper/entity'
 
-class TestEntity < Minimapper::Entity
+class TestEntity
+  include Minimapper::Entity
   attributes :name
   validates :name, :presence => true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: informal
-  requirement: &70203560076140 !ruby/object:Gem::Requirement
+  requirement: &70274943136540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70203560076140
+  version_requirements: *70274943136540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70203560075340 !ruby/object:Gem::Requirement
+  requirement: &70274943135820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70203560075340
+  version_requirements: *70274943135820
 description: A minimalistic way of separating your models from ORMs like ActiveRecord
   (by implementing the repository pattern)
 email: