ez 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc7371a54621cea994857087bcf5d613e717247c
-  data.tar.gz: 97ba31197de369c56fa907d157508ac5a82b3da4
+  metadata.gz: 33044a33df8727278898d03a7c1caaa6f139e2a2
+  data.tar.gz: 64bfe376ccdc13ec0748e7ba7adefb54d938059d
 SHA512:
-  metadata.gz: 6b579317552b30d8b6619ca7ad3cd03768e1a5cb036ba1779fd7c8d9fab8fa307039df0bc92faf43098a29f1a47032eb6fbb05e2bd6f0ce072b148dc187f9ed6
-  data.tar.gz: 5273b89d19801fcfb4844672bf401be35f8da0e4a0ba9bf9c74ba64629ce7227d8dd88959921870eab9d508a98f68af9fd7403db77b18cfd10c8a8b33c517be7
+  metadata.gz: 53c36051739a15018e61042a661d05006a21a8f7a583e93e514d10772fd770d990f7edbbd8dce3717776edc7008dd413254289445098326f9c1c39d40cc5d5be
+  data.tar.gz: 97d586b236546fcae7c7ef4ab93b053135ed55f3a175d169be5c1ad1078fa15c49571b434e688bf690f5f24e8e688afd7ef6977bc65cfaefe38bad0306bedd71

data/README.md

@@ -1,6 +1,6 @@
 # EZ
 
-**Version 0.9.9**
+**Version 1.1.0**
 
 *For educational purposes only.*
 
@@ -22,13 +22,13 @@ Then:
 
 ## Summary of Best Practices
 
-1. Use `db/models.yml` to define your schema. Foreign-key indexes will be generated automatically.  (This step by itself should cover 100% of what most beginners will ever need to do.)
+1. Run `rake db:migrate` to initially generate a file named `db/models.yml`.
 
-2. Use Rails migrations for any additional indexes, database constraints, etc.
-
-3. Overall, just use `rake db:migrate` as usual.
+2. Use `db/models.yml` to define your schema. Database schema changes are applied directly and triggered automatically in development mode.  (`rake db:migrate` will also trigger the changes).  Foreign-key indexes will be generated automatically.
 
+3. You can continue to use traditional Rails migrations for any additional indexes, database constraints, etc.
 
+4. Run `rake db:migrate:preview` to do a "dry run" to see what would change based your `db/models.yml` file.
 
 ## Features
 
@@ -36,8 +36,8 @@ Then:
 ### 1. Domain Modeling Enhancements
 
 * Enables **instant domain modeling without migrations** by using a file named `db/models.yml`.
-* No new rake tasks to learn.  This gem enhances `db:migrate` to incorporate the `db/models.yml` file automatically.
-* You can run `rake db:migrate` to initially generate a file named `db/models.yml`.  It will have some self-documenting comments inside of it.
+* This gem enhances `db:migrate` to incorporate the `db/models.yml` file automatically.
+* Run `rake db:migrate` to initially generate a file named `db/models.yml`.  It will have some self-documenting comments inside of it.
 * In development mode, there's no need to ever run `rake db:migrate`! Every browser request will trigger automatic table updates.
 * In the rails console, 'reload!' will also trigger table updates.
 * If you prefer, just run `rake db:migrate` whenever you modify `db/models.yml`.

data/lib/ez/domain_modeler.rb

@@ -54,14 +54,14 @@ module EZ
       end
     end
 
-    def self.update_tables(silent = false)
-      self.new.update_tables(silent)
+    def self.update_tables(silent = false, dry_run = false)
+      self.new.update_tables(silent, dry_run)
     end
 
-    def update_tables(silent = false)
+    def update_tables(silent = false, dry_run = false)
       return false unless @ok
 
-      SchemaModifier.migrate(@spec, silent)
+      SchemaModifier.migrate(@spec, silent, dry_run)
       return true
 
       rescue => e
@@ -138,8 +138,8 @@ module EZ
 
       default_column_value = nil
       DEFAULT_VALUE_REGEXES.each { |r| default_column_value = $1 if column_type.sub!(r, '') }
-      default_column_value = default_column_value.to_i if column_type == 'integer'
-      default_column_value = default_column_value.to_f if column_type == 'float'
+      default_column_value = default_column_value.to_i if default_column_value.present? && column_type == 'integer'
+      default_column_value = default_column_value.to_f if default_column_value.present? && column_type == 'float'
 
       if column_type == 'boolean'
         default_column_value = default_column_value.present? && default_column_value.downcase.strip == 'true'

data/lib/ez/schema_modifier.rb

@@ -4,28 +4,38 @@ module EZ
   # and applies any necessary db schema changes.
   class SchemaModifier
 
-    attr_reader :db, :spec
+    attr_reader :db, :spec, :dry_run
 
-    def initialize(model_spec, silent = false)
+    def initialize(model_spec, silent = false, dry_run = false)
       @silent = silent
+      @dry_run = dry_run
       @spec = model_spec
       connect_to_database
     end
 
-    def self.migrate(model_spec, silent = false)
-      self.new(model_spec, silent).migrate
+    def self.migrate(model_spec, silent = false, dry_run = false)
+      self.new(model_spec, silent, dry_run).migrate
     end
 
     def migrate
       @changed = false
 
+      if @dry_run
+        puts "Previewing... no changes will actually take place..."
+        puts
+      end
+
       add_missing_schema
       remove_dead_schema
 
       if @changed
-        update_schema_version
+        update_schema_version unless @dry_run
+        puts "\n(No changes were actually made)" if @dry_run
       else
-        puts "All tables are up-to-date."
+          puts "All tables are up-to-date."
+        if @dry_run
+          puts "\nNo changes would be made."
+        end
       end
 
       return @changed
@@ -77,22 +87,23 @@ module EZ
           if !assume_missing
             display_change "Adding new column '#{col_name}' as #{col_type} for model #{model_name}"
           end
-          db.add_column(table_name, col_name.to_sym, col_type.to_sym, default: col_default)
+          db.add_column(table_name, col_name.to_sym, col_type.to_sym, default: col_default)  unless @dry_run
           if data[:index]
             display_change "  (adding database index for '#{col_name}')"
-            db.add_index table_name, col_name.to_sym
+            db.add_index table_name, col_name.to_sym unless @dry_run
           end
         else
           if db_col.type != col_type
             display_change "Changing column type for #{col_name} to #{col_type} for model #{model_name}"
           end
 
+          # puts "#{table_name} #{col_name}: #{db_col.default} and #{col_default}"
           if db_col.default != col_default
-            display_change "Applying new default value #{col_default} for #{col_name} for model #{model_name}"
+            display_change "Applying new default value #{col_default || 'NULL'} for #{col_name} for model #{model_name}"
           end
 
           if (db_col.type != col_type) || (db_col.default != col_default)
-            db.change_column(table_name, col_name.to_sym, col_type.to_sym, default: col_default)
+            db.change_column(table_name, col_name.to_sym, col_type.to_sym, default: col_default)  unless @dry_run
           end
         end
       end
@@ -101,7 +112,7 @@ module EZ
     def add_model(model_name, columns)
       table_name = model_name.tableize
       display_change "Defining new table for model '#{model_name}'."
-      db.create_table table_name
+      db.create_table table_name  unless @dry_run
       add_missing_columns model_name, columns, true
       filename = "app/models/#{model_name.underscore}.rb"
       unless Rails.env.production? || File.exists?(filename)
@@ -125,13 +136,15 @@ module EZ
         if @spec.has_key?(model_name)
           db_columns = db.columns(table_name).map { |column| column.name.to_sym } - [:id, :created_at, :updated_at]
           spec_columns = @spec[model_name].keys.map(&:to_sym)
+          # puts spec_columns.inspect
           dead_columns = db_columns - spec_columns
 
+
           if dead_columns.any?
             dead_columns.each do |dead_column_name|
               display_change "Removing unused column '#{dead_column_name}' from model '#{model_name}'"
             end
-            db.remove_columns(table_name, *dead_columns)
+            db.remove_columns(table_name, *dead_columns)  unless @dry_run
           end
         end
       end
@@ -149,7 +162,7 @@ module EZ
       dead_tables.each do |table_name|
         model_name = table_name.classify
         display_change "Dropping table #{table_name}"
-        db.drop_table(table_name)
+        db.drop_table(table_name) unless @dry_run
         begin
           filename = "app/models/#{model_name.underscore}.rb"
           code = IO.read(filename)
@@ -157,7 +170,7 @@ module EZ
 
           if is_empty
             display_change "Deleting file #{filename}"
-            File.unlink(filename)
+            File.unlink(filename) unless @dry_run
           end
         rescue => e
           display_change "Could not delete old model #{model_name.underscore}.rb."
@@ -165,10 +178,6 @@ module EZ
       end
     end
 
-    def silence_migration_output
-      ActiveRecord::Migration.verbose = false
-    end
-
     def connect_to_database
       ActiveRecord::Base.establish_connection
       @db = ActiveRecord::Base.connection

data/lib/ez/version.rb

@@ -1,3 +1,3 @@
 module EZ
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/tasks/ez_tasks.rake

@@ -1,3 +1,19 @@
+namespace :db do
+
+  namespace :migrate do
+
+    desc "Preview table updates"
+    task :preview => :environment do
+      if File.exists?('db/models.yml')
+        EZ::DomainModeler.update_tables(false, true)
+      else
+        puts "Nothing to preview."
+      end
+    end
+
+  end
+end
+
 namespace :ez do
 
   desc "Generate models.yml if it doesn't exist yet."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ez
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeff Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb