dbmodel 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2005 William T Katz
+
+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

@@ -0,0 +1,72 @@
+= dbmodel - rails model generator from XML database model file
+
+=== Synopsis
+
+     dbmodel [options] [xml_file_name(s) ...]
+
+=== Description
+
+     The dbmodel generator loads an XML file from a database design tool
+     (MySQL DBDesigner 4), generates files you'd normally get by
+     "generate model" or "generate scaffold", and inserts comments and
+     relationships (e.g., "has_many :foos") into the model files.
+     
+     If no XML files are specified on the command line, dbmodel will
+     check if the file "dbmodel.xml" is present in the current directory.
+     
+     While full roundtripping is possible in the future, this version is a
+     simplistic proof-of-concept. It assumes you are using the free
+     DBDesigner 4. Tables are created using Rails naming conventions and
+     relationships are named in Rails fashion. Scaffolding commands can
+     be embedded as comments in the tables using the format:
+     [SCAFFOLD]
+     or optionally
+     [SCAFFOLD controller-name action1 action2 ...]
+
+     dbmodel is simplistic and requires convention to bypass configuration.
+     Relationships should be labelled habtm, has_many, or has_one. Reciprocal
+     relationships for has_many and has_one are auto-generated. The database
+     model XML file is assumed to be in the /db directory of a Rails app.
+     Creation of a model file or scaffolding only occurs if a model file is
+     missing. Only tables with relationships drive creation of a model file.
+
+=== Simple Example
+
+     Get DBDesigner 4 at http://www.fabforce.net/dbdesigner4/
+     Eventually, this will be replaced by MySQL Workbench.
+     
+     Using DBDesigner 4, create two tables: banks and accounts. Add a 1:n
+     relationship between the "banks" table and the "accounts" table. Name
+     the relationship "has_many :accounts". Open the "accounts" table and
+     add the following comment: "[SCAFFOLD]These are the bank accounts."
+     Comments can have newlines (/n) in them; dbmodel will break the comments
+     into separate lines.
+     
+     DBDesigner can synchronize a model with your database in two ways:
+     1) Output a SQL create script (a DDL file).
+     2) Use the "synchronize" feature which updates your database. Note that
+        DBDesigner is an old program that will be re-released as MySQL
+        Workbench. For now, though, in order to use the built-in synchronize
+        feature, you'll have to establish a MySQL account with an OLD PASSWORD
+        (pre-4.1) -- see http://www.billkatz.com/rails_dbmodel
+        
+     Save the database model as "bankmodel". By default, the model is saved
+     as an XML file from DBDesigner. Place the XML file in the /db directory 
+     of your Rails app.
+     
+     To update the Rails model files, simply execute the following:
+     
+     ruby script/generate dbmodel bankmodel.xml
+     
+     The generator will create Bank and Account model files by calling
+     the model or scaffold generator, depending on whether a table has
+     the [SCAFFOLD] tag in the table comments. If a model file already
+     exists, it is NOT overwritten; the file is scanned for the existence
+     of the proper relationships, and if they aren't there, they're added.
+     Table comments are written only when a file is newly created.
+     
+=== License
+
+dbmodel is available under an MIT-style license.
+
+:include: MIT-LICENSE

data/README.txt

@@ -0,0 +1,69 @@
+NAME
+     dbmodel - rails model generator from XML database model file
+
+SYNOPSIS
+     dbmodel [options] [xml_file_name(s) ...]
+
+DESCRIPTION
+     The dbmodel generator loads an XML file from a database design tool
+     (MySQL DBDesigner 4), generates files you'd normally get by
+     "generate model" or "generate scaffold", and inserts comments and
+     relationships (e.g., "has_many :foos") into the model files.
+     
+     If no XML files are specified on the command line, dbmodel will
+     check if the file "dbmodel.xml" is present in the current directory.
+     
+     While full roundtripping is possible in the future, this version is a
+     simplistic proof-of-concept. It assumes you are using the free
+     DBDesigner 4. Tables are created using Rails naming conventions and
+     relationships are named in Rails fashion. Scaffolding commands can
+     be embedded as comments in the tables. Scaffolding commands can
+     be embedded as comments in the tables using the format:
+     [SCAFFOLD]
+     or optionally
+     [SCAFFOLD controller-name action1 action2 ...]
+
+     dbmodel is simplistic and requires convention to bypass configuration.
+     Relationships should be labelled habtm, has_many, or has_one. Reciprocal
+     relationships for has_many and has_one are auto-generated. The database
+     model XML file is assumed to be in the /db directory of a Rails app.
+     Creation of a model file or scaffolding only occurs if a model file is
+     missing. Only tables with relationships drive creation of a model file.
+
+EXAMPLE   
+     Get DBDesigner 4 at http://www.fabforce.net/dbdesigner4/
+     Eventually, this will be replaced by MySQL Workbench.
+     
+     Using DBDesigner 4, create two tables: banks and accounts. Add a 1:n
+     relationship between the "banks" table and the "accounts" table. Name
+     the relationship "has_many :accounts". Open the "accounts" table and
+     add the following comment: "[SCAFFOLD]These are the bank accounts."
+     Comments can have newlines (/n) in them; dbmodel will break the comments
+     into separate lines.
+     
+     DBDesigner can synchronize a model with your database in two ways:
+     1) Output a SQL create script (a DDL file).
+     2) Use the "synchronize" feature which updates your database. Note that
+        DBDesigner is an old program that will be re-released as MySQL
+        Workbench. For now, though, in order to use the built-in synchronize
+        feature, you'll have to establish a MySQL account with an OLD PASSWORD
+        (pre-4.1) -- see http://www.billkatz.com/rails_dbmodel
+        
+     Save the database model as "bankmodel". By default, the model is saved
+     as an XML file from DBDesigner. Place the XML file in the /db directory 
+     of your Rails app.
+     
+     To update the Rails model files, simply execute the following:
+     
+     ruby script/generate dbmodel bankmodel.xml
+     
+     The generator will create Bank and Account model files by calling
+     the model or scaffold generator, depending on whether a table has
+     the [SCAFFOLD] tag in the table comments. If a model file already
+     exists, it is NOT overwritten; the file is scanned for the existence
+     of the proper relationships, and if they aren't there, they're added.
+     Table comments are written only when a file is newly created.
+      
+LICENSE
+     dbmodel is available under an MIT-style license.
+

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "dbmodel"
+  s.version           = "0.1.0"
+  s.author            = "William T Katz"
+  s.email             = "bill@billkatz.com"
+  s.homepage          = "http://www.billkatz.com/rails_dbmodel"
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = "A program that generates Rails files from a data model"
+  s.files             = FileList["[A-Z]*","{bin,lib}/**/*"].exclude("rdoc").to_a
+  s.require_path      = "lib"
+  s.bindir            = "bin"
+  s.executables       = ["dbmodel"]
+  s.default_executable  = "dbmodel"
+  s.autorequire       = "dbmodel"
+  s.has_rdoc          = true
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+  s.add_dependency("rails", ">= 0.12.0")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end

data/bin/dbmodel

@@ -0,0 +1,7 @@
+begin
+  require 'dbmodel'
+rescue LoadError
+  require 'rubygems'
+  require_gem 'dbmodel'
+end
+DBModelApp.new.run

data/lib/dbmodel.rb

@@ -0,0 +1,295 @@
+#--
+# Copyright (c) 2005 William T Katz
+#
+# 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.
+#++
+
+DBMODELVERSION = '0.1.0'
+
+
+require 'getoptlong'
+require 'rexml/document'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+# A class to handle parsing of table information from a datamodel XML file.
+# Since relationships are defined by table IDs, a hash is constructed using
+# table IDs.
+class Tables
+  def initialize
+    @table_hash = Hash.new
+  end
+
+  # Adds a table to the hash, where the table is a <tt>REXML::Element</tt> with
+  # +ID+, +Tablename+, and +Comments+ attributes
+  def add_table(t)
+    @table_hash[t.attributes['ID']] = {
+      'name' => t.attributes['Tablename'],
+      'comments' => t.attributes['Comments'],
+      'relationships' => []
+    }
+  end
+
+  # Adds a relationship to the hash, where the relationship has source and
+  # destination table IDs definied by attributes +SrcTable+ and +DstTable+.
+  # The +RelationName+ attribute should be Rails-valid code. To-do: this
+  # could be made more robust where we trace the relationships through
+  # join tables and don't require any model names in the relationship name.
+  def add_relationship(r)
+    src_table_id = r.attributes['SrcTable']
+    src_table_name = @table_hash[src_table_id]['name']
+    dest_table_id = r.attributes['DestTable']
+    dest_table_name = @table_hash[dest_table_id]['name']
+    
+    relationship = r.attributes['RelationName']
+    if relationship =~ /\s*habtm\s*:(\w+)/
+      relationship = "  has_and_belongs_to_many :#{$1}"
+    else
+      # If we are inserting the other side of a relationship (non-habtm),
+      # we need to mirror the relationship.
+      # NOTE: in the DB model, links should be labeled 'has_one' or 'has_many'
+      #       not 'belongs_to' since that label is ambiguous 1:1 or 1:n
+      if relationship =~ /has_one/ or relationship =~ /has_many/
+        @table_hash[dest_table_id]['relationships'] << '  belongs_to :' + src_table_name
+      else relationship !~ /has_and_belongs_to_many/
+        puts "error: relationships must be labeled 'has_one :x', 'has_many :x', 'habtm :x' or 'has_and_belongs_to_many :x'"
+        return
+      end
+      relationship = '  ' + relationship
+    end
+    @table_hash[src_table_id]['relationships'] << relationship
+  end
+
+  # Updates the Rails app files to reflect what's in the table hash. The location
+  # of the Rails app is gleaned from +xmlfile+, which is assumed to be in /db.
+  # If a model file doesn't exist, a <tt>generate model</tt> or <tt>generate scaffold</tt>
+  # is called, depending on the presence of a <tt>[SCAFFOLD]</tt> tag in the table
+  # comments. Existing files are checked to make sure the relationship
+  # is defined. To-do: old relationships aren't removed
+  def update_files(xmlfile)
+    @table_hash.each do |table_id, table|
+      if not table['relationships'].empty?
+        add_comments = false
+        # If there's no model file, create one via generate scaffold script
+        modelfile = File.dirname(xmlfile) + '\..\app\models\\' + table['name'].singularize + '.rb'
+        if File.exist?(modelfile)
+          puts "Model file (#{table['name'].singularize}) already exists. Skipping generation." if not $silent
+        elsif table['comments'] =~ /\[\s*SCAFFOLD\s*(\s.*)*\s*\]/
+          cmdline = ['scaffold', table['name'].singularize]
+          if not $1.nil?
+            $1.split(' ').collect { |arg| cmdline << arg }
+          end
+          cmdline << '-f'
+          puts "Calling generator: #{cmdline.join(' ')}" if not $silent
+          Rails::Generator::Scripts::Generate.new.run(cmdline) if not $dryrun
+          add_comments = true
+        elsif
+          cmdline = ['model', table['name'].singularize, '-f']
+          puts "Generating model for #{table['name'].singularize}" if not $silent
+          Rails::Generator::Scripts::Generate.new.run(cmdline) if not $dryrun
+          add_comments = true
+        end
+
+        update_file(modelfile, table_id, add_comments) if not $dryrun
+      end
+    end
+  end 
+
+  #####################################
+  private
+
+  def find_class_declaration_line(code)
+    code.each_with_index do |line, index|     
+      return index if line =~ /class/
+    end
+    puts "error: couldn't find class to insert relationships"
+    return -2
+  end
+  
+  def prettify_comments(comment)
+    lines = comment.split(/\[\s*SCAFFOLD.*\]/).join.split('\n')
+    return lines
+  end
+
+  # Update model file for this table
+  def update_file(modelfile, table_id, add_comments)
+    begin
+      File.open(modelfile, "r+") do |file|
+        modelcode = file.readlines
+        class_line = find_class_declaration_line(modelcode)
+        if class_line >= 0
+          # Update the relationships
+          @table_hash[table_id]['relationships'].each do |relationship|
+            our_relation = Regexp.new(relationship.strip)
+            unless modelcode.grep(our_relation).any?
+              puts "  --> insert#{relationship}  (in #{modelfile})" if not $silent
+              modelcode.insert(class_line + 1, relationship + "\n")
+            end
+          end
+          # Add comments
+          if add_comments and not @table_hash[table_id]['comments'].empty?
+            puts "  --> modifying comments in #{modelfile}" if not $silent
+            lines = prettify_comments(@table_hash[table_id]['comments'])
+            lines.reverse.each do |line|
+              modelcode.insert(class_line, '# ' + line + "\n")
+            end
+          end
+          # File should always grow with our additions
+          file.rewind
+          file.puts(modelcode)
+        end
+      end
+    rescue
+      puts "\nCouldn't open file (#{modelfile}). Make sure your database "
+      puts "model XML files are in the /db directory of your Rails app."
+    end
+  end
+end
+
+############################################################################
+# DBModel main application object.  When invoking +dbmodel+ from the command
+# line, a DBModelApp object is created and run.
+#
+class DBModelApp
+
+  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
+    filenames = []
+    ARGV.each { |arg| filenames << arg if arg !~ /^-+.*/ }
+    if filenames.size == 0
+      if File.exist?('dbmodel.xml')
+        filenames.push("dbmodel.xml")
+      else
+        puts "\nCould not find any database model XML files."
+      end
+    end
+    filenames
+  end
+
+  # Run the dbmodel app
+  def run
+    handle_options
+    begin
+      get_filenames.each do |f|
+        require File.dirname(f) + '/../config/environment'  # Better way to do this?
+        @dbmodelxml = REXML::Document.new(File.open(f))
+        # Verify that this is a DBDesigner XML file
+        if @dbmodelxml.elements['DBMODEL'].nil?
+          puts "\nFile '#{f}' is not a DBDesigner 4 XML file. Skipping..."
+        else
+          puts "\nReading the datamodel XML (#{f}) from DBDesigner..." if not $silent
+          # Create a hash for each table with ID key
+          tables = Tables.new
+          @dbmodelxml.elements.each("//TABLE") { |t| tables.add_table(t) }
+          # Add relationship information to the tables
+          @dbmodelxml.elements.each("//RELATION") { |r| tables.add_relationship(r) }
+          # Modify the files for each table
+          tables.update_files(f)
+        end
+      end
+    rescue Exception => ex
+      puts "dbmodel aborted!"
+      if ex.message =~ /config\/environment/
+        puts "Make sure your datamodel XML file is in the Rails app /db directory\n"
+      end
+      puts ex.message
+      puts ex.backtrace.find {|str| str =~ /\.rb/ } || ""
+      exit(1)
+    end    
+  end
+end
+
+if __FILE__ == $0 then
+  DBModelApp.new.run
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: dbmodel
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-07-25
+summary: A program that generates Rails files from a data model
+require_paths: 
+  - lib
+email: bill@billkatz.com
+homepage: http://www.billkatz.com/rails_dbmodel
+rubyforge_project: 
+description: 
+autorequire: dbmodel
+default_executable: dbmodel
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - William T Katz
+files: 
+  - MIT-LICENSE
+  - Rakefile
+  - README
+  - README.txt
+  - bin/dbmodel
+  - lib/dbmodel.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: 
+  - README
+  - MIT-LICENSE
+executables: 
+  - dbmodel
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.12.0
+      version: