minimapper 0.7.0 → 0.8.0

data/README.md

@@ -123,9 +123,9 @@ p Repository.users.count    # => 0
 p user.errors.full_messages # Name can't be blank
 ```
 
-### Loading all the data you need before acting on it
+### Eager loading
 
-When using minimapper you generally want to load all data you need upfront whenever possible as you don't have lazy loading. We haven't gotten around to adding the inclusion syntax yet, but [it's quite simple to implement](https://gist.github.com/joakimk/5656945).
+When using minimapper you don't have lazy loading. We haven't gotten around to adding the association-inclusion syntax yet, but [it's quite simple to implement](https://gist.github.com/joakimk/5656945).
 
 ### Uniqueness validations and other DB validations
 
@@ -267,8 +267,6 @@ For some discussion, [see this issue](https://github.com/joakimk/minimapper/issu
 
 This is called after any kind of find and can be used for things like loading associated data.
 
-The parameters to the after_find hook differs between mappers, for example the ActiveRecord mapper provides a record as the second argument. In practice this should not be a problem as each mapper class in an app only implements one type of mapper.
-
 ``` ruby
 class ProjectMapper < Minimapper::AR
   private
@@ -320,12 +318,6 @@ You need mysql and postgres installed (but they do not have to be running) to be
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
 
-## Todo
-
-### Next
-
-* Support default values for attributes (probably only using lambdas to avoid bugs).
-
 ## Credits and license
 
 By [Joakim Kolsjö](https://twitter.com/joakimk) under the MIT license:

data/lib/minimapper/entity/attributes.rb

@@ -3,62 +3,81 @@ require 'minimapper/entity/convert'
 module Minimapper
   module Entity
     module Attributes
-      def attributes(*list)
-        columns = add_columns(list)
-
-        # By adding instance methods via an included module,
-        # they become overridable with "super".
-        unless @minimapper_instance_method_container
-          @minimapper_instance_method_container = Module.new
-          include @minimapper_instance_method_container
-        end
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
 
-        columns.each do |column|
-          define_reader(column)
-          define_writer(column)
-        end
+      def initialize(attributes = {})
+        self.attributes = attributes
       end
 
-      def attribute(*opts)
-        attributes [ *opts ]
+      def attributes=(new_attributes)
+        super(new_attributes)
+        new_attributes.each_pair { |name, value| self.send("#{name}=", value) }
       end
 
-      # Compatibility with certain Rails plugins, like Traco.
-      def column_names
-        @entity_columns.map(&:name).map(&:to_s)
+      def normalize_attribute_value(value, type)
+        Convert.new(value).to(type)
       end
 
-      private
+      module ClassMethods
+        def attributes(*list)
+          columns = add_columns(list)
 
-      def add_columns(list)
-        @entity_columns ||= []
-        @entity_columns |= list.map { |data| Column.new(data) }
-      end
+          # By adding instance methods via an included module,
+          # they become overridable with "super".
+          unless @minimapper_instance_method_container
+            @minimapper_instance_method_container = Module.new
+            include @minimapper_instance_method_container
+          end
 
-      def define_reader(column)
-        @minimapper_instance_method_container.module_eval do
-          define_method(column.name) do
-            attributes[column.name]
+          columns.each do |column|
+            define_reader(column)
+            define_writer(column)
           end
         end
-      end
 
-      def define_writer(column)
-        @minimapper_instance_method_container.module_eval do
-          define_method("#{column.name}=") do |value|
-            attributes[column.name] = Convert.new(value).to(column.type)
+        def attribute(*opts)
+          attributes [ *opts ]
+        end
+
+        # Compatibility with certain Rails plugins, like Traco.
+        def column_names
+          @entity_columns.map(&:name).map(&:to_s)
+        end
+
+        private
+
+        def add_columns(list)
+          @entity_columns ||= []
+          @entity_columns |= list.map { |data| Column.new(data) }
+        end
+
+        def define_reader(column)
+          @minimapper_instance_method_container.module_eval do
+            define_method(column.name) do
+              attributes[column.name]
+            end
+          end
+        end
+
+        def define_writer(column)
+          @minimapper_instance_method_container.module_eval do
+            define_method("#{column.name}=") do |value|
+              attributes[column.name] = normalize_attribute_value(value, column.type)
+            end
           end
         end
-      end
 
-      class Column
-        attr_reader :name, :type
+        class Column
+          attr_reader :name, :type
 
-        def initialize(data)
-          if data.is_a?(Array)
-            @name, @type = data
-          else
-            @name = data
+          def initialize(data)
+            if data.is_a?(Array)
+              @name, @type = data
+            else
+              @name = data
+            end
           end
         end
       end

data/lib/minimapper/entity/convert.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext'
 require 'minimapper/entity/convert/to_integer'
 require 'minimapper/entity/convert/to_date_time'
 

data/lib/minimapper/entity/core.rb

@@ -1,8 +1,8 @@
 # The core entity API required by minimapper. If your entity class implements
-# this API, it should work with the data mappers.
+# this API, it should work with the mapper.
 
 # IMPORTANT: This module should only implement the minimal interface needed
-# to talk to the data mappers. If a method isn't used by the mappers it should
+# to talk to the data mapper. If a method isn't used by the mapper it should
 # not be in this file.
 
 module Minimapper

data/lib/minimapper/entity/rails.rb

@@ -1,35 +1,10 @@
-# Include this in your entity models for
+# Include this in your entity classes for
 # Ruby on Rails conveniences, like being
 # able to use them in forms.
 
-require "active_model"
-
 module Minimapper
   module Entity
     module Rails
-      def self.included(klass)
-        klass.class_eval do
-          extend  ActiveModel::Naming
-          include ActiveModel::Validations
-
-          # Must be added after ActiveModel::Validations so our
-          # validations can call ActiveModel's with `super`.
-          include ValidationsWithMapperErrors
-        end
-      end
-
-      module ValidationsWithMapperErrors
-        def valid?
-          super
-
-          mapper_errors.each do |a, v|
-            errors.add(a, v)
-          end
-
-          errors.empty?
-        end
-      end
-
       def to_param
         id
       end

data/lib/minimapper/entity/validation.rb

@@ -0,0 +1,30 @@
+require "active_model"
+
+module Minimapper
+  module Entity
+    module Validation
+      def self.included(klass)
+        klass.class_eval do
+          extend  ActiveModel::Naming
+          include ActiveModel::Validations
+
+          # Must be added after ActiveModel::Validations so our
+          # validations can call ActiveModel's with `super`.
+          include ValidationsWithMapperErrors
+        end
+      end
+
+      module ValidationsWithMapperErrors
+        def valid?
+          super
+
+          mapper_errors.each do |a, v|
+            errors.add(a, v)
+          end
+
+          errors.empty?
+        end
+      end
+    end
+  end
+end

data/lib/minimapper/entity.rb

@@ -1,21 +1,13 @@
 # Look at minimapper/entity/core for the required API.
 require 'minimapper/entity/core'
 require 'minimapper/entity/attributes'
+require 'minimapper/entity/validation'
 require 'minimapper/entity/rails'
 
 module Minimapper
   module Entity
     include Minimapper::Entity::Core
 
-    def initialize(attributes = {})
-      self.attributes = attributes
-    end
-
-    def attributes=(new_attributes)
-      super(new_attributes)
-      new_attributes.each_pair { |name, value| self.send("#{name}=", value) }
-    end
-
     def ==(other)
       super || (
         other.instance_of?(self.class) &&
@@ -25,8 +17,9 @@ module Minimapper
     end
 
     def self.included(klass)
+      klass.send(:include, Minimapper::Entity::Attributes)
+      klass.send(:include, Minimapper::Entity::Validation)
       klass.send(:include, Minimapper::Entity::Rails)
-      klass.send(:extend, Minimapper::Entity::Attributes)
       klass.attributes(
         [ :id, :integer ],
         [ :created_at, :date_time ],

data/lib/minimapper/version.rb

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

data/unit/entity/attributes_spec.rb

@@ -0,0 +1,140 @@
+require 'minimapper/entity/core'
+require 'minimapper/entity/attributes'
+
+module Attribute
+  class User
+    include Minimapper::Entity::Core
+    include Minimapper::Entity::Attributes
+    attribute :id, :integer
+    attribute  :name
+  end
+
+  class AgedUser < User
+    attributes :age
+  end
+
+  class Project
+    include Minimapper::Entity::Core
+    include Minimapper::Entity::Attributes
+    attributes :title
+  end
+
+  class Task
+    include Minimapper::Entity::Core
+    include Minimapper::Entity::Attributes
+
+    attribute :due_at, :date_time
+  end
+
+  class OverridingUser
+    include Minimapper::Entity::Core
+    include Minimapper::Entity::Attributes
+    attributes :name
+
+    def name
+      super.upcase
+    end
+
+    def name=(value)
+      super(value.strip)
+    end
+  end
+end
+
+describe Minimapper::Entity::Attributes, "attributes without type" do
+  let(:entity_class) do
+    Class.new do
+      include Minimapper::Entity::Core
+      include Minimapper::Entity::Attributes
+      attribute :name
+    end
+  end
+
+  it "can be set and get with anything" do
+    user = entity_class.new
+    user.name = "Hello"
+    user.name.should == "Hello"
+    user.name = 5
+    user.name.should == 5
+  end
+end
+
+describe Minimapper::Entity::Attributes do
+  it "can access attributes set at construction time" do
+    entity = Attribute::User.new(:id => 5)
+    entity.id.should == 5
+    entity.attributes[:id].should == 5
+  end
+
+  it "can access attributes set through a hash" do
+    entity = Attribute::User.new
+    entity.attributes = { :id => 5 }
+    entity.id.should == 5
+    entity.attributes = { "id" => 8 }
+    entity.id.should == 8
+  end
+
+  it "converts typed attributes" do
+    entity = Attribute::User.new
+    entity.id = "10"
+    entity.id.should == 10
+    entity.attributes = { :id => "15" }
+    entity.id.should == 15
+  end
+
+  it "can use single line type declarations" do
+    task = Attribute::Task.new(:due_at => "2012-01-01 15:00")
+    task.due_at.should == DateTime.parse("2012-01-01 15:00")
+  end
+
+  it "sets blank values to nil" do
+    user = Attribute::User.new
+    user.name = "  "
+    user.name.should be_nil
+  end
+
+  it "symbolizes keys" do
+    entity = Attribute::User.new
+    entity.attributes = { "id" => "15" }
+    entity.attributes[:id].should == 15
+  end
+
+  it "inherits attributes" do
+    user = Attribute::AgedUser.new
+    user.name = "Name"
+    user.age = 123
+    user.name.should == "Name"
+    user.age.should == 123
+  end
+
+  it "is possible to override attribute readers with inheritance" do
+    user = Attribute::OverridingUser.new
+    user.name = "pelle"
+    user.name.should == "PELLE"
+  end
+
+  it "is possible to override attribute writers with inheritance" do
+    user = Attribute::OverridingUser.new
+    user.name = " 123 "
+    user.name.should == "123"
+  end
+end
+
+describe Minimapper::Entity::Attributes, "attributes" do
+  it "returns the attributes" do
+    entity = Attribute::User.new(:id => 5)
+    time = Time.now
+    entity.attributes.should == { :id => 5 }
+  end
+end
+
+describe Minimapper::Entity::Attributes, "self.column_names" do
+  it "returns all attributes as strings" do
+    # used by some rails plugins
+    Attribute::User.column_names.should == [ "id", "name" ]
+  end
+
+  it "does not leak between different models" do
+    Attribute::Project.column_names.should == [ "title" ]
+  end
+end

data/unit/entity/convert_spec.rb

@@ -1,5 +1,4 @@
 require 'minimapper/entity/convert'
-require 'active_support/core_ext'
 
 describe Minimapper::Entity::Convert do
   describe ":integer" do

data/unit/entity/rails_spec.rb

@@ -1,12 +1,9 @@
-require 'minimapper/entity/rails'
 require 'minimapper/entity/core'
+require 'minimapper/entity/rails'
 
 class RailsEntity
   include Minimapper::Entity::Core
   include Minimapper::Entity::Rails
-
-  attr_accessor :name
-  validates :name, :presence => true
 end
 
 describe Minimapper::Entity::Rails do
@@ -43,22 +40,4 @@ describe Minimapper::Entity::Rails do
     entity.id = 5
     entity.should be_persisted
   end
-
-  it "includes active model validations" do
-    entity = RailsEntity.new
-    entity.should_not be_valid
-    entity.name = "Joe"
-    entity.should be_valid
-  end
-
-  describe "#mapper_errors=" do
-    it "adds an error to the errors collection" do
-      entity = RailsEntity.new
-      entity.name = "Joe"
-      entity.should be_valid
-      entity.mapper_errors = [ [:name, "must be unique"] ]
-      entity.should_not be_valid
-      entity.errors[:name].should == ["must be unique"]
-    end
-  end
 end

data/unit/entity/validation_spec.rb

@@ -0,0 +1,30 @@
+require 'minimapper/entity/core'
+require 'minimapper/entity/validation'
+
+class ValidatableEntity
+  include Minimapper::Entity::Core
+  include Minimapper::Entity::Validation
+
+  attr_accessor :name
+  validates :name, :presence => true
+end
+
+describe Minimapper::Entity::Validation do
+  it "includes active model validations" do
+    entity = ValidatableEntity.new
+    entity.should_not be_valid
+    entity.name = "Joe"
+    entity.should be_valid
+  end
+
+  describe "#mapper_errors=" do
+    it "adds an error to the errors collection" do
+      entity = ValidatableEntity.new
+      entity.name = "Joe"
+      entity.should be_valid
+      entity.mapper_errors = [ [:name, "must be unique"] ]
+      entity.should_not be_valid
+      entity.errors[:name].should == ["must be unique"]
+    end
+  end
+end

data/unit/entity_spec.rb

@@ -1,45 +1,24 @@
 require 'minimapper/entity'
 
-class TestEntity
-  include Minimapper::Entity
-end
-
 class TestUser
   include Minimapper::Entity
   attributes :name
 end
 
-class TestAgedUser < TestUser
-  attributes :age
-end
-
 class TestProject
   include Minimapper::Entity
   attributes :title
 end
 
-class TestTask
-  include Minimapper::Entity
-
-  attribute :due_at, :date_time
-end
-
-class OverridingTestUser
-  include Minimapper::Entity
-  attributes :name
-
-  def name
-    super.upcase
-  end
-
-  def name=(value)
-    super(value.strip)
+describe Minimapper::Entity do
+  let(:entity_class) do
+    Class.new do
+      include Minimapper::Entity
+    end
   end
-end
 
-describe Minimapper::Entity do
   it "handles base attributes" do
-    entity = TestEntity.new
+    entity = entity_class.new
 
     entity.id = 5
     entity.id.should == 5
@@ -51,95 +30,6 @@ describe Minimapper::Entity do
     entity.updated_at = time
     entity.updated_at.should == time
   end
-
-  it "can access attributes set at construction time" do
-    entity = TestUser.new(:id => 5)
-    entity.id.should == 5
-    entity.attributes[:id].should == 5
-  end
-
-  it "can access attributes set through a hash" do
-    entity = TestUser.new
-    entity.attributes = { :id => 5 }
-    entity.id.should == 5
-    entity.attributes = { "id" => 8 }
-    entity.id.should == 8
-  end
-
-  it "converts typed attributes" do
-    entity = TestEntity.new
-    entity.id = "10"
-    entity.id.should == 10
-    entity.attributes = { :id => "15" }
-    entity.id.should == 15
-  end
-
-  it "can use single line type declarations" do
-    task = TestTask.new(:due_at => "2012-01-01 15:00")
-    task.due_at.should == DateTime.parse("2012-01-01 15:00")
-  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" }
-    entity.attributes[:id].should == 15
-  end
-
-  it "inherits attributes" do
-    user = TestAgedUser.new
-    user.name = "Name"
-    user.age = 123
-    user.name.should == "Name"
-    user.age.should == 123
-  end
-
-  it "is possible to override attribute readers with inheritance" do
-    user = OverridingTestUser.new
-    user.name = "pelle"
-    user.name.should == "PELLE"
-  end
-
-  it "is possible to override attribute writers with inheritance" do
-    user = OverridingTestUser.new
-    user.name = " 123 "
-    user.name.should == "123"
-  end
-end
-
-describe Minimapper::Entity, "attributes without type" do
-  it "can be set and get with anything" do
-    user = TestUser.new
-    user.name = "Hello"
-    user.name.should == "Hello"
-    user.name = 5
-    user.name.should == 5
-  end
-end
-
-describe Minimapper::Entity, "attributes" do
-  it "returns the attributes" do
-    entity = TestEntity.new(:id => 5)
-    time = Time.now
-    entity.created_at = time
-    entity.attributes.should == { :id => 5, :created_at => time }
-  end
-end
-
-describe Minimapper::Entity, "self.column_names" do
-  it "returns all attributes as strings" do
-    # used by some rails plugins
-    TestUser.column_names.should == [ "id", "created_at", "updated_at", "name" ]
-  end
-
-  it "does not leak between different models" do
-    TestProject.column_names.should == [ "id", "created_at", "updated_at", "title" ]
-  end
 end
 
 describe Minimapper::Entity, "#==" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-02 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70148053526900 !ruby/object:Gem::Requirement
+  requirement: &70270060752600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148053526900
+  version_requirements: *70270060752600
 description: A minimalistic way of separating your models from ActiveRecord.
 email:
 - joakim.kolsjo@gmail.com
@@ -44,6 +44,7 @@ files:
 - lib/minimapper/entity/convert/to_integer.rb
 - lib/minimapper/entity/core.rb
 - lib/minimapper/entity/rails.rb
+- lib/minimapper/entity/validation.rb
 - lib/minimapper/mapper.rb
 - lib/minimapper/repository.rb
 - lib/minimapper/version.rb
@@ -54,9 +55,11 @@ files:
 - spec/spec_helper.rb
 - spec/support/database_setup.rb
 - spec/support/shared_examples/mapper.rb
+- unit/entity/attributes_spec.rb
 - unit/entity/convert_spec.rb
 - unit/entity/core_spec.rb
 - unit/entity/rails_spec.rb
+- unit/entity/validation_spec.rb
 - unit/entity_spec.rb
 - unit/repository_spec.rb
 - unit/spec_helper.rb
@@ -72,18 +75,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4244542897336928819
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4244542897336928819
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5