activerecord-conversion 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-conversion.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2012 Maximilian Schneider
+
+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,39 @@
+# Activerecord::Conversion
+
+Aids you in migrating legacy model data.
+Saves its progress in the database and is able to resume after interruptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-conversion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-conversion
+
+## Usage
+
+    class UserConversion < ActiveRecord::Conversion
+      source "old_users"
+      target "new_users"
+
+      def self.convert old_user
+        # create and return a new user
+      end
+    end
+
+    UserConversion.run
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/activerecord-conversion.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "activerecord/conversion/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Maximilian Schneider"]
+  gem.email         = ["mail@maximilianschneider.net"]
+  gem.description   = "Aids you in migrating legacy model data. Saves its progress in the database and is able to resume after interruptions."
+  gem.summary       = "Simple data migration based on ActiveRecord"
+  gem.homepage      = "https://github.com/mschneider/activerecord-conversion"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-conversion"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveRecord::Conversion::VERSION
+
+  gem.add_runtime_dependency 'activerecord', '~> 3.2.3'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/activerecord/conversion.rb

@@ -0,0 +1,85 @@
+#encoding: utf-8
+
+require "active_record"
+
+module ActiveRecord
+  class Conversion
+
+    class << self
+      attr_accessor :source, :target
+
+      %w[source target].each do |field|
+        define_method "#{field}_foreign_key" do
+          send(field).singularize.foreign_key
+        end
+
+        define_method "#{field}_class" do
+          send(field).classify.constantize
+        end
+      end
+
+      def record_class
+        this = self
+        @record_class ||= Class.new(ActiveRecord::Base) do
+          self.table_name = this.record_table_name
+        end
+      end
+
+      def record_table_name
+        self.to_s.tableize.singularize
+      end
+
+      def create_record_table
+        record_class.connection.execute(
+          "CREATE TABLE IF NOT EXISTS '#{record_table_name}'('id' INTEGER, "+
+          "'#{source_foreign_key}' INTEGER, '#{target_foreign_key}' INTEGER, "+
+          "PRIMARY KEY('#{source_foreign_key}'))")
+      end
+
+      def define_relation_to(model)
+        record_class.belongs_to(model)
+        record_class.validates(model, presence: true)
+      end
+
+      def define_relations
+        [source, target].each do |relation|
+          model_name = relation.singularize
+          define_relation_to(model_name)
+        end
+      end
+
+      def remaining_items
+        source_class.where(
+          ["#{source_class.primary_key} NOT IN (SELECT #{source_foreign_key} FROM :records)",
+           records: record_table_name])
+      end
+
+      def convert source_item
+        raise "implement self.convert in your subclass"
+      end
+
+      def migrate source_item
+        target_item = convert(source_item)
+        progress_record = record_class.create!({ source_foreign_key => source_item.id,
+                                                 target_foreign_key => target_item.id })
+      end
+
+      def resume
+        remaining_items.each do |source_item|
+          ActiveRecord::Base.transaction do
+            migrate source_item
+          end
+        end
+      end
+
+      def run
+        define_relations
+        create_record_table
+        resume
+      end
+    end
+  end
+end
+
+
+

data/lib/activerecord/conversion/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class Conversion
+    VERSION = "0.0.1"
+  end
+end

data/spec/conversion_spec.rb

@@ -0,0 +1,126 @@
+#encoding: utf-8
+
+require "rubygems"
+require "bundler/setup"
+Bundler.require
+require "activerecord/conversion"
+
+#require 'logger'
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+class SourceRecord < ActiveRecord::Base;end
+class TargetRecord < ActiveRecord::Base;end
+
+class ExampleConversion < ActiveRecord::Conversion
+  self.source = "source_records"
+  self.target = "target_records"
+
+  def self.convert source_record
+    TargetRecord.create!(source_record.attributes)
+  end
+end
+
+class MinimalConversion < ActiveRecord::Conversion
+
+end
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :documentation
+
+  config.before :suite do
+    ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+    ActiveRecord::Base.connection.execute "CREATE TABLE IF NOT EXISTS source_records(id INTEGER, name STRING, PRIMARY KEY(id))"
+    ActiveRecord::Base.connection.execute "CREATE TABLE IF NOT EXISTS target_records(id INTEGER, name STRING, PRIMARY KEY(id))"
+  end
+
+  config.after :suite do
+    ActiveRecord::Base.connection.execute "DROP TABLE source_records"
+    ActiveRecord::Base.connection.execute "DROP TABLE target_records"
+    ActiveRecord::Base.connection.execute "DROP TABLE example_conversion"
+  end
+end
+
+
+describe ActiveRecord::Conversion do
+  context MinimalConversion do
+    it "should raise an exception when convert is not defined" do
+      lambda { MinimalConversion.convert(nil) }.should raise_error(RuntimeError,
+                                       "implement self.convert in your subclass")
+    end
+  end
+
+  before(:all) { ExampleConversion.create_record_table }
+
+  before do
+    SourceRecord.all.each(&:delete)
+    TargetRecord.all.each(&:delete)
+    ExampleConversion.record_class.all.each(&:delete)
+  end
+
+  it "should define all relationships, create a table and resume the migration when run" do
+    ExampleConversion.should_receive(:define_relations).ordered
+    ExampleConversion.should_receive(:create_record_table).ordered
+    ExampleConversion.should_receive(:resume).ordered
+    ExampleConversion.run
+  end
+
+
+  it "should setup the record_class when defining relations" do
+    ExampleConversion.record_class.should_receive(:belongs_to).with("source_record")
+    ExampleConversion.record_class.should_receive(:validates).with("source_record", presence: true)
+    ExampleConversion.record_class.should_receive(:belongs_to).with("target_record")
+    ExampleConversion.record_class.should_receive(:validates).with("target_record", presence: true)
+
+    ExampleConversion.define_relations
+  end
+
+  it "should execute a CREATE TABLE statement when creating the record table" do
+      @connection = double("connection")
+      ExampleConversion.record_class.stub(:connection).and_return(@connection)
+      @connection.should_receive(:execute).with(
+        "CREATE TABLE IF NOT EXISTS 'example_conversion'('id' INTEGER, "+
+        "'source_record_id' INTEGER, 'target_record_id' INTEGER, "+
+        "PRIMARY KEY('source_record_id'))")
+      ExampleConversion.create_record_table
+  end
+
+  it "resumes by migrating all remaining_items" do
+    @source_items = [double("source_record1"), double("source_record2")]
+    ExampleConversion.should_receive(:remaining_items).and_return(@source_items)
+    ExampleConversion.should_receive(:migrate).with(@source_items.first)
+    ExampleConversion.should_receive(:migrate).with(@source_items.second)
+    ExampleConversion.resume
+  end
+
+  it "migrates source items by converting them and saving a mapping record" do
+    source_item = double("source_record", id: :source_id)
+    target_item = double("target_record", id: :target_id)
+    ExampleConversion.should_receive(:convert).with(source_item).and_return(target_item)
+    ExampleConversion.record_class.should_receive(:create!).with({
+      "source_record_id" => :source_id, "target_record_id" => :target_id })
+    ExampleConversion.migrate(source_item)
+  end
+
+  context "#record_class" do
+    subject { MinimalConversion.record_class }
+
+    its(:superclass) { should be(ActiveRecord::Base) }
+    its(:table_name) { should == "minimal_conversion" }
+  end
+
+  context "#remaining_items" do
+    before do
+      @first = SourceRecord.create!(name: "already migrated")
+      ExampleConversion.migrate(@first)
+      @second = SourceRecord.create!(name: "not migrated")
+    end
+
+    subject { ExampleConversion.remaining_items.all }
+
+    it { should_not include(@first) }
+    it { should include(@second) }
+  end
+
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-conversion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maximilian Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2157775120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157775120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157774700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157774700
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2157774240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157774240
+description: Aids you in migrating legacy model data. Saves its progress in the database
+  and is able to resume after interruptions.
+email:
+- mail@maximilianschneider.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-conversion.gemspec
+- lib/activerecord/conversion.rb
+- lib/activerecord/conversion/version.rb
+- spec/conversion_spec.rb
+has_rdoc: true
+homepage: https://github.com/mschneider/activerecord-conversion
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple data migration based on ActiveRecord
+test_files:
+- spec/conversion_spec.rb