activerecord_to_poro 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 587b516b162dcf78327bfe17f0321636477647c0
-  data.tar.gz: cbe5c6dfee693432493fa3f6edc03e17b5e103c4
+  metadata.gz: 73555a31ecff01b8d794c304d390d6a742480dff
+  data.tar.gz: 7966c2cd299ba10bb133ee76e421b928990c826d
 SHA512:
-  metadata.gz: c842467aa6ac65f6108088d5160180fa3b4be50b267cc393e18345bccf3988a3a672a448e59a11b00ef3f5ee7cab755a9028ea7470a64d6c5367af604c25fa51
-  data.tar.gz: 395836a68972a580931c8480b4a7b8eb7cdbfbd5acfcccb1a20dda3ff456311be71a21ed0cfd2dc406f1d448578a7b32f1f8587daef5d7dd994678263a90dc30
+  metadata.gz: 0980c84cee2f41eed81bf1e588b849be5cdd0e435f125a42ade0631f13d970ce6e187e15a690c01c35d7010c2c83e81b458c19ec1abf5db2e07c0572726e31f4
+  data.tar.gz: c1de463a85bec7018d6bdfa855acd24758ba9a46523a8abf96f45cbeb78811acea5190d87b8941b824c5e4031407b9f3f91164203032978b389188f04a80119d

data/Guardfile

@@ -11,7 +11,9 @@ guard :rspec, all_after_pass: true ,
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/unit/lib/#{m[1]}_spec.rb" }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/integration/lib/#{m[1]}_spec.rb" }
 
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')    { "spec" }
+  watch(%r{spec/support/.+\.rb})  { "spec" }
+  watch(%r{spec/ar_support/.+\.rb})  { "spec" }
 
   watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
 

data/README.md

@@ -18,15 +18,82 @@ Or install it yourself as:
 
 ## Usage
 
+For uptodate doc's take a look into the specs.
+
 ```ruby
 
+# for instance you'r ActiveRecord models look like this
+
+class User  < ActiveRecord::Base
+  has_many :roles, autosave: true
+  has_many :permissions, through: :roles, autosave: true
+
+  belongs_to :salutation, autosave: true
+  has_one :address, autosave: true
+end
+
+class Role < ActiveRecord::Base
+  has_many :permissions, autosave: true
+  belongs_to :user, autosave: true
+end
+
+class Salutation < ActiveRecord::Base
+  has_many :users, autosave: true
+end
+
+class Permission < ActiveRecord::Base
+  belongs_to :role, autosave: true
+end
+
+
+# You can convert them to poro's like this (automatic genereation of a poro class out of you'r AR class)
+
 roles_converter = ActiverecordToPoro::Converter.new(Role)
 salutation_converter = ActiverecordToPoro::Converter.new(Salutation)
-user_converter = ActiverecordToPoro::Converter.new(User, roles: roles_converter, salutation: salutation_converter)
+user_converter = ActiverecordToPoro::Converter.new(User, convert_associations: {roles: roles_converter, salutation: salutation_converter})
 
 
 poro = user_converter.load(User.first)
 
+# Or with you'r custom class
+
+roles_converter = ActiverecordToPoro::Converter.new(Role,
+                                                    load_source: YourPoroClass
+                                                    )
+
+
+# default 1:1 mapping only or except
+
+roles_converter = ActiverecordToPoro::Converter.new(Role,
+                                                    except: [:lock_version]
+                                                    )
+
+roles_converter = ActiverecordToPoro::Converter.new(Role,
+                                                    only: [:name]
+                                                    )
+
+# add you'r own mapping rules
+
+roles_converter.extend_mapping do
+  rule to: :lock_version # for more look @ https://github.com/slowjack2k/yaoc
+end
+
+# new rule for faster association mapping
+
+roles_converter.extend_mapping do
+  association_rule to: association_name,
+                   lazy_loading: true,
+                   converter: association_converter
+                   # optional
+                   # from: ...,
+                   # reverse_to: ...,
+                   # reverse_from: ...,
+                   # converter: ...,  # a ActiverecordToPoro::Converter
+                   # is_collection: ..., # when for instance a scope is used or another method that delivers an ar object
+end
+
+
+
 
 
 ```

data/lib/activerecord_to_poro.rb

@@ -3,6 +3,7 @@ require 'activerecord_to_poro/version'
 require 'activerecord_to_poro/metadata_enabled'
 require 'activerecord_to_poro/metadata'
 require 'activerecord_to_poro/default_poro_class_builder'
+require 'activerecord_to_poro/mapper_extension'
 require 'activerecord_to_poro/converter'
 
 module ActiverecordToPoro

data/lib/activerecord_to_poro/converter.rb

@@ -5,13 +5,22 @@ module ActiverecordToPoro
     attr_accessor :load_source_class,
                   :dump_source_class,
                   :association_converters,
-                  :use_lazy_loading
-
-    def initialize(ar_class, use_lazy_loading=true, **association_converters)
+                  :use_lazy_loading,
+                  :except_attributes,
+                  :only_attributes
+
+    def initialize(ar_class,
+                   use_lazy_loading=true,
+                   except: nil,
+                   only: nil,
+                   load_source: nil,
+                   convert_associations: {})
       self.load_source_class = ar_class
-      self.dump_source_class = DefaultPoroClassBuilder.new(ar_class).()
-      self.association_converters = association_converters
+      self.dump_source_class = load_source || DefaultPoroClassBuilder.new(ar_class).()
+      self.association_converters = convert_associations
       self.use_lazy_loading = use_lazy_loading
+      self.except_attributes = Array(except)
+      self.only_attributes = only.nil? ? nil : Array(only) # an empty array can be wanted, so that there is no default mapping @ all
     end
 
     def load(to_convert)
@@ -22,20 +31,37 @@ module ActiverecordToPoro
       mapper.dump(to_convert)
     end
 
+    def extend_mapping(&block)
+      mapper.add_mapping &block
+    end
+
+
     def mapper
       @mapper||= Yaoc::ObjectMapper.new(self.dump_source_class, self.load_source_class).tap do |mapper|
-        add_mapping_for_current_class(mapper)
+        mapper.extend ActiverecordToPoro::MapperExtension
+        mapper.fetcher(:public_send)
+
+        add_default_mapping_for_current_class(mapper)
         add_mapping_for_associations(mapper)
       end
     end
 
+    def attributes_for_default_mapping
+      self.only_attributes || (
+                                columns(self.load_source_class) -
+                                primary_keys(self.load_source_class) -
+                                association_specific_columns(self.load_source_class) -
+                                associated_object_accessors(self.load_source_class) -
+                                self.except_attributes
+                              )
+    end
+
     protected
 
-    def add_mapping_for_current_class(mapper)
-      tmp_quirk = plain_attributes
+    def add_default_mapping_for_current_class(mapper)
+      tmp_quirk = attributes_for_default_mapping
 
       mapper.add_mapping do
-        fetcher :public_send
         rule to: tmp_quirk
 
         rule to: :_set_metadata,
@@ -55,17 +81,13 @@ module ActiverecordToPoro
 
     def add_mapping_for_associations(mapper)
       association_converters.each_pair do |association_name, association_converter|
-        map_collection = self.load_source_class.reflections[association_name].collection?
 
         lazy_quirk = self.use_lazy_loading
 
         mapper.add_mapping do
-          fetcher :public_send
-          rule to: association_name,
-               lazy_loading: lazy_quirk,
-               reverse_lazy_loading: false, #AR doesn't like ToProcDelegator
-               object_converter: association_converter.mapper,
-               is_collection: map_collection
+          association_rule to: association_name,
+                           lazy_loading: lazy_quirk,
+                           converter: association_converter
         end
       end
     end
@@ -86,12 +108,5 @@ module ActiverecordToPoro
       end
     end
 
-    def plain_attributes
-      columns(self.load_source_class) -
-      primary_keys(self.load_source_class) -
-      association_specific_columns(self.load_source_class) -
-      associated_object_accessors(self.load_source_class)
-    end
-
   end
 end

data/lib/activerecord_to_poro/default_poro_class_builder.rb

@@ -2,19 +2,19 @@ module ActiverecordToPoro
   module ColumnHelper
     module_function
     def columns(ar_class)
-      ar_class.column_names
+      ar_class.column_names.map &:to_sym
     end
 
     def primary_keys(ar_class)
-      [ar_class.primary_key]
+      [ar_class.primary_key].map &:to_sym
     end
 
     def association_specific_columns(ar_class)
-      ar_class.reflect_on_all_associations(:belongs_to).map(&:foreign_key)
+      ar_class.reflect_on_all_associations(:belongs_to).map(&:foreign_key).map &:to_sym
     end
 
     def associated_object_accessors(ar_class)
-      ar_class.reflections.keys
+      ar_class.reflections.keys.map &:to_sym
     end
   end
 

data/lib/activerecord_to_poro/mapper_extension.rb

@@ -0,0 +1,27 @@
+module ActiverecordToPoro
+  module MapperExtension
+
+    def association_rule(to: nil,
+                         from: to,
+                         reverse_to: from,
+                         reverse_from: to,
+                         converter: nil,
+                         is_collection: false,
+                         lazy_loading: nil
+                        )
+
+      map_collection = (self.dump_result_source.reflections[from] &&
+                        self.dump_result_source.reflections[from].collection?) || is_collection
+
+      rule to: to,
+           from: from,
+           reverse_to: reverse_to,
+           reverse_from: reverse_from,
+           reverse_lazy_loading: false, #AR doesn't like ToProcDelegator
+           object_converter: converter.mapper,
+           is_collection: map_collection,
+           lazy_loading: lazy_loading
+
+    end
+  end
+end

data/lib/activerecord_to_poro/version.rb

@@ -1,3 +1,3 @@
 module ActiverecordToPoro
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/acceptance/map_ar_associations_spec.rb

@@ -7,13 +7,17 @@ feature 'Map active record associations', %q{
 } do
 
   given!(:mapper){
-    ActiverecordToPoro::Converter.new(a_active_record_class, roles: roles_converter, salutation: salutation_converter)
+    ActiverecordToPoro::Converter.new(a_active_record_class, convert_associations: {roles: roles_converter, salutation: salutation_converter} )
   }
 
   given!(:roles_converter){
     ActiverecordToPoro::Converter.new(Role)
   }
 
+  given!(:permissions_converter){
+    ActiverecordToPoro::Converter.new(Permission)
+  }
+
   given!(:salutation_converter){
     ActiverecordToPoro::Converter.new(Salutation)
   }
@@ -26,12 +30,35 @@ feature 'Map active record associations', %q{
     a_active_record_class.create!(name: "my name", email: "my_name@example.com").tap do |user|
       user.roles.create!(name: "admin")
       user.roles.create!(name: "guest")
+
+      user.roles.first.permissions.create!(name: "first_permission")
+      user.roles.first.permissions.create!(name: "second_permission")
+
+      user.roles.last.permissions.create!(name: "third_permission")
+
       user.salutation = Salutation.create!(name: "Mister")
 
+      user.address = Address.create!(street: 'Westminster Abbey')
+
       user.save!
+
+      user.reload
+    end
+  }
+
+  given(:a_custom_poro_class){
+    ActiverecordToPoro::DefaultPoroClassBuilder.new(a_active_record_class).().tap do |new_class|
+      new_class.send(:attr_accessor, :some_other_name)
     end
   }
 
+  given(:mapper_with_custom_source){
+    ActiverecordToPoro::Converter.new(a_active_record_class,
+                                      load_source: a_custom_poro_class,
+                                      except: [:lock_version]
+    )
+  }
+
 
   scenario "creates a poro out of an ActiveRecord object with associations set" do
     expect(mapper.load(a_active_record_object).roles.size).to eq 2
@@ -41,6 +68,7 @@ feature 'Map active record associations', %q{
   scenario "creates an ActiveRecord object from a poro object with associations set" do
     poro = mapper.load(a_active_record_object)
     expect(mapper.dump(poro).roles.size).to eq 2
+    expect(mapper.dump(poro).permissions.size).to eq 3
   end
 
   scenario "lazy loads associated objects" do
@@ -50,4 +78,21 @@ feature 'Map active record associations', %q{
     mapper.load(a_active_record_object)
   end
 
+  scenario 'add custom association mappings' do
+    quirk_converter = permissions_converter
+
+    mapper_with_custom_source.extend_mapping do
+
+      association_rule to: :some_other_name,
+                       from: :permissions,
+                       converter: quirk_converter,
+                       lazy_loading: true
+
+    end
+
+    user_poro = mapper_with_custom_source.load(a_active_record_object)
+
+    expect(user_poro.some_other_name.size).to eq 3
+  end
+
 end

data/spec/acceptance/map_ar_objects_spec.rb

@@ -10,6 +10,13 @@ feature "Map active record objects", %q{
     ActiverecordToPoro::Converter.new(a_active_record_class)
   }
 
+  given(:mapper_with_custom_source){
+    ActiverecordToPoro::Converter.new(a_active_record_class,
+                                      load_source: custom_poro_class,
+                                      except: [:lock_version]
+    )
+  }
+
   given(:a_active_record_class){
     User
   }
@@ -18,13 +25,12 @@ feature "Map active record objects", %q{
     a_active_record_class.create!(name: "my name", email: "my_name@example.com")
   }
 
-  given(:expected_poro_class_attributes){
-    [:name, :email, :roles, :salutation]
+  given(:custom_poro_class){
+    ActiverecordToPoro::DefaultPoroClassBuilder.new(a_active_record_class).()
   }
 
-
   scenario "creates a poro out of an ActiveRecord object" do
-    expect(mapper.load(a_active_record_object).members).to eq expected_poro_class_attributes
+    expect(mapper.load(a_active_record_object)).not_to be_kind_of ActiveRecord::Base
   end
 
   scenario "creates an ActiveRecord object from a poro object" do
@@ -32,4 +38,16 @@ feature "Map active record objects", %q{
     expect(mapper.dump(poro)).to eq a_active_record_object
   end
 
+  scenario "use my own source class for converting ActiveRecord objects" do
+    expect(mapper_with_custom_source.load(a_active_record_object)).to be_kind_of custom_poro_class
+  end
+
+  scenario 'extend default mapping' do
+    mapper_with_custom_source.extend_mapping do
+      rule to: :lock_version
+    end
+
+    expect(mapper.load(a_active_record_object).lock_version).to eq a_active_record_object.lock_version
+  end
+
 end

data/spec/ar_support/db/migrate/20140127093447_create_my_ar_class.rb

@@ -4,15 +4,30 @@ class CreateMyArClass < ActiveRecord::Migration
       t.string :name
       t.string :email
       t.integer :salutation_id
+      t.integer :lock_version
     end
 
     create_table :roles do |t|
       t.string  :name
       t.integer :user_id
+      t.integer :lock_version
+    end
+
+    create_table :permissions do |t|
+      t.string  :name
+      t.integer :role_id
+      t.integer :lock_version
     end
 
     create_table :salutations do |t|
       t.string  :name
+      t.integer :lock_version
+    end
+
+    create_table :addresses do |t|
+      t.string  :street
+      t.integer :user_id
+      t.integer :lock_version
     end
   end
 end

data/spec/ar_support/models/address.rb

@@ -0,0 +1,3 @@
+class Address < ActiveRecord::Base
+  belongs_to :user, autosave: true
+end

data/spec/ar_support/models/permission.rb

@@ -0,0 +1,3 @@
+class Permission < ActiveRecord::Base
+  belongs_to :role, autosave: true
+end

data/spec/ar_support/models/role.rb

@@ -1,3 +1,4 @@
 class Role < ActiveRecord::Base
-  belongs_to :user
+  has_many :permissions, autosave: true
+  belongs_to :user, autosave: true
 end

data/spec/ar_support/models/salutation.rb

@@ -1,3 +1,3 @@
 class Salutation < ActiveRecord::Base
-  has_many :users
+  has_many :users, autosave: true
 end

data/spec/ar_support/models/user.rb

@@ -1,8 +1,9 @@
 class User < ActiveRecord::Base
-  has_many :roles
-  belongs_to :salutation
+  has_many :roles, autosave: true
+  has_many :permissions, through: :roles, autosave: true
+
+  belongs_to :salutation, autosave: true
+  has_one :address, autosave: true
+
 
-  def zz
-    ActiveRecord::Base.new
-  end
 end

data/spec/integration/lib/activerecord_to_poro/converter_spec.rb

@@ -1,67 +1,88 @@
 require 'integration_spec_helper'
 
 describe ActiverecordToPoro::Converter do
-  subject!{
-    ActiverecordToPoro::Converter.new(User, roles: roles_converter, salutation: salutation_converter)
-  }
-
-  let(:roles_converter){
-    ActiverecordToPoro::Converter.new(Role)
-  }
-
-  let(:salutation_converter){
-    ActiverecordToPoro::Converter.new(Salutation)
-  }
-
-  let(:ar_object){
-    User.create!(name: 'my name', email: 'my_name@example.com').tap do |user|
-      user.roles.create!(name: 'admin')
-      user.roles.create!(name: 'guest')
-    end
-  }
 
-  let!(:loaded_poro_object){
-    subject.load(ar_object)
-  }
+  describe '.new' do
+    subject{
+      ActiverecordToPoro::Converter
+    }
 
-  describe '#load' do
-    it 'creates a poro' do
-      expect(subject.load(ar_object)).not_to be_kind_of ActiveRecord::Base
+    it 'removes "except" attributes from default mapping' do
+      object = subject.new(User, except: :lock_version)
+      expect(object.attributes_for_default_mapping).not_to include :lock_version
     end
 
-    it 'sets metadata for loaded objects' do
-      expect(loaded_poro_object._metadata).not_to be_nil
-      expect(loaded_poro_object._metadata.primary_key_value).to eq ar_object.id
+    it 'uses "only" attributes for default mapping' do
+      object = subject.new(User, only: :id)
+      expect(object.attributes_for_default_mapping).to eq [:id]
     end
 
-    it 'converts also associated objects' do
-      expect(subject.load(ar_object).roles.size).to eq 2
-    end
+  end
+
+  context 'instance methods' do
+    subject!{
+      ActiverecordToPoro::Converter.new(User,  convert_associations: {roles: roles_converter, salutation: salutation_converter})
+    }
 
-    it 'lazy loads associated objects' do
-      expect(ar_object).not_to receive :roles
+    let(:roles_converter){
+      ActiverecordToPoro::Converter.new(Role)
+    }
+
+    let(:salutation_converter){
+      ActiverecordToPoro::Converter.new(Salutation)
+    }
+
+    let(:ar_object){
+      User.create!(name: 'my name', email: 'my_name@example.com').tap do |user|
+        user.roles.create!(name: 'admin')
+        user.roles.create!(name: 'guest')
+      end
+    }
+
+    let!(:loaded_poro_object){
       subject.load(ar_object)
-    end
+    }
 
-  end
+    describe '#load' do
+      it 'creates a poro' do
+        expect(subject.load(ar_object)).not_to be_kind_of ActiveRecord::Base
+      end
 
-  describe '#dump' do
-    it 'creates an ActiveRecordObject' do
-      expect(subject.dump(loaded_poro_object)).to be_kind_of ActiveRecord::Base
-    end
+      it 'sets metadata for loaded objects' do
+        expect(loaded_poro_object._metadata).not_to be_nil
+        expect(loaded_poro_object._metadata.primary_key_value).to eq ar_object.id
+      end
 
-    it 'sets the primary key when it existed before' do
-      expect(subject.dump(loaded_poro_object).id).to eq ar_object.id
-    end
+      it 'converts also associated objects' do
+        expect(subject.load(ar_object).roles.size).to eq 2
+      end
+
+      it 'lazy loads associated objects' do
+        expect(ar_object).not_to receive :roles
+        subject.load(ar_object)
+      end
 
-    it 'sets new_record to false when it is an existing record' do
-      expect(subject.dump(loaded_poro_object).new_record?).to be_falsy
     end
 
-    it 'converts also associated objects' do
-      count_roles = ar_object.roles.size
+    describe '#dump' do
+      it 'creates an ActiveRecordObject' do
+        expect(subject.dump(loaded_poro_object)).to be_kind_of ActiveRecord::Base
+      end
 
-      expect(subject.dump(loaded_poro_object).roles.size).to eq count_roles
+      it 'sets the primary key when it existed before' do
+        expect(subject.dump(loaded_poro_object).id).to eq ar_object.id
+      end
+
+      it 'sets new_record to false when it is an existing record' do
+        expect(subject.dump(loaded_poro_object).new_record?).to be_falsy
+      end
+
+      it 'converts also associated objects' do
+        count_roles = ar_object.roles.size
+
+        expect(subject.dump(loaded_poro_object).roles.size).to eq count_roles
+      end
     end
+
   end
 end

data/spec/integration/lib/activerecord_to_poro/default_poro_class_builder_spec.rb

@@ -6,13 +6,13 @@ describe ActiverecordToPoro::DefaultPoroClassBuilder do
   }
 
   let(:expected_poro_class){
-    Yaoc::Helper::StructHE(:name, :email, :roles, :salutation)
+    Yaoc::Helper::StructHE(:name, :email, :roles, :salutation, :address, :permissions, :lock_version)
   }
 
   describe "#call" do
 
     it "creates a poro class for an ActiveRecord class" do
-      expect(subject.call.members).to eq expected_poro_class.members
+      expect(subject.call.members.sort).to eq expected_poro_class.members.sort
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_to_poro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dieter Späth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -280,6 +280,7 @@ files:
 - lib/activerecord_to_poro.rb
 - lib/activerecord_to_poro/converter.rb
 - lib/activerecord_to_poro/default_poro_class_builder.rb
+- lib/activerecord_to_poro/mapper_extension.rb
 - lib/activerecord_to_poro/metadata.rb
 - lib/activerecord_to_poro/metadata_enabled.rb
 - lib/activerecord_to_poro/version.rb
@@ -288,6 +289,8 @@ files:
 - spec/acceptance_spec_helper.rb
 - spec/ar_spec_helper.rb
 - spec/ar_support/db/migrate/20140127093447_create_my_ar_class.rb
+- spec/ar_support/models/address.rb
+- spec/ar_support/models/permission.rb
 - spec/ar_support/models/role.rb
 - spec/ar_support/models/salutation.rb
 - spec/ar_support/models/user.rb
@@ -328,6 +331,8 @@ test_files:
 - spec/acceptance_spec_helper.rb
 - spec/ar_spec_helper.rb
 - spec/ar_support/db/migrate/20140127093447_create_my_ar_class.rb
+- spec/ar_support/models/address.rb
+- spec/ar_support/models/permission.rb
 - spec/ar_support/models/role.rb
 - spec/ar_support/models/salutation.rb
 - spec/ar_support/models/user.rb