ez 1.9.2 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb03b6da20e1afb0c548a1d8be3ba5efaaea9922
-  data.tar.gz: 50f53f9864921ec57b2f7d3f70dfc75ec01ba486
+  metadata.gz: 7ac405024955a31e91958c4f679c63a062ec6d7e
+  data.tar.gz: e57f68f2e1a86b817bb592eac4d014334c512d41
 SHA512:
-  metadata.gz: 284b6ce37d4950607c14298fbd63609fdcad4f6ea6db23f15f844a2765d1c288168aad84c92e59a9bed72ae6d500f660c1cf2aac324a8e91439d14f977e648dd
-  data.tar.gz: fcb66139091f785ab8c0fd4567fc50b3216f97e4c82df61f325088ae1bc21afe37cef1ac824f491aa234f65af72b407f4e237c1b88fecdafee6c5e915cb93c70
+  metadata.gz: fa70cc7f7e368952a118ac0c162fb89ae71450589effb6be12917719ae88e2a7831168e36156ada6293b826fed36c0689c937d39b908f38ce936c8fc135bc895
+  data.tar.gz: a0838f2498ca2683405752c7167edeb1ba8ff2a70b8de12ef5042cc67a04a1d41c7f8bf42c3f3aad91e4774b1ba38ddfcca9f0ab82be409fc0b3399dc713e1d4

data/README.md

@@ -1,56 +1,57 @@
 # EZ
 
-**Version 1.5.0.3**
+Easy domain modeling in Rails without migrations.  
+
+**Version 1.9.3**
 
 *For educational purposes only.*
 
-Tested against Rails 5.1.1.
+Tested against Rails 5.1.4.
 
 _NOTE: For Rails < 5.0, use version 1.3_.
 
-Easy domain modeling in Rails without migrations.  
+### Highlights
 
-* Applies instant schema changes based on a file named `db/models.yml`.  
-* Schema changes applied automatically when code is reloaded.
+* Applies schema changes based on a file named `db/models.yml`.  
+* Schema changes are applied by running `rails server`, `rails console`, or `reload!` in the console.
 * Diffs are determined automatically and applied to the database.  
 * Embraces Rails' column naming conventions by inferring columns types based on the name.
 * Enhances the Rails Console with customized AwesomePrint and Hirb integration
 * Adds two new ActiveRecord methods: `.sample(n = 1)` and `.none?`
 
 
-## Usage
+### Installation
 
 ```ruby
 gem 'ez'
 ```
 
-Then start your server or console to force the initial generation of
-`db/models.yml` and a configuation file named `.ez`.
+Start the server or console to force the initial generation of
+`db/models.yml` and a hidden configuration file named `.ez`.
 
 Alternatively, you can run `rails db:migrate` to generate these files without running your app.
 
-## Get Started
-
-1. Use `db/models.yml` to define your schema. Database schema changes are applied directly and triggered automatically in development mode.  (`rails db:migrate` will also trigger the changes).  Foreign-key indexes will be generated automatically.
+### Usage
 
-2. Run `rails db:migrate:preview` to do a "dry run" and see what would change based your `db/models.yml` file.
-
-
-2. Use the `.ez` file to control functionality.
+1. Use `db/models.yml` to define your schema. Database schema changes are applied directly without affecting migrations.  (`rails db:migrate` will also trigger the changes).
+2. Foreign-key indexes are generated automatically.
+3. Use `rails db:migrate:preview` to perform a "dry run" based your `db/models.yml` file.
+4. Use the `.ez` file to control functionality.
+5. See the section on Migrations below.
 
 
 |Config setting|Default|Description|
 |----|----|----|
 |models|true|Watches `models.yml` for changes.  Set to `false` to turn off all functionality|
+|timestamps|true|Generates `created_at` and `updated_at` columns on every model.
 |restful_routes|true|Adds `resources :<tablename>` to routes.rb for each model|
 |controllers|true|Generates one controller per model with 7 empty methods.
 |views|true|Generates the view folder for each model, with 7 empty views.
-|timestamps|true|Generates `created_at` and `updated_at` columns on every model.
 
 
 ## Syntax Guide for `db/models.yml`**
 
-It's just YAML.  We recommend `text` instead of `string` columns but both are supported.
+It's just YAML.  We recommend `text` instead of `string` columns (because of recent SQLite3 changes) but both are supported.
 
 ```
 Book:
@@ -115,17 +116,33 @@ Author
 * Boolean columns are assumed to be given a default of `false` if not otherwise specified.
 
 
-### 2. ActiveRecord Enhancements
+### ActiveRecord Enhancements
 
-* 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.
+* `.sample` method to choose a random row, or `.sample(5)` for five sample rows.
+* `.none?` method on a collection: `Product.where(in_stock: true).none?`
+* `.to_ez` to generate a snippet from legacy models that you can paste into models.yml.
 
 
-### 3. Beginner-friendly "It Just Works" console
+### Beginner-friendly Rails Console
 
-* 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.
-* Activates AwesomePrint in the Rails consol.
+* 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.
+* Activates AwesomePrint.
 * Uses Hirb for table-like display.
 * Configures Hirb to allow nice table output for `ActiveRecord::Relation` collections
 * Configures Hirb to produce hash-like output for single ActiveRecord objects
+
+
+### Migrations
+
+This gem is expecting that the student will not use database migrations
+to control the schema.  However, it is ok to use a combination of migrations
+and `models.yml`, but be aware of the following:
+
+* If at least one migration file is detected, this gem will stop
+removing tables that are removed from `models.yml` since
+it's not possible to know if there's a migration for it or not.
+* Where possible, it's best to translate a migration required for
+a third-party gem (say, for Devise) into an entry in models.yml
+so that everything is managed in one place.
+Pull requests for integrating such features into `ez` are encouraged.

data/ez.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = []
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'awesome_print'
+  spec.add_runtime_dependency 'awesome_print', '~> 1.8', '>= 1.8.0'
   spec.add_runtime_dependency 'hirb', '~> 0.7'
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/ez.rb

@@ -7,33 +7,16 @@ require 'awesome_print'
 
 require 'hirb' if (Rails.env.development? || Rails.env.test?)
 
-module EZ
-  module Console
-    def reload!
-      puts "Reloading code..."
-      if Rails::VERSION::MAJOR < 5
-        ActionDispatch::Reloader.cleanup!
-        ActionDispatch::Reloader.prepare!
-      else
-        Rails.application.reloader.reload!
-      end
-
-      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
 
     console do |app|
-      # Rails::ConsoleMethods.send :prepend, EZ::Console
       AwesomePrint.irb!
 
       Hirb.enable(pager: false) if (Rails.env.development? || Rails.env.test?) && defined?(Hirb)
@@ -42,17 +25,18 @@ module EZ
 
       models = EZ::DomainModeler.models
       puts
+      puts "Rails Console"
+      puts "-" * 50
+      puts "* Type 'exit' (or press CTRL-D) when you're done."
+      puts "* Press Ctrl-C if things seem to get stuck."
+      puts "* Use the up/down arrows to repeat commands."
+      puts
       if models.any?
-        puts "Models: #{models.to_sentence}" if models.any?
+        puts "Models: #{models.to_sentence}"
         puts
         puts "Use this console to create, read, update, and delete rows from the database."
-        puts
+        puts "Or simply type the name of a model to see what columns it has."
       end
-      puts "HINTS:"
-      puts "* Type 'exit' (or press CTRL-D) when you're done."
-      puts "* Press Ctrl-C if things seem to get stuck."
-      puts "* Use the up/down arrows to repeat commands."
-      puts "* Type the name of a Model to see what columns it has." if models.any?
       puts
     end
 

data/lib/ez/config.rb

@@ -21,7 +21,14 @@ module EZ
     end
 
     def self.filename
-      File.join(Rails.root, '.ez')
+      @filename = begin
+        n = File.join(Rails.root, '.ez')
+        if File.exist?(n)
+          n
+        else
+          File.expand_path('~/.ez')
+        end
+      end
     end
 
     def self.configuration

data/lib/ez/domain_modeler.rb

@@ -21,25 +21,26 @@ module EZ
     end
 
     def self.automigrate
-      if EZ::Config.models?
+      return unless EZ::Config.models?
+
+      begin
         models_yml = File.join(Rails.root, 'db', 'models.yml')
         schema_rb = File.join(Rails.root, 'db', 'schema.rb')
 
         EZ::DomainModeler.generate_models_yml unless File.exist?(models_yml)
 
         if !File.exist?(schema_rb) || (File.mtime(schema_rb) < File.mtime(models_yml))
-          puts "Updating your app based on models.yml..."
           old_level = ActiveRecord::Base.logger.level
-          ActiveRecord::Base.logger.level = Logger::WARN
 
+          ActiveRecord::Base.logger.level = Logger::WARN
           EZ::DomainModeler.update_tables
           dump_schema if (Rails.env.development? || Rails.env.test?)
-          puts "Models: #{EZ::DomainModeler.models.to_sentence}"
+
           ActiveRecord::Base.logger.level = old_level
+          EZ::RailsUpdater.update!
         end
-
-        EZ::RailsUpdater.update!
-
+      rescue => e
+        puts "Exception: #{e}"
       end
     end
 
@@ -68,37 +69,36 @@ module EZ
       unless File.exist?(filename)
         File.open(filename, "w") do |f|
           f.puts <<-EOS
-# Example table for a typical Book model.
+# Example:
 #
 # Book
 #   title: text
 #   author_id: integer
-#   price: integer
 #   summary: text
+#   price: integer
 #   hardcover: boolean
 #
+#
 # Indent consistently!  Follow the above syntax exactly.
-# Typical column choices are: string, text, integer, boolean, date, time, and datetime.
 #
 #
-# About Default Values
-# ----------------------------------------------------
-# Default column values can be specified like this:
-#    price: integer(0)
 #
-# If not specified, Boolean columns always default to false.
+# Column choices are: text, integer, boolean, datetime, and float.
 #
 #
-# Convention-Based Defaults:
-# ----------------------------------------------------
-# You can omit the column type if it's a string, or if it's obviously an integer column:
+# Default values can be specified like this:
 #
+#    price: integer(0)
+#
+# If not specified, Boolean columns always default to false.
+#
+# You can omit the column type if it's a text column or obviously an integer column:
 #
 # Book
 #   title
 #   author_id
+#   summary
 #   price: integer
-#   summary: text
 #   hardcover: boolean
 #
 # Complete details are in the README file online.
@@ -143,9 +143,9 @@ module EZ
       @spec = YAML.load(s)
       parse_model_spec
 
-      puts "@spec:"
-      puts @spec.inspect
-      puts "-" * 10
+      # puts "@spec:"
+      # puts @spec.inspect
+      # puts "-" * 10
     end
 
     def load_model_specs(filename = "db/models.yml")
@@ -173,7 +173,7 @@ module EZ
           columns['created_at'] = 'datetime'
           columns['updated_at'] = 'datetime'
         end
-        
+
         columns.each do |column_name, column_type|
           interpret_column_spec column_name, column_type, model
         end
@@ -192,7 +192,7 @@ module EZ
         elsif column_name =~ /\?$/
           'boolean'
         else
-          'string'
+          'text'
         end
       end
 

data/lib/ez/rails_updater.rb

@@ -31,7 +31,7 @@ module EZ
       filename = File.join(Rails.root, 'app', 'controllers', "#{controller}_controller.rb")
       if !File.exist?(filename)
         File.open(filename, "w:utf-8") do |file|
-          file.puts "class #{controller.classify} < ApplicationController"
+          file.puts "class #{"#{controller}_controller".classify} < ApplicationController"
           METHODS.each do |method|
             file.puts
             file.puts "  def #{method}"

data/lib/ez/version.rb

@@ -1,3 +1,3 @@
 module EZ
-  VERSION = "1.9.2"
+  VERSION = "1.9.3"
 end

data/lib/tasks/ez_tasks.rake

@@ -1,7 +1,3 @@
-# Rake::Task["db:migrate"].enhance do
-#   Rake::Task["ez:resources"].invoke
-# end
-
 namespace :db do
 
   namespace :migrate do
@@ -22,7 +18,7 @@ namespace :ez do
 
   desc "Generate models.yml if it doesn't exist yet."
   task :generate_yml do
-    EZ::DomainModeler.generate_yml
+    EZ::DomainModeler.generate_models_yml
   end
 
   desc "Erases all data, and builds all table schema from scratch."

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ez
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.9.3
 platform: ruby
 authors:
 - Jeff Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement