db_discovery_generator 0.1.0

data/README

@@ -0,0 +1,3 @@
+README for db_discovery
+=======================
+

data/USAGE

@@ -0,0 +1,19 @@
+Description:
+    The db_discovery generator creates stub for a new models based on
+    information discovered from DB.
+
+    The generator creates a model classes in app/models, a test suites
+    in test/unit, test fixtures in test/fixtures/singular_name.yml,
+    and a migrations in db/migrate.
+
+Example:
+    ./script/generate db_discovery --no-fields
+
+    This will create an discovered models:
+        Model:      app/models/<table name>.rb
+        Test:       test/unit/<table name>_test.rb
+        Fixtures:   test/fixtures/<table name>s.yml
+        Migration:  db/migrate/XXX_add_<table name>s.rb
+
+        If --no-fields is provided then table's available field
+        definitions will be skipped

data/db_discovery_generator.rb

@@ -0,0 +1,110 @@
+class DbDiscoveryGenerator < Rails::Generator::Base
+  default_options :skip_migration => false
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    if options[:help] then
+      usage
+      exit
+    end
+    @no_fields = options['no_fields']
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'app/models'
+
+      generate_models.each do
+      |table, model|
+        m.template 'model.rb',
+                   "app/models/#{table.singularize.underscore}.rb",
+                   :assigns => {
+                       :table_name => table.singularize.underscore.camelize,
+                       :model => model,
+                       :no_fields => @no_fields
+                   }
+      end
+    end
+  end
+
+  protected
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--no-fields", 
+             "Don't show a list of available fields") { |v| options[:no_fields] = v }
+      opt.on("-h","--help", 
+             "Show this help message") { |v| options[:help] = v }
+    end
+
+    def mysql_primary_key (table_name, name = nil)#:nodoc:
+      sql = "SHOW FIELDS FROM #{table_name}"
+      pk = []
+      @connection.execute(sql, name).each do
+      |field|
+	pk << field[0] if field[3] == 'PRI'
+      end
+      if pk.length > 1 then
+        ''
+      else
+        pk[0]
+      end
+    end
+
+
+    def generate_models
+      @connection = ActiveRecord::Base.connection
+      models = {}
+
+      @connection.tables.each do
+      | table |
+        # Model class, unit test, and fixtures.
+
+	if table =~ /[A-Z]/ then
+		set_table_name = "  self.table_name = %( #{@connection.quote_column_name(table)} )"
+	else
+		set_table_name = "  self.table_name = \"#{table}\""
+	end
+
+	columns = @connection.columns(@connection.quote_column_name(table))
+	adapterName = @connection.adapter_name
+	pk = ''
+	case adapterName
+	  when 'PostgreSQL' then
+		pk, seq = @connection.pk_and_sequence_for(@connection.quote_column_name(table))
+		pk ||= ''
+	  when 'MySQL' then
+		pk = mysql_primary_key(@connection.quote_column_name(table))
+	end
+
+
+	models[table] = {
+			  :table => table,
+			  :columns => columns,
+			  :primary_key => pk,
+			  :table_name => set_table_name
+			}
+      end
+
+      models.each do
+      |table, model|
+        model[:columns].each do
+        |c|
+          next if c.name.nil?
+          next if model[:primary_key] && c.name == model[:primary_key]
+          next if c.name !~ /^(.+)(?:_id|ID)$/
+	  master = $1
+	  master_model = models[master.pluralize] || models[master]
+	  if master_model then
+	    model[:belongs_to] = [] if model[:belongs_to].nil?
+	    model[:belongs_to] << master.singularize.underscore
+	    # TODO: Distinguish between has_one and has_many
+            # TODO: HABTM - hint (relation)_(relation)
+	    master_model[:has_many] = [] if master_model[:has_many].nil?
+	    master_model[:has_many] << table.pluralize.underscore
+	  end
+        end
+      end
+      models
+    end
+end

data/templates/fixtures.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+first:
+  id: 1
+another:
+  id: 2

data/templates/migration.rb

@@ -0,0 +1,11 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      # t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/templates/model.rb

@@ -0,0 +1,20 @@
+class <%= model[:table].camelize %> < ActiveRecord::Base
+<%= model[:table_name] %>
+  self.primary_key = "<%= model[:primary_key] %>"
+
+<% model[:belongs_to].each do |b_t| -%>
+  belongs_to :<%= b_t %>
+<% end if model[:belongs_to] -%>
+
+<% model[:has_many].each do |h_m| -%>
+  has_many :<%= h_m %>
+<% end if model[:has_many] -%>
+
+<% if no_fields.nil? then -%>
+  # Fields information, just FYI.
+  #
+<% model[:columns].each do |c| -%>
+  # Field: <%= c.name =~ /[A-Z]/ ? ActiveRecord::Base.connection.quote_column_name(c.name) : c.name %> <%= ', SQL Definition:' + c.sql_type if c.respond_to?('sql_type') %>
+<% end %>
+<% end %>
+end

data/templates/unit_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  fixtures :<%= table_name %>
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/version.rb

@@ -0,0 +1,9 @@
+module DbDiscovery #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: db_discovery_generator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-10-14 00:00:00 -04:00
+summary: db_discovery generator allows you to create the DB models with associations from existing DB
+require_paths: 
+  - ''
+email: db_discovery@deeptown.org
+homepage: http://db-discovery.rubyforge.org
+rubyforge_project: 
+description: db_discovery generator allows you to create the DB models with associations from existing DB
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+  - Sergey Kuznetsov
+files: 
+  - version.rb
+  - db_discovery_generator.rb
+  - templates
+  - USAGE
+  - CHANGELOG
+  - README
+  - templates/fixtures.yml
+  - templates/migration.rb
+  - templates/model.rb
+  - templates/unit_test.rb
+test_files: []
+rdoc_options: 
+  - "--quiet"
+  - "--title"
+  - db_discovery documentation
+  - "--opname"
+  - index.html
+  - "--line-numbers"
+  - "--main"
+  - README
+  - "--inline-source"
+  - "--exclude"
+  - "^(examples|extras)/"
+extra_rdoc_files: 
+  - README
+  - CHANGELOG
+executables: []
+extensions: []
+requirements: []
+dependencies: []