rmre 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Boško Ivanišević
+
+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.rdoc

@@ -0,0 +1,59 @@
+= Rails Models Reverse Engineering
+
+Rmre is utility gem for creating Ruby on Rails, at the moment only ActiveRecord, models
+for legacy databases. Besides creating all models it sets proper table name and primary
+key if tables and columns naming doesn't follow Rails convention. It also tries to read
+all foreign keys data from a database if DBE is MySql, PostgreSQL, Oracle or MS SQL and
+sets models relationships on a basic level through belongs_to and has_many declarations.
+
+= How to use
+
+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
+
+That's all! Of course there is standard help which you can print at any time:
+
+  rmre --help
+
+or
+
+  rmre -h
+
+I believe that command line options are self explanatory especially if you are familliar
+with Ruby on Rails database handling. Apart from Ruby on Rails related options there are
+several that should be explained.
+
+== MS SQL options
+
+Options:
+
+  -m or --mode
+  -n or --dsn
+
+are user for setting ODBC specific arguments. First one must be used with MS SQL and must
+be set to ODBC and the second one is data source name.
+
+== General options
+
+Otput directory can be set with:
+
+  -o /path/to/target/directory
+  --out /path/to/target/directory
+
+otherwise Rmre will create models in the directory where it is started.
+
+Rmre can also filter tables for which it will create models. Filtering is very basic and
+it mathes whether name of the table starts with passed patterns:
+
+  -i ec_,vi_
+  --include ic_,vi_
+
+with create models only for tables names with prefixes ec_ or vi_.
+
+= TODO
+
+* Improve filtering
+* Write more tests
+* Foreign key support for other DBEs (firebird, SQLite, Sybase,...)
+* Probably much more which I cannot remember right now

data/bin/rmre

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'optparse'
+require 'rmre'
+
+options = {:db => {}}
+optparse = OptionParser.new do |opts|
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+
+  options[:db][:adapter] = 'sqlite3'
+  opts.on('-a', '--adapter [ADAPTER]', 'ActiveRecord adapter to use (default SQLite3)') do |a|
+    options[:db][:adapter] = a
+  end
+
+  opts.on('-d', '--database DATABASE', 'Name of database') do |d|
+    options[:db][:database] = d
+  end
+
+  options[:db][:username] = ''
+  opts.on('-u', '--user [USER]', 'Databse connection username (default empty)') do |u|
+    options[:db][:username] = u
+  end
+
+  options[:db][:password] = ''
+  opts.on('-p', '--pass [PASS]', 'Database connection password (default empty)') do |p|
+    options[:db][:password] = p
+  end
+
+  opts.on('-m', '--mode [MODE]', 'MS SQL conenction mode (ODBC only)') do |m|
+    options[:db][:mode] = m
+  end
+
+  opts.on('-n', '--dsn [DSN]', 'ODBC DSN name (MS SQL only)') do |n|
+    options[:db][:dsn] = n
+  end
+  
+  options[:out_path] = File.expand_path(File.join(Dir.tmpdir, "rmre_models"))
+  opts.on('-o', '--out [PATH]', 'Path where models will be generated (default <TMP>/rmre_models)') do |p|
+    options[:out_path] = p
+  end
+
+  opts.on('-s', '--host [HOST]', 'IP address or name of the host') do |s|
+    options[:db][:host] = s
+  end
+  
+  opts.on('-i', '--include pattern1,pattern2', Array, 'Include prefixes') do |i|
+    options[:include] = i
+  end
+end
+
+optparse.parse!
+
+generator = Rmre::Generator.new(options[:db], options[:out_path], options[:include])
+generator.connect
+generator.create_models(generator.connection.tables)

data/lib/rmre.rb

@@ -0,0 +1 @@
+require 'rmre/generator'

data/lib/rmre/generator.rb

@@ -0,0 +1,178 @@
+require "tmpdir"
+require "fileutils"
+require "active_record"
+
+module Rmre
+  class Generator
+    attr_reader :connection
+    attr_reader :output_path
+
+    SETTINGS_ROOT = File.expand_path('../../../../db', __FILE__)
+    
+    def initialize(options, out_path, include)
+      @connection_options = options
+      @connection = nil
+      @output_path = out_path
+      @include_prefixes = include
+    end
+
+    def connect
+      return if @connection_options.empty?
+      
+      ActiveRecord::Base.establish_connection(@connection_options)
+      @connection = ActiveRecord::Base.connection
+    end
+
+    def create_models(tables)
+      return unless tables.is_a? Array
+      
+      FileUtils.mkdir_p(@output_path) if !Dir.exists?(@output_path)
+
+      tables.each do |table_name|
+        create_model(table_name) if process?(table_name)
+      end
+    end
+    
+    def create_model(table_name)
+      File.open(File.join(output_path, "#{table_name}.rb"), "w") do |file|
+        constraints = []
+
+        foreign_keys.each do |fk|
+          src = constraint_src(table_name, fk)
+          constraints << src unless src.nil?
+        end
+        
+        file.write generate_model_source(table_name, constraints)
+      end
+    end
+
+    def process?(table_name)
+      return true if @include_prefixes.nil? || @include_prefixes.empty?
+      
+      @include_prefixes.each do |prefix|
+        return true if table_name =~ /^#{prefix}/
+      end
+
+      false
+    end
+
+    def foreign_keys
+      @foreign_keys ||= fetch_foreign_keys
+    end
+
+    private
+    def fetch_foreign_keys
+      fk = []
+      case @connection_options[:adapter]
+      when 'mysql'
+        fk = mysql_foreign_keys
+      when 'postgresql'
+        fk = psql_foreign_keys
+      when 'sqlserver'
+        fk = mssql_foreign_keys
+      when 'oracle_enhanced'
+        fk = oracle_foreign_keys
+      end
+      fk
+    end
+
+    def constraint_src(table_name, fk={})
+      src = nil
+      if fk['from_table'] == table_name
+        src = "belongs_to :#{fk['to_table']}, :class_name => '#{fk['to_table'].classify}', :foreign_key => :#{fk['from_column']}"
+      elsif fk['to_table'] == table_name
+        src = "has_many :#{fk['from_table'].pluralize}, :class_name => '#{fk['from_table'].classify}'"
+      end
+      src
+    end
+    
+    def generate_model_source(table_name, constraints)
+      src = "class #{table_name.classify} < ActiveRecord::Base\n"
+      primary_key = connection.primary_key(table_name)
+      src << "  set_primary_key :#{primary_key}\n" unless "id" == primary_key || primary_key.nil?
+      src << "  set_table_name '#{table_name}'\n" unless table_name == table_name.classify.tableize
+      src << "  #{constraints.join("\n  ")}"
+      src << "\nend\n"
+    end
+    
+    def mysql_foreign_keys
+      sql = <<-SQL
+select
+ table_name as from_table,
+ column_name as from_column,
+ referenced_table_name as to_table,
+ referenced_column_name as to_column
+from information_schema.KEY_COLUMN_USAGE
+where referenced_table_schema like '%'
+ and constraint_schema = '#{@connection_options[:database]}'
+ and referenced_table_name is not null
+SQL
+      connection.select_all(sql)
+    end
+
+    def psql_foreign_keys
+      sql = <<-SQL
+SELECT tc.table_name as from_table,
+          kcu.column_name as from_column,
+          ccu.table_name AS to_table,
+          ccu.column_name AS to_column
+     FROM information_schema.table_constraints tc
+LEFT JOIN information_schema.key_column_usage kcu
+       ON tc.constraint_catalog = kcu.constraint_catalog
+      AND tc.constraint_schema = kcu.constraint_schema
+      AND tc.constraint_name = kcu.constraint_name
+      
+LEFT JOIN information_schema.referential_constraints rc
+       ON tc.constraint_catalog = rc.constraint_catalog
+      AND tc.constraint_schema = rc.constraint_schema
+      AND tc.constraint_name = rc.constraint_name
+LEFT JOIN information_schema.constraint_column_usage ccu
+       ON rc.unique_constraint_catalog = ccu.constraint_catalog
+      AND rc.unique_constraint_schema = ccu.constraint_schema
+      AND rc.unique_constraint_name = ccu.constraint_name
+    WHERE tc.table_name like '%'
+    AND tc.constraint_type = 'FOREIGN KEY';
+SQL
+      connection.select_all(sql)
+    end
+
+    def mssql_foreign_keys
+      sql = <<-SQL
+SELECT C.TABLE_NAME [from_table], 
+       KCU.COLUMN_NAME [from_column], 
+       C2.TABLE_NAME [to_table], 
+       KCU2.COLUMN_NAME [to_column]
+FROM   INFORMATION_SCHEMA.TABLE_CONSTRAINTS C 
+       INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE KCU 
+         ON C.CONSTRAINT_SCHEMA = KCU.CONSTRAINT_SCHEMA 
+            AND C.CONSTRAINT_NAME = KCU.CONSTRAINT_NAME 
+       INNER JOIN INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS RC 
+         ON C.CONSTRAINT_SCHEMA = RC.CONSTRAINT_SCHEMA 
+            AND C.CONSTRAINT_NAME = RC.CONSTRAINT_NAME 
+       INNER JOIN INFORMATION_SCHEMA.TABLE_CONSTRAINTS C2 
+         ON RC.UNIQUE_CONSTRAINT_SCHEMA = C2.CONSTRAINT_SCHEMA 
+            AND RC.UNIQUE_CONSTRAINT_NAME = C2.CONSTRAINT_NAME 
+       INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE KCU2 
+         ON C2.CONSTRAINT_SCHEMA = KCU2.CONSTRAINT_SCHEMA 
+            AND C2.CONSTRAINT_NAME = KCU2.CONSTRAINT_NAME 
+            AND KCU.ORDINAL_POSITION = KCU2.ORDINAL_POSITION 
+WHERE  C.CONSTRAINT_TYPE = 'FOREIGN KEY'
+SQL
+      connection.select_all(sql)
+    end
+
+    def oracle_foreign_keys
+      fk = []
+      connection.tables.each do |table|
+        connection.foreign_keys(table).each do |oracle_fk|
+          table_fk = { 'from_table' => oracle_fk.from_table,
+            'from_column' => oracle_fk.options[:column],
+            'to_table' => oracle_fk.to_table,
+            'to_column' => oracle_fk.options[:primary_key] }
+          fk << table_fk
+        end
+      end
+      fk
+    end
+  end
+end

data/lib/rmre/version.rb

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

data/rmre.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'rmre/version'
+
+Gem::Specification.new do |s|
+  s.name        = "rmre"
+  s.version     = Rmre::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bosko Ivanisevic"]
+  s.email       = ["bosko.ivanisevic@gmail.com"]
+  s.homepage    = "http://github.com/bosko/rmre"
+  s.summary     = %q{The easiest way to create ActiveRecord models for legacy database}
+  s.description = %q{Rmre creates ActiveRecord models for legacy database with all constraints found.}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "rmre"
+
+  s.add_development_dependency "rspec"
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths      = ["lib"]
+
+  s.extra_rdoc_files   = ["README.rdoc", "LICENSE.txt"]
+  s.rdoc_options << '--title' << 'Rmre -- Rails Models Reverse Engineering' <<
+                       '--main' << 'README.rdoc'
+end

data/spec/rmre/generator_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+module Rmre
+  describe Generator do
+    let(:settings) do |sett|
+      sett = {:db => {:adapter => 'some_adapter',
+          :database => 'db',
+          :username => 'user',
+          :password => 'pass'},
+        :out_path => '/tmp/gne-test',
+        :include => ['incl1_', 'incl2_']}
+    end
+    
+    let(:generator) { Generator.new(settings[:db], settings[:out_path], settings[:include]) }
+    let(:tables)    { %w(incl1_tbl1 incl1_tbl2 incl2_tbl1 user processes) }
+    
+    it "should flag table inv_plan for processing" do
+      generator.process?('incl1_tbl1').should be_true
+    end
+
+    it "should not flag table shkprocesses 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)
+
+      generator.should_receive(:create_model).exactly(3).times
+      generator.create_models(tables)
+    end
+
+    it "should contain set_table_name 'incl1_tbl1' in generated source" do
+      generator.stub_chain(:connection, :primary_key).and_return("id")
+      generator.send(:generate_model_source, 'incl1_tbl1', []).should match(/set_table_name \'incl1_tbl1\'/)
+    end
+    
+    it "should create three model files" do
+      generator.stub_chain(:connection, :primary_key).and_return("id")
+      generator.stub(:foreign_keys).and_return([])
+      generator.create_models(tables)
+      Dir.glob(File.join(generator.output_path, "*.rb")).should have(3).items
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rmre'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: rmre
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bosko Ivanisevic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Rmre creates ActiveRecord models for legacy database with all constraints found.
+email: 
+- bosko.ivanisevic@gmail.com
+executables: 
+- rmre
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- .gitignore
+- LICENSE.txt
+- README.rdoc
+- bin/rmre
+- lib/rmre.rb
+- lib/rmre/generator.rb
+- lib/rmre/version.rb
+- rmre.gemspec
+- spec/rmre/generator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bosko/rmre
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Rmre -- Rails Models Reverse Engineering
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: rmre
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The easiest way to create ActiveRecord models for legacy database
+test_files: []
+