oracle-model-generator 0.1.0

data/CHANGES

@@ -0,0 +1,2 @@
+= 0.1.0 - 6-Oct-2010
+* Initial release.

data/MANIFEST

@@ -0,0 +1,8 @@
+CHANGES
+MANIFEST
+README
+oracle-model-generator.gemspec
+Rakefile
+bin/omg
+lib/oracle/model/generator.rb
+test/test_oracle_model_generator.rb

data/README

@@ -0,0 +1,68 @@
+= Description
+A library for generating an ActiveRecord model from an existing Oracle table.
+This will install an "omg" executable that you can use from the command line.
+
+= Synopsis
+Using the command line tool:
+
+  omg -d your_database -t your_table -u some_user -p some_password
+
+Results in a file called "your_table.rb". This is an ActiveRecord model
+declaration, with all validations, primary keys, table name and belongs_to
+relationships defined.
+
+= Requirements
+== Must Have
+* ruby-oci8
+* getopt
+
+== Optional
+If you want to be able to avoid specifying a username and password on the
+command line then you will need the dbi-dbrc library.
+
+If you want your models to support multiple primary keys, then you will
+need to install the composite_primary_keys library.
+
+If you want date format validations, then you will need to install the
+validates_timeliness library.
+
+= What this library doesn't do
+I do not attempt to set has_many or has_one relationships. There's no good
+way to determine that relationship (one or many?). Besides, in practice I
+find that most people set custom has_xxx relationships that go over and
+above what's set in the Oracle database anyway for purposes of their
+application.
+
+I also do not go out of my way to get the model name correct with regards
+to singular vs plural. I do a simple guess that covers most cases, but
+complex cases will break it. It's much easier for you to rename a class or
+file name than it is for me to get this 100% correct.
+
+= Author's Comments
+I chose not to patch legacy_data because I have no interest in supporting
+other vendors other than Oracle with this library. By focusing only on
+Oracle I could take advantage of ruby-oci8 features. In addition, I have no
+interest in making this a Rails plugin, and I needed the support of multiple
+primary keys.
+
+= Future Plans
+Add support for views.
+
+= Known Issues
+None known. If you find any issues, please report them on the github project
+page at http://www.github.com/djberg96/oracle-model-generator.
+
+= Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+= Copyright
+(C) 2010, Daniel J. Berger
+All Rights Reserved
+
+= License
+Artistic 2.0
+
+= Author
+Daniel J. Berger

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+namespace 'gem' do
+  desc 'Remove any old gem files'
+  task :clean do
+    Dir['*.gem'].each{ |f| File.delete(f) }
+  end
+
+  desc 'Create the oracle-model-generator gem'
+  task :create => :clean do
+    spec = eval(IO.read('oracle-model-generator.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Install the oracle-model-generator gem'
+  task :install => [:create] do
+    file = Dir["oracle-model-generator*.gem"].last
+    sh "gem install #{file}"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.warning = true
+  t.verbose = true
+end
+
+task :default => :test

data/bin/omg

@@ -0,0 +1,179 @@
+#!/usr/bin/env ruby
+
+require 'oracle/model/generator'
+require 'dbi/dbrc'
+require 'getopt/long'
+
+opts = Getopt::Long.getopts(
+  ['--help',     '-h'],
+  ['--table',    '-t', Getopt::REQUIRED],
+  ['--view',     '-v', Getopt::REQUIRED],
+  ['--user',     '-u', Getopt::REQUIRED],
+  ['--password', '-p', Getopt::REQUIRED],
+  ['--database', '-d', Getopt::REQUIRED],
+  ['--output',   '-o', Getopt::REQUIRED]
+)
+
+def help
+  %Q{
+    Available options for the Oracle Model Generator are:
+
+    -h, --help     => Display the help text you're looking at now.
+    -t, --table    => The name of the table you wish to model.
+    -v, --view     => The name of the view you wish to model.
+    -o, --output   => The name of the file to create.
+    -u, --user     => The user used to establish a connection to the database.
+    -p, --password => The password used to establish a connection to the database.
+
+    If no user or password are supplied, then OMG will attempt to glean that
+    information using a combination of the database name and your .dbrc file.
+    If that cannot be found, then an error is raised.
+
+    If no output file is supplied then the file generated will match the name
+    of the table, minus the 's' if present, with a .rb extension. This is lazy,
+    but it is orders of magnitude easier for you to rename a file than it is
+    for me to deal with all possible permutations. Note that the output file
+    name is also used as the basis for the class name
+
+    Examples:
+
+    # Create a User model for the users table.
+    omg -d some_database -u scott -p tiger -t users
+
+    # Same thing, using dbi-dbrc behind the scenes
+    omg -d some_database -t users
+
+    # Create a Lily model for the lilies table, and specify the output file.
+    omg -d some_database -u scott -p tiger -t lilies -o lily.rb
+  }
+end
+
+if opts['h']
+  puts help
+  exit!
+end
+
+unless opts['database']
+  puts "You must specify a database."
+  exit!
+end
+
+unless opts['table'] || opts['view']
+  puts "You must specify a table or view."
+  exit!
+end
+
+user = opts['user']
+pass = opts['password']
+
+unless user && pass
+  begin
+    dbrc = DBI::DBRC.new(opts['database'], user)
+    user = dbrc.user
+    pass = dbrc.passwd
+  rescue DBI::DBRC::Error
+    msg = "No user or password provided, and no dbrc entry found for '"
+    msg << opts['database'] + "'."
+    puts msg
+    exit!
+  end
+end
+
+table = opts['table']
+view  = opts['view']
+
+if table && view
+  puts "You cannot specify both a table and a view."
+  exit!
+end
+
+connection = OCI8.new(user, pass, opts['database'])
+omg = Oracle::Model::Generator.new(connection)
+omg.generate(table || view, view)
+
+ofile = opts['o'] || table + '.rb'
+
+File.open(ofile, 'w') do |fh|
+  fh.puts "class #{omg.table} < ActiveRecord::Base"
+  fh.puts "  set_table_name :#{table}"
+
+  if omg.primary_keys.size > 1
+    fh.puts "\n  # Requires the composite-primary-keys library"
+    fh.puts "  set_primary_keys " + omg.primary_keys.inspect
+  else
+    fh.puts "\n  set_primary_key " + omg.primary_keys.first.to_sym.inspect
+  end
+
+  fh.puts "\n  # Table relationships\n\n"
+  omg.belongs_to.uniq.each{ |table|
+    fh.puts "  belongs_to :#{table.downcase}"
+  }
+
+  fh.puts "\n  # Validations\n\n"
+
+  # Character fields, size
+  omg.column_info.each{ |col|
+    data_type = col.data_type.to_s
+    if ['char', 'varchar', 'varchar2'].include?(data_type)
+      validation = "validates_size_of :#{col.name.downcase}, :maximum => #{col.data_size}"
+      validation << ", :allow_blank => #{col.nullable?}" if col.nullable?
+      fh.puts "  #{validation}"
+    end
+  }
+
+  fh.puts # Line break
+
+  # Fields that must be present
+  omg.column_info.each{ |col|
+    unless col.nullable?
+      validation = "validates_presence_of :#{col.name.downcase}"
+      fh.puts "  #{validation}"
+    end
+  }
+
+  fh.puts # Line break
+
+  # Numeric fields
+  omg.column_info.each{ |col|
+    if col.data_type.to_s == 'number'
+      max = ("9" * (col.precision - col.scale)).to_i
+
+      validation = "validates_numericality_of :#{col.name.downcase}"
+      validation << ", :less_than => #{max + 1}, :greater_than => -#{max + 1}"
+
+      if col.scale == 0
+        validation << ", :only_integer => true"
+      end
+
+      fh.puts "  #{validation}"
+    end
+  }
+
+  fh.puts # Line break
+  header_printed = false
+
+  # Date fields
+  omg.column_info.each{ |col|
+    data_type = col.data_type.to_s
+
+    if ['date', 'time'].include?(data_type)
+      if data_type == 'date'
+        validation = "validates_date :#{col.name.downcase}"
+      end
+
+      if data_type == 'timestamp'
+        validation = "validates_time :#{col.name.downcase}"
+      end
+
+      unless header_printed
+        fh.puts "  # Requires the validates_timeliness library"
+      end
+
+      fh.puts "  #{validation}"
+    end
+  }
+
+  fh.puts "end"
+end
+
+puts "\nFile '#{ofile}' generated\n\n"

data/lib/oracle/model/generator.rb

@@ -0,0 +1,118 @@
+require 'oci8'
+
+module Oracle
+  module Model
+    class Generator
+      VERSION = '0.1.0'
+
+      attr_reader :connection
+      attr_reader :constraints
+      attr_reader :foreign_keys
+      attr_reader :belongs_to
+      attr_reader :table
+      attr_reader :view
+      attr_reader :dependencies
+      attr_reader :column_info
+      attr_reader :primary_keys
+
+      # Example:
+      #
+      #   connection = Oracle::Connection.new(user, password, database)
+      #   ogenerator = Oracle::Model::Generator.new(connection)
+      #   ogenerator.generate('users')
+      #
+      def initialize(connection)
+        @connection   = connection
+        @constraints  = []
+        @primary_keys = []
+        @foreign_keys = []
+        @dependencies = []
+        @belongs_to   = []
+        @column_info  = []
+        @table        = nil
+      end
+
+      def generate(table, view = false)
+        @table = table.split('_').map{ |e| e.downcase.capitalize }.join
+        @view  = view
+        get_constraints(table) unless view
+        get_foreign_keys unless view
+        get_column_info(table) unless view
+        get_primary_keys
+      end
+
+      private
+
+      def get_column_info(table_name)
+        table = @connection.describe_table(table_name)
+        table.columns.each{ |col| @column_info << col }
+      end
+
+      # Returns an array of primary keys.
+      #
+      def get_primary_keys
+        @constraints.each{ |hash|
+          if hash['CONSTRAINT_TYPE'] == 'P'
+            @primary_keys << hash['COLUMN_NAME'].downcase
+          end
+        }
+      end
+
+      def get_foreign_keys
+        @constraints.each{ |hash|
+          if hash['CONSTRAINT_TYPE'] == 'R'
+            @foreign_keys << hash['R_CONSTRAINT_NAME']
+          end
+        }
+
+        get_belongs_to()
+      end
+
+      def get_belongs_to
+        @foreign_keys.each{ |fk|
+          @belongs_to << find_fk_table(fk)
+        }
+      end
+
+      def find_fk_table(fk)
+        sql = %Q{
+          select table_name
+          from all_constraints
+          where constraint_name = '#{fk}'
+        }
+
+        begin
+          cursor = @connection.exec(sql)
+          fk = cursor.fetch.first
+        ensure
+          cursor.close if cursor
+        end
+
+        fk
+      end
+
+      # Get a list of constraints for a given table.
+      #
+      def get_constraints(table_name)
+        sql = %Q{
+          select *
+          from all_cons_columns a, all_constraints b
+          where a.owner = b.owner
+          and a.constraint_name = b.constraint_name
+          and a.table_name = b.table_name
+          and b.table_name = '#{table_name.upcase}'
+        }
+
+        begin
+          cursor = @connection.exec(sql)
+          while rec = cursor.fetch_hash
+            @constraints << rec
+          end
+        ensure
+          cursor.close if cursor
+        end
+      end
+
+    end
+  end
+end

data/lib/oracle_model_generator.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'oracle/model/generator')

data/oracle-model-generator.gemspec

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+Gem::Specification.new do |gem|
+  gem.name       = 'oracle-model-generator'
+  gem.version    = '0.1.0'
+  gem.author     = 'Daniel J. Berger'
+  gem.license    = 'Artistic 2.0'
+  gem.email      = 'djberg96@gmail.com'
+  gem.homepage   = 'http://www.github.com/djberg96/oracle-model-generator'
+  gem.summary    = 'A Ruby interface for determining protocol information'
+  gem.test_file  = 'test/test_oracle_model_generator.rb'
+  gem.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  gem.executables       = "omg"
+  gem.rubyforge_project = 'N/A'
+  gem.extra_rdoc_files  = %w[CHANGES README MANIFEST]
+
+  gem.add_dependency('ruby-oci8')
+  gem.add_dependency('getopt', '>= 1.4.0')
+  gem.add_development_dependency('test-unit', '>= 2.1.1')
+
+  gem.description = <<-EOF
+    The oracle-model-generator library allows you to generate an ActiveRecord
+    model from an existing Oracle table or view.
+  EOF
+end

data/test/test_oracle_model_generator.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'oracle/model/generator'
+
+class TC_Oracle_Model_Generator < Test::Unit::TestCase
+  def setup
+    @username   = 'hr'
+    @password   = 'hr'
+    @database   = 'xe'
+    @generator  = nil
+    @connection = OCI8.new(@username, @password, @database)
+  end
+
+  test "version number is correct" do
+    assert_equal('0.1.0', Oracle::Model::Generator::VERSION)
+  end
+
+  test "constructor accepts an oci8 connection object" do
+    assert_nothing_raised{ @generator = Oracle::Model::Generator.new(@connection) }
+  end
+
+  test "generate method basic functionality" do
+    assert_nothing_raised{ @generator = Oracle::Model::Generator.new(@connection) }
+    assert_respond_to(@generator, :generate)
+  end
+
+  test "generate method works with a table name or view" do
+    assert_nothing_raised{ @generator = Oracle::Model::Generator.new(@connection) }
+    assert_nothing_raised{ @generator.generate('employees') }
+    assert_nothing_raised{ @generator.generate('emp_details_view', true) }
+  end
+
+  def teardown
+    @username  = nil
+    @password  = nil
+    @database  = nil
+    @generator = nil
+    @connection.logoff if @connection
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: oracle-model-generator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-06 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-oci8
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: getopt
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :development
+  version_requirements: *id003
+description: "    The oracle-model-generator library allows you to generate an ActiveRecord\n    model from an existing Oracle table or view.\n"
+email: djberg96@gmail.com
+executables: 
+- omg
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
+files: 
+- Rakefile
+- README
+- oracle-model-generator.gemspec
+- lib/oracle/model/generator.rb
+- lib/oracle_model_generator.rb
+- CHANGES
+- test/test_oracle_model_generator.rb
+- MANIFEST
+- bin/omg
+has_rdoc: true
+homepage: http://www.github.com/djberg96/oracle-model-generator
+licenses: 
+- Artistic 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: N/A
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby interface for determining protocol information
+test_files: 
+- test/test_oracle_model_generator.rb