ez_model 1.0.5 → 1.0.6

data/README.md

@@ -1,54 +1,12 @@
 # EZModel
 
-Generate models and schema.rb from existing database just in one command line. If you prefer design ER diagram and export scripts to generate database schema, or if you have to work with a legacy database, this can save you insane amount of time. All you need to do is to have a database.yml configuraiton file in ~/config/. Besides creating all models it sets proper table name and primary key if tables and columns naming doesn’t follow Rails convention. It also tries to read all foreign keys data from a database.     
-
-It uses [Rmre](https://github.com/bosko/rmre "Rmre") as underlying reverse engine to generate models. I made some modifications to Rmre to support mysql2 adapter, and had those auto-generated model files placed in a subfolder inside ~/app/models/ez_models/ instead of the default ~/app/models/, so that regenerating models will not overwrite the existing ones. Over the times, db schema can ge changed, all it needs is to run the command again to regenerate models, developers can feel free to add methods to the models classes in ~/app/models/ without worrying about being overwritten.
-
-
-## How it works
-
-First let's take a look at what it does.
-
-In ~/app/models/ez_models/, it will generate model files inherit ActiveRecord::Base    
-
-~/app/models/ez_models/billing_info.rb
-
-	# This file is auto-generated from the current state of the database registered
-	# in ~config/database.yml. Instead of editing this file, please go to ~/app/models/
-	# and find the file with same name and class that inherits this class
-	module EZModel
-	    module ActiveRecord
-		class BillingInfo < ::ActiveRecord::Base
-		    belongs_to :users, :class_name => 'User', :foreign_key => :user_id
-		    belongs_to :invoices, :class_name => 'Invoice', :foreign_key => :invoice_id
-		    has_many :chargebacks, :class_name => 'Chargeback'
-		end
-	    end
-	end
-
-Isn't model files supposed to be in ~/app/models/? Take a look at the following first   
-In ~/app/models/, it will generate same model files and inherit the above classes   
-
-~/app/models/billing_info.rb
-
-	require File.expand_path('../ez_models/billing_info', __FILE__)
-	# Please add your own methods to this class.
-	# It's strongly recommended to check this file into your version control system.
-	class BillingInfo < EZModel::ActiveRecord::BillingInfo
-
-	end
-
+Automatically generate model files from database.
 
 ## How to use it
 
-###Prerequisite
+###1. Setup database
 
-####1. Setup database schema, if you already have a database set up, skip this step;
-
-there are many tools can be use for database design, you can then export scripts to generate db schema;   
-checkout mysql-workbench and its forward-engineering feature for more details about designing ER diagram and generate schema;    
-
-####2. Prepare ~/config/database.yml, here is a sample:   
+###2. Prepare ~/config/database.yml, here is a sample:   
 
 	development:
 		adapter: mysql2
@@ -89,13 +47,6 @@ or
 
 	ezmodel -g -e development
 
-generate model files and overwrite existing ones in ~/app/models/   
-use this command only if the model files in ~/app/models/ don't inherit EZModel::ActiveRecord    
-backup your models files is strongly suggested if you are not sure what it is doing   
-use it at your own risk   
-
-	ezmodel -g -o
-
 see help   
 
 	ezmodel -h

data/bin/ezmodel

@@ -5,6 +5,7 @@ $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 require "yaml"
 require "optparse"
 require "erubis"
+require "fileutils"
 require "ez_model"
 require "rmre"
 
@@ -20,11 +21,13 @@ optparse = OptionParser.new do |opts|
     options[:generate] = true
   end
 
+=begin
   options[:overwrite] = false
   opts.on("-o", "--overwrite",
           "Overwrite model files (before you do so, back up your models in '~app/models/')") do
     options[:overwrite] = true
   end
+=end
 
   options[:dbconfig] = "config/database.yml"
   opts.on("-d", "--dbconfig PATH",
@@ -91,8 +94,9 @@ options[:db].merge!(:host => db_config[d_environment]["host"])
 options[:db].merge!(:port => db_config[d_environment]["port"])
 options[:db][:timeout] = 5000
 options[:dump_schema] = rails_root_path + "db/schema.rb"
-options[:out_path] = rails_root_path + "app/models/ez_models/"
+options[:out_path] = rails_root_path + "app/models/"
 options[:model_path] = rails_root_path + "app/models/"
+options[:old_model_path] = rails_root_path + "app/models/ez_models/"
 
 ########################################################################################################
 # generate ez_models using external rmre
@@ -142,9 +146,9 @@ end
 
 if options[:dump_schema]
   _backup_schema_file = options[:dump_schema]+".bak"
-  if(File.exists?(options[:dump_schema]))
-     puts "Backing up schema file to #{_backup_schema_file}"
-     File.rename(options[:dump_schema], _backup_schema_file)
+  if (File.exists?(options[:dump_schema]))
+    puts "Backing up schema file to #{_backup_schema_file}"
+    File.rename(options[:dump_schema], _backup_schema_file)
   end
   puts "Dumping schema to #{options[:dump_schema]}..."
   File.open(options[:dump_schema], 'w') do |file|
@@ -152,15 +156,17 @@ if options[:dump_schema]
   end
 end
 
-puts "Generating base models in #{options[:out_path]}..."
+puts "Generating models in #{options[:out_path]}..."
 generator.create_models(generator.connection.tables)
 
 ########################################################################################################
 # generate models
 ########################################################################################################
 
-puts "Generating models in #{options[:model_path]}..."
-EZModel::Generator.CreateModels(options[:model_path], generator.connection.tables, options[:overwrite])
+#puts "Generating models in #{options[:model_path]}..."
+#EZModel::Generator.CreateModels(options[:model_path], generator.connection.tables, options[:overwrite])
+
+# remove old base model
+FileUtils.rm_rf(options[:old_model_path]) if Dir.exists?(options[:old_model_path])
 
-puts "Congratulations, your schema.rb and all of your models have been generated"
-puts "Feel free to customize your model in ~/app/models/"
+puts "Congratulations, your schema.rb and models have been generated"

data/lib/ez_model/version.rb

@@ -1,3 +1,3 @@
 module EZModel
-  VERSION = "1.0.5" unless defined?(::EZModel::VERSION)
+  VERSION = "1.0.6" unless defined?(::EZModel::VERSION)
 end

data/lib/rmre/content.eruby

@@ -0,0 +1,14 @@
+    ##########BEGIN-EZMODEL-AUTO-GENERATED-SECTION##########
+    <% unless table_name == table_name.tableize %>
+    <%= "set_table_name '#{table_name}'" + "\n" -%>
+    <% end %>
+    <% unless "id" == primary_key || primary_key.nil? %>
+    <%= "set_primary_key :#{primary_key}" + "\n" -%>
+    <% end %>
+    <% if has_type_column %>
+    <%= "set_inheritance_column :ruby_type" + "\n" -%>
+    <% end %>
+    <% constraints.each do |constraint| %>
+    <%= constraint + "\n" -%>
+    <% end %>
+    ##########END-EZMODEL-AUTO-GENERATED-SECTION##########

data/lib/rmre/generator.rb

@@ -10,6 +10,9 @@ module Rmre
 
     SETTINGS_ROOT = File.expand_path('../../../../db', __FILE__)
 
+    BEGIN_TAG = "##########BEGIN-EZMODEL-AUTO-GENERATED-SECTION##########"
+    END_TAG = "##########END-EZMODEL-AUTO-GENERATED-SECTION##########"
+
     def initialize(options, out_path, include)
       @connection_options = options
       @connection = nil
@@ -39,16 +42,72 @@ module Rmre
     end
 
     def create_model(table_name)
-      File.open(File.join(output_path, "#{table_name.tableize.singularize}.rb"), "w") do |file|
-        constraints = []
+      constraints = []
+
+      foreign_keys.each do |fk|
+        src = constraint_src(table_name, fk)
+        constraints << src unless src.nil?
+      end
+
+      _file_path = File.join(output_path, "#{table_name.tableize.singularize}.rb")
+      if (!File.exists?(_file_path))
+        content = generate_model_source(table_name, constraints)
+      else
+
+        # read file content
+        file = File.open(_file_path, "r+")
+        content = ""
+        line_begin = -1
+        line_end = -1
+        i = -1
+        while (!file.eof?)
+          i = i+1
+          _line = file.readline
+
+          # remove old code
+          if (_line.include?(table_name.tableize.classify) &&
+              _line.include?("EZModel::ActiveRecord"))
+            _line = "class #{table_name.tableize.classify} < ActiveRecord::Base \n"
+          end
+
+          if (_line.include?(BEGIN_TAG))
+            line_begin = i
+          end
+          if (_line.include?(END_TAG))
+            line_end = i
+          end
+
+          content += _line
+        end
+        file.close()
+
+        # remove auto generated code
+        if (line_begin<line_end)
+          content = content.gsub(/#{BEGIN_TAG}(.*)#{END_TAG}/im, "")
+        end
 
-        foreign_keys.each do |fk|
-          src = constraint_src(table_name, fk)
-          constraints << src unless src.nil?
+        _text = content
+        content = ""
+        _text.split("\n").each do |_line|
+
+          # remove include header from old version
+          unless (_line.include?("require File.expand_path('../ez_models"))
+            content += _line + "\n"
+          end
+
+          # add auto-gen code below class
+          if (_line.include?(table_name.tableize.classify) &&
+              _line.include?("ActiveRecord::Base"))
+            _body = generate_model_content(table_name, constraints)
+            content += _body + "\n"
+          end
         end
+      end
 
-        file.write generate_model_source(table_name, constraints)
+      File.open(_file_path, "w") do |file|
+        file.write(content)
       end
+
     end
 
     def process?(table_name)
@@ -69,16 +128,16 @@ module Rmre
     def fetch_foreign_keys
       fk = []
       case @connection_options[:adapter].downcase
-      when 'mysql'
-        fk = mysql_foreign_keys
-      when 'mysql2'
-        fk = mysql_foreign_keys
-      when 'postgresql'
-        fk = psql_foreign_keys
-      when 'sqlserver'
-        fk = mssql_foreign_keys
-      when 'oracle_enhanced'
-        fk = oracle_foreign_keys
+        when 'mysql'
+          fk = mysql_foreign_keys
+        when 'mysql2'
+          fk = mysql_foreign_keys
+        when 'postgresql'
+          fk = psql_foreign_keys
+        when 'sqlserver'
+          fk = mssql_foreign_keys
+        when 'oracle_enhanced'
+          fk = oracle_foreign_keys
       end
       fk
     end
@@ -96,10 +155,19 @@ module Rmre
     def generate_model_source(table_name, constraints)
       eruby = Erubis::Eruby.new(File.read(File.join(File.expand_path("../", __FILE__), 'model.eruby')))
       eruby.result(
-        :table_name => table_name,
-        :primary_key => connection.primary_key(table_name),
-        :constraints => constraints,
-        :has_type_column => connection.columns(table_name).find { |col| col.name == 'type' })
+          :table_name => table_name,
+          :primary_key => connection.primary_key(table_name),
+          :constraints => constraints,
+          :has_type_column => connection.columns(table_name).find { |col| col.name == 'type' })
+    end
+
+    def generate_model_content(table_name, constraints)
+      eruby = Erubis::Eruby.new(File.read(File.join(File.expand_path("../", __FILE__), 'content.eruby')))
+      eruby.result(
+          :table_name => table_name,
+          :primary_key => connection.primary_key(table_name),
+          :constraints => constraints,
+          :has_type_column => connection.columns(table_name).find { |col| col.name == 'type' })
     end
 
     def mysql_foreign_keys
@@ -113,7 +181,7 @@ from information_schema.KEY_COLUMN_USAGE
 where referenced_table_schema like '%'
  and constraint_schema = '#{@connection_options[:database]}'
  and referenced_table_name is not null
-SQL
+      SQL
       connection.select_all(sql)
     end
 
@@ -139,7 +207,7 @@ SELECT tc.table_name as from_table,
       AND rc.unique_constraint_name = ccu.constraint_name
     WHERE tc.table_name like '%'
     AND tc.constraint_type = 'FOREIGN KEY';
-SQL
+      SQL
       connection.select_all(sql)
     end
 
@@ -164,7 +232,7 @@ FROM   INFORMATION_SCHEMA.TABLE_CONSTRAINTS C
             AND C2.CONSTRAINT_NAME = KCU2.CONSTRAINT_NAME
             AND KCU.ORDINAL_POSITION = KCU2.ORDINAL_POSITION
     WHERE  C.CONSTRAINT_TYPE = 'FOREIGN KEY'
-SQL
+      SQL
       connection.select_all(sql)
     end
 
@@ -172,10 +240,10 @@ SQL
       fk = []
       connection.tables.each do |table|
         connection.foreign_keys(table).each do |oracle_fk|
-          table_fk = { 'from_table' => oracle_fk.from_table,
-            'from_column' => oracle_fk.options[:columns][0],
-            'to_table' => oracle_fk.to_table,
-            'to_column' => oracle_fk.options[:references][0] }
+          table_fk = {'from_table' => oracle_fk.from_table,
+                      'from_column' => oracle_fk.options[:columns][0],
+                      'to_table' => oracle_fk.to_table,
+                      'to_column' => oracle_fk.options[:references][0]}
           fk << table_fk
         end
       end

data/lib/rmre/model.eruby

@@ -1,24 +1,19 @@
-# This file is auto-generated from the current state of the database registered
-# in ~config/database.yml. Instead of editing this file, please go to ~/app/models/
-# and find the file with same name and class that inherits this class
-module EZModel
-    module ActiveRecord
-        class <%= table_name.tableize.classify %> < ::ActiveRecord::Base
-          <% unless table_name == table_name.tableize %>
-            <%= "set_table_name '#{table_name}'" + "\n" -%>
-          <% end %>
 
-          <% unless "id" == primary_key || primary_key.nil? %>
-            <%= "set_primary_key :#{primary_key}" + "\n" -%>
-          <% end %>
+class <%= table_name.tableize.classify %> < ActiveRecord::Base
+    ##########BEGIN-EZMODEL-AUTO-GENERATED-SECTION##########
+    <% unless table_name == table_name.tableize %>
+    <%= "set_table_name '#{table_name}'" + "\n" -%>
+    <% end %>
+    <% unless "id" == primary_key || primary_key.nil? %>
+    <%= "set_primary_key :#{primary_key}" + "\n" -%>
+    <% end %>
+    <% if has_type_column %>
+    <%= "set_inheritance_column :ruby_type" + "\n" -%>
+    <% end %>
+    <% constraints.each do |constraint| %>
+    <%= constraint + "\n" -%>
+    <% end %>
+    ##########END-EZMODEL-AUTO-GENERATED-SECTION##########
 
-          <% if has_type_column %>
-            <%= "set_inheritance_column :ruby_type" + "\n" -%>
-          <% end %>
 
-          <% constraints.each do |constraint| %>
-            <%= constraint + "\n" -%>
-          <% end %>
-        end
-    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ez_model
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -72,6 +72,7 @@ files:
 - lib/rmre.rb
 - lib/rmre/LICENSE.txt
 - lib/rmre/active_record/schema_dumper.rb
+- lib/rmre/content.eruby
 - lib/rmre/generator.rb
 - lib/rmre/load_file.eruby
 - lib/rmre/model.eruby