alexrothenberg-legacy_data 0.0.1 → 0.0.6

data/README.rdoc

@@ -2,8 +2,37 @@
 
 How can you start a rails project on top of a large legacy database ... use the legacy_data plugin.
 
- 
+What if the database doesn't follow Rails/ActiveRecord naming conventions? ... not a problem
+What if there are a lot of tables? ... not a problem
+What about all the information contained in the database already (relationships, constraints, etc) ... they are extracted into your models
+
+Usage: script/generate models_from_tables [options]
+        --table-name [ARG] Only generate models for tables starting with
+        --table-naming-convention [ARG]
+                                     Naming convention for tables in the database. Only the wildcard is used when generating the model name
+
+Examples:
+* script/generate script/generate models_from_tables --table-naming-convention=tb*
+  Generate a model for each table in the database.  The tables all start with a tb (i.e. table 'tbperson' will generate the model 'person')
+* script/generate script/generate models_from_tables --table-name tbperson 
+  Generate a model for the 'tbperson' table in the database. 
 
+== Usage
+
+* Create a new rails project with the admin data plugin
+  rails my_application -m http://gist.github.com/188172.txt
+* Configure your application to connect to your existing Oracle database.  Get the connect connect string from your dba (something like: user/password@server.example.com:1541/sid.world) and edit your config/database.yml
+development:
+  adapter: oracle_enhanced
+  database: server.example.com:1541/sid.world
+  username: user
+  password: password
+* Generate models for all existing tables
+  script/generate models_for_all
+* Take a look
+  script/server
+  http://localhost:3000/admin_data
+ 
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.6

data/generators/models_from_tables/models_from_tables_generator.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../../lib/legacy_data/schema'
+require File.dirname(__FILE__) + '/../../lib/active_record/connection_adapters/oracle_enhanced_adapter'
+
+class ModelsFromTablesGenerator < Rails::Generator::Base  
+  def manifest
+    record do |m|
+      m.directory File.join('app/models')
+
+      if options[:table_name]
+        tables = [options[:table_name] ] 
+      else
+        naming_convention = options[:table_naming_convention] || '*'
+        tables = LegacyData::Schema.tables(/^#{naming_convention.gsub('*', '.*')}$/)
+      end
+      tables.each do |table_name|
+        puts "analyzing #{table_name}"
+        analysis = LegacyData::Schema.new(table_name, options[:table_naming_convention]).analyze_table
+
+        file_name = analysis[:class_name].underscore
+        m.template           'model.rb',      
+                             File.join('app/models', "#{file_name}.rb"), 
+                             :assigns => analysis
+      end
+    end
+  end
+
+protected
+  def add_options!(opt)
+    opt.on('--table-name [ARG]', 
+          'Only generate models for given table') { |value| options[:table_name] = value }
+    opt.on('--table-naming-convention [ARG]', 
+          'Naming convention for tables in the database - will not be used when generating naming the models') { |value| options[:table_naming_convention] = value }
+  end
+  
+end

data/generators/{legacy_models → models_from_tables}/templates/model.rb

@@ -1,6 +1,6 @@
 class <%= class_name -%> < ActiveRecord::Base
   set_table_name :<%= table_name %>
-  set_primary_key :<%= primary_key %>
+  <%= "set_primary_key #{primary_key.inspect}" if primary_key %>
   
   # Relationships
   <%- relations[:has_some].each do |class_name, foreign_key| 
@@ -15,11 +15,12 @@ class <%= class_name -%> < ActiveRecord::Base
   <%- constraints[:multi_column_unique].each do |cols| 
   -%>  #validates_uniqueness_of_multiple_column_constraint :<%= cols.inspect %>
   <%- end -%>
-  <%= "validates_presence_of #{constraints[:non_nullable].map {|cols| cols.first.downcase.to_sym.inspect}.join(', ')}" unless constraints[:non_nullable].blank? %>
+  <%= "validates_presence_of #{constraints[:non_nullable].map {|cols| cols.downcase.to_sym.inspect}.join(', ')}" unless constraints[:non_nullable].blank? %>
   <%- constraints[:custom].each do |name, sql_rule| 
   -%>  validate <%= "validate_#{name}".to_sym.inspect %>
   def <%= "validate_#{name}" %>
-    # TODO: validate this SQL constraint "<%= sql_rule %>"
+    # TODO: validate this SQL constraint 
+    "<%= sql_rule %>"
   end
   <%- end %>
 end

data/legacy_data.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{legacy_data}
-  s.version = "0.0.1"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Rothenberg"]
-  s.date = %q{2009-09-16}
+  s.date = %q{2009-09-17}
   s.description = %q{Create ActiveRecord models from an existing database}
   s.email = %q{alex@alexrothenberg.com}
   s.extra_rdoc_files = [
@@ -23,9 +23,9 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "generators/legacy_models/USAGE",
-     "generators/legacy_models/legacy_models_generator.rb",
-     "generators/legacy_models/templates/model.rb",
+     "generators/models_from_tables/USAGE",
+     "generators/models_from_tables/models_from_tables_generator.rb",
+     "generators/models_from_tables/templates/model.rb",
      "legacy_data.gemspec",
      "lib/active_record/connection_adapters/oracle_enhanced_adapter.rb",
      "lib/legacy_data.rb",

data/lib/legacy_data/schema.rb

@@ -2,8 +2,10 @@ module LegacyData
   class Schema
     attr_reader :table_name
     
-    def initialize(table_name)
-      @table_name = table_name
+    def initialize(table_name, naming_convention=nil)
+      @table_name        = table_name
+      @naming_convention = naming_convention
+      @naming_convention = /^#{naming_convention.gsub('*', '(.*)')}$/i if @naming_convention.is_a? String
     end
     
     def analyze_table
@@ -16,7 +18,7 @@ module LegacyData
     end
     
     def self.tables name_pattern=/.*/
-      connection.tables.select {|table_name| table_name =~ name_pattern }
+      connection.tables.select {|table_name| table_name =~ name_pattern }.sort
     end
     
     
@@ -26,7 +28,9 @@ module LegacyData
     end
 
     def class_name_for table
-      ActiveRecord::Base.class_name(table.downcase.pluralize)
+      table =~ @naming_convention
+      stripped_table_name = $1 || table
+      ActiveRecord::Base.class_name(stripped_table_name.downcase.pluralize)
     end
 
     def primary_key
@@ -71,8 +75,10 @@ module LegacyData
     end
     
     def non_nullable_constraints
-      connection.columns(table_name, "#{table_name} Columns").reject(&:null).map(&:name)
+      non_nullable_constraints = connection.columns(table_name, "#{table_name} Columns").reject(&:null).map(&:name)
+      non_nullable_constraints.reject {|col| col == primary_key}
     end
+
     def unique_constraints
       connection.indexes(table_name).select(&:unique).map(&:columns)
     end

data/spec/legacy_data_schema_spec.rb

@@ -46,6 +46,20 @@ describe LegacyData::Schema do
     it 'should handle tables with an irregular pluralization name' do
       @schema.class_name_for('TBPERSON').should == 'Tbperson'
     end
+    
+    describe 'ignore the table prefix naming convention when figuring out the model name' do
+      before :each do
+        @schema = LegacyData::Schema.new('some_table', /^TB(.*)$/)
+      end
+      
+      it 'should strip off the prefix' do
+        @schema.class_name_for('TBPERSON').should == 'Person'
+      end
+
+      it 'should work on tables that do not have the prefix' do
+        @schema.class_name_for('PERSON').should == 'Person'
+      end
+    end
   
     it 'should have the correct primary_key' do
       @connection.should_receive(:pk_and_sequence_for).with('some_table').and_return(['PK', 'SEQ'])
@@ -76,11 +90,13 @@ describe LegacyData::Schema do
   
     it 'should have the correct constraints'
 
-    it 'should get non-nullable constraints' do
+    it 'should get non-nullable constraints as all columns that do not allow null except the primary key' do
+      @schema.stub(:primary_key).and_return('col1')   
       @connection.should_receive(:columns).with('some_table', 'some_table Columns').and_return([col1=stub(:null=>false, :name=>'col1'), 
-                                                                                                col2=stub(:null=>true,  :name=>'col2'),
-                                                                                                col3=stub(:null=>false, :name=>'col3')])
-      @schema.non_nullable_constraints.should == ['col1', 'col3']
+                                                                                                col2=stub(:null=>false, :name=>'col2'),
+                                                                                                col3=stub(:null=>true,  :name=>'col3'),
+                                                                                                col3=stub(:null=>false, :name=>'col4')])
+      @schema.non_nullable_constraints.should == ['col2', 'col4']
     end
   
     it 'should get uniqueness constraints' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: alexrothenberg-legacy_data
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors: 
 - Alex Rothenberg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-16 00:00:00 -07:00
+date: 2009-09-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,9 +48,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- generators/legacy_models/USAGE
-- generators/legacy_models/legacy_models_generator.rb
-- generators/legacy_models/templates/model.rb
+- generators/models_from_tables/USAGE
+- generators/models_from_tables/models_from_tables_generator.rb
+- generators/models_from_tables/templates/model.rb
 - legacy_data.gemspec
 - lib/active_record/connection_adapters/oracle_enhanced_adapter.rb
 - lib/legacy_data.rb

data/generators/legacy_models/legacy_models_generator.rb

@@ -1,22 +0,0 @@
-require File.dirname(__FILE__) + '/../../lib/legacy_data/schema'
-require File.dirname(__FILE__) + '/../../lib/active_record/connection_adapters/oracle_enhanced_adapter'
-
-class LegacyModelsGenerator < Rails::Generator::Base  
-  def manifest
-    record do |m|
-      m.directory File.join('app/models')
-
-      LegacyData::Schema.tables(/^tb/).each do |table_name|
-        puts "analyzing #{table_name}"
-        analysis = LegacyData::Schema.new(table_name).analyze_table
-
-        file_name = analysis[:class_name].underscore
-        m.template           'model.rb',      
-                             File.join('app/models', "#{file_name}.rb"), 
-                             :assigns => analysis
-      end
-    end
-  end
-
-  
-end