ez_model 1.0.2 → 1.0.3

data/README.md

@@ -3,15 +3,47 @@ Generate models and schema.rb from existing database just in one command line. I
 
 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
+
+
 ## How to use it
 ###Prerequisite
-####1. Setup database server, mysql is suggested;
-
-####2. Setup database schema, if you already have a database set up, skip this step;
+####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;    
 
-####3. Prepare ~/config/database.yml, here is a sample:   
+####2. Prepare ~/config/database.yml, here is a sample:   
 
 	development:
 		adapter: mysql2
@@ -71,7 +103,7 @@ see version
 
 See here for more details: [http://rubygems.org/gems/ez_model](http://rubygems.org/gems/ez_model "EZModel RubyGem Page")   
 
-## Author
+## Authors
 Tianyu Huang   
 The reverse engine for generating models was created by Bosko Ivanisevic, check out https://github.com/bosko/rmre for details
 

data/ez_model.gemspec

@@ -11,9 +11,8 @@ Gem::Specification.new do |s|
   s.version = ::EZModel::VERSION
   s.platform = Gem::Platform::RUBY
   s.date = "2012-04-08"
-  s.summary = "%q{Generate model files just in one command line}"
-  s.description = "%q{	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 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.}"
+  s.summary = "Rails gem for generating model files in one command line"
+  s.description = "Generate models and schema.rb from existing(legacy) 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 as underlying reverse engine to generate models..."
 
   # Author info
   s.authors = ["Tianyu Huang"]

data/lib/ez_model/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ez_model
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &72362480 !ruby/object:Gem::Requirement
+  requirement: &82647050 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *72362480
+  version_requirements: *82647050
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &72362180 !ruby/object:Gem::Requirement
+  requirement: &82646710 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,20 +32,15 @@ dependencies:
         version: 2.6.6
   type: :runtime
   prerelease: false
-  version_requirements: *72362180
-description: ! "%q{\tGenerate models and schema.rb from existing database just in
+  version_requirements: *82646710
+description: Generate models and schema.rb from existing(legacy) 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.\n\tIt uses 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.}"
+  to read all foreign keys data from a database. It uses Rmre as underlying reverse
+  engine to generate models...
 email:
 - tianhsky@yahoo.com
 executables:
@@ -94,6 +89,6 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: ! '%q{Generate model files just in one command line}'
+summary: Rails gem for generating model files in one command line
 test_files: []
 has_rdoc: