minimapper 0.1.2 → 0.1.3

data/README.md

@@ -1,4 +1,4 @@
-![Build status](https://secure.travis-ci.org/joakimk/minimapper.png) | [builds](https://travis-ci.org/#!/joakimk/minimapper/builds)
+[![Build Status](https://secure.travis-ci.org/joakimk/minimapper.png)](http://travis-ci.org/joakimk/minimapper)
 
 # Minimapper
 
@@ -6,31 +6,28 @@
 
 ### Introduction
 
-A minimalistic way of separating your models from ORMs like ActiveRecord that allows you to swap out your persistence layer for an in-memory implementation in tests or use different persistence for different models.
+Minimapper is a minimalistic way of separating models from ORMs like ActiveRecord. It enables you to test your models (and code using your models) within a [sub-second unit test suite](https://github.com/joakimk/fast_unit_tests_example) and makes it simpler to have a modular design as described in [Matt Wynne's Hexagonal Rails posts](http://blog.mattwynne.net/2012/04/09/hexagonal-rails-introduction/).
 
-If you're following good style you're probably already pushing all knowledge of your ORM down into your models or model-layer classes. This takes it a step further and let's you work with your models without depending on heavy frameworks like rails or needing a database.
+Minimapper comes with an in-memory implementation of common CRUD operations. You can use this in tests to not hit the database where it isn't nessesary to do so. You can also develop new features without having to think about migrations until you need to persist data.
 
-Minimapper is a partial [repository-pattern](http://martinfowler.com/eaaCatalog/repository.html) implementation (it implements repositories and data mappers but not criteria builders).
+Minimapper is not an ORM, instead it's a tool to make it simpler to handle persistence in existing applications using ORMs like ActiveRecord. It may also be an attractive alternative to using DataMapper 2 (when it's done) for new apps if you already know ActiveRecord well (most of the rails developers I know have many years of experience with ActiveRecord).
 
-### Only the most basic API
-
-This library only implements the most basic persistence API (mostly just CRUD). Any significant additions will be made into separate gems (with names like "minimapper-FOO").
-
-The reasons for this are:
+### Early days
 
-* You should be able to depend on the API
-* It should be possible to learn all it does in a short time
-* It should be simple to add an adapter for a new database
-* It should be simple to maintain minimapper
+The API may not be entirely stable yet and there are probably edge cases that aren't covered. However... it's most likely better to use this than to roll your own project specific solution. We need good tools for this kind of thing in the rails community, but to make that possible we need to gather around a few of them and make them good.
 
 ### Compatibility
 
 This gem is tested against all major rubies in both 1.8 and 1.9, see [.travis.yml](https://github.com/joakimk/minimapper/blob/master/.travis.yml). For each ruby version, the SQL mappers are tested against SQLite3, PostgreSQL and MySQL.
 
-### Early days
+### Only the most basic API
 
-This is not quite intended for production use yet. It's a very small API that is well tested so you could use it in production apps, but there are still some problem areas that hasn't been well explored (for example, how to handle associations). It is probably better to use this than to roll your own project specific solution though.
+This library only implements the most basic persistence API (mostly just CRUD). Any significant additions will be made into separate gems. The reasons for this are:
 
+* It should have a stable API
+* It should be possible to learn all it does in a short time
+* It should be simple to add an adapter for a new database
+* It should be simple to maintain minimapper
 
 ## Installation
 
@@ -176,10 +173,9 @@ It gets simpler to maintain if you use shared tests to test both implementations
 
 ### Typed attributes
 
-``` ruby
-# Supported types: Integer, DateTime
-# TODO: Will probably not support more types, but instead provide a way to add custom conversions.
+If you specify type, minimapper will attempt to convert into that type. Supported types: Integer and DateTime.
 
+``` ruby
 class User
   include Minimapper::Entity
   attributes [ :profile_id, Integer ]
@@ -191,9 +187,32 @@ User.new(:profile_id => " ").profile_id       # => nil
 User.new(:profile_id => "foobar").profile_id  # => nil
 ```
 
+You can add your own type conversions like this:
+
+``` ruby
+require "date"
+
+class ToDate
+  def convert(value)
+    Date.parse(value) rescue nil
+  end
+end
+
+Minimapper::Entity::Convert.register_converter(Date, ToDate.new)
+
+class User
+  include Minimapper::Entity
+  attributes [ :profile_id, Date ]
+end
+
+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.
+
 ### Custom entity class
 
-You don't need to use Minimapper::Entity. The core API is implemented in [Minimapper::Entity::Core](https://github.com/joakimk/minimapper/blob/master/lib/minimapper/entity/core.rb). Either include that module or implement your own version.
+[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)).
 
 ### Adding a new mapper
 

data/lib/minimapper/entity/convert/to_date_time.rb

@@ -0,0 +1,11 @@
+module Minimapper
+  module Entity
+    class Convert
+      class ToDateTime
+        def convert(value)
+          DateTime.parse(value) rescue nil
+        end
+      end
+    end
+  end
+end

data/lib/minimapper/entity/convert/to_integer.rb

@@ -0,0 +1,15 @@
+module Minimapper
+  module Entity
+    class Convert
+      class ToInteger
+        def convert(value)
+          if value =~ /[0-9]/
+            value.to_i
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minimapper/entity/convert.rb

@@ -1,3 +1,6 @@
+require 'minimapper/entity/convert/to_integer'
+require 'minimapper/entity/convert/to_date_time'
+
 module Minimapper
   module Entity
     class Convert
@@ -5,32 +8,31 @@ module Minimapper
         @value = value
       end
 
+      def self.register_converter(type, converter)
+        @@converters ||= {}
+        @@converters[type.to_s] = converter
+      end
+
       def to(type)
-        return if value.blank?
+        return nil if value.blank?
         return value unless value.is_a?(String)
 
-        case type.to_s
-        when "Integer"
-          to_integer
-        when "DateTime"
-          to_date_time
-        else
-          value
-        end
+        converter_for(type).convert(value)
       end
 
+      register_converter Integer,  ToInteger.new
+      register_converter DateTime, ToDateTime.new
+
       private
 
-      def to_integer
-        if value =~ /[0-9]/
-          value.to_i
-        else
-          nil
-        end
+      def converter_for(type)
+        @@converters.fetch(type.to_s, NoOpConverter.new)
       end
 
-      def to_date_time
-        DateTime.parse(value) rescue nil
+      class NoOpConverter
+        def convert(value)
+          value
+        end
       end
 
       attr_reader :value

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/minimapper.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Minimapper::VERSION
   gem.authors       = ["Joakim Kolsjö"]
   gem.email         = ["joakim.kolsjo@gmail.com"]
-  gem.description   = %q{A minimalistic way of separating your models from ORMs like ActiveRecord (by implementing the repository pattern)}
-  gem.summary       = %q{A minimalistic way of separating your models from ORMs like ActiveRecord (by implementing the repository pattern)}
+  gem.description   = %q{A minimalistic way of separating your models from ORMs like ActiveRecord.}
+  gem.summary       = %q{A minimalistic way of separating your models from ORMs like ActiveRecord.}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70233951931080 !ruby/object:Gem::Requirement
+  requirement: &70178508749460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,9 +21,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233951931080
-description: A minimalistic way of separating your models from ORMs like ActiveRecord
-  (by implementing the repository pattern)
+  version_requirements: *70178508749460
+description: A minimalistic way of separating your models from ORMs like ActiveRecord.
 email:
 - joakim.kolsjo@gmail.com
 executables: []
@@ -43,6 +42,8 @@ files:
 - lib/minimapper/entity.rb
 - lib/minimapper/entity/attributes.rb
 - lib/minimapper/entity/convert.rb
+- lib/minimapper/entity/convert/to_date_time.rb
+- lib/minimapper/entity/convert/to_integer.rb
 - lib/minimapper/entity/core.rb
 - lib/minimapper/entity/rails.rb
 - lib/minimapper/memory.rb
@@ -74,19 +75,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3127199441283205218
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3127199441283205218
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: A minimalistic way of separating your models from ORMs like ActiveRecord
-  (by implementing the repository pattern)
+summary: A minimalistic way of separating your models from ORMs like ActiveRecord.
 test_files:
 - spec/ar_spec.rb
 - spec/spec_helper.rb