sqld4r 0.0.1

data/lib/sqld4r/sqld4r_core.rb

@@ -0,0 +1,206 @@
+require "activesupport"
+
+class Sqld4r_core
+  
+  def initialize(options)
+    super()
+    @options = options
+    @logfile = File::new( @options["log_file"], "a" ) if @options["logging"]
+  end
+  
+  def run
+    notice "sqld4r: Starting at " + Time.now.strftime("%Y/%m/%d %H:%M:%S")
+    notice "start to parse about SQLDesigner xml file"
+    @structure = Sqld4r_parser.new.parse(@options["sqld_path"])
+    notice "finish to parse"
+    @structure.each do |table|
+      generate_model_for(table)
+    end
+    @structure.each do |table|
+      add_relationship_to(table) unless @options["skip-relation"]
+      add_index_to(table) unless @options["skip-index"]
+    end
+    notice "sqld4r: Complete at " + Time.now.strftime("%Y/%m/%d %H:%M:%S")
+    @logfile.close if @logfile
+  end
+  
+  def paramaters_for_model_generator
+    param_string = " "
+    param_string << "--svn " if @options["svn"]
+    param_string << "--git " if @options["git"]
+    param_string << "--skip-timestamps " if @options["skip-timestamps"]
+    param_string << "--skip-migration " if @options["skip-migration"]
+    param_string << "--skip-fixture " if @options["skip-fixture"]
+    param_string << "--quiet " unless @options["verbose"]
+    param_string
+  end
+  
+  # script/generate model post title:string body:text published:boolean owner:references
+  def model_and_columns_from_structure(table)
+    model_columns_string = ""
+    model_name = tablename2modelname(table["tablename"])
+    model_columns_string << model_name + " "
+    table["colums"].each do |column|
+      #puts column.inspect
+      next if "id" == column["name"]
+      if column["relation"].nil?
+        model_columns_string << column["name"] + ":" + column["datatype"] + " "
+      else
+        rel_table = Inflector.singularize(column["relation"]["table"])
+        model_columns_string << rel_table + ":references "
+      end
+    end
+    model_columns_string
+  end
+
+=begin
+script/generate model post title:string body:text published:boolean owner:references
+=end  
+  
+  def generate_model_for(table)
+    notice "generate for " + table["tablename"]
+    command = "script/generate "
+    if @options["rspec"]
+      command << "rspec_model " + paramaters_for_model_generator
+    else
+      command << "model " + paramaters_for_model_generator
+    end
+    command << model_and_columns_from_structure(table)
+    exec_shell_command(command)
+  end
+  
+=begin
+{
+  "tablename" => "comments", # => "has_many :comments" to Item model
+  "colums" => [
+    {
+      "relation" => nil,
+      "comment" => "com",
+    },
+    {
+      "relation" => {"table" => "items", "column" => "id"}, # => "belongs_to :item" to Comment model
+      "comment" => "has_many",
+    },
+  ],
+  "comment" => "user has many actions"
+},
+
+class Post < ActiveRecord::Base
+end
+
+relation_models = [
+  "app/model/comment.rb",
+  "app/model/sometable.rb",
+]
+=end
+  def add_relationship_to(table)
+    notice "add relationship to " + table["tablename"]
+    current_model_name = tablename2modelname(table["tablename"])
+    relation_models = []
+    current_model_relations = []
+    table["colums"].each do |column|
+      next if column["relation"].nil?
+      current_model_relations << tablename2modelname(column["relation"]["table"])
+      relation_models << tablename2modelname(column["relation"]["table"])
+    end
+    
+    # current model
+    notice "-add belongs_to relationship to " + table["tablename"] + " about:"
+    if 0 == current_model_relations.size
+      notice "--skip. becase this model dose not have relationship."
+    else
+      notice "--" + current_model_relations.join(",")
+      text_insert_to(modelname2modelpath(current_model_name)) do |file, line|
+        file.puts line
+        if /^class\s.+\s<\sActiveRecord::Base$/ =~ line
+          file.puts '#' + table["comment"] unless table["comment"].nil?
+          current_model_relations.each do |rel|
+            file.puts "  belongs_to :" + Inflector.singularize(rel)
+          end
+        end
+      end
+    end
+      
+    # target models
+    notice "-add has_one/has_many relationship to:"
+    if 0 == relation_models.size
+      notice "--skip. because this model dose not have relationship"
+    else
+      notice "--" + relation_models.join(",")
+      relation_models.each do |target_model|
+        text_insert_to(modelname2modelpath(target_model)) do |file, line|
+          file.puts line
+          if /^class\s.+\s<\sActiveRecord::Base$/ =~ line
+            single_name = Inflector.singularize(table["tablename"])
+            plural_name = table["tablename"]
+            file.puts '  # has_one :' + single_name + ' # TODO:CHECK_ME'
+            file.puts '  has_many :' + plural_name
+          end    
+        end
+      end
+    end
+  end
+
+  def tablename2modelname(tablename)
+    Inflector.singularize(tablename).classify
+  end
+  
+  def modelname2modelpath(modelname)
+    "app/models/" + modelname + ".rb"
+  end
+
+  def text_insert_to(filename)
+    current_model_contents = []
+    File::open(filename, "r") do |file|
+      current_model_contents = file.readlines
+    end
+    File::open(filename, "w") do |file|
+      current_model_contents.each do |line|
+        yield(file, line)
+      end
+    end
+  end
+=begin
+
+script/generate migration add_indexes_for_all_tables
+
+
+
+class CreatePosts < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+      t.boolean :published
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :posts
+  end
+end
+=end  
+  def add_index_to(table)
+    
+  end
+
+  def notice(message)
+    puts "* " + message if @options["verbose"]
+    @logfile.puts "* " + message if @options["logging"] and @logfile
+  end
+  
+  def exec_shell_command(command)
+    command << " > /dev/null" unless @options["verbose"]
+    command = "sudo " + command if @options["sudo"]
+    puts '->' + command  if @options["verbose"]
+    @logfile.puts '->' + command if @options["logging"] 
+    result = `#{command}`.chomp unless @options["emulate"]
+    puts '-->' + result  if @options["verbose"] and not result.nil? and not result.empty?
+    @logfile.puts '-->' + result if @options["logging"] and not result.nil? and not result.empty?
+    Sqld4r_options::error_with_show_usage "receive error from command." unless 0 == $?
+    $?
+  end
+
+end

data/lib/sqld4r/sqld4r_options.rb

@@ -0,0 +1,243 @@
+require 'optparse'
+require "yaml"
+require "readline"
+
+
+=begin
+script/generate model post title:string body:text published:boolean owner:references
+--svn Modify files with subversion. (Note: svn must be in path)
+--git Modify files with git. (Note: git must be in path)
+--skip-timestamps Don't add timestamps to the migration file for this model
+--skip-migration Don't generate a migration file for this model
+--skip-fixture Don't generation a fixture file for this model
+
+script/generate rspec_model Blog name:string
+=end
+
+
+class Sqld4r_options < Hash
+  @@version = Sqld4r::VERSION::STRING
+  @@product_name = "sqld4r"
+  
+  @@command_line_params = {}
+
+  def initialize
+    super()
+    
+    # default values
+    self["sqld_path"] = ""
+    self["sqld4r_conf_path"] = ENV["HOME"] + "/.sqld4r"
+    self["sqld4r_conf_path"] = ENV['SQLD4R_CONF'] unless ENV['SQLD4R_CONF'].nil?
+    self["init"] = false
+    self.merge(Sqld4r_options::static_default_values)
+    
+  end
+  
+  
+  def parse
+    @@opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{@@product_name} SQLDesigner_xml_path [options]"
+      opts.separator "Usage: #{@@product_name} --init [options]"
+      opts.separator "Usage: #{@@product_name} --check [options]"
+      opts.separator "version #{@@version}"
+      
+      opts.separator ""
+      opts.separator "Useful Options:"
+      opts.separator ""
+      
+      opts.on( '--conf=/path/to/conffile', 'change conf file path($HOME/.sqld4r < conf < command line params)' ) do |p|
+        self["sqld4r_conf_path"] = p
+      end
+
+      opts.on( '--svn', 'Modify files with subversion. (Note: svn must be in path/for script/generate)') do
+        @@command_line_params["svn"] = true
+      end
+
+      opts.on( '--git', 'Modify files with git. (Note: git must be in path/for script/generate)') do
+        @@command_line_params["git"] = true
+      end
+
+      opts.on( '--skip-timestamps', "Don't add timestamps to the migration file for this model") do
+        @@command_line_params["skip-timestamps"] = true
+      end
+
+      opts.on( '--skip-migration', "Don't generate a migration file for this model") do
+        @@command_line_params["skip-migration"] = true
+      end
+
+      opts.on( '--skip-fixture', "Don't generation a fixture file for this model") do
+        @@command_line_params["skip-fixture"] = true
+      end
+
+      opts.on( '--rspec', 'generate model with rspec') do
+        @@command_line_params["rspec"] = true
+      end
+
+      opts.on( '--skip-relation', "Don't add belongs_to/has_one/has_many to a model") do
+        @@command_line_params["skip-relation"] = true
+      end
+
+      opts.on( '--skip-index', "Don't add index to migration files") do
+        @@command_line_params["skip-index"] = true
+      end
+
+      opts.on( '--verbose', 'provide extra output while running') do
+        @@command_line_params["verbose"] = true
+      end
+      
+      opts.on( '--sudo', 'use sudo command') do
+        @@command_line_params["sudo"] = true
+      end
+
+      opts.on( '--log', 'create a log of command activity' ) do
+        @@command_line_params["logging"] = true
+      end
+      
+      opts.on( '--logfile=/path/to/logfile', 'Set path to logfile. default is ../docs/sqld4r.log' ) do |p|
+        @@command_line_params["log_file"] = p
+      end
+
+      opts.on( '--emulate', 'enable emulation mode' ) do
+        @@command_line_params["emulate"] = true
+      end
+
+      opts.separator ""
+      opts.separator "General Options:"
+      opts.separator ""
+      
+      opts.on( '-h', '--help', 'display this information' ) do
+        puts opts
+        exit
+      end
+      
+      opts.on( '-v', '--version', 'display version information'  ) do
+        puts "The model generator for SQLDesigner: #{@@product_name} version #{@@version}"
+        exit
+      end
+
+      opts.on( '--init', 'setup a template of conf file'  ) do
+        self["init"] = true
+      end
+
+      self["check"] = false
+      opts.on( '--check', 'check current variables'  ) do
+        self["check"] = true
+      end
+
+      opts.separator ""
+      opts.separator "Notice:"
+      opts.separator ""
+      opts.separator "Paramater priority: static < conf < command line"
+      opts.separator "You can use a environment variable SQLD4R_CONF for a sqld4r_conf_file"
+      opts.separator "conf path priority: env < command line"
+      opts.separator "I tested with Rails 2.1.0"
+
+    end
+    
+    validate_sqld_path
+    @@opts.parse!
+    marge_values
+    validate_options
+    if self["check"] or "--check" == self["sqld_path"]
+      puts "current variables"
+      self.each_pair do |key, value| puts "#{key}:#{value}" end
+      exit
+    end 
+    if self["init"] or "--init" == self["sqld_path"] 
+      put_conf_file
+      exit
+    end
+    self
+  end
+  
+  def validate_options
+    error_with_show_usage "Can not use --svn option with --git" if self["git"] and self["svn"]
+  end
+  
+  # write a template conf file to sqld4r_conf_path
+  def put_conf_file
+    # check put path
+    Sqld4r_options::error_with_show_usage "conf path is empty. set SQL4R_CONF environment variable or use --conf paramater." if self["sqld4r_conf_path"].empty?
+    
+    unless "y" == Readline.readline("Would a template file put to #{self["sqld4r_conf_path"]}? [y/N] > ").downcase
+      puts "Set your conf path to SQLD4R_CONF environment variable or use --conf paramater."
+      exit
+    end
+        
+    begin
+      File.open(self["sqld4r_conf_path"]) do |yamlfile|
+        # check overwrite?
+        exit unless "y" == Readline.readline("Overwrite? [y/N]").downcase
+      end
+    rescue
+    end
+    
+    begin
+      File.open(self["sqld4r_conf_path"], "w") do |yamlfile|
+        yamlfile.puts "# sqld4r conf file"
+        yamlfile.puts ""
+        yamlfile.puts Sqld4r_options::static_default_values.to_yaml
+      end
+      puts "Put template yaml file to #{self["sqld4r_conf_path"]}"
+    rescue
+      puts "Warning:Could not open for writing. check parmitions."
+    end
+  end
+  
+  def self.error_with_show_usage(message)
+    puts "Error:" + message
+    Sqld4r_options::show_usage
+    exit(1)
+  end
+
+  def self.show_usage
+    puts @@opts
+  end
+  
+  def validate_sqld_path
+    temp  = ARGV.first
+    unless temp.nil? or temp.empty?
+      @@command_line_params["sqld_path"] = temp.chomp
+    else
+      Sqld4r_options::error_with_show_usage("Need SQLDesigner_xml_path.")
+    end
+  end
+  
+  # default values if not use .sqld4r file
+  def self.static_default_values
+    defaults = {}
+    defaults["sqld4r_conf_path"] = ENV["HOME"] + "/.sqld4r"
+    defaults["copy_sqld_to"] = "../docs/sqldesigner.xml"
+    defaults["svn"] = false
+    defaults["git"] = false
+    defaults["skip-timestamps"] = false
+    defaults["skip-migration"] = false
+    defaults["skip-fixture"] = false
+    defaults["rspec"] = false
+    defaults["skip-relation"] = false
+    defaults["skip-index"] = false
+    defaults["execute_command_list"] = ENV["HOME"] + "/.sqld4r_execute_commands"
+    defaults["verbose"] = false
+    defaults["sudo"] = false
+    defaults["logging"] = false
+    defaults["log_file"] = "./sqld4r.log"
+    defaults["emulate"] = false
+    defaults
+  end
+  
+  # priority static < conf < command line params
+  def marge_values
+    conf_params = {}
+    # can open?
+    begin
+      File::open(self["sqld4r_conf_path"]) do |conf_file|
+        temp = YAML.load(conf_file.read)
+        conf_params = temp if temp
+      end
+    rescue
+      conf_params = {}
+    end
+    self.merge!(conf_params.merge!(@@command_line_params))
+  end
+  
+end

data/lib/sqld4r/sqld4r_parser.rb

@@ -0,0 +1,124 @@
+require "rexml/document"
+
+=begin
+structure = [
+  {
+    "tablename" => "table1",
+    "colums" => [
+      {
+        "name" => "col1",
+        "datatype" => "text",
+        "null" => "0",
+        "autoincrement" => "1",
+        "relation" => nil,
+        "comment" => "com",
+      },
+      {
+        "name" => "item_id",
+        "datatype" => "string",
+        "null" => "0",
+        "autoincrement" => "1",
+        "relation" => {"table" => "items", "column" => "id"},
+        "comment" => "has_many",
+      },
+      {
+        "name" => "col3",
+        "datatype" => "integer",
+        "null" => "0",
+        "autoincrement" => "1",
+        "relation" => nil,
+        "comment" => "",
+      },
+    ],
+    "comment" => "user has many actions"
+  },
+
+]
+=end
+
+class Sqld4r_parser
+  @@trans_map = {
+    "INTEGER" => "integer",
+    "DECIMAL" => "integer",
+    "FLOAT" => "float",
+    "DOUBLE" => "float",
+    "CHAR" => "string",
+    "VARCHAR" => "string",
+    "MEDIUMTEXT" => "text",
+    "BINARY" => "binary",
+    "VARBINARY" => "binary",
+    "BLOB" => "binary",
+    "DATE" => "date",
+    "TIME" => "time",
+    "DATETIME" => "datetime",
+    "YEAR" => "date",
+    "TIMESTAMP" => "timestamp",
+    "ENUM" => "string",
+    "SET" => "boolean",
+  }
+  
+  def initialize
+    super()
+    @structure = []
+    self
+  end
+  
+  def parse(filepath)
+    doc = REXML::Document.new File.new(filepath)
+    doc.elements.each("sql/table") do |table|
+      #puts table.attributes["name"]
+      @structure << table_hash(table)
+    end
+    @structure
+  end
+  
+  def table_hash(table_elem)
+    buffer_hash = {}
+    buffer_hash["tablename"] = table_elem.attributes["name"]
+    begin
+      buffer_hash["comment"] = table_elem.elements["comment"].text
+    rescue
+      buffer_hash["comment"] = ""
+    end
+    buffer_hash["colums"] = []
+    table_elem.elements.each("row") do |row|
+      buffer_hash["colums"] << colums_hash(row)
+    end
+    return buffer_hash
+  end
+
+=begin
+    <row name="user_id" null="0" autoincrement="0">
+      <datatype>INTEGER</datatype>
+      <relation table="users" row="id" />
+    </row>
+
+      {
+        "name" => "col2",
+        "datatype" => "integer",
+        "null" => "0",
+        "autoincrement" => "1",
+        "relation" => {"table" => "users", "column" => "id"},
+        "comment" => "has_many",
+      },
+=end
+  
+  def colums_hash(row)
+    rowbuffer_hash = {}
+    rowbuffer_hash["name"] = row.attributes["name"]
+    rowbuffer_hash["null"] = row.attributes["null"]
+    rowbuffer_hash["autoincrement"] = row.attributes["autoincrement"]
+    rowbuffer_hash["datatype"] = @@trans_map[row.elements["datatype"].text]
+    begin
+      rowbuffer_hash["relation"] = {"table" => row.elements["relation"].attributes["table"], "column" => row.elements["relation"].attributes["row"]}
+    rescue
+      rowbuffer_hash["relation"] = nil
+    end
+    begin
+      rowbuffer_hash["comment"] = row.elements["comment"].text
+    rescue
+      rowbuffer_hash["comment"] = ""
+    end
+    return rowbuffer_hash
+  end
+end