ez 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 770aabcbe8ed373f6de55df41fea16a0c5c13497
-  data.tar.gz: dc77713cf0d05697828c687b41a07caf037dbe75
+  metadata.gz: 651da5699fe33ae98d63db37c12d5d75e30fdc68
+  data.tar.gz: 1b3d7f79c58140be5a7c1a9403b47d930b3837cb
 SHA512:
-  metadata.gz: f8b266eb5f7dcacd3ee45ece255653e127353e38d397b299df534f1c1d0d676a149bf7d5e1dde3e1d31561fbbad08d77b3d4902cb97ca26bbdfaf2ef57c485c9
-  data.tar.gz: 9010ac66acb8c13eeee33edb5fb992c45d8f2ff974d4b8a8b00c3c3250949c2b26b860120b4be96f51f3df8749cb9c16192773c9335f8f9277855fd3031da313
+  metadata.gz: d481867135942e93bd1deadca16ccb1c6400ebb5c03adaeedfac3341bcf2354e40a205c4b238fff6aa069454169712b0b74185cb3fc71fe6df5910ef1fa68f0f
+  data.tar.gz: 596950b0f26338731f1d02fc3284b03a397375567ae9dcf80a8a05834adf6ac6d72f47e8036bd38d47bfde73b86895af5a2c1c9b1186b5b239c9ca30de3ed7d8

data/README.md

@@ -1,12 +1,12 @@
 # EZ
 
-**Version 1.1.3**
+**Version 1.3.0**
 
 *For educational purposes only.*
 
-Makes domain modeling in Rails more beginner-friendly by avoiding migrations.
+Easy domain modeling in Rails without migrations.  Applies instant schema changes based on a file named `db/models.yml`.  Diffs are determined automatically and applied to the database.  Embraces Rails column naming conventions by providing happy-path default types for most columns.
 
-Also enhances the rails console.
+Also, enhances the rails console and provides extra ActiveRecord helper methods.
 
 
 ## Usage
@@ -24,33 +24,31 @@ rake db:migrate
 to generate a skeleton `db/models.yml` that you should edit.
 
 
-## Summary of Best Practices
+## Get Started
 
 1. Run `rake db:migrate` to initially generate a file named `db/models.yml`.
 
 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.
+3. You can still 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.
+4. Run `rake db:migrate:preview` to do a "dry run" and see what would change based your `db/models.yml` file.
 
 ## Features
 
 
 ### 1. Domain Modeling Enhancements
 
-* Enables **instant domain modeling without migrations** by using a file named `db/models.yml`.
 * 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`.
+* Just run `rake db:migrate` whenever you modify `db/models.yml`.
+* Starting the rails console will automatically run any pending table updates, and `reload!` will also trigger table updates while inside the console.
 * `rake db:migrate` will run any pending migrations *after* any table updates from the `db/models.yml` file.
 
 
 **Syntax Guide for `db/models.yml`**
 
-It's just YAML and the syntax is very simple:
+It's just YML and the syntax is very simple:
 
 ```
 Book:
@@ -97,7 +95,8 @@ Author
   book_count
 ```
 
-Finally, you can specify default values for columns in several ways.  Suppose we want to make sure that `copies_on_hand` always has the value `0` for new rows.  First, the fancy way:
+**Default Values**
+You can specify default values for columns in several ways.  Suppose we want to make sure that `copies_on_hand` always has the value `0` for new rows.  First, the fancy way:
 
 ```
 Book
@@ -131,7 +130,7 @@ Author
   book_count: integer default 0
 ```
 
-And for the extra lazy like me, you can use parentheses:
+And for the extra lazy, like me, you can just use parentheses:
 
 ```
 Book
@@ -154,17 +153,19 @@ Author
 ### 2. More Model Enhancements
 
 * Adds ActiveRecord::Base `.read` method so that models have complete *CRUD*: `.create`, `.read`, `.update`, and `.delete`.  When given an integer, `.read` becomes a synonym for `.find`.  When given a hash, it is a synonym for `.where`.
-* Adds ActiveRecord::Base `.sample` method to choose a random row.
-* Adds ActiveRecord::Base `[id]` method as a synonym for `.find_by(id: ...)`. Especially handy in the console, i.e. `Book[5]` instead of `Book.find_by(id: 5)` and in controllers: `Book[params[:id]]` if you don't find the double bracing too harsh to look at.
+* Adds `.sample` method to choose a random row.
+* Adds `.to_ez' to generate a snippet from legacy models that you can paste into models.yml.
+
 
 
 ### 3. Beginner-friendly "It Just Works" console
 
+* Starting `rails console` will automatically apply any pending database changes, followed by any traditional migrations.
 * Solves the "no connection" message in Rails >= 4.0.1 (if you try to inspect a model without making a query first) by establishing an initial connection to the development database.
 * Shows helpful instructions when console starts, including the list of model classes found in the application.
 * Uses Hirb for table-like display. (Requires Hirb ~> 0.7.1)
 * Patches Hirb to allow nice table output for `ActiveRecord::Relation` lists (i.e. result of `.all`, `.where`) and hash-like output for single ActiveRecord objects, such as the result of `.find_by(:title => 'Apollo 13')`.
-* `reload!` will automatically trigger the table updates from the console.
+* `reload!` will also force a schema update from the console.
 
 
 ### 4. Controller and View Enhancements

data/lib/ez/domain_modeler.rb

@@ -150,6 +150,7 @@ module EZ
       end
 
       @spec[model][column_name] = { type: column_type, default: default_column_value}
+      @spec[model][column_name][:limit] = 1024 if column_type == 'binary'
       @spec[model][column_name][:index] = true if column_name =~ /_id$/
     end
   end

data/lib/ez/schema_modifier.rb

@@ -86,7 +86,9 @@ 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)  unless @dry_run
+          opts = { default: col_default }
+          opts[:limit] = data[:limit] if data[:limit]
+          db.add_column(table_name, col_name.to_sym, col_type.to_sym, opts)  unless @dry_run
           if data[:index]
             display_change "  (adding database index for '#{col_name}')"
             db.add_index table_name, col_name.to_sym unless @dry_run
@@ -104,7 +106,9 @@ module EZ
           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)  unless @dry_run
+              opts = { default: col_default }
+              opts[:limit] = data[:limit] if data[:limit]
+              db.change_column(table_name, col_name.to_sym, col_type.to_sym, opts)  unless @dry_run
           end
         end
       end

data/lib/ez/version.rb

@@ -1,3 +1,3 @@
 module EZ
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ez
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeff Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: For educational purposes only.