ez 1.3.0 → 1.5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 651da5699fe33ae98d63db37c12d5d75e30fdc68
-  data.tar.gz: 1b3d7f79c58140be5a7c1a9403b47d930b3837cb
+  metadata.gz: 1489c438d97d79208d963c25252fded0a1abaf9e
+  data.tar.gz: 784a7645ba2e2a63bc37942b9dbeb6eba536a857
 SHA512:
-  metadata.gz: d481867135942e93bd1deadca16ccb1c6400ebb5c03adaeedfac3341bcf2354e40a205c4b238fff6aa069454169712b0b74185cb3fc71fe6df5910ef1fa68f0f
-  data.tar.gz: 596950b0f26338731f1d02fc3284b03a397375567ae9dcf80a8a05834adf6ac6d72f47e8036bd38d47bfde73b86895af5a2c1c9b1186b5b239c9ca30de3ed7d8
+  metadata.gz: ae85e1d114644062bcf66924b8d231bce256dc9782cd9b11d96aa81cf470e69d1c6ba7cb1cec963f18ecf170b5873ce12898873a2c964166147e17616b029a06
+  data.tar.gz: 6dab9bc2e6bf81859a2d7e3eef8f8696141405a045826f81b739686ea7df4aabeb5763917820b463ee59ca6b1ae6113385249f2e901b9e8e98fdad30dee900e2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+*Version 1.5.0.2*
+
+- Rails 5 compatibility
+- Column deletion, model deletion, and column renaming applied in dev and test environments only
+- Warning! Column type changes are allowed in ALL environments.
+- Starting the console no longer evaluates `models.yml` file.  You must run `reload!` to apply any changes.
+- Focused on domain modeling only. Removed old controller filters, generators, and view helpers.
+- Removed dead code.

data/README.md

@@ -1,9 +1,11 @@
 # EZ
 
-**Version 1.3.0**
+**Version 1.5.0.2**
 
 *For educational purposes only.*
 
+Tested against Rails 5.0.2 and Rails 4.2.6.
+
 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 and provides extra ActiveRecord helper methods.
@@ -40,10 +42,10 @@ to generate a skeleton `db/models.yml` that you should edit.
 ### 1. Domain Modeling Enhancements
 
 * 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.
-* 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.
+* Run `rails db:migrate` (Rails 5.x) or `rake db:migrate` (Rails 4.x) to initially generate a file named `db/models.yml`.  It will have some self-documenting comments inside of it.
+* Just run `rails db:migrate` (or `rake db:migrate`) whenever you modify `db/models.yml`.
+* Using `reload!` inside the rails console is an alternative to the `db:migrate` task.
+* Pending migrations will be run *after* running table updates based on the `db/models.yml` file.
 
 
 **Syntax Guide for `db/models.yml`**
@@ -160,16 +162,8 @@ Author
 
 ### 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 also force a schema update from the console.
-
-
-### 4. Controller and View Enhancements
-
-* Easier JSON API calls by calling `EZ.from_api(url)`; returns parsed Ruby hash (or array, etc.)
-* Built-in view helper `<%= weather %>` and `EZ.weather` for classroom demo of a JSON API, to get quick hash and avoid gory details.  (Relies on http://openweathermap.org).  Default location is Evanston.  Can pass location: `<%= weather('San Diego, CA') %>`.  The `<%= weather %>` helper just delegates to `EZ.weather`.
-* Adds view helper `map` to display a static Google map of any address. Example: `<%= map('Millenium Park, Chicago, IL') %>`
+* `reload!` will force a schema update from the console.

data/lib/ez.rb

@@ -1,21 +1,19 @@
 require "ez/version"
-# require 'ez/dispatcher.rb'
-# require 'ez/mapper.rb'
-require 'ez/controller.rb'
-
-require 'ez/apis.rb'
 require 'ez/domain_modeler.rb'
 require 'ez/model.rb'
-require 'ez/view_helpers.rb'
 
-require 'hirb' if Rails.env.development?
+require 'hirb' if (Rails.env.development? || Rails.env.test?)
 
 module EZ
   module Console
-    def reload!(print=true)
+    def reload!(print = true)
       puts "Reloading code..." if print
-      ActionDispatch::Reloader.cleanup!
-      ActionDispatch::Reloader.prepare!
+      if Rails::VERSION::MAJOR < 5
+        ActionDispatch::Reloader.cleanup!
+        ActionDispatch::Reloader.prepare!
+      else
+        Rails.application.reloader.reload!
+      end
 
       puts "Updating tables (if necessary) ..." if print
       old_level = ActiveRecord::Base.logger.level
@@ -40,7 +38,7 @@ module EZ
 
     console do |app|
       Rails::ConsoleMethods.send :prepend, EZ::Console
-      Hirb.enable(pager: false) if ::Rails.env.development? && defined?(Hirb)
+      Hirb.enable(pager: false) if ::(Rails.env.development? || Rails.env.test?) && defined?(Hirb)
 
       old_level = ActiveRecord::Base.logger.level
       ActiveRecord::Base.logger.level = Logger::WARN
@@ -70,11 +68,7 @@ module EZ
 
     initializer "ez" do
 
-      ActiveSupport.on_load :action_view do
-        include EZ::ViewHelpers
-      end
-
-      # tables = ActiveRecord::Base.connection.tables - ['schema_migrations']
+      # tables = ActiveRecord::Base.connection.data_sources - ['schema_migrations', 'ar_internal_metadata']
       # models.each { |m| m.constantize.magic_associations }
       # Rails.application.routes.draw do
       #   tables.each do |table_name|
@@ -82,7 +76,7 @@ module EZ
       #   end
       # end
 
-      if Rails.env.development?
+      if (Rails.env.development? || Rails.env.test?)
         module ::Hirb
           # A Formatter object formats an output object (using Formatter.format_output) into a string based on the views defined
           # for its class and/or ancestry.

data/lib/ez/domain_modeler.rb

@@ -1,6 +1,9 @@
 require_relative 'schema_modifier'
 
 module EZ
+
+  COLUMN_TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE']
+
   # The DomainModeler class implements the db/models.yml file syntax
   # and provides a hash of the domain model specification.
 
@@ -10,7 +13,7 @@ module EZ
     DEFAULT_VALUE_REGEXES = [/\s*\((.+)?\)/, /\s+(.+)?\s*/, /,\s*default:\s*(.+)?\s*/]
 
     def self.models
-      tables = ActiveRecord::Base.connection.tables - ['schema_migrations']
+      tables = ActiveRecord::Base.connection.data_sources - ['schema_migrations', 'ar_internal_metadata']
       tables.map { |t| t.classify }
     end
 
@@ -50,6 +53,7 @@ module EZ
   #
   # Default column values can be specified like this:
   #    price: integer(0)
+  #    hardcover: boolean(false)
   #
   # Have fun!
 
@@ -146,7 +150,7 @@ module EZ
       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'
+        default_column_value = default_column_value.present? && default_column_value.in?(EZ::COLUMN_TRUE_VALUES)
       end
 
       @spec[model][column_name] = { type: column_type, default: default_column_value}

data/lib/ez/model.rb

@@ -1,15 +1,5 @@
 class ActiveRecord::Base
 
-  def self.magic_associations
-    x = self.column_names.select { |n| n.ends_with? '_id' }
-
-    x.each do |fk|
-      assoc_name = fk[0, fk.length - 3]
-      belongs_to assoc_name.to_sym
-      assoc_name.classify.constantize.send(:has_many, self.name.underscore.pluralize.to_sym, dependent: :destroy)
-    end
-  end
-
   def inspect
     "#<#{self.class.name} #{attributes}>"
   end
@@ -45,7 +35,7 @@ class ActiveRecord::Base
   end
 
   def self.dump_tables_to_ez
-    (connection.tables - ['schema_migrations']).each do |table|
+    (connection.data_sources - ['schema_migrations', 'ar_internal_metadata']).each do |table|
       puts table.classify.constantize.to_ez
     end
   end

data/lib/ez/schema_modifier.rb

@@ -47,7 +47,7 @@ module EZ
 
 
     def tables
-      @tables ||= (db.tables - ['schema_migrations'])
+      @tables ||= (db.data_sources - ['schema_migrations', 'ar_internal_metadata'])
     end
 
     def missing_model?(model_name)
@@ -73,54 +73,58 @@ module EZ
       @changed = true
     end
 
-    def add_missing_columns(model_name, columns, assume_missing = false)
+    def add_missing_columns(model_name, spec_columns, assume_missing = false)
       table_name = model_name.tableize
       db_columns = db.columns(table_name)
 
-      columns.each do |col_name, data|
-        col_type = data[:type].to_sym
-        col_default = data[:default]
+      spec_columns.each do |col_name, col_spec|
+        col_type = col_spec[:type].to_sym
+        col_default = col_spec[:default]
         db_col = !assume_missing && (db_columns.detect { |dbc| dbc.name == col_name })
 
         if !db_col
           if !assume_missing
-            display_change "Adding new column '#{col_name}' as #{col_type} for model #{model_name}"
+            display_change "Adding new column '#{col_name}' as #{col_type} in model #{model_name}"
           end
           opts = { default: col_default }
-          opts[:limit] = data[:limit] if data[:limit]
+          opts[:limit] = col_spec[:limit] if col_spec[:limit]
           db.add_column(table_name, col_name.to_sym, col_type.to_sym, opts)  unless @dry_run
-          if data[:index]
+          if col_spec[:index]
             display_change "  (adding database index for '#{col_name}')"
             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}"
+            display_change "Changing column type for #{col_name} to #{col_type} in model #{model_name}"
           end
 
           # puts "#{table_name} #{col_name}: #{db_col.default} and #{col_default}"
-          if db_col.default != col_default
+          if col_type == :boolean
+            db_col_default = db_col.default.in?(EZ::COLUMN_TRUE_VALUES)
+          end
+
+          if db_col_default != col_default
             displayable_value = col_default
             displayable_value = "NULL" if col_default.nil?
-            display_change "Applying new default value #{displayable_value} for #{col_name} for model #{model_name}"
+            display_change "Applying new default value `#{displayable_value}` for #{col_name} attrbute in model #{model_name}"
           end
 
           if (db_col.type != col_type) || (db_col.default != col_default)
               opts = { default: col_default }
-              opts[:limit] = data[:limit] if data[:limit]
+              opts[:limit] = col_spec[:limit] if col_spec[:limit]
               db.change_column(table_name, col_name.to_sym, col_type.to_sym, opts)  unless @dry_run
           end
         end
       end
     end
 
-    def add_model(model_name, columns)
+    def add_model(model_name, spec_columns)
       table_name = model_name.tableize
       display_change "Defining new table for model '#{model_name}'."
       db.create_table table_name  unless @dry_run
-      add_missing_columns model_name, columns, true
+      add_missing_columns model_name, spec_columns, true
       filename = "app/models/#{model_name.underscore}.rb"
-      unless Rails.env.production? || File.exists?(filename)
+      if (Rails.env.development? || Rails.env.test?) && !File.exists?(filename)
         display_change "Creating new model file: #{filename}"
         File.open(filename, "w") do |f|
           f.puts "class #{model_name} < ActiveRecord::Base"
@@ -130,11 +134,15 @@ module EZ
     end
 
     def remove_dead_schema
+      return unless Rails.env.development? || Rails.env.test?
+
       remove_dead_tables
       remove_dead_columns
     end
 
     def remove_dead_columns
+      return unless Rails.env.development? || Rails.env.test?
+
       tables.each do |table_name|
         model_name = table_name.classify.to_s
 
@@ -161,6 +169,8 @@ module EZ
     end
 
     def remove_dead_tables
+      return unless Rails.env.development? || Rails.env.test?
+
       tables_we_need = @spec.keys.map { |model| model.tableize }
       dead_tables = tables - tables_we_need
 

data/lib/ez/version.rb

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

data/lib/tasks/ez_tasks.rake

@@ -35,7 +35,7 @@ namespace :ez do
 # Typical column choices are: string, text, integer, boolean, date, time, and datetime.
 #
 #
-# Specifying Default Values
+# About Default Values
 # ----------------------------------------------------
 # Default column values can be specified like this:
 #    price: integer(0)
@@ -73,7 +73,7 @@ EOS
   task :tables => [:environment] do
     if File.exists?('db/models.yml')
       if EZ::DomainModeler.update_tables
-        Rake::Task["db:schema:dump"].invoke unless Rails.env.production?
+        Rake::Task["db:schema:dump"].invoke if (Rails.env.development? || Rails.env.test?)
       end
     else
       Rake::Task["ez:generate_yml"].invoke

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ez
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0.2
 platform: ruby
 authors:
 - Jeff Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb
@@ -66,52 +66,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ez.gemspec
 - lib/ez.rb
-- lib/ez/apis.rb
-- lib/ez/controller.rb
-- lib/ez/dispatcher.rb
 - lib/ez/domain_modeler.rb
-- lib/ez/mapper.rb
 - lib/ez/model.rb
 - lib/ez/schema_modifier.rb
 - lib/ez/version.rb
-- lib/ez/view_helpers.rb
-- lib/generators/ez/resource/USAGE
-- lib/generators/ez/resource/migration.rb
-- lib/generators/ez/resource/resource_generator.rb
-- lib/generators/ez/resource/templates/bootstrapped/edit.html.erb
-- lib/generators/ez/resource/templates/bootstrapped/index.html.erb
-- lib/generators/ez/resource/templates/bootstrapped/new.html.erb
-- lib/generators/ez/resource/templates/bootstrapped/show.html.erb
-- lib/generators/ez/resource/templates/controller.rb
-- lib/generators/ez/resource/templates/dried/_form.html.erb
-- lib/generators/ez/resource/templates/dried/bootstrapped/_form.html.erb
-- lib/generators/ez/resource/templates/dried/bootstrapped/edit.html.erb
-- lib/generators/ez/resource/templates/dried/bootstrapped/index.html.erb
-- lib/generators/ez/resource/templates/dried/bootstrapped/new.html.erb
-- lib/generators/ez/resource/templates/dried/bootstrapped/show.html.erb
-- lib/generators/ez/resource/templates/dried/controller.rb
-- lib/generators/ez/resource/templates/dried/edit.html.erb
-- lib/generators/ez/resource/templates/dried/index.html.erb
-- lib/generators/ez/resource/templates/dried/new.html.erb
-- lib/generators/ez/resource/templates/dried/show.html.erb
-- lib/generators/ez/resource/templates/edit.html.erb
-- lib/generators/ez/resource/templates/index.html.erb
-- lib/generators/ez/resource/templates/migration.rb
-- lib/generators/ez/resource/templates/model.rb
-- lib/generators/ez/resource/templates/new.html.erb
-- lib/generators/ez/resource/templates/show.html.erb
-- lib/generators/ez/style/USAGE
-- lib/generators/ez/style/style_generator.rb
-- lib/generators/ez/style/templates/layout.html.erb
-- lib/generators/ez/user/templates/user_controller.rb
-- lib/generators/ez/user/user_generator.rb
-- lib/generators/ez/views/USAGE
 - lib/tasks/ez_tasks.rake
 homepage: http://www.jeffcohenonline.com/ez
 licenses:
@@ -133,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: For educational purposes only.

data/lib/ez/apis.rb

@@ -1,26 +0,0 @@
-require 'json'
-require 'open-uri'
-
-module EZ
-
-  def self.weather(location = 'Evanston, IL')
-    # Only cache up to 30 locations to avoid abuse
-    @wx = {} unless @wx && @wx.keys.count < 30
-
-    # Cache based on location
-    @wx[location] ||= begin
-      puts "Getting the current weather from openweathermap.org..."
-      wx = from_api("http://api.openweathermap.org/data/2.5/weather?q=#{location}&units=imperial")
-      @wx[location] = wx[:main]
-    end
-
-  end
-
-  def self.from_api(uri_string)
-    uri = URI.parse(URI.escape(uri_string))
-    string = open(uri).read
-    JSON.parse(string, symbolize_names: true)
-  end
-
-end
-

data/lib/ez/controller.rb

@@ -1,19 +0,0 @@
-module ActionController
-  class Base
-
-    if Rails.env.development?
-
-      # before_action :ez_update_tables
-
-      def ez_update_tables
-        Rails.cache.fetch('ez-generate-yml') do
-          EZ::DomainModeler.generate_models_yml
-        end
-        EZ::DomainModeler.update_tables(true)
-        EZ::DomainModeler.dump_schema
-      end
-
-    end
-
-  end
-end

data/lib/ez/dispatcher.rb

@@ -1,28 +0,0 @@
-# require_relative './jeff_controller.rb'
-
-# module ActionDispatch
-#   module Routing
-#     class RouteSet
-#       class Dispatcher
-#         def controller(params, default_controller=true)
-#           if params && params.key?(:controller)
-#             controller_param = params[:controller]
-#             controller_reference(controller_param)
-#           end
-#         rescue NameError => e
-#           raise ActionController::RoutingError, e.message, e.backtrace if default_controller
-#         end
-
-#         def controller_reference(controller_param)
-#           begin
-#             const_name = @controller_class_names[controller_param] ||= "#{controller_param.camelize}Controller"
-#             ActiveSupport::Dependencies.constantize(const_name)
-#           rescue NameError => e
-#             Kernel.class_eval("class ::#{const_name} < ApplicationController; end")
-#             ActiveSupport::Dependencies.constantize("::#{const_name}")
-#           end
-#         end
-#       end
-#     end
-#   end
-# end