minimapper-extras 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42df3b244862e78e980ea66d96b31a8bd2d8c6ce
-  data.tar.gz: efe6cba3602a1253e5f775b22bb162050362f90a
+  metadata.gz: e0ad3696155f47065eb0f5378f2029eba9320aa5
+  data.tar.gz: b0cb60bb92ed7458ac6a8a19a67f731bd8de730c
 SHA512:
-  metadata.gz: a58cb2feb537a00740dbe89c1f84ee55b7a116cdda136f5fe29e2fccad7d2c4f73462400bba4044f44eb2b7bc46810c81d93122c2220a6dc3b7402f36c29537a
-  data.tar.gz: b88fa0ed5eacf7b8e89e638d96d91ca55003574cf34bcd7834ca89e2c8f8679335ac84d02174b58f0d2db4279a4e730bb525839b884069a19c22a35af4f1006d
+  metadata.gz: bae580892e3dafc93ddaa787285345ba2ae3bac3fa4d402d9c91d101d7f934fbb9ce5c5c65751e1947f50338aa8477c4d304a35e608b1800aff6a5a6fe1e4cca
+  data.tar.gz: 6e8361ebff43f1a1fae9edd035096e163b93a3f4e847caba91ad83c7cda2513836726b2e1509f12dc157386f64640cf170fb9c6f4aa556d82f2029f19b457d20

data/README.md

@@ -3,7 +3,7 @@
 
 # Minimapper::Extras
 
-Extra tools for minimapper.
+Extra tools for [minimapper](https://github.com/joakimk/minimapper).
 
 ## Installation
 
@@ -23,6 +23,32 @@ Or install it yourself as:
 
 For now, see the specs. TODO: Write docs.
 
+## Custom FactoryGirl strategy
+
+Add this to your spec_helper after loading FactoryGirl:
+
+    require "minimapper/factory_girl"
+
+It changes the create strategy used by FactoryGirl to make it compatible with minimapper.
+
+So far it only supports saving single entities and belongs_to associations.
+
+It assumes you can access your mappers though something like "Repository.employees". You can override that by
+changing CreateThroughRepositoryStrategy::Create#mapper_with_name.
+
+It also assumes the model has accessors for related objects, we use the "minimapper/entity/belongs_to" to do this.
+
+Example factory definition:
+
+    require "customer"
+
+    FactoryGirl.define do
+      factory :order do
+        customer { FactoryGirl.build(:customer) }
+        description "ref. 123"
+      end
+    end
+
 ## Contributing
 
 1. Fork it

data/lib/minimapper/extras/version.rb

@@ -1,5 +1,5 @@
 module Minimapper
   module Extras
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/minimapper/factory_girl.rb

@@ -0,0 +1,51 @@
+require "attr_extras"
+require "backports/1.9.1/kernel/public_send"
+
+class CreateThroughRepositoryStrategy
+  def result(evaluation)
+    Create.new(evaluation.object).create
+  end
+
+  private
+
+  class Create
+    pattr_initialize :entity
+
+    def create
+      entity_class = entity.class
+      mapper_name = entity_class.name.underscore.pluralize
+
+      # Recursively creates all dependencies of this entity before
+      # going on to the the entity itself. This is here so that we can do
+      # "customer { FactoryGirl.build(:customer) }" in factories.
+      create_dependencies
+
+      if mapper_with_name(mapper_name).create(entity)
+        entity
+      else
+        errors = entity.errors.full_messages.join(", ")
+        raise "Can't create invalid record: #{errors}"
+      end
+    end
+
+    # Override this if you want to access the mappers some other way.
+    def mapper_with_name(name)
+      Repository.public_send(name)
+    end
+
+    def create_dependencies
+      associated_entity_names.each do |name|
+        dependency_entity = self.class.new(entity.public_send(name)).create
+        entity.public_send("#{name}=", dependency_entity)
+      end
+    end
+
+    def associated_entity_names
+      entity.class.column_names.find_all { |name| name[-3..-1] == '_id' }.map do |belongs_to_id|
+        belongs_to_id[0...-3]
+      end
+    end
+  end
+end
+
+FactoryGirl.register_strategy(:create, CreateThroughRepositoryStrategy)

data/minimapper-extras.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "minimapper"
+  spec.add_dependency "attr_extras"
+  spec.add_dependency "backports"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/minimapper/factory_girl_spec.rb

@@ -0,0 +1,71 @@
+FactoryGirl = Class.new do
+  def self.register_strategy(name, klass)
+  end
+end
+
+Repository = Class.new
+
+require "minimapper/factory_girl"
+require "minimapper/entity"
+require "minimapper/entity/belongs_to"
+
+class Payment
+  include Minimapper::Entity
+
+  attribute :amount
+end
+
+class Order
+  include Minimapper::Entity
+
+  attribute :name
+  belongs_to :payment
+end
+
+class Location
+  include Minimapper::Entity
+
+  attribute :name
+end
+
+describe CreateThroughRepositoryStrategy do
+  let(:entity) { Location.new }
+  let(:location_mapper) { mock }
+  let(:evaluation) { mock(:object => entity) }
+
+  before do
+    Repository.stub(:locations).and_return(location_mapper)
+  end
+
+  it "can create a single entity though a factory class" do
+    location_mapper.should_receive(:create).with(entity).and_return(true)
+    CreateThroughRepositoryStrategy.new.result(evaluation)
+  end
+
+  it "raises if the entity isn't valid after create" do
+    entity.errors.add :base, "some error"
+    location_mapper.stub(:create => false)
+    lambda {
+      CreateThroughRepositoryStrategy.new.result(evaluation)
+    }.should raise_error("Can't create invalid record: some error")
+  end
+end
+
+describe CreateThroughRepositoryStrategy, "when there are belongs_to associations" do
+  let(:payment_mapper) { mock }
+  let(:order_mapper) { mock }
+
+  before do
+    Repository.stub(:orders => order_mapper)
+    Repository.stub(:payments => payment_mapper)
+  end
+
+  it "creates dependencies first" do
+    payment = Payment.new
+    order = Order.new(:payment => payment)
+    payment_mapper.should_receive(:create).ordered.with(payment).and_return(true)
+    order_mapper.should_receive(:create).ordered.with(order).and_return(true)
+    evaluation = mock(:object => order)
+    CreateThroughRepositoryStrategy.new.result(evaluation)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimapper-extras
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joakim Kolsjö
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minimapper
@@ -25,6 +25,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,11 +128,13 @@ files:
 - lib/minimapper/entity/serialized_association.rb
 - lib/minimapper/extras.rb
 - lib/minimapper/extras/version.rb
+- lib/minimapper/factory_girl.rb
 - minimapper-extras.gemspec
 - script/ci
 - script/turbux_rspec
 - spec/minimapper/entity/belongs_to_spec.rb
 - spec/minimapper/entity/serialized_association_spec.rb
+- spec/minimapper/factory_girl_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -133,4 +163,5 @@ summary: Extras for Minimapper.
 test_files:
 - spec/minimapper/entity/belongs_to_spec.rb
 - spec/minimapper/entity/serialized_association_spec.rb
+- spec/minimapper/factory_girl_spec.rb
 - spec/spec_helper.rb