sequel_deep_dup 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dde7ced04065758f9cc497072032be96caf0795d
+  data.tar.gz: 5aa9acc6054864fdd7fa8360217edcafa36fb2eb
+SHA512:
+  metadata.gz: e7531307317303235bcd0596701770aad8b126b04c9cc1da3d42663dcb15dc59acccb357a6cd9caf92b95971e8d66cb5547b68a06abf538bc70910a610216b75
+  data.tar.gz: a7868f64e6cec794d6d4867d3794d954920e16787da4a60b74932b31433620914b8459e7c543c3c0e9273cf3d8a096a22949865e489f20af29cab0587eaf81b6

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel_deep_dup.gemspec
+gemspec
+
+gem 'rspec'
+gem 'sqlite3'
+gem 'sequel'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 macario
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Sequel::DeepDup
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel_deep_dup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel_deep_dup
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/maca/sequel_deep_dup/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sequel_deep_dup.rb

@@ -0,0 +1,72 @@
+require 'sequel'
+require 'sequel/plugins/instance_hooks'
+
+module Sequel
+  module Plugins
+    module DeepDup
+      class DeepDupper
+        attr_reader :instance, :omit_records
+
+        def initialize instance, omit = []
+          @instance     = instance
+          @omit_records = omit
+        end
+
+        def dup_associations instance, copy, associations
+          associations.each do |name|
+            next unless refl = instance.class.association_reflection(name)
+            [*instance.send(name)].compact.each { |rec| instantiate_associated(copy, refl, rec) }
+          end
+        end
+
+        def dup
+          copy = shallow_dup.extend(InstanceHooks::InstanceMethods)
+          omit_records << instance
+          dup_associations(instance, copy, instance.class.associations)
+          copy
+        end
+
+        def shallow_dup
+          klass      = instance.class
+          attributes = instance.to_hash.dup
+          [*klass.primary_key].each { |attr| attributes.delete(attr) }
+          klass.new attributes
+        end
+
+        private
+        def instantiate_associated copy, reflection, record
+          return if omit_records.detect { |to_omit| record.pk == to_omit.pk && record.class == to_omit.class }
+
+          unless reflection[:type] == :many_to_many
+            record = DeepDupper.new(record, omit_records).dup
+          end
+
+          if reflection.returns_array?
+            copy.send(reflection[:name]) << record
+            copy.after_save_hook{ copy.send(reflection.add_method, record) }
+          else
+            copy.associations[reflection[:name]] = record
+
+            copy.instance_variable_set :@set_associated_object_if_same, true
+
+            if reflection[:type] == :many_to_one 
+              copy.before_save_hook {
+                copy.send reflection.setter_method, record.save(:validate=>false)
+              }
+            else
+              copy.after_save_hook{
+                copy.send(reflection.setter_method, record)
+              }
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        def deep_dup
+          DeepDupper.new(self).dup
+        end
+      end
+    end
+  end
+end

data/lib/sequel_deep_dup/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module DeepDup
+      VERSION = "0.1.1"
+    end
+  end
+end

data/sequel_deep_dup.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel_deep_dup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel_deep_dup"
+  spec.version       = Sequel::Plugins::DeepDup::VERSION
+  spec.authors       = ["macario"]
+  spec.email         = ["mail@makarius.me"]
+  spec.summary       = %q{Makes deep copies of existing sequel models into a new record, along with its association tree}
+  spec.description   = %q{Makes deep copies of existing sequel models into a new record, along with its association tree}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/deep_dup_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Sequel::Plugins::DeepDup do
+  let(:program)         { Program.create name: 'CS' }
+  let(:program_copy)    { program.deep_dup }
+  let(:course)          { Course.create name: 'Ruby', program: program }
+  let(:course_copy)     { course.deep_dup }
+  let(:student)         { Student.create name: 'Macario' }
+  let(:student_copy)    { student.deep_dup }
+  let(:enrollment)      { Enrollment.create(student_id: student.id, course_id: course.id) }
+  let(:enrollment_copy) { enrollment.deep_dup }
+
+  describe 'duplicating plain record' do
+
+    before do
+      Program.plugin :deep_dup
+      Enrollment.plugin :deep_dup
+    end
+
+    it { program_copy.name.should == 'CS' }
+    it { program_copy.pk.should be_nil } 
+    it { program_copy.should be_new } 
+    it { enrollment_copy.pk.should == [nil, nil] } 
+    it { enrollment_copy.should be_new }
+  end
+
+  describe 'duplicating record with a one to many association' do
+    before do
+      Program.plugin :deep_dup
+      3.times { |num| program.add_course name: "Course #{num}" }
+    end
+
+    it { program_copy.should have(3).courses }
+    it { program_copy.courses.map(&:pk).should be_none }
+    it { expect { program_copy.save }.to change{ Course.count }.to(6) }
+  end
+
+  describe 'duplicating record with a many to many association' do
+    before do
+      Course.plugin :deep_dup
+      3.times { |num| course.add_category name: "Category #{num}" }
+    end
+
+    it { course_copy.should have(3).categories }
+    it { course_copy.categories.should == course.categories }
+    it { expect { course_copy.save }.not_to change{ Category.count } }
+  end
+
+  describe 'duplicating record with nested many to one' do
+    before do
+      Program.plugin :deep_dup
+      3.times { |num| program.add_course name: "Course #{num}" }
+
+      program.courses.each do |course|
+        3.times { |num| course.add_assignment name: "Assignment #{num}" }
+      end
+    end
+
+    it { program_copy.should have(3).courses }
+    it { program_copy.courses.first.should have(3).assignments }
+    it { expect { program_copy.save }.to change{ Course.count }.to(6) }
+    it { expect { program_copy.save }.to change{ Assignment.count }.to(18) }
+  end
+
+  describe 'duplicating record with a many to many association after a many to one' do
+    before do
+      Program.plugin :deep_dup
+      3.times { |num| program.add_course name: "Course #{num}" }
+      program.courses.each do |course|
+        3.times { |num| course.add_category name: "Category #{num}" }
+      end
+    end
+    
+    it { program_copy.should have(3).courses }
+    it { program_copy.courses.first.should have(3).categories }
+    it { program_copy.courses.last.should have(3).categories }
+    it { expect { program_copy.save }.not_to change{ Category.count } }
+  end
+
+  describe 'duplicating record with one to one' do
+    before do
+      Student.plugin :deep_dup
+      student.account = Account.new(email: 'mail@makarius.me')
+    end
+
+    it { student_copy.account.pk.should be_nil }
+    it { student_copy.account.email.should == 'mail@makarius.me' }
+    it { expect { student_copy.save }.to change { Account.count }.to(2) }
+  end
+
+  describe 'duplicating record with many to one association' do
+    before do
+      Account.plugin :deep_dup
+    end
+
+    let(:account)      { Account.create(email: 'mail@makarius.me', student: student) }
+    let(:account_copy) { account.deep_dup }
+
+    it { account_copy.student.pk.should be_nil }
+    it { account_copy.student.name.should == 'Macario' }
+    it { expect { account_copy.save }.to change { Student.count }.to(2) }
+  end
+
+  describe 'duplicating record with one to one when foreign key is pk' do
+    before do
+      Student.plugin :deep_dup
+      student.profile = Profile.create(bio: 'likes sequel, rides bycicle', student: student)
+    end
+
+    it { student_copy.profile.pk.should be_nil }
+    it { student_copy.profile.bio.should == 'likes sequel, rides bycicle' }
+    it { expect { student_copy.save }.to change { Profile.count }.to(2) }
+  end
+
+  describe 'duplicating record with many to one association when foreign key is pk' do
+    before do
+      Profile.plugin :deep_dup
+    end
+
+    let(:profile)      { Profile.create(bio: 'likes sequel, rides bycicle', student: student) }
+    let(:profile_copy) { profile.deep_dup }
+
+    it { profile_copy.student.pk.should be_nil }
+    it { profile_copy.student.name.should == 'Macario' }
+    it { expect { profile_copy.save }.to change { Student.count }.to(2) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+Bundler.require
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sequel/extensions/migration'
+load 'support/migrations.rb'
+
+DB = Sequel.sqlite
+Sequel::Migration.descendants.each { |m| m.apply(DB, :up) }
+
+
+RSpec.configure do |config|
+  config.around :each do |example|
+    load 'support/models.rb'
+
+    DB.transaction do
+      example.run
+      raise Sequel::Rollback
+    end
+
+    %w(Program Course Assignment Student Account Profile Enrollment Category).each do |const|
+      Object.send :remove_const, const
+    end
+  end
+end

data/spec/support/migrations.rb

@@ -0,0 +1,55 @@
+Sequel.migration do
+  up do
+    create_table :programs do
+      primary_key :id
+      String :name, null: false
+    end
+
+    create_table :courses do
+      primary_key :id
+      foreign_key :program_id, :programs, :on_delete => :restrict, :on_update => :restrict, :null => false
+      String :name, null: false
+      Date :starts
+      Date :ends
+    end
+
+    create_table :assignments do
+      primary_key :id
+      foreign_key :course_id, :courses, :on_delete => :restrict, :on_update => :restrict, :null => false
+      String :name, null: false
+    end
+
+    create_table :students do
+      primary_key :id
+      String :name, null: false
+    end
+
+    create_table :accounts do
+      primary_key :id
+      foreign_key :student_id, :students, :on_delete => :restrict, :on_update => :restrict, :null => false
+      String :email, null: false
+    end
+
+    create_table :profiles do
+      foreign_key :student_id, :students, :on_delete => :restrict, :on_update => :restrict, :null => false
+      String :bio
+      primary_key :student_id
+    end
+
+    create_table :enrollments do
+      foreign_key :student_id, :on_delete => :restrict, :on_update => :restrict, :null => false
+      foreign_key :course_id, :on_delete => :restrict, :on_update => :restrict, :null => false
+      primary_key [:student_id, :course_id]
+    end
+
+    create_table :categories do
+      primary_key :id
+      String :name, null: false
+    end
+
+    create_table :course_categories do
+      foreign_key :course_id, :courses, :on_delete => :restrict, :on_update => :restrict, :null => false
+      foreign_key :category_id, :categories, :on_delete => :restrict, :on_update => :restrict, :null => false
+    end
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,39 @@
+class Program < Sequel::Model
+  one_to_many :courses
+end
+
+class Course < Sequel::Model
+  many_to_one  :program
+  one_to_many  :assignments
+  many_to_many :categories, join_table: :course_categories
+end
+
+class Assignment < Sequel::Model
+  many_to_one :course
+end
+
+class Student < Sequel::Model
+  one_to_many :enrollments
+  one_to_one  :account
+  one_to_one  :profile
+end
+
+class Account < Sequel::Model
+  many_to_one :student
+end
+
+class Profile < Sequel::Model
+  set_primary_key :student_id  
+  many_to_one :student
+end
+
+class Enrollment < Sequel::Model
+  unrestrict_primary_key
+  set_primary_key [:student_id, :course_id]
+  many_to_one :student
+  many_to_one :course
+end
+
+class Category < Sequel::Model
+  many_to_many :courses, join_table: :course_categories
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: sequel_deep_dup
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- macario
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes deep copies of existing sequel models into a new record, along
+  with its association tree
+email:
+- mail@makarius.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel_deep_dup.rb
+- lib/sequel_deep_dup/version.rb
+- sequel_deep_dup.gemspec
+- spec/deep_dup_spec.rb
+- spec/spec_helper.rb
+- spec/support/migrations.rb
+- spec/support/models.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Makes deep copies of existing sequel models into a new record, along with
+  its association tree
+test_files:
+- spec/deep_dup_spec.rb
+- spec/spec_helper.rb
+- spec/support/migrations.rb
+- spec/support/models.rb
+has_rdoc: