rmre 0.0.5 → 0.0.6

data/.gitignore

@@ -1,4 +1,7 @@
 *.gem
 tmp
-vendor/bundle
 .bundle
+vendor/
+.projectile
+*.sublime-project
+*.sublime-workspace

data/Gemfile.lock

@@ -1,43 +1,45 @@
 PATH
   remote: .
   specs:
-    rmre (0.0.5)
+    rmre (0.0.6)
       activerecord (>= 3.0.0)
       erubis
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.4)
     diff-lcs (1.1.3)
     erubis (2.7.0)
     i18n (0.6.1)
-    multi_json (1.3.6)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    tzinfo (0.3.34)
+    multi_json (1.7.3)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rake
   rmre!
   rspec

data/HISTORY.rdoc

@@ -2,6 +2,21 @@ Rmre is utility gem for creating Ruby on Rails models for legacy databases.
 
 Changes:
 
+=== 0.0.6 / 2013-xx-xx
+
+* Enhancements
+
+  * Added support for mysql2 gem with foreign keys ({Daniel Garajau}[https://github.com/kriansa])
+  * Added support for non-standard foreign key names in has_many relationship ({Gui Weinmann}[https://github.com/alphabet])
+  * Changed readme file to use mysql2 gem in samples ({Ketan Deshmukh}[https://github.com/ketan21])
+  * Experimental support for copying databases through db_copy binary or by using Rmre::Migrator class
+
+=== 0.0.5 / 2012-11-04
+
+* Enhancements
+
+  * Drop explicit erubis dependency which prevented rmre usage along with newest Rails versions
+
 === 0.0.4 / 2012-06-07
 
 * Enhancements

data/README.rdoc

@@ -8,7 +8,7 @@ sets models relationships on a basic level through belongs_to and has_many decla
 
 = Installation
 
-Rmre gem is on the Rubygems and you can install it with
+Rmre can be installed with
 
   gem install rmre
 
@@ -16,7 +16,7 @@ Rmre gem is on the Rubygems and you can install it with
 
 Rmre is very simple to use:
 
-  rmre -a mysql -d my_database -u my_username -p my_password -o /path/where/models/will/be/created
+  rmre -a mysql2 -d my_database -u my_username -p my_password -o /path/where/models/will/be/created
 
 That's all! Of course there is standard help which you can print at any time:
 
@@ -63,6 +63,83 @@ If you want to try *Rmre* and you do not have sample database you can use
 _Sakila_ at http://dev.mysql.com/doc/sakila/en/sakila.html#sakila-installation for MySQL and
 _Pagila_ at http://pgfoundry.org/projects/dbsamples for PostgreSQL.
 
+= Copying databases
+
+Rmre gem has built-in support for copying databases (structure and data). This feature is
+currently experimental.
+
+During copy, Rmre will create primary keys on target tables. Since Rmre uses ActiveRecord,
+composite primary keys are not supported.
+
+Copying structure between different RDBMS can be tricky due to different data types.
+Some adapters do not convert all types to Rails value. Example is oracle_enhanced adapter
+which for 'LONG' column type sets column's type to nil but keeps sql_type as 'LONG'. Rmre
+handles these cases through Rmre::DbUtils module. Currently it properly converts Oracle's
++raw+ and +LONG+ types to MySQL's +binary+ and +text+. Support for more conversions will
+be added (if I find or get info about needed conversions). However if you write your own
+script and do not use +db_copy+ runner you can set additional conversion rules by adding
+values to Rmre::DbUtils::COLUMN_CONVERSIONS hash.
+
+Keys in this hash are target sdapter names and values are hashes with source column type
+as key and target column type as value:
+
+  COLUMN_CONVERSIONS = {
+      "Mysql2" => {
+        :raw => :binary,
+        "LONG" => :text
+      }
+    }
+
+In order to copy one database to another RDBMS you must start db_copy with +-f+ option
+and with path to YAML configuration file. Full sample of configuration file is:
+
+  :source:
+    adapter: sqlserver
+    mode: dblib
+    dataserver:
+    host: localhost
+    port: 1433
+    database: source_db
+    username: source_username
+    password: source_pass
+    timeout: 5000
+  :target:
+    adapter: mysql2
+    encoding: utf8
+    reconnect: false
+    database: target_db
+    pool: 5
+    username: target_username
+    password: target_pass
+    host: localhost
+  :verbose: true
+  :force: true
+  :skip_existing: false
+  :skip:
+    - do_not_copy_table_1
+    - do_not_copy_table_2
+
+Source and target options are standard Rails configurations for source and target databases.
+Parameter +:verbose+ is optional and can be omitted. If set to try will db_copy will pring out
+progress during copy. This parameter can be set also by passing +-v+ options to db_copy
+
+  db_copy -f /path/to/config/file.yml -v
+
+Value from file will override the one given on the command line.
+
+Next optional parameter is +:force+. If it is set to true Migrator class will force table creation
+Similar to +verbose+ parameter this value can be set by passing +-o+ option to db_copy and value
+from configuration file will override the value given on the command line.
+
+Parameter +:skip_existing+ signals db_copy to skip tables that already exist in target database.
+
+If you do not want to copy some tables add them to the array +:skip+ in configuration file.
+
+There is a big probability that db_copy will not be able to copy database which is not Rails compliant.
+Reasons for this are numerous: unsupported column types, composite primary keys, etc. If you face such
+a problem create an issue and I will try to implement support for various special cases. However if used
+on Rails compliant databases db_copy should be able to peform full copy between any of supported RDBMS.
+
 = TODO
 
 * Improve filtering

data/bin/db_copy

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require "yaml"
+require "optparse"
+require "rmre"
+
+options = {verbose: false, force: false}
+sample_cfg = {source: '<Source DB connection settings>',
+  target: '<Target DB connection settings>',
+  verbose: true,
+  force: true,
+  skip_existing: false,
+  skip: ["skip_one", "skip_two"]
+}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: db_copy -f CONFIGURATION_FILE"
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    puts "Format of configuration file:\n#{sample_cfg.to_yaml}"
+    exit
+  end
+
+  opts.on('-f', '--file CONFIGURATION_FILE',
+          'File with source and target DB connection settings') do |f|
+    options[:file] = f
+  end
+
+  opts.on('-v', '--verbose',
+    'Verbose mode (show progress)') do |v|
+    options[:verbose] = true
+  end
+
+  opts.on('-o', '--force',
+    'Force creating tables in target database') do |o|
+    options[:force] = true
+  end
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::ParseError => pe
+  puts pe.message
+  puts optparse
+  exit
+end
+
+options.merge! YAML.load_file(options[:file]) if options[:file] && File.exists?(options[:file])
+
+unless options[:source] && options[:target]
+  puts "Missing configurations for source and target database"
+  puts optparse
+  puts "Format of configuration file:\n#{sample_cfg.to_yaml}"
+  exit
+end
+
+mig = Rmre::Migrator.new(options[:source],
+  options[:target],
+  verbose: options[:verbose],
+  skip_existing: options[:skip_existing])
+mig.before_copy = lambda { |table_name|
+  return false if options[:skip].include?(table_name)
+  true
+}
+
+begin
+  mig.copy(options[:force])
+rescue Exception => e
+  puts e.message
+  exit
+end

data/bin/rmre

@@ -107,7 +107,7 @@ if options[:file] == true
                             :file_name => "#{file_name}")
   end
 else
-  options = YAML.load_file(options[:file]) if options[:file] && File.exists?(options[:file])
+  options.merge! YAML.load_file(options[:file]) if options[:file] && File.exists?(options[:file])
 
   unless options[:db][:adapter]
     puts "Missing required arguments -a (--adapter) and -d (--database)"
@@ -115,7 +115,7 @@ else
     exit
   end
 
-  generator = Rmre::Generator.new(options[:db], options[:out_path], options[:include])
+  generator = Rmre::Generator.new(options[:db], options[:out_path], options[:include], options[:inflections])
 
   begin
     generator.connect

data/lib/contrib/progressbar.rb

@@ -0,0 +1,237 @@
+# = progressbar.rb
+#
+# == Copyright (C) 2001 Satoru Takabayashi
+#
+#   Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
+#
+# == Author(s)
+#
+# * Satoru Takabayashi
+
+# Author::    Satoru Takabayashi
+# Copyright:: Copyright (c) 2001 Satoru Takabayashi
+# License::   Ruby License
+
+# = Console Progress Bar
+#
+# Console::ProgressBar is a terminal-based progress bar library.
+#
+# == Usage
+#
+#   pbar = ConsoleProgressBar.new( "Demo", 100 )
+#   100.times { pbar.inc }
+#   pbar.finish
+#
+
+module Console; end
+
+class Console::ProgressBar
+
+  def initialize(title, total, out = STDERR)
+    @title = title
+    @total = total
+    @out = out
+    @bar_length = 80
+    @bar_mark = "o"
+    @total_overflow = true
+    @current = 0
+    @previous = 0
+    @is_finished = false
+    @start_time = Time.now
+    @format = "%-14s %3d%% %s %s"
+    @format_arguments = [:title, :percentage, :bar, :stat]
+    show_progress
+  end
+
+  private
+  def convert_bytes (bytes)
+    if bytes < 1024
+      sprintf("%6dB", bytes)
+    elsif bytes < 1024 * 1000 # 1000kb
+      sprintf("%5.1fKB", bytes.to_f / 1024)
+    elsif bytes < 1024 * 1024 * 1000  # 1000mb
+      sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
+    else
+      sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
+    end
+  end
+
+  def transfer_rate
+    bytes_per_second = @current.to_f / (Time.now - @start_time)
+    sprintf("%s/s", convert_bytes(bytes_per_second))
+  end
+
+  def bytes
+    convert_bytes(@current)
+  end
+
+  def format_time (t)
+    t = t.to_i
+    sec = t % 60
+    min  = (t / 60) % 60
+    hour = t / 3600
+    sprintf("%02d:%02d:%02d", hour, min, sec);
+  end
+
+  # ETA stands for Estimated Time of Arrival.
+  def eta
+    if @current == 0
+      "ETA:  --:--:--"
+    else
+      elapsed = Time.now - @start_time
+      eta = elapsed * @total / @current - elapsed;
+      sprintf("ETA:  %s", format_time(eta))
+    end
+  end
+
+  def elapsed
+    elapsed = Time.now - @start_time
+    sprintf("Time: %s", format_time(elapsed))
+  end
+
+  def stat
+    if @is_finished then elapsed else eta end
+  end
+
+  def stat_for_file_transfer
+    if @is_finished then 
+      sprintf("%s %s %s", bytes, transfer_rate, elapsed)
+    else 
+      sprintf("%s %s %s", bytes, transfer_rate, eta)
+    end
+  end
+
+  def eol
+    if @is_finished then "\n" else "\r" end
+  end
+
+  def bar
+    len = percentage * @bar_length / 100
+    sprintf("|%s%s|", @bar_mark * len, " " *  (@bar_length - len))
+  end
+
+  def percentage
+    if @total.zero?
+      100
+    else
+      @current  * 100 / @total
+    end
+  end
+
+  def title
+    @title[0,13] + ":"
+  end
+
+  def get_width
+    # FIXME: I don't know how portable it is.
+    default_width = 80
+    begin
+      tiocgwinsz = 0x5413
+      data = [0, 0, 0, 0].pack("SSSS")
+      if @out.ioctl(tiocgwinsz, data) >= 0 then
+        rows, cols, xpixels, ypixels = data.unpack("SSSS")
+        if cols >= 0 then cols else default_width end
+      else
+        default_width
+      end
+    rescue Exception
+      default_width
+    end
+  end
+
+  def show
+    arguments = @format_arguments.map {|method| send(method) }
+    line = sprintf(@format, *arguments)
+
+    width = get_width
+    if line.length == width - 1 
+      @out.print(line + eol)
+    elsif line.length >= width
+      @bar_length = [@bar_length - (line.length - width + 1), 0].max
+      if @bar_length == 0 then @out.print(line + eol) else show end
+    else #line.length < width - 1
+      @bar_length += width - line.length + 1
+      show
+    end
+  end
+
+  def show_progress
+    if @total.zero?
+      cur_percentage = 100
+      prev_percentage = 0
+    else
+      cur_percentage  = (@current  * 100 / @total).to_i
+      prev_percentage = (@previous * 100 / @total).to_i
+    end
+
+    if cur_percentage > prev_percentage || @is_finished
+      show
+    end
+  end
+
+  public
+  def file_transfer_mode
+    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]  
+  end
+
+  def bar_mark= (mark)
+    @bar_mark = String(mark)[0..0]
+  end
+
+  def total_overflow= (boolv)
+    @total_overflow = boolv ? true : false
+  end
+
+  def format= (format)
+    @format = format
+  end
+
+  def format_arguments= (arguments)
+    @format_arguments = arguments
+  end
+
+  def finish
+    @current = @total
+    @is_finished = true
+    show_progress
+  end
+
+  def halt
+    @is_finished = true
+    show_progress
+  end
+
+  def set (count)
+    if count < 0
+      raise "invalid count less than zero: #{count}"
+    elsif count > @total
+      if @total_overflow
+        @total = count + 1
+      else
+        raise "invalid count greater than total: #{count}"
+      end
+    end
+    @current = count
+    show_progress
+    @previous = @current
+  end
+
+  def inc (step = 1)
+    @current += step
+    @current = @total if @current > @total
+    show_progress
+    @previous = @current
+  end
+
+  def inspect
+    "(ProgressBar: #{@current}/#{@total})"
+  end
+
+end

data/lib/rmre.rb

@@ -1,2 +1,3 @@
 require 'rmre/generator'
+require "rmre/migrator"
 require 'rmre/version'

data/lib/rmre/db_utils.rb

@@ -0,0 +1,18 @@
+module Rmre
+  module DbUtils
+    COLUMN_CONVERSIONS = {
+      "Mysql2" => {
+        :raw => :binary,
+        "LONG" => :text
+      }
+    }
+
+    def self.convert_column_type(target_adapter_name, start_type)
+      if COLUMN_CONVERSIONS[target_adapter_name] &&
+         COLUMN_CONVERSIONS[target_adapter_name][start_type]
+        return COLUMN_CONVERSIONS[target_adapter_name][start_type]
+      end
+      return start_type
+    end
+  end
+end

data/lib/rmre/dynamic_db.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+
+module Rmre
+  module DynamicDb
+    def self.included(base)
+      base.send :extend, Rmre::DynamicDb
+    end
+
+    def connection_options
+      @connection_options
+    end
+
+    def connection_options= v
+      @connection_options = v
+    end
+
+    def create_model_for(table_name, primary_key_name)
+      model_name = table_name.classify
+      module_eval <<-ruby_src, __FILE__, __LINE__ + 1
+        class #{model_name} < Db
+          self.table_name = '#{table_name}'
+          establish_connection(#{connection_options})
+        end
+      ruby_src
+      klass = const_get model_name
+      klass.primary_key = primary_key_name if primary_key_name && primary_key_name != 'id'
+      klass
+    end
+  end
+end

data/lib/rmre/generator.rb

@@ -10,11 +10,17 @@ module Rmre
 
     SETTINGS_ROOT = File.expand_path('../../../../db', __FILE__)
 
-    def initialize(options, out_path, include)
+    def initialize(options, out_path, include, custom_inflections)
       @connection_options = options
       @connection = nil
       @output_path = out_path
       @include_prefixes = include
+      ActiveSupport::Inflector.inflections do |inflect|
+        custom_inflections.each do |ci|
+          inflect.plural(/#{ci[:plural].first}/, ci[:plural].second)
+          inflect.singular(/#{ci[:singular].first}/, ci[:singular].second)
+        end if custom_inflections.is_a? Array
+      end
     end
 
     def connect
@@ -70,6 +76,7 @@ module Rmre
       fk = []
       case @connection_options[:adapter]
       when 'mysql'
+      when 'mysql2'
         fk = mysql_foreign_keys
       when 'postgresql'
         fk = psql_foreign_keys
@@ -87,6 +94,9 @@ module Rmre
         src = "belongs_to :#{fk['to_table'].downcase.singularize}, :class_name => '#{fk['to_table'].tableize.classify}', :foreign_key => :#{fk['from_column']}"
       elsif fk['to_table'] == table_name
         src = "has_many :#{fk['from_table'].downcase.pluralize}, :class_name => '#{fk['from_table'].tableize.classify}'"
+        if connection.primary_key(table_name) == fk['from_column']
+          src +=  ", :foreign_key => :#{fk['from_column']}"
+        end
       end
       src
     end

data/lib/rmre/migrator.rb

@@ -0,0 +1,141 @@
+require "rmre/db_utils"
+require "rmre/dynamic_db"
+require "contrib/progressbar"
+
+module Rmre
+  module Source
+    include DynamicDb
+
+    class Db < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+
+  module Target
+    include DynamicDb
+
+    class Db < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+
+  class Migrator
+    attr_accessor :before_copy
+
+    def initialize(source_db_options, target_db_options, options = {})
+      # If set to true will call AR create_table with force (table will be dropped if exists)
+      @force_table_create = false
+      @skip_existing_tables = options[:skip_existing]
+      @verbose = options[:verbose]
+      @before_copy = nil
+
+      Rmre::Source.connection_options = source_db_options
+      Rmre::Target.connection_options = target_db_options
+      Rmre::Source::Db.establish_connection(Rmre::Source.connection_options)
+      Rmre::Target::Db.establish_connection(Rmre::Target.connection_options)
+    end
+
+    # Before we start copying we call block if it is given so some additional options
+    # can be set. For example MS SQL adapter has option to use lowercase names for
+    # all entities. We can set this options in a following way:
+    #
+    # mig = Migrator.new(..)
+    # mig.copy(true) do
+    #   ActiveRecord::ConnectionAdapters::SQLServerAdapter.lowercase_schema_reflection = true
+    # end
+    def copy(force = false)
+      yield if block_given?
+
+      @force_table_create = force
+      tables_count = Rmre::Source::Db.connection.tables.length
+      Rmre::Source::Db.connection.tables.sort.each_with_index do |table, idx|
+        info "Copying table #{table} (#{idx + 1}/#{tables_count})..."
+        copy_table(table)
+      end
+    end
+
+    def copy_table(table)
+      if @skip_existing_tables && Rmre::Target::Db.connection.table_exists?(table)
+        info "Skipping #{table}"
+        return
+      end
+
+      if before_copy && before_copy.is_a?(Proc)
+        return unless before_copy.call(table)
+      end
+
+      if !Rmre::Target::Db.connection.table_exists?(table) || @force_table_create
+        create_table(table, Rmre::Source::Db.connection.columns(table))
+      end
+      copy_data(table)
+    end
+
+    def create_table(table, source_columns)
+      primary_key = Rmre::Source::Db.connection.primary_key(table)
+
+      # Create primary key if source table has primary key
+      opts = { :id => !primary_key.nil?, :force => @force_table_create }
+      # If primary key is not 'id' then set option to create proper primary key
+      opts[:primary_key] = primary_key unless primary_key == "id"
+
+      Rmre::Target::Db.connection.create_table(table, opts) do |t|
+        # Skip 'id' column if it is already created as primary key
+        source_columns.reject {|col| col.name == 'id' && opts[:id] && opts[:primary_key].nil? }.each do |sc|
+          options = {
+            :null => sc.null,
+            :default => sc.default
+          }
+
+          # Some adapters do not convert all types to Rails value. Example is oracle_enhanced adapter
+          # which for 'LONG' column type sets column's type to nil but keeps sql_type as 'LONG'.
+          # Therefore we will use one of these values so we can, in DbUtils, handle all possible
+          # column type mappings when we are migrating from one DB to anohter (Oracle -> MySQL,
+          # MS SQL -> PostgreSQL, etc).
+          source_type = sc.type.nil? ? sc.sql_type : sc.type
+          col_type = Rmre::DbUtils.convert_column_type(Rmre::Target::Db.connection.adapter_name, source_type)
+          case col_type
+          when :decimal
+            options.merge!({
+                :limit => sc.limit,
+                :precision => sc.precision,
+                :scale => sc.scale,
+              })
+          when :string
+            options.merge!({
+                :limit => sc.limit
+              })
+          end
+
+          t.column(sc.name, col_type, options)
+        end
+      end
+    end
+
+    def table_has_type_column(table)
+      Rmre::Source::Db.connection.columns(table).find {|col| col.name == 'type'}
+    end
+
+    def copy_data(table_name)
+      primary_key = Rmre::Source::Db.connection.primary_key(table_name)
+
+      src_model = Rmre::Source.create_model_for(table_name, primary_key)
+      src_model.inheritance_column = 'ruby_type' if table_has_type_column(table_name)
+      tgt_model = Rmre::Target.create_model_for(table_name, primary_key)
+
+      rec_count = src_model.count
+      # We will always copy attributes without protection because we
+      # are the ones initiating DB copy (no need to preform additional checks)
+      progress_bar = Console::ProgressBar.new(table_name, rec_count) if @verbose
+      src_model.all.each do |src_rec|
+        tgt_model.create!(src_rec.attributes, :without_protection => true)
+        progress_bar.inc if @verbose
+      end
+    end
+
+    private
+
+    def info(msg)
+      puts msg if @verbose
+    end
+  end
+end

data/lib/rmre/version.rb

@@ -1,3 +1,3 @@
 module Rmre
-  VERSION = "0.0.5" unless defined?(::Rmre::VERSION)
+  VERSION = "0.0.6" unless defined?(::Rmre::VERSION)
 end

data/rmre.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "activerecord", ">= 3.0.0"
   s.add_dependency "erubis"
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
 
   s.files              = `git ls-files`.split("\n")

data/spec/rmre/generator_spec.rb

@@ -8,17 +8,19 @@ module Rmre
           :username => 'user',
           :password => 'pass'},
         :out_path => File.join(Dir.tmpdir, 'gne-test'),
-        :include => ['incl1_', 'incl2_']}
+        :include => ['incl1_', 'incl2_'],
+        :inflections => [{plural: ["(.*)_des$", '\1_des'], singular: ["(.*)_des$", '\1_des']}]
+      }
     end
 
     let(:generator) do |gen|
-      gen = Generator.new(settings[:db], settings[:out_path], settings[:include])
+      gen = Generator.new(settings[:db], settings[:out_path], settings[:include], settings[:inflections])
       connection = double("db_connection")
       connection.stub(:columns).and_return([])
       gen.stub(:connection).and_return(connection)
       gen
     end
-    
+
     let(:tables)    { %w(incl1_tbl1 incl1_tbl2 incl2_tbl1 user processes) }
 
     it "should flag table incl1_tbl1 for processing" do
@@ -28,7 +30,7 @@ module Rmre
     it "should not flag table 'processes' for processing" do
       generator.process?('processes').should be_false
     end
-    
+
     it "should process three tables from the passed array of tables" do
       generator.stub(:create_model)
 
@@ -53,7 +55,7 @@ module Rmre
       file.stub(:write)
 
       generator.connection.stub(:primary_key).and_return('')
-      
+
       File.stub(:open).and_yield(file)
       File.should_receive(:open).with(/tbl_user/, "w")
       file.should_receive(:write).with(/class TblUser/)
@@ -61,16 +63,50 @@ module Rmre
       generator.create_model("TBL_USERS")
     end
 
-    it "should set primary key if PK column is not id" do
-      file = double("model_file")
-      file.stub(:write)
+    context 'with non standard keys' do
+      before(:each) do
+        @file = double('model_file')
+        @file.stub(:write)
+      end
 
-      generator.connection.stub(:primary_key).and_return("usr_id")
+      it "should set primary key if PK column is not id" do
+        generator.connection.stub(:primary_key).and_return('usr_id')
 
-      File.stub(:open).and_yield(file)
-      file.should_receive(:write).with(/self\.primary_key = :usr_id/)
+        File.stub(:open).and_yield(@file)
+        @file.should_receive(:write).with(/self\.primary_key = :usr_id/)
+
+        generator.create_model('users')
+      end
+
+      it "should set foreign key if FK column is not id" do
+        generator.connection.stub(:primary_key).and_return('pst_id')
+        generator.stub(:foreign_keys).and_return([
+          { 'from_table' => 'posts',
+            'from_column' => 'pst_id',
+            'to_table'=>'user',
+            'to_column'=>'user_id'}
+            ])
+
+        File.stub(:open).and_yield(@file)
+        @file.should_receive(:write).with(/:foreign_key => :pst_id/)
+
+        generator.create_model('posts')
+      end
+    end
+
+    context 'irregular plural table names' do
+      it "should create correct file and class names" do
+        file = double("model_file")
+        file.stub(:write)
+
+        generator.connection.stub(:primary_key).and_return('')
+
+        File.stub(:open).and_yield(file)
+        File.should_receive(:open).with(/status_des/, "w")
+        file.should_receive(:write).with(/class StatusDes/)
 
-      generator.create_model("users")
+        generator.create_model("status_des")
+      end
     end
   end
 end

data/spec/rmre/migrator_spec.rb

@@ -0,0 +1,178 @@
+require "spec_helper"
+
+module Rmre
+  describe Migrator do
+    let(:src_connection) do |src_con|
+      src_con = double("source_connection")
+    end
+
+    let(:tgt_connection) do |tgt_con|
+      tgt_con = double("target_connection")
+    end
+
+    let(:src_db_opts) do |opts|
+      opts = { :adapter => "fake_adapter", :database => "source_db" }
+    end
+
+    let(:tgt_db_opts) do |opts|
+      opts = { :adapter => "fake_adapter", :database => "target_db" }
+    end
+
+    let(:id_column) do |col|
+      col = double("id_column")
+      col.stub!(:name).and_return("id")
+      col.stub!(:null).and_return(false)
+      col.stub!(:default).and_return(nil)
+      col.stub!(:type).and_return("integer")
+      col
+    end
+
+    let(:name_column) do |col|
+      col = double("name_column")
+      col.stub!(:name).and_return("name")
+      col.stub!(:null).and_return(false)
+      col.stub!(:default).and_return(nil)
+      col.stub!(:type).and_return("integer")
+      col
+    end
+
+    let(:table) do |tbl|
+      tbl = double("created_table")
+      tbl.stub!(:column)
+      tbl
+    end
+
+    before(:each) do
+      Source::Db.stub!(:establish_connection).and_return(true)
+      Source::Db.stub!(:connection).and_return(src_connection)
+
+      Target::Db.stub!(:establish_connection).and_return(true)
+      Target::Db.stub!(:connection).and_return(tgt_connection)
+    end
+
+    context "initialization" do
+      it "stores connection options in source and target modules" do
+        Migrator.new(src_db_opts, tgt_db_opts)
+        Source.connection_options.should be_eql(src_db_opts)
+        Target.connection_options.should be_eql(tgt_db_opts)
+      end
+
+      it "passes connection options to source and target connections" do
+        Source::Db.should_receive(:establish_connection).with(src_db_opts)
+        Target::Db.should_receive(:establish_connection).with(tgt_db_opts)
+        Migrator.new(src_db_opts, tgt_db_opts)
+      end
+    end
+
+    context "copying tables" do
+      before(:each) do
+        src_connection.stub(:tables).and_return %w{parent_table child_table}
+        src_connection.stub!(:columns).and_return([id_column, name_column])
+        src_connection.stub!(:primary_key).and_return("id")
+
+        @migrator = Migrator.new(src_db_opts, tgt_db_opts)
+        @migrator.stub!(:copy_data)
+      end
+
+      it "copies all tables if they do not exist" do
+        tgt_connection.should_receive(:table_exists?).exactly(2).times.and_return(false)
+        tgt_connection.should_receive(:create_table).exactly(2).times
+        @migrator.copy
+      end
+
+      it "doesn't copy tables if they exist" do
+        tgt_connection.should_receive(:table_exists?).exactly(2).times.and_return(true)
+        tgt_connection.should_not_receive(:create_table)
+        @migrator.copy
+      end
+
+      it "copies existing tables if it is forced to recreate them" do
+        tgt_connection.should_receive(:table_exists?).exactly(2).times.and_return(true)
+        tgt_connection.should_receive(:create_table).exactly(2).times
+        @migrator.copy(true)
+      end
+
+      context "with before_copy filter" do
+        before(:each) do
+          @migrator.before_copy = lambda { |table_name| 
+              return false if table_name == "child_table"
+              true
+            }
+        end
+
+        it "does not copy table if before copy filter returns false" do
+          tgt_connection.should_receive(:table_exists?).with("parent_table").and_return(false)
+          tgt_connection.should_receive(:create_table).once
+          @migrator.copy
+        end
+      end
+    end
+
+    context "copying tables with 'skip existing' turned on" do
+      before(:each) do
+        src_connection.stub(:tables).and_return %w{parent_table child_table}
+        src_connection.stub!(:columns).and_return([id_column, name_column])
+
+        @migrator = Migrator.new(src_db_opts, tgt_db_opts, {:skip_existing => true})
+      end
+
+      it "skips existing tables" do
+        tgt_connection.should_receive(:table_exists?).exactly(2).times.and_return(true)
+        tgt_connection.should_not_receive(:create_table)
+        @migrator.copy
+      end
+    end
+
+    context "table creation" do
+      before(:each) do
+        @source_columns = [id_column, name_column]
+      end
+
+      context "Rails copy mode" do
+        before(:each) do
+          @migrator = Migrator.new(src_db_opts, tgt_db_opts)
+          src_connection.stub!(:primary_key).and_return("id")
+          tgt_connection.stub!(:adapter_name).and_return("fake adapter")
+        end
+
+        it "does not explicitely create ID column" do
+          tgt_connection.should_receive(:create_table).with("parent", {:id => true, :force => false}).
+            and_yield(table)
+          table.should_not_receive(:column).with("id", anything(), anything())
+          @migrator.create_table("parent", @source_columns)
+        end
+
+        it "creates other columns but ID column" do
+          tgt_connection.should_receive(:create_table).with("parent", {:id => true, :force => false}).
+            and_yield(table)
+          table.should_receive(:column).with("name", anything(), anything())
+          @migrator.create_table("parent", @source_columns)
+        end
+      end
+
+      context "non-Rails copy mode" do
+        before(:each) do
+          @migrator = Migrator.new(src_db_opts, tgt_db_opts, {:rails_copy_mode => false})
+          tgt_connection.stub!(:adapter_name).times.and_return("fake adapter")
+          src_connection.stub!(:primary_key).and_return("primaryIdColumn")
+        end
+
+        it "explicitely creates ID column" do
+          tgt_connection.should_receive(:create_table).with("parent",
+            {:id => true, :force => false, :primary_key => "primaryIdColumn" }).
+            and_yield(table)
+          table.should_receive(:column).with("id", anything(), anything())
+          @migrator.create_table("parent", @source_columns)
+        end
+
+        it "creates other columns too" do
+          tgt_connection.should_receive(:create_table).with("parent",
+            {:id => true, :force => false, :primary_key => "primaryIdColumn"}).
+            and_yield(table)
+          table.should_receive(:column).with("name", anything(), anything())
+          @migrator.create_table("parent", @source_columns)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rmre
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2013-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +80,7 @@ description: Rmre creates ActiveRecord models for legacy database with all const
 email:
 - bosko.ivanisevic@gmail.com
 executables:
+- db_copy
 - rmre
 extensions: []
 extra_rdoc_files:
@@ -77,15 +94,21 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- bin/db_copy
 - bin/rmre
+- lib/contrib/progressbar.rb
 - lib/rmre.rb
 - lib/rmre/active_record/schema_dumper.rb
+- lib/rmre/db_utils.rb
+- lib/rmre/dynamic_db.rb
 - lib/rmre/generator.rb
 - lib/rmre/load_file.eruby
+- lib/rmre/migrator.rb
 - lib/rmre/model.eruby
 - lib/rmre/version.rb
 - rmre.gemspec
 - spec/rmre/generator_spec.rb
+- spec/rmre/migrator_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/bosko/rmre
 licenses: []
@@ -105,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -146509643511923988
+      hash: -360534453122830700
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,4 +143,5 @@ specification_version: 3
 summary: The easiest way to create ActiveRecord models for legacy database
 test_files:
 - spec/rmre/generator_spec.rb
+- spec/rmre/migrator_spec.rb
 - spec/spec_helper.rb