ez 0.9.7 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46f68c1557debf7db379e3240a76ffad307d12f4
-  data.tar.gz: 3c88b18298f9e8c7d24bc0d6ce2e800b5c32f26c
+  metadata.gz: c1435cdce1c508b5097a63994d5410bacc4d70b0
+  data.tar.gz: c45bc846995af9ff76cd7b4ae516f1bb9d9921b0
 SHA512:
-  metadata.gz: 43c5759b7b0236b82bc8c063dcc84176cad6249d11156b18b42b466a1e8e3f18a666a9273112880aacb5917e79cc784ba88b9dfe08e5ae32fa8a47026cfc77da
-  data.tar.gz: f60d613d29cb36d4cf12ac59c7d53003f9634aa8ce26fc20edbaf8e97e2d081381228ebfd83144daab73491001f854757fddae672a1735f8f85f45593b0c434c
+  metadata.gz: 4531ea674bbd3fb547aeda0ab8ed898592292a6997497aecc46637b5917693a45f56b3137c9c3057d02bc96909eb0fc3fa53034d95f2ba05d8591c75de3d5162
+  data.tar.gz: 9b13d85e4e0ed661244b87e7cb3a485131904da9adb7e1c967a72363cfdf4c487a681b5fc1c4048031273d372de1539ba440f06ef81d97b5843561acc80adcb6

data/README.md

@@ -2,9 +2,11 @@
 
 **Version 0.9.8**
 
+*For educational purposes only.*
+
 Makes domain modeling in Rails more beginner-friendly by avoiding migrations.
 
-For educational purposes only.
+Also enhances the rails console.
 
 
 ## Usage
@@ -13,15 +15,35 @@ For educational purposes only.
 gem 'ez'
 ```
 
+Then:
+
+`rake db:migrate` to generate a skeleton `db/models.yml` that you should edit.
+
+
+## Summary of Best Practices
+
+1. Use `db/models.yml` to define your schema. Foreign-key indexes will be generated automatically.  (This should cover 100% of what most beginners will ever need to do.)
+
+2. Use Rails migrations for any additional indexes, database constraints, etc.
+
+3. Just use `rake db:migrate` as usual.  Nothing new to learn.
+
+
+
 ## Features
 
 
 ### 1. Domain Modeling Enhancements
 
-* Enables **instant domain modeling without migrations** by editing a simple file named `db/models.yml` and then running `rake db:migrate`.  If things ever get messed up, use `rake ez:reset_tables` to drop the entire db first.
-* You can run `rake ez:tables` once to 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 action will trigger automatic table updates.
-* You can run `rake db:migrate` whenever you modify `db/models.yml` instead of waiting for a browser action.
+* 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.
+* In development mode, there's no need to ever run `rake db:migrate`! Every brower request will trigger automatic table updates.
+* In the rails console, 'reload!' will also trigger table updates.
+* If you prefer, you can run `rake db:migrate` whenever you modify `db/models.yml`.
+* `rake db:migrate` will run any pending migrations *after* following instructions in the `db/models.yml` file.
+
+
 
 **Syntax Guide for `db/models.yml`**
 

data/lib/ez.rb

@@ -11,28 +11,47 @@ require 'ez/view_helpers.rb'
 require 'hirb' if Rails.env.development?
 
 module EZ
+  module Console
+    def reload!(print=true)
+      puts "Reloading code..." if print
+      ActionDispatch::Reloader.cleanup!
+      ActionDispatch::Reloader.prepare!
+
+      puts "Updating tables (if necessary) ..." if print
+      old_level = ActiveRecord::Base.logger.level
+      ActiveRecord::Base.logger.level = Logger::WARN
+      EZ::DomainModeler.generate_models_yml
+      EZ::DomainModeler.update_tables
+      puts "Models: #{EZ::DomainModeler.models.to_sentence}"
+      ActiveRecord::Base.logger.level = old_level
+      true
+    end
+  end
+end
+
+module EZ
+
   class Railtie < Rails::Railtie
     rake_tasks do
       load "tasks/ez_tasks.rake"
       Rake::Task["db:migrate"].enhance ["ez:tables"]
     end
 
-    config.to_prepare do
-      Rails.cache.fetch('ez-generate-yml-flag') do
-        EZ::DomainModeler.generate_models_yml
-      end
-      EZ::DomainModeler.update_tables
-    end
-
     console do |app|
-      Hirb.enable(pager: false) if Rails.env.development? && defined?(Hirb)
+      Rails::ConsoleMethods.send :prepend, EZ::Console
+      Hirb.enable(pager: false) if ::Rails.env.development? && defined?(Hirb)
+
+      old_level = ActiveRecord::Base.logger.level
+      ActiveRecord::Base.logger.level = Logger::WARN
+      EZ::DomainModeler.generate_models_yml
+      EZ::DomainModeler.update_tables(true)
+      ActiveRecord::Base.logger.level = old_level
 
       I18n.enforce_available_locales = false
       puts "Welcome to the Rails Console."
       puts "-" * 60
       puts
-      tables = ActiveRecord::Base.connection.tables - ['schema_migrations']
-      models = tables.map { |t| t.classify }
+      models = EZ::DomainModeler.models
       if models.any?
         puts "Models: #{models.to_sentence}"
         puts

data/lib/ez/domain_modeler.rb

@@ -9,12 +9,19 @@ module EZ
     # Valid formats for default values
     DEFAULT_VALUE_REGEXES = [/\s*\((.+)?\)/, /\s+(.+)?\s*/, /,\s*default:\s*(.+)?\s*/]
 
+    def self.models
+      tables = ActiveRecord::Base.connection.tables - ['schema_migrations']
+      tables.map { |t| t.classify }
+    end
+
     # Get the domain model as a hash
     attr_reader :spec
 
     def initialize
+      @ok = false
       begin
         load_model_specs
+        @ok = true
       rescue => e
         puts e
       end
@@ -52,15 +59,23 @@ module EZ
     end
 
     def update_tables(silent = false)
+      return false unless @ok
+
       SchemaModifier.migrate(@spec, silent)
+      return true
 
       rescue => e
         puts e.message unless silent
         puts e.backtrace.first unless silent
+        @ok = false
+        return false
     end
 
     def load_model_specs_from_string(s)
 
+      # Ignore comments
+      s.gsub!(/#.*$/,'')
+
       # Append missing colons
       s.gsub!(/^((\s|\-)*\w[^\:]+?)$/, '\1:')
 
@@ -74,8 +89,8 @@ module EZ
       parse_model_spec
 
       # puts "@spec:"
-      # puts @spec.inspect
-      # puts "-" * 10
+      puts @spec.inspect
+      puts "-" * 10
     end
 
     def load_model_specs(filename = "db/models.yml")
@@ -86,10 +101,19 @@ module EZ
       @spec ||= {}
       @spec.each do |model, columns|
 
+        msg = nil
+
         if !columns.is_a?(Hash)
-          raise "Could not understand models.yml while parsing model: #{model}"
+          msg = "Could not understand models.yml while parsing model '#{model}'."
+        end
+
+        if model !~ /^[A-Z]/ || model =~ /\s/
+          msg = "Could not understand models.yml while parsing model '#{model}'."
+          msg <<  " Models must begin with an uppercase letter and cannot contain spaces."
         end
 
+        raise msg if msg
+
         columns.each do |column_name, column_type|
           interpret_column_spec column_name, column_type, model
         end
@@ -112,7 +136,7 @@ module EZ
         end
       end
 
-      default_column_value = (column_type == 'boolean' ? true : nil)
+      default_column_value = (column_type == 'boolean' ? false : 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'

data/lib/ez/schema_modifier.rb

@@ -138,8 +138,8 @@ module EZ
     end
 
     def update_schema_version
-      db.initialize_schema_migrations_table
-      db.assume_migrated_upto_version(Time.now.utc.strftime("%Y%m%d%H%M%S"))
+      # db.initialize_schema_migrations_table
+      # db.assume_migrated_upto_version(Time.now.utc.strftime("%Y%m%d%H%M%S"))
     end
 
     def remove_dead_tables

data/lib/ez/version.rb

@@ -1,3 +1,3 @@
 module EZ
-  VERSION = "0.9.7"
+  VERSION = "0.9.9"
 end

data/lib/tasks/ez_tasks.rake

@@ -8,19 +8,39 @@ namespace :ez do
         f.puts <<-EOS
 # Example table for a typical Book model.
 #
-Book
-  title: string
-  price: integer
-  author: string
-  summary: text
-  hardcover: boolean
+# Book
+#   title: string
+#   author_id: integer
+#   price: integer
+#   summary: text
+#   hardcover: boolean
 #
 # Indent consistently!  Follow the above syntax exactly.
-# Typical column choices are: string, text, integer, boolean, date, and datetime.
+# Typical column choices are: string, text, integer, boolean, date, time, and datetime.
 #
+#
+# Specifying Default Values
+# ----------------------------------------------------
 # Default column values can be specified like this:
 #    price: integer(0)
 #
+# If not specified, Boolean columns always default to false.
+#
+#
+# Convention-Based Defaults:
+# ----------------------------------------------------
+# You can omit the column type if it's a string, or if it's obviously an integer column:
+#
+#
+# Book
+#   title
+#   author_id
+#   price: integer
+#   summary: text
+#   hardcover: boolean
+#
+# Complete details are in the README file online.
+#
 # Have fun!
 
 EOS
@@ -35,7 +55,6 @@ EOS
 
   desc "Attempts to update the database schema and model files with minimal data loss."
   task :tables => [:environment] do
-    puts "Running ez:tables..."
     if File.exists?('db/models.yml')
       if EZ::DomainModeler.update_tables
         Rake::Task["db:schema:dump"].invoke unless Rails.env.production?

metadata

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