oracle-model-generator 0.2.1 → 0.3.0

data/CHANGES

@@ -1,3 +1,17 @@
+= 0.3.0 - 12-May-2011
+* Added automatic test generation. In addition to the active record model file,
+  a test file will be generated that includes a series of stock tests that
+  are based on the model's validations. At the moment only test-unit is
+  supported, but I'll eventually add rspec.
+* Added the -x/--tests command line option for the new test generation feature.
+* The dependencies method now returns an array of dependencies for the given
+  table or view.
+* The table method has been altered. It now returns just the plain, uppercased
+  name of the table. A new method called 'model' now returns the active record
+  model name.
+* The default output file name will now chop any trailing 's' characters.
+* More tests and comments added.
+
 = 0.2.1 - 3-May-2011
 * Fixed a bug where the omg binary blew up if you didn't have the dbi-dbrc
   library installed. It's supposed to be optional. Thanks go to Jason Roth

data/README

@@ -49,6 +49,43 @@ The omg library will generate this:
     validates :country_id, :length => {:maximum => 2}
   end
 
+  It will also generate a corresponding test file using test-unit 2 by default.
+  For the above example you will see some tests like this:
+
+class TC_Location < Test::Unit::TestCase
+  def setup
+    @location = Location.new
+  end
+
+  test 'table name is locations' do
+    assert_equal('locations', Location.table_name)
+  end
+
+  test 'primary key is location_id' do
+    assert_equal('location_id', Location.primary_key)
+  end
+
+  test 'location_id basic functionality' do
+    assert_respond_to(@location, :location_id)
+    assert_nothing_raised{ @location.location_id }
+    assert_kind_of(Numeric, @location.location_id)
+  end
+
+  test 'location_id must be a number' do
+    @location.location_id = 'test_string'
+    assert_false(@location.valid?)
+    assert_true(@location.errors[:location_id].include?('is not a number'))
+  end
+
+  test 'location_id cannot exceed the value 9999' do
+    @location.location_id = 10000
+    assert_false(@location.valid?)
+    assert_true(@location.errors[:location_id].include?('must be less than or equal to 9999'))
+  end
+
+  # ... and so on.
+end
+
 = Requirements
 == Must Have
 * ruby-oci8
@@ -85,7 +122,7 @@ primary keys.
 
 = Future Plans
 Add support for views.
-Add automatic test suite generation.
+Add automatic test suite generation for rspec.
 Explicitly set :foreign_key if using CPK in belongs_to relationships.
 The output could use a little formatting love.
 

data/bin/omg

@@ -18,7 +18,8 @@ opts = Getopt::Long.getopts(
   ['--password', '-p', Getopt::REQUIRED],
   ['--database', '-d', Getopt::REQUIRED],
   ['--output',   '-o', Getopt::REQUIRED],
-  ['--rails',    '-r', Getopt::REQUIRED]
+  ['--rails',    '-r', Getopt::REQUIRED],
+  ['--tests',     '-x', Getopt::OPTIONAL]
 )
 
 def help
@@ -33,6 +34,7 @@ def help
     -u, --user     => The user used to establish a connection to the database.
     -p, --password => The password used to establish a connection to the database.
     -r, --rails    => The version of rails you're using (2 or 3).
+    -x, --tests    => Generate tests (the default).
 
     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.
@@ -44,6 +46,10 @@ def help
     for me to deal with all possible permutations. Note that the output file
     name is also used as the basis for the class name
 
+    If no tests option is specified then a test file, using test-unit 2, will
+    be generated that includes some basic tests to backup the builtin
+    validations. Legal options are 'testunit', 'rspec', or 'none'.
+
     Examples:
 
     # Create a User model for the users table (rails 3)
@@ -109,7 +115,13 @@ connection = OCI8.new(user, pass, opts['database'])
 omg = Oracle::Model::Generator.new(connection)
 omg.generate(table || view, view)
 
-ofile = opts['o'] || table + '.rb'
+ofile = opts['o']
+
+unless ofile
+  ofile = omg.table.downcase
+  ofile.chop! if ofile[-1].chr.upcase == 'S'
+  ofile += '.rb'
+end
 
 # Default to Rails 3
 rails = (opts['rails'] && opts['rails'].to_i) || 3
@@ -120,7 +132,7 @@ if rails < 2 || rails > 3
 end
 
 File.open(ofile, 'w') do |fh|
-  fh.puts "class #{omg.table} < ActiveRecord::Base"
+  fh.puts "class #{omg.model} < ActiveRecord::Base"
   fh.puts "  set_table_name :#{table}"
 
   if omg.primary_keys.size > 1
@@ -135,7 +147,7 @@ File.open(ofile, 'w') do |fh|
     fh.puts "  belongs_to :#{table.downcase}"
   }
 
-  fh.puts "\n  # Validations\n\n"
+  fh.puts "\n  # Validations\n"
 
   if rails == 2
     # Character fields, size
@@ -185,7 +197,18 @@ File.open(ofile, 'w') do |fh|
         when 'char', 'varchar', 'varchar2'
           validation = "validates :#{col.name.downcase}, "
           validation << ":length => {:maximum => #{col.data_size}}"
-          validation << ", :presence => #{!col.nullable?}" unless col.nullable?
+
+          format_str = ",\n    :format => { :with => /[:alpha]/, :message => 'is not a string'"
+
+          if col.nullable?
+            format_str += ", :if => :#{col.name.downcase}? }"
+          else
+            format_str += " }"
+          end
+
+          validation << format_str
+          validation << ",\n    :presence => #{!col.nullable?}" unless col.nullable?
+          validation << "\n\n"
         when 'number'
           max = "9" * col.precision
           max.insert(col.precision - col.scale, ".") if col.scale > 0
@@ -197,14 +220,14 @@ File.open(ofile, 'w') do |fh|
           end
 
           validation << ":numericality => {"
-          validation << "\n      :less_than_or_equal_to => #{max}, "
-          validation << "\n      :greater_than_or_equal_to => -#{max}"
+          validation << "\n    :less_than_or_equal_to => #{max}, "
+          validation << "\n    :greater_than_or_equal_to => -#{max}"
 
           if col.scale == 0
-            validation << ",\n      :only_integer => true"
+            validation << ",\n    :only_integer => true"
           end
 
-          validation << "\n    }"
+          validation << "\n  }\n\n"
       end
 
       fh.puts "  #{validation}"
@@ -238,4 +261,160 @@ File.open(ofile, 'w') do |fh|
   fh.puts "end"
 end
 
+if opts['x'].nil? || opts['x'] == 'testunit'
+  test_file = "test_#{ofile}"
+  File.open(test_file, "w") do |fh|
+    setup_var = omg.table.downcase
+    setup_var.chop! if setup_var[-1].chr.downcase == 's'  
+    instance_var = "@#{setup_var}"
+
+    # This bit is necessary to force test-unit 2 instead of using the library
+    # that ships as part of the Ruby standard library.
+    fh.puts "require 'rubygems'"
+    fh.puts "gem 'test-unit'"
+    fh.puts "require 'test/unit'\n\n"
+
+    fh.puts "class TC_#{omg.model} < Test::Unit::TestCase\n"
+    fh.puts "  def setup"
+    fh.puts "    #{instance_var} = #{omg.model}.new"
+    fh.puts "  end\n\n"
+
+    fh.puts "  test 'table name is #{omg.table.downcase}' do"
+    fh.puts "    assert_equal('#{omg.table.downcase}', #{omg.model}.table_name)"
+    fh.puts "  end\n\n"
+
+    if omg.primary_keys.size > 1
+      test_string = "  test 'primary keys are #{omg.primary_keys.join(', ')}' do"
+      fh.puts test_string
+      fh.puts "    assert_equal('#{omg.primary_keys.join(', ')}', #{omg.model}.primary_keys)"
+    else
+      test_string = "  test 'primary key is #{omg.primary_keys.first}' do"
+      fh.puts test_string
+      fh.puts "    assert_equal('#{omg.primary_keys.first}', #{omg.model}.primary_key)"
+    end
+
+    fh.puts "  end\n"
+
+    omg.column_info.each{ |col|
+      data_type = col.data_type.to_s
+      column    = col.name.downcase
+
+      fh.puts "\n  test '#{column} basic functionality' do"
+      fh.puts "    assert_respond_to(#{instance_var}, :#{column})"
+      fh.puts "    assert_nothing_raised{ #{instance_var}.#{column} }"
+
+      case data_type
+        when 'char', 'varchar', 'varchar2'
+          if col.nullable?
+            fh.puts "    assert_kind_of([NilClass, String], #{instance_var}.#{column})"
+          else
+            fh.puts "    assert_kind_of(String, #{instance_var}.#{column})"
+          end
+        when 'number'
+          if col.nullable?
+            fh.puts "    assert_kind_of([NilClass, Numeric], #{instance_var}.#{column})"
+          else
+            fh.puts "    assert_kind_of(Numeric, #{instance_var}.#{column})"
+          end
+        when 'date'
+          if col.nullable?
+            fh.puts "    assert_kind_of([NilClass, DateTime, Time], #{instance_var}.#{column})"
+          else
+            fh.puts "    assert_kind_of([DateTime, Time], #{instance_var}.#{column})"
+          end
+      end
+
+      fh.puts "  end\n"
+
+      case data_type
+        when 'char', 'varchar', 'varchar2'
+          test_title = "\n  test '#{column} must be a string"
+          test_title += " if present" if col.nullable?
+          test_title += "' do"
+
+          fh.puts test_title
+          fh.puts "    #{instance_var}.#{column} = #{rand(100)}"
+          fh.puts "    assert_false(#{instance_var}.valid?)"
+          fh.puts "    assert_true(#{instance_var}.errors[:#{column}].include?('is not a string'))"
+          fh.puts "  end\n"
+
+          max_len = col.data_size
+          err_msg = "is too long (maximum is #{max_len} characters)"
+
+          fh.puts "\n  test '#{column} cannot exceed #{max_len} characters' do"
+          fh.puts "    #{instance_var}.#{column} = 'a' * #{max_len + 1}"
+          fh.puts "    assert_false(#{instance_var}.valid?)"
+          fh.puts "    assert_true(#{instance_var}.errors[:#{column}].include?('#{err_msg}'))"
+          fh.puts "  end\n"
+        when 'number'
+          test_title = "\n  test '#{column} must be a number"
+          test_title += " if present" if col.nullable?
+          test_title += "' do"
+
+          fh.puts test_title
+          fh.puts "    #{instance_var}.#{column} = 'test_string'"
+          fh.puts "    assert_false(#{instance_var}.valid?)"
+          fh.puts "    assert_true(#{instance_var}.errors[:#{column}].include?('is not a number'))"
+          fh.puts "  end\n"
+
+          max = "9" * col.precision
+          max.insert(col.precision - col.scale, ".") if col.scale > 0
+          err_msg = "must be less than or equal to #{max}"
+
+          fh.puts "\n  test '#{column} cannot exceed the value #{max}' do"
+
+          if col.scale > 0
+            fh.puts "    #{instance_var}.#{column} = #{max.to_f.round}"
+          else
+            fh.puts "    #{instance_var}.#{column} = #{max.to_i + 1}"
+          end
+
+          fh.puts "    assert_false(#{instance_var}.valid?)"
+          fh.puts "    assert_true(#{instance_var}.errors[:#{column}].include?('#{err_msg}'))"
+          fh.puts "  end\n"
+
+          err_msg = "must be greater than or equal to -#{max}"
+
+          fh.puts "\n  test '#{column} cannot be less than the value -#{max}' do"
+
+          if col.scale > 0
+            fh.puts "    #{instance_var}.#{column} = -#{max.to_f.round}"
+          else
+            fh.puts "    #{instance_var}.#{column} = -#{max.to_i + 1}"
+          end
+
+          fh.puts "    assert_false(#{instance_var}.valid?)"
+          fh.puts "    assert_true(#{instance_var}.errors[:#{column}].include?('#{err_msg}'))"
+          fh.puts "  end\n"
+      end
+
+      unless col.nullable?
+        err_msg = "can't be blank"
+        fh.puts "\n  test '#{column} cannot be nil' do"
+          fh.puts "    #{instance_var}.#{column} = nil"
+          fh.puts "    assert_false(#{instance_var}.valid?)"
+          fh.puts "    assert_true(#{instance_var}.errors[:#{column}].include?(\"#{err_msg}\"))"
+        fh.puts "  end\n"
+      end
+    }
+
+    fh.puts "\n  def teardown"
+    fh.puts "     @#{setup_var} = nil"
+    fh.puts "  end"
+
+    fh.puts "end"
+  end
+  puts "\nTest file '#{test_file}' generated\n"
+else
+  if opts['x'] == 'rspec'
+    puts "\nrspec not yet supported for generating tests.\n"
+  elsif opts['x'] != 'none'
+    puts "\nInvalid option to -x/--tests: " + opts['x']
+  else
+    puts "\nSkipping test file genertion.\n"
+  end 
+end
+
+omg.connection.logoff if omg.connection
+
 puts "\nFile '#{ofile}' generated\n\n"

data/lib/oracle/model/generator.rb

@@ -3,18 +3,43 @@ require 'oci8'
 module Oracle
   module Model
     class Generator
-      VERSION = '0.2.1'
+      # The version of the oracle-model-generator library
+      VERSION = '0.3.0'
 
+      # The raw OCI8 connection.
       attr_reader :connection
+
+      # An array of hashes that contain per-column constraint information.
       attr_reader :constraints
+
+      # An array of foreign key names.
       attr_reader :foreign_keys
+
+      # An array of parent tables that the table has a foreign key
+      # relationship with.
       attr_reader :belongs_to
+
+      # The table name associated with the generator.
       attr_reader :table
+
+      # The name of the active record model to be generated.
+      attr_reader :model
+
+      # Boolean indicating whether the generator is for a regular table or a view.
       attr_reader :view
+
+      # A list of dependencies for the table.
       attr_reader :dependencies
+
+      # An array of raw OCI::Metadata::Column objects.
       attr_reader :column_info
+
+      # An array of primary keys for the column. May contain one or more values.
       attr_reader :primary_keys
 
+      # Creates and returns a new Oracle::Model::Generator object. It accepts
+      # an Oracle::Connection object, which is what OCI8.new returns.
+      #
       # Example:
       #
       #   connection = Oracle::Connection.new(user, password, database)
@@ -30,6 +55,7 @@ module Oracle
         @belongs_to   = []
         @column_info  = []
         @table        = nil
+        @model        = nil
       end
 
       # Generates an Oracle::Model::Generator object for +table+. If this is
@@ -38,20 +64,33 @@ module Oracle
       # This method does not actually generate a file of any sort. It merely
       # sets instance variables which you can then use in your own class/file
       # generation programs.
+      #--
+      # Makes a best guess as to the model name. I'm not going to put too much
+      # effort into this. It's much easier for you to hand edit a class name
+      # than it is for me to parse English.
       #
       def generate(table, view = false)
-        @table = table.split('_').map{ |e| e.downcase.capitalize }.join
+        @table = table.upcase
+        @model = 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
+
+        # Remove trailing 's'
+        @model.chop! if @model[-1].chr.upcase == 'S'
+
+        unless view
+          get_constraints
+          get_foreign_keys
+          get_column_info
+        end
+
         get_primary_keys
+        get_dependencies
       end
 
       private
 
-      def get_column_info(table_name)
-        table = @connection.describe_table(table_name)
+      def get_column_info
+        table = @connection.describe_table(@table)
         table.columns.each{ |col| @column_info << col }
       end
 
@@ -107,14 +146,14 @@ module Oracle
 
       # Get a list of constraints for a given table.
       #
-      def get_constraints(table_name)
+      def get_constraints
         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}'
+          and b.table_name = '#{@table}'
         }
 
         begin
@@ -127,6 +166,25 @@ module Oracle
         end
       end
 
+      # An array of hashes indicating objects that are dependent on the table.
+      #
+      def get_dependencies
+        sql = %Q{
+          select *
+          from all_dependencies dep
+          where referenced_name = '#{@table}'
+        }
+
+        begin
+          cursor = @connection.exec(sql)
+          while rec = cursor.fetch_hash
+            @dependencies << rec
+          end
+        ensure
+          cursor.close if cursor
+        end
+      end
+
     end
   end
 end

data/oracle-model-generator.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |gem|
   gem.name       = 'oracle-model-generator'
-  gem.version    = '0.2.1'
+  gem.version    = '0.3.0'
   gem.author     = 'Daniel J. Berger'
   gem.license    = 'Artistic 2.0'
   gem.email      = 'djberg96@gmail.com'

data/test/test_oracle_model_generator.rb

@@ -1,3 +1,10 @@
+#############################################################################
+# test_oracle_model_generator.rb
+#
+# Test suite for the oracle-model-generator library. For testing purposes
+# I'm using the 'hr' database that comes as part of the Oracle Express
+# edition which you can download from oracle.com. Adjust as necessary.
+#############################################################################
 require 'rubygems'
 gem 'test-unit'
 require 'test/unit'
@@ -13,7 +20,7 @@ class TC_Oracle_Model_Generator < Test::Unit::TestCase
   end
 
   test "version number is correct" do
-    assert_equal('0.2.1', Oracle::Model::Generator::VERSION)
+    assert_equal('0.3.0', Oracle::Model::Generator::VERSION)
   end
 
   test "constructor accepts an oci8 connection object" do
@@ -26,11 +33,33 @@ class TC_Oracle_Model_Generator < Test::Unit::TestCase
   end
 
   test "generate method works with a table name or view" do
-    assert_nothing_raised{ @generator = Oracle::Model::Generator.new(@connection) }
+    @generator = Oracle::Model::Generator.new(@connection)
     assert_nothing_raised{ @generator.generate('employees') }
     assert_nothing_raised{ @generator.generate('emp_details_view', true) }
   end
 
+  test "model method returns active record model name" do
+    @generator = Oracle::Model::Generator.new(@connection)
+    @generator.generate('emp_details_view', true)
+    assert_respond_to(@generator, :model)
+    assert_equal('EmpDetailsView', @generator.model)
+  end
+
+  test "table method returns uppercased table name passed to generate method" do
+    @generator = Oracle::Model::Generator.new(@connection)
+    @generator.generate('emp_details_view', true)
+    assert_respond_to(@generator, :table)
+    assert_equal('EMP_DETAILS_VIEW', @generator.table)
+  end
+
+  test "dependencies method returns an array of hashes" do
+    @generator = Oracle::Model::Generator.new(@connection)
+    @generator.generate('employees', true)
+    assert_respond_to(@generator, :dependencies)
+    assert_kind_of(Array, @generator.dependencies)
+    assert_kind_of(Hash, @generator.dependencies.first)
+  end
+
   def teardown
     @username  = nil
     @password  = nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oracle-model-generator
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-03 00:00:00 -06:00
+date: 2011-05-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency