dbd4 1.0.2

data/bin/dbd4

@@ -0,0 +1,152 @@
+#--
+# Copyright (c) 2006 Daniel Shane
+#
+# 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.
+#--
+
+DBD4VERSION = '1.0.0'
+
+require 'getoptlong'
+require 'dbd4/dbd4_model_file'
+
+############################################################################
+# DBModel main application object.  When invoking +dbmodel+ from the command
+# line, a DBModelApp object is created and run.
+#
+class DBD4Import
+
+  OPTIONS = [
+    ['--dry-run',  '-n', GetoptLong::NO_ARGUMENT,
+      "Do a dry run without executing actions."],
+    ['--help',     '-H', GetoptLong::NO_ARGUMENT,
+      "Display this help message."],
+    ['--quiet',    '-q', GetoptLong::NO_ARGUMENT,
+      "Do not log messages to standard output."],
+    ['--usage',    '-h', GetoptLong::NO_ARGUMENT,
+      "Display usage."],
+    ['--version',  '-V', GetoptLong::NO_ARGUMENT,
+      "Display the program version."],
+  ]
+
+  # Create a DBModelApp object.
+  def initialize
+  end
+
+  # Display the program usage line.
+  def usage
+    puts "dbmodel {options} [dbmodelfiles ...]"
+  end
+
+  # Display the dbmodel command line help.
+  def help
+    usage
+    puts
+    puts "Options are ..."
+    puts
+    OPTIONS.sort.each do |long, short, mode, desc|
+      if mode == GetoptLong::REQUIRED_ARGUMENT
+        if desc =~ /\b([A-Z]{2,})\b/
+          long = long + "=#{$1}"
+        end
+      end
+      printf "  %-20s (%s)\n", long, short
+      printf "      %s\n", desc
+    end
+    puts "\nPlease read the rdoc README for more information."
+  end
+
+  # Return a list of the command line options supported by the
+  # program.
+  def command_line_options
+    OPTIONS.collect { |lst| lst[0..-2] }
+  end
+
+  # Do the option defined by +opt+ and +value+.
+  def do_option(opt, value)
+    case opt
+    when '--dry-run'
+      $dryrun = true
+    when '--help'
+      help
+      exit
+    when '--quiet'
+      $silent = true
+    when '--usage'
+      usage
+      exit
+    when '--version'
+      puts "dbmodel, version #{DBMODELVERSION}"
+      exit
+    else
+      fail "Unknown option: #{opt}"
+    end
+  end
+  
+  # Read and handle the command line options.
+  def handle_options
+    opts = GetoptLong.new(*command_line_options)
+    opts.each { |opt, value| do_option(opt, value) }
+  end
+
+  # Collect the list of dbmodel filenames on the command line.  
+  # Default filename is "dbmodel.xml"
+  def get_filenames
+    default_filename = File.join('db', 'dbd4model.xml')
+    filenames = []
+    ARGV.each { |arg| filenames << arg }
+    if filenames.size == 0
+      if File.exist?(default_filename)
+        filenames.push(default_filename)
+      else
+        puts "\nERROR: Could not find any database model XML files (default : #{default_filename})."
+      end
+    end
+    
+    filenames.each do |f| 
+      raise "File #{f} is not located in the DB directory, make sure your XML model is in your app/db directory." if File.basename(File.dirname(File.expand_path(f))) != 'db'
+    end
+    
+    filenames
+  end
+
+  # Run the dbmodel app
+  def run
+    handle_options
+    begin
+      get_filenames.each do |f|
+        puts "\nReading the datamodel XML (#{f}) from DBDesigner..." if not $silent
+        dbmf = DBD4::DBD4ModelFile.new(f)
+        if dbmf.messages[:warnings].size > 0
+          puts dbmf.messages[:warnings]
+          exit(1)
+        end
+        
+        dbmf.generateModelFiles
+        puts "Done!"
+      end
+    rescue Exception => ex
+      puts "dbmodel aborted!"
+      puts ex
+      exit(1)
+    end    
+  end
+end
+
+DBD4Import.new.run

data/lib/dbd4/dbd4_model_file.rb

@@ -0,0 +1,531 @@
+#--
+# Copyright (c) 2006 Daniel Shane
+#
+# 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.
+#--
+
+require 'rexml/document'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+require 'active_support/inflector'
+require 'config/boot'
+require 'dbd4/rails_model_file'
+require 'dbd4/rails_migration_file'
+require 'dbd4/ordered_hash'
+
+module DBD4
+  class DBD4Error < StandardError
+  end
+  
+  class DBD4ModelFile
+    attr_reader :tables, :generalDatatypes, :relations, :dbmodelxml, :file, :messages
+  
+    def initialize(file)
+      @messages = { :errors => [], :warnings => [], :info => [] }
+      @file = file
+      @dbmodelxml = REXML::Document.new(File.open(file))  
+      @allObjects = {
+        :tables => Tables.new,
+        :relations => Relations.new,
+        :datatypeDefinitions => DatatypeDefinitions.new
+      }
+  
+      dbmodelxml.elements.each("//*[@ID]") do |e|
+        case e.name
+          when "DATATYPE"
+            @allObjects[:datatypeDefinitions] << DatatypeDefinition.new(e)
+          when "TABLE"
+            @allObjects[:tables] << Table.new(e)
+          when "COLUMN"
+            @allObjects[:tables].last.addColumnFromXml(e)
+          when "RELATION_START"
+            @allObjects[:tables].last.addStartRelation(RelationID.new(e))
+          when "RELATION_END"
+            @allObjects[:tables].last.addEndRelation(RelationID.new(e))
+          when "RELATION"
+            @allObjects[:relations] << Relation.new(e)
+        end
+      end
+      @allObjects[:relations].resolve(@allObjects)
+      @allObjects[:tables].resolve(@allObjects)
+      @tables = @allObjects[:tables]
+      validate
+      raise DBD4Error, messages[:errors].join("\n") if @messages[:errors].size > 0
+    end
+    
+    def validate
+      @tables.each_value { |t| t.validate(@messages) }
+    end
+    
+    def generateModelFiles
+      @tables.generateModelFiles
+    end
+    
+    def to_str
+      "DBModelFile(file=#{File.basename(file)})\n" + @tables.to_str + "\n"
+    end
+  end
+  
+  
+  
+  class Table
+    attr_reader :id, :name, :columns, :relation_starts, :relation_ends, :modelname, :comments, :non_standard_name, :nm_table
+    attr_writer :modelfile, :name, :nm_table
+      
+    def initialize(table)
+      @id = table.attributes['ID']
+      @comments = table.attributes['Comments']
+      @name = table.attributes['Tablename']
+      @modelname = Inflector.singularize(@name)
+      @nm_table = false;
+      @primary_key = nil;
+      
+      @relation_starts = Array.new
+      @relation_ends = Array.new
+      @columns = Columns.new(self)
+      @non_standard_name = false
+    end
+    
+    def addColumnFromXml(column_xml)
+      column = Column.new(column_xml, self)
+      @primary_key = column if column.primary_key? and ! @primary_key
+      columns << column
+      
+    end
+    
+    def addEndRelation(e)
+      @relation_ends << e
+    end
+    
+    def addStartRelation(e)
+      @relation_starts << e
+    end
+    
+    def validate(messages)
+      if @nm_table
+        t1 = @relation_ends.values[0].source_table
+        t2 = @relation_ends.values[1].source_table
+        expected_name = nil;
+        if t1.name < t2.name
+          expected_name = "#{t1.name}_#{t2.name}"
+        else
+          expected_name = "#{t2.name}_#{t1.name}"
+        end
+        if @name != expected_name then
+          messages[:warnings] << "Warning : join table #{name} differs from expected #{expected_name}"
+          @non_standard_name = true
+        end
+      else
+        if @modelname == @name
+          messages[:warnings] << "Warning : table name #{name} is not in a valid plural form, should be #{Inflector.pluralize(name)}"
+          @non_standard_name = true
+        elsif Inflector.pluralize(@modelname) != @name
+          messages[:warnings] << "Warning : table name #{name} is not in a valid plural formm should be #{Inflector.pluralize(@modelname)}"
+          @non_standard_name = true
+        end
+      end
+      
+      columns.validate(messages)
+      relation_starts.validate(messages)
+      # no need to validate relation_ends, since we would do the job twice... doh
+    end
+    
+    def resolve(allObjects)
+      @columns.resolve(allObjects)
+      tmp = Relations.new
+      @relation_starts.each { |r| tmp<<allObjects[:relations][r.id] }
+      @relation_starts = tmp
+      tmp = Relations.new
+      @relation_ends.each { |r| tmp<<allObjects[:relations][r.id] }
+      @relation_ends = tmp
+      if @columns.size == 3
+        if @columns.foreign_keys.size == 2
+          if @relation_ends.values.size == 2
+            if @relation_ends.values[0].type == :one2many and @relation_ends.values[1].type == :one2many
+              @nm_table = true
+              @relation_ends.values[0].destination_table = @relation_ends.values[1].source_table
+              @relation_ends.values[0].join_table = self
+              @relation_ends.values[1].destination_table = @relation_ends.values[0].source_table
+              @relation_ends.values[1].join_table = self
+              @relation_ends.values[0].type = :many2many
+              @relation_ends.values[1].type = :many2many
+            end
+          end
+        end
+      end
+    end
+    
+    def generateModelFile 
+      m = RailsModelFile.new({:modelname => @modelname})
+      m.update(self) unless @nm_table
+      m = RailsMigrationFile.new({:tablename => @name})
+      m.update(self)
+    end
+    
+    def to_str
+      "Table(id=#{id}, name=#{name}, non_standard_name=#{non_standard_name}, nm_table=#{nm_table})\n" +
+      "Start relations\n" +
+      @relation_starts.to_str + "\n" +
+      "End relations" + "\n" +
+      @relation_ends.to_str + "\n" +
+      "Columns" + "\n" +
+      @columns.to_str + "\n-----------------------\n"
+    end  
+  end
+  
+  class Column
+    attr_reader :id, :name, :datatype, :primary_key, :foreign_key, :table, :non_standard_name, :polymorphic
+    attr_writer :table, :non_standard_name, :polymorphic
+     
+    def primary_key?
+      return @primary_key != nil && @primary_key == '1'
+    end
+    
+    def foreign_key?
+      return @foreign_key != nil && @foreign_key == '1'
+    end
+    
+    def initialize(column, table) 
+      @id = column.attributes['ID']
+      @name= column.attributes['ColName']
+      @primary_key = column.attributes['PrimaryKey']
+      @foreign_key = column.attributes['IsForeignKey']
+      @datatype = Datatype.new(column, self)
+      @table = table
+      @non_standard_name = false
+      @polymorphic = nil
+    end
+    
+    def validate(messages)
+      @datatype.validate(messages)
+    end
+    
+    def resolve(allObjects)
+      @datatype.resolve(allObjects)
+    end
+    
+    def to_str
+      "Column(id=#{id}, name=#{name}, pkey=#{primary_key?}, fkey=#{foreign_key?}, poly=#{polymorphic}, non_standard=#{non_standard_name}, " + datatype.to_str + ")"
+    end
+  end
+  
+  class ForeignKeyField
+    attr_reader :source_field, :destination_field
+    
+    def initialize(fkfield_string)
+      @source_field, @destination_field = fkfield_string.split(/=/)
+    end
+    
+    def to_str
+      "#{source_field} => #{destination_field}"
+    end
+  end
+  
+  class ForeignKeyFields < Array
+    def initialize(fkfields_string)
+      if fkfields_string
+        fkfields_string.split(/\\n/).each do |fk|
+          fkfield = ForeignKeyField.new(fk)
+          self<<fkfield
+        end
+      end
+    end
+    
+    def to_str
+      self.collect {|v| v.to_str}.join(",")      
+    end
+  end
+  
+  class RelationID
+    attr_reader :id
+    
+    def initialize(relation)
+      @id = relation.attributes['ID']
+    end
+  end
+  
+  class Relation
+    attr_reader :id, :name, :type, :source_column, :destination_column, :source_table, :destination_table, :join_table, :fk_fields
+    attr_writer :destination_table, :source_table, :join_table, :type
+    
+    def initialize(relation)
+      @join_table = nil
+      @fk_fields = ForeignKeyFields.new(relation.attributes['FKFields'])
+      @id = relation.attributes['ID']
+      @name = relation.attributes['RelationName']
+      @kind = relation.attributes['Kind']
+      @type = nil
+      case @kind
+        when '5'
+          @type = :one2one
+        when '2'
+          @type = :one2many
+      end
+      @source_table = relation.attributes['SrcTable']
+      @destination_table = relation.attributes['DestTable']
+    end
+     
+    def resolve(allObjects)
+      @source_table = allObjects[:tables][@source_table] 
+      @destination_table = allObjects[:tables][@destination_table]
+      @source_column = @source_table.columns.primary_keys[@fk_fields[0].source_field]
+      @destination_column = @destination_table.columns.foreign_keys[@fk_fields[0].destination_field]
+    end
+    
+    def validate(messages)
+      if @fk_fields.size > 1
+        messages[:warnings] << "Warning : between table #{@destination_column.table.name} and table #{@source_column.table.name}, relation #{name} targets more than 1 foreign_key" 
+      end
+      
+      expected_fkey_name = Inflector.singularize(@source_table.name) + "_id"
+      if @destination_column.name != expected_fkey_name and @destination_column.polymorphic == nil then
+        messages[:warnings] << "Warning : table #{@destination_column.table.name}, foreign key #{@destination_column.name} does not match expected name #{expected_fkey_name}"
+        @destination_column.non_standard_name = true
+      end
+    end
+  
+    def to_str
+      "Relation(id=#{id}, name=#{name}, type=#{type}, src=#{source_table.name}, dst=#{destination_table.name}, fk=#{fk_fields.to_str})"
+    end
+  end
+  
+  class Datatype
+    attr_reader :type, :params, :notnull, :id, :non_standard_type, :column
+  
+    def initialize(datatype, column)
+      @column = column
+      @params = Hash.new()
+      @id = datatype.attributes['idDatatype']
+      @param_values = datatype.attributes['DatatypeParams'].delete("()").split(/[,]/)
+      @params = Hash.new()
+      @type = nil
+      @notnull = datatype.attributes['NotNull']
+      @non_standard_type = false
+    end  
+    
+    def resolve(allObjects)
+      dd = allObjects[:datatypeDefinitions][@id] 
+      # Create a Hash from 2 arrays by zipping them together
+      @params = Hash[*dd.zip(@param_values).flatten] if ! @param_values.empty?
+      @type = dd.type
+    end
+    
+    def validate(messages)
+      case @type
+        when 'BOOL'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} cannot take any parameters"
+            @non_standard_type = true
+          end
+        when 'TEXT'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} cannot take any parameters"
+            @non_standard_type = true
+          end
+        when 'VARCHAR'
+          @params.each_key do |k|
+            if k != 'length'
+              messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} can only take length as parameter"
+              @non_standard_type = true
+            end
+          end
+        when 'FLOAT'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} cannot take any parameters"
+            @non_standard_type = true
+          end
+        when 'DATETIME'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} cannot take any parameters"
+            @non_standard_type = true
+          end
+        when 'DATE'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} cannot take any parameters"
+            @non_standard_type = true
+          end
+        when 'INTEGER'
+          @params.each_key do |k|
+            if k != 'length'
+              messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} can only take length as parameter"
+              @non_standard_type = true
+            end
+          end
+        when 'DECIMAL'
+          if @params.size != 2 or not @params['length'] or not @params['decimals']
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} takes 2 params, length and decimals"
+            @non_standard_type = true
+          end
+        when 'BINARY'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} does not take any parameters"
+            @non_standard_type = true
+          end
+         when 'BLOB'
+          if @params.size != 0
+            messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} does not take any parameters"
+            @non_standard_type = true
+          end
+        else
+         messages[:warnings] << "Warning : table #{column.table.name} column #{column.name}, #{type} is not a valid type"
+         @non_standard_type = true
+      end
+    end
+    
+    def to_str
+      "Datatype(type=#{type}, non_standard=#{non_standard_type}, notnull=#{notnull}" + params.keys.collect { |k| ", #{k}=#{params[k]}" }.join("") + ")"
+    end
+  end
+  
+  class DatatypeDefinition < Array
+    attr_reader :type, :id, :param_keys
+      
+    def initialize(datatype)
+      @id = datatype.attributes['ID']
+      @type = datatype.attributes['TypeName']
+      datatype.elements.each("PARAMS/PARAM") do |p|
+        self << p.attributes['Name']
+      end
+    end
+    
+    def to_str
+      "GeneralDataType(id=#{id}, type=#{type}, #{params})"
+    end
+  end
+  
+  
+  class Relations < OrderedHash
+    def <<(relation)
+      self[relation.id] = relation
+    end
+      
+    def fix_many2many
+      each_value { |v| v.fix_many2many }
+    end
+    
+    def resolve(allObjects)
+      each_key { |k| self[k] = allObjects[:relations][k] }
+      each_value { |v| v.resolve(allObjects) }
+    end
+    
+    def validate(messages)
+      each_value { |v| v.validate(messages) }
+    end
+    
+    def to_str
+      values.collect { |v| v.to_str + "\n" }.join("")
+    end
+  end
+  
+  class Columns < Hash
+    attr_reader :primary_keys, :foreign_keys
+    attr_writer :primary_keys, :foreign_keys
+    
+    def initialize(table, *args)
+      @primary_key = nil
+      @primary_keys = OrderedHash.new
+      @foreign_keys = OrderedHash.new
+      @table = table
+      super(*args)
+    end
+      
+    def <<(column)
+      column.table = @table
+      @primary_key = column unless @primary_key
+      if column.primary_key?
+        @primary_keys[column.name] = column
+      end
+      if column.foreign_key?
+        @foreign_keys[column.name] = column if column.foreign_key?
+        if column.name =~ /^(.*)_id/ and self[$~[1] + "_type"] then
+          column.polymorphic = $~[1]
+        end
+      end
+      
+      if ! column.primary_key? and ! column.foreign_key?
+        if column.name =~ /^(.*)_type/ and @foreign_keys[$~[1] + "_id"] then
+          @foreign_keys[$~[1] + "_id"].polymorphic = $~[1]
+        end
+      end
+      self[column.name] = column
+    end
+    
+    def validate(messages)
+      if @primary_key == nil then
+        messages[:errors] << "Error : table #{@table.name} has no primary keys, you need at least 1"
+      else    
+        if @primary_keys.size > 1 then
+          messages[:warnings] << "Warning : table #{@table.name} has more than 1 primary key, only the first one will be considered"
+        end
+        
+        if @primary_key.name != 'id'
+          messages[:warnings] << "Warning : table #{@table.name} primary key #{@primary_key.name} differs from expected name id"
+          @primary_key.non_standard_name = true
+        end
+      end
+      each_value { |v| v.validate(messages) }
+    end
+    
+    def resolve(allObjects)
+      each_value { |v| v.resolve(allObjects) }
+    end
+    
+    def to_str
+      values.collect { |v| v.to_str + "\n" }.join("")
+    end
+  end
+  
+  class Tables < Hash
+    def last
+      self[@order.last]
+    end
+    
+    def initialize
+      @order = Array.new
+    end
+    
+    def <<(table)
+      self[table.id] = table
+      @order << table.id
+    end
+    
+    def resolve(allObjects)
+      each_value { |v| v.resolve(allObjects) }
+    end
+    
+    def generateModelFiles
+      each_value { |v| v.generateModelFile }
+    end
+    
+    def to_str
+      values.collect { |v| v.to_str + "\n" }.join("")
+    end
+  end
+  
+  class DatatypeDefinitions < Hash
+    def <<(datatypeDefinition)
+      self[datatypeDefinition.id] = datatypeDefinition
+    end
+    
+    def to_str
+      values { |v| v.to_str + "\n"}.join("")
+    end
+  end
+end