datamappify 0.52.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd079889034877268b854c9c1402e747eb84348a
-  data.tar.gz: ea1988a5cea43748d9d55658e999b9c1a95a9de6
+  metadata.gz: bad8103a3c5c165af76967bc3b93b2c1a79c303d
+  data.tar.gz: a84ea4a4f05701f9bdbbb4ef68baba89f2887dc9
 SHA512:
-  metadata.gz: 18fde8f5ddccee08904440fdd706f0563130a78566a8860bc3a67017b35320444655db5226e6019d73e29e069750a80ddc267dd7e0bcc63d64a84daf05d263c8
-  data.tar.gz: 91fa0a11fd1af61e398b0b22e6dcad429c4123653dafabcb9c70bc39681ce0a8a9b1e61944996f688eac8221b771344a02679f9b137d3cc278a57a4b6b9114f6
+  metadata.gz: 49c79d48411f0e71f550aeba3d0022cae4e8bf1a61aae621493164da4f64942034f348e34a0a1fe4a66221bc86cf6a744c22cf232c8722ca2580336f758b4463
+  data.tar.gz: e6e75cdce7912e86ce5e023f3e44fee19e6c890b23c77159b883db53a53ee92b295e456aca40fef871ca997252c49139dfde9ac6190abf317707e55e501ddccc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master
 
+## 0.53.0 [2013-06-27]
+
+- Added support for mapping to namespaced data models.
+
 ## 0.52.0 [2013-06-26]
 
 - Added support for reverse mapping attributes.

data/README.md

@@ -1,6 +1,6 @@
 # Datamappify [![Gem Version](https://badge.fury.io/rb/datamappify.png)](http://badge.fury.io/rb/datamappify) [![Build Status](https://api.travis-ci.org/fredwu/datamappify.png?branch=master)](http://travis-ci.org/fredwu/datamappify) [![Coverage Status](https://coveralls.io/repos/fredwu/datamappify/badge.png)](https://coveralls.io/r/fredwu/datamappify) [![Code Climate](https://codeclimate.com/github/fredwu/datamappify.png)](https://codeclimate.com/github/fredwu/datamappify)
 
-#### Compose, decouple and manage domain logic and data persistence separately. Works great with forms!
+#### Compose, decouple and manage domain logic and data persistence separately. Works particularly great for composing form objects!
 
 ## Overview
 
@@ -27,7 +27,7 @@ Datamappify consists of three components:
 
 Below is a high level and somewhat simplified overview of Datamappify's architecture.
 
-![](http://i.imgur.com/byt6P3f.png)
+![](http://i.imgur.com/I9GpLds.png)
 
 Note: Datamappify is NOT affiliated with the [Datamapper](https://github.com/datamapper/) project.
 

data/datamappify.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Datamappify::VERSION
   spec.authors       = ["Fred Wu"]
   spec.email         = ["ifredwu@gmail.com"]
-  spec.description   = %q{Compose, decouple and manage domain logic and data persistence separately. Works great with forms!}
+  spec.description   = %q{Compose, decouple and manage domain logic and data persistence separately. Works particularly great for composing form objects!}
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/fredwu/datamappify"
   spec.license       = "MIT"

data/lib/datamappify/data/mapper/attribute.rb

@@ -56,7 +56,7 @@ module Datamappify
 
         # @example
         #
-        #   UserComment
+        #   Namespaced::UserComment
         #
         # @return [Class]
         def source_class
@@ -69,7 +69,7 @@ module Datamappify
         #
         # @return [String]
         def source_name
-          @source_name ||= source_class_name.underscore
+          @source_name ||= source_class_name.demodulize.underscore
         end
 
         # @example
@@ -141,8 +141,9 @@ module Datamappify
           provider_name != primary_provider_name
         end
 
+        # @return [Boolean]
         def reverse_mapped?
-          @options[:via]
+          !!@options[:via]
         end
 
         private
@@ -150,7 +151,7 @@ module Datamappify
         # @return [Array<String>]
         #   an array with provider name, source class name and source attribute name
         def parse_source(source)
-          provider_name, source_class_and_attribute = source.split('::')
+          provider_name, source_class_and_attribute = source.split('::', 2)
 
           [provider_name, *source_class_and_attribute.split('#')]
         end

data/lib/datamappify/data/provider/active_record.rb

@@ -9,9 +9,15 @@ module Datamappify
           #
           # @return [ActiveRecord::Base]
           def build_record_class(source_class_name)
-            Datamappify::Data::Record::ActiveRecord.const_set(
-              source_class_name, Class.new(::ActiveRecord::Base)
-            )
+            class_eval <<-CODE, __FILE__, __LINE__ + 1
+              module Datamappify::Data::Record::ActiveRecord
+                class #{source_class_name} < ::ActiveRecord::Base
+                  self.table_name = '#{source_class_name.pluralize.gsub('::', '_').underscore}'
+                end
+              end
+            CODE
+
+            Datamappify::Data::Record::ActiveRecord.const_get(source_class_name)
           end
 
           # @return [void]

data/lib/datamappify/data/provider/common_provider.rb

@@ -35,8 +35,18 @@ module Datamappify
           # @return [Class]
           #   the data record class
           def find_or_build_record_class(source_class_name)
-            if records_namespace.const_defined?(source_class_name, false)
-              records_namespace.const_get(source_class_name)
+            namespace    = build_or_return_namespace(source_class_name)
+            record_class = source_class_name.safe_constantize
+
+            # check for existing record class
+            if record_class && !entity_class?(source_class_name)
+              record_class
+
+            # check for existing record class in the Datamappify::Data::Record::Provider namespace
+            elsif namespace.const_defined?(source_class_name.demodulize, false)
+              namespace.const_get(source_class_name.demodulize)
+
+            # no existing record class is found, let's build it
             else
               build_record_class(source_class_name)
             end
@@ -44,6 +54,26 @@ module Datamappify
 
           private
 
+          # @return [Boolean]
+          def entity_class?(source_class_name)
+            source_class_name.constantize.ancestors.include?(Datamappify::Entity)
+          end
+
+          # Builds or returns the namespace for the source class
+          #
+          # @param source_class_name [String]
+          #
+          # @return [Module]
+          def build_or_return_namespace(source_class_name)
+            source_class_name.deconstantize.split('::').inject(records_namespace) do |namespaces, namespace|
+              if namespaces.const_defined?(namespace, false)
+                namespaces.const_get(namespace)
+              else
+                namespaces.const_set(namespace, Module.new)
+              end
+            end
+          end
+
           # The namespace for the data records, e.g. +Datamappify::Data::Record::ActiveRecord+
           #
           # @return [Module]

data/lib/datamappify/data/provider/sequel.rb

@@ -9,11 +9,15 @@ module Datamappify
           #
           # @return [Sequel::Model]
           def build_record_class(source_class_name)
-            Record::Sequel.const_set(
-              source_class_name, Class.new(::Sequel::Model(source_class_name.pluralize.underscore.to_sym))
-            ).tap do |klass|
-              klass.raise_on_save_failure = true
-            end
+            class_eval <<-CODE, __FILE__, __LINE__ + 1
+              module Datamappify::Data::Record::Sequel
+                class #{source_class_name} < ::Sequel::Model(:#{source_class_name.pluralize.gsub('::', '_').underscore})
+                  raise_on_save_failure = true
+                end
+              end
+            CODE
+
+            Datamappify::Data::Record::Sequel.const_get(source_class_name)
           end
 
           # @param attribute (see Record#build_association)

data/lib/datamappify/version.rb

@@ -1,3 +1,3 @@
 module Datamappify
-  VERSION = '0.52.0'
+  VERSION = '0.53.0'
 end

data/spec/entity/composable_spec.rb

@@ -9,34 +9,22 @@ describe Datamappify::Entity do
       :gfx                 => 'Voodoo',
       :vendor              => 'Compaq',
       :software_os         => 'OS X',
-      :software_osx_id     => 1,
-      :software_windows_id => 2,
-      :software_linux_id   => 3,
-      :software_vendor     => 'Lotus',
-      :game_os             => 'OS X',
-      :game_osx_id         => 1,
-      :game_windows_id     => 2,
-      :game_linux_id       => 3,
-      :game_vendor         => 'Lotus'
+      :software_vendor     => 'Apple',
+      :game_os             => 'Orbit OS',
+      :game_vendor         => 'SONY'
     })
   end
 
-  its(:brand)               { should == 'Fruit' }
-  its(:cpu)                 { should == '286' }
-  its(:ram)                 { should == 4242 }
-  its(:hdd)                 { should == 65536 }
-  its(:gfx)                 { should == 'Voodoo' }
-  its(:vendor)              { should == 'Compaq' }
-  its(:software_os)         { should == 'OS X' }
-  its(:software_osx_id)     { should == 1 }
-  its(:software_windows_id) { should == 2 }
-  its(:software_linux_id)   { should == 3 }
-  its(:software_vendor)     { should == 'Lotus' }
-  its(:game_os)             { should == 'OS X' }
-  its(:game_osx_id)         { should == 1 }
-  its(:game_windows_id)     { should == 2 }
-  its(:game_linux_id)       { should == 3 }
-  its(:game_vendor)         { should == 'Lotus' }
+  its(:brand)           { should == 'Fruit' }
+  its(:cpu)             { should == '286' }
+  its(:ram)             { should == 4242 }
+  its(:hdd)             { should == 65536 }
+  its(:gfx)             { should == 'Voodoo' }
+  its(:vendor)          { should == 'Compaq' }
+  its(:software_os)     { should == 'OS X' }
+  its(:software_vendor) { should == 'Apple' }
+  its(:game_os)         { should == 'Orbit OS' }
+  its(:game_vendor)     { should == 'SONY' }
 
   describe "validation" do
     context "valid" do

data/spec/repository/namespaced_mapping_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+shared_examples_for "namespaced mapping" do |data_provider|
+  let!(:computer_repository) { "ComputerRepository#{data_provider}".constantize }
+  let(:new_computer) {
+    Computer.new({
+      :brand               => 'Fruit',
+      :cpu                 => '286',
+      :ram                 => 4242,
+      :gfx                 => 'Voodoo',
+      :vendor              => 'Compaq',
+      :software_os         => 'OS X',
+      :software_vendor     => 'Apple',
+      :game_os             => 'Orbit OS',
+      :game_vendor         => 'SONY'
+    })
+  }
+
+  context "#{data_provider}" do
+    describe "entity" do
+      let!(:computer) { computer_repository.save!(new_computer) }
+
+      subject { computer_repository.find(computer.id) }
+
+      its(:brand)           { should == 'Fruit' }
+      its(:cpu)             { should == '286' }
+      its(:ram)             { should == 4242 }
+      its(:hdd)             { should == 65536 }
+      its(:gfx)             { should == 'Voodoo' }
+      its(:vendor)          { should == 'Compaq' }
+      its(:software_os)     { should == 'OS X' }
+      its(:software_vendor) { should == 'Apple' }
+      its(:game_os)         { should == 'Orbit OS' }
+      its(:game_vendor)     { should == 'SONY' }
+    end
+  end
+end
+
+describe Datamappify::Repository do
+  DATA_PROVIDERS.each do |data_provider|
+    it_behaves_like "namespaced mapping", data_provider
+  end
+end

data/spec/support/entities/computer.rb

@@ -1,14 +1,14 @@
-require_relative 'computer_hardware'
-require_relative 'computer_software'
+require_relative 'computer_component/hardware'
+require_relative 'computer_component/software'
 
 class Computer
   include Datamappify::Entity
 
   attribute :brand, String
 
-  attributes_from ComputerHardware
-  attributes_from ComputerSoftware, :prefix_with => :software
-  attributes_from ComputerSoftware, :prefix_with => :game
+  attributes_from ComputerComponent::Hardware
+  attributes_from ComputerComponent::Software, :prefix_with => :software
+  attributes_from ComputerComponent::Software, :prefix_with => :game
 
   validates :brand, :presence => true
 end

data/spec/support/entities/computer_component/hardware.rb

@@ -0,0 +1,14 @@
+module ComputerComponent
+  class Hardware
+    include Datamappify::Entity
+
+    attribute :cpu, String
+    attribute :ram, Integer, :default => 8192
+    attribute :hdd, Integer, :default => 65536
+    attribute :gfx, String
+    attribute :vendor, String
+
+    validates :ram, :hdd, :numericality => { :greater_than_or_equal_to => 4096 }
+    validates :hdd,       :numericality => { :less_than_or_equal_to => 65536 }
+  end
+end

data/spec/support/entities/computer_component/software.rb

@@ -0,0 +1,10 @@
+module ComputerComponent
+  class Software
+    include Datamappify::Entity
+
+    attribute :os, String
+    attribute :vendor, String
+
+    validates_presence_of :os
+  end
+end

data/spec/support/repositories/active_record/computer_repository.rb

@@ -0,0 +1,20 @@
+class ComputerSoftware < ActiveRecord::Base
+  self.table_name = 'computer_component_softwares'
+end
+
+class ComputerRepositoryActiveRecord
+  include Datamappify::Repository
+
+  for_entity Computer
+  default_provider :ActiveRecord
+
+  map_attribute :cpu,             'ActiveRecord::ComputerComponent::Hardware#cpu'
+  map_attribute :ram,             'ActiveRecord::ComputerComponent::Hardware#ram'
+  map_attribute :hdd,             'ActiveRecord::ComputerComponent::Hardware#hdd'
+  map_attribute :gfx,             'ActiveRecord::ComputerComponent::Hardware#gfx'
+  map_attribute :vendor,          'ActiveRecord::ComputerComponent::Hardware#vendor'
+  map_attribute :software_os,     'ActiveRecord::ComputerSoftware#os'
+  map_attribute :software_vendor, 'ActiveRecord::ComputerSoftware#vendor'
+  map_attribute :game_os,         'ActiveRecord::ComputerSoftware#os',     :via => :game_id
+  map_attribute :game_vendor,     'ActiveRecord::ComputerSoftware#vendor', :via => :game_id
+end

data/spec/support/repositories/sequel/computer_repository.rb

@@ -0,0 +1,16 @@
+class ComputerRepositorySequel
+  include Datamappify::Repository
+
+  for_entity Computer
+  default_provider :Sequel
+
+  map_attribute :cpu,             'Sequel::ComputerComponent::Hardware#cpu'
+  map_attribute :ram,             'Sequel::ComputerComponent::Hardware#ram'
+  map_attribute :hdd,             'Sequel::ComputerComponent::Hardware#hdd'
+  map_attribute :gfx,             'Sequel::ComputerComponent::Hardware#gfx'
+  map_attribute :vendor,          'Sequel::ComputerComponent::Hardware#vendor'
+  map_attribute :software_os,     'Sequel::ComputerComponent::Software#os'
+  map_attribute :software_vendor, 'Sequel::ComputerComponent::Software#vendor'
+  map_attribute :game_os,         'Sequel::ComputerComponent::Software#os',     :via => :game_id
+  map_attribute :game_vendor,     'Sequel::ComputerComponent::Software#vendor', :via => :game_id
+end

data/spec/support/tables/active_record.rb

@@ -76,5 +76,32 @@ ActiveRecord::Migration.suppress_messages do
       t.references :post
       t.timestamps
     end
+
+    create_table :computers do |t|
+      t.string :brand
+      t.references :game
+      t.timestamps
+    end
+
+    create_table :computer_component_hardwares do |t|
+      t.string :brand
+      t.string :cpu
+      t.integer :ram
+      t.integer :hdd
+      t.string :gfx
+      t.string :vendor
+      t.references :computer
+      t.timestamps
+    end
+
+    create_table :computer_component_softwares do |t|
+      t.string :os
+      t.string :vendor
+      t.references :osx
+      t.references :windows
+      t.references :linux
+      t.references :computer
+      t.timestamps
+    end
   end
 end

data/spec/support/tables/sequel.rb

@@ -89,7 +89,40 @@ DB.create_table :authors do |t|
   primary_key :id
   String :name
   String :bio
-  String :post_id
+  foreign_key :post_id
+  DateTime :created_at
+  DateTime :updated_at
+end
+
+DB.create_table :computers do |t|
+  primary_key :id
+  String :brand
+  foreign_key :game_id
+  DateTime :created_at
+  DateTime :updated_at
+end
+
+DB.create_table :computer_component_hardwares do |t|
+  primary_key :id
+  String :brand
+  String :cpu
+  Integer :ram
+  Integer :hdd
+  String :gfx
+  String :vendor
+  foreign_key :computer_id
+  DateTime :created_at
+  DateTime :updated_at
+end
+
+DB.create_table :computer_component_softwares do |t|
+  primary_key :id
+  String :os
+  String :vendor
+  foreign_key :computer_id
+  foreign_key :osx_id
+  foreign_key :windows_id
+  foreign_key :linux_id
   DateTime :created_at
   DateTime :updated_at
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datamappify
 version: !ruby/object:Gem::Version
-  version: 0.52.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Fred Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -253,7 +253,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.1
 description: Compose, decouple and manage domain logic and data persistence separately.
-  Works great with forms!
+  Works particularly great for composing form objects!
 email:
 - ifredwu@gmail.com
 executables: []
@@ -349,6 +349,7 @@ files:
 - spec/repository/dirty_persistence_spec.rb
 - spec/repository/dirty_tracking_spec.rb
 - spec/repository/finders_spec.rb
+- spec/repository/namespaced_mapping_spec.rb
 - spec/repository/persistence_spec.rb
 - spec/repository/reverse_mapped_spec.rb
 - spec/repository/transactions_spec.rb
@@ -359,8 +360,8 @@ files:
 - spec/support/entities/author.rb
 - spec/support/entities/comment.rb
 - spec/support/entities/computer.rb
-- spec/support/entities/computer_hardware.rb
-- spec/support/entities/computer_software.rb
+- spec/support/entities/computer_component/hardware.rb
+- spec/support/entities/computer_component/software.rb
 - spec/support/entities/group.rb
 - spec/support/entities/hero_user.rb
 - spec/support/entities/post.rb
@@ -370,6 +371,7 @@ files:
 - spec/support/repositories/active_record/admin_user_repository.rb
 - spec/support/repositories/active_record/author_repository.rb
 - spec/support/repositories/active_record/comment_repository.rb
+- spec/support/repositories/active_record/computer_repository.rb
 - spec/support/repositories/active_record/group_repository.rb
 - spec/support/repositories/active_record/post_repository.rb
 - spec/support/repositories/active_record/role_repository.rb
@@ -379,6 +381,7 @@ files:
 - spec/support/repositories/sequel/admin_user_repository.rb
 - spec/support/repositories/sequel/author_repository.rb
 - spec/support/repositories/sequel/comment_repository.rb
+- spec/support/repositories/sequel/computer_repository.rb
 - spec/support/repositories/sequel/group_repository.rb
 - spec/support/repositories/sequel/post_repository.rb
 - spec/support/repositories/sequel/role_repository.rb
@@ -413,7 +416,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Compose, decouple and manage domain logic and data persistence separately.
-  Works great with forms!
+  Works particularly great for composing form objects!
 test_files:
 - spec/entity/composable_spec.rb
 - spec/entity/inheritance_spec.rb
@@ -424,6 +427,7 @@ test_files:
 - spec/repository/dirty_persistence_spec.rb
 - spec/repository/dirty_tracking_spec.rb
 - spec/repository/finders_spec.rb
+- spec/repository/namespaced_mapping_spec.rb
 - spec/repository/persistence_spec.rb
 - spec/repository/reverse_mapped_spec.rb
 - spec/repository/transactions_spec.rb
@@ -434,8 +438,8 @@ test_files:
 - spec/support/entities/author.rb
 - spec/support/entities/comment.rb
 - spec/support/entities/computer.rb
-- spec/support/entities/computer_hardware.rb
-- spec/support/entities/computer_software.rb
+- spec/support/entities/computer_component/hardware.rb
+- spec/support/entities/computer_component/software.rb
 - spec/support/entities/group.rb
 - spec/support/entities/hero_user.rb
 - spec/support/entities/post.rb
@@ -445,6 +449,7 @@ test_files:
 - spec/support/repositories/active_record/admin_user_repository.rb
 - spec/support/repositories/active_record/author_repository.rb
 - spec/support/repositories/active_record/comment_repository.rb
+- spec/support/repositories/active_record/computer_repository.rb
 - spec/support/repositories/active_record/group_repository.rb
 - spec/support/repositories/active_record/post_repository.rb
 - spec/support/repositories/active_record/role_repository.rb
@@ -454,6 +459,7 @@ test_files:
 - spec/support/repositories/sequel/admin_user_repository.rb
 - spec/support/repositories/sequel/author_repository.rb
 - spec/support/repositories/sequel/comment_repository.rb
+- spec/support/repositories/sequel/computer_repository.rb
 - spec/support/repositories/sequel/group_repository.rb
 - spec/support/repositories/sequel/post_repository.rb
 - spec/support/repositories/sequel/role_repository.rb

data/spec/support/entities/computer_hardware.rb

@@ -1,12 +0,0 @@
-class ComputerHardware
-  include Datamappify::Entity
-
-  attribute :cpu, String
-  attribute :ram, Integer, :default => 8192
-  attribute :hdd, Integer, :default => 65536
-  attribute :gfx, String
-  attribute :vendor, String
-
-  validates :ram, :hdd, :numericality => { :greater_than_or_equal_to => 4096 }
-  validates :hdd,       :numericality => { :less_than_or_equal_to => 65536 }
-end

data/spec/support/entities/computer_software.rb

@@ -1,12 +0,0 @@
-class ComputerSoftware
-  include Datamappify::Entity
-
-  attribute :os, String
-  attribute :vendor, String
-
-  references :osx
-  references :windows
-  references :linux
-
-  validates_presence_of :os
-end