ez 0.9.1 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bbacb9af6fd2f80c8aed574c56265d9f7e9af8c
-  data.tar.gz: 529687c8f65652ff1c9133d0fee355cd0204cd67
+  metadata.gz: 5cf4b1d3d88ed176c6158aa4a3d36bcf9839f7a6
+  data.tar.gz: c883f390a67350f0eff832ae33c8d309ad50d24a
 SHA512:
-  metadata.gz: c36d5521426c59b5f9fbf483bedd3cff07fc24f404556f868fffc6bc402a00d2152bbd97c70bf32f3da08f2c26b88686fe1d63c25449afc6a6ab6eb13ca9fd18
-  data.tar.gz: 9dd7a0f3d63031b615be468a56a45b34319ed02226314f98e132338dde81ce5b9a0bf6cb5f1d372702e582aae1e66deb69ad45075ce9b229a8b5df6a55194b9c
+  metadata.gz: 2504acb195bd45a35c4119049e5f289a345da9dfffb8add1ce47ca4ac0ed512bd9c8d619a50b92c7352ebac8a270e02f653ede15ac0d3792686c33b759e3591b
+  data.tar.gz: 6c5b356cf56615a97e2bba4221a2c7e2ecc07587117642fba3fad44ed45ad3e4d5f61b5314d5c78a0963a296119174139b917278b6c576059edf0d7d85b1960d

data/README.md

@@ -1,41 +1,147 @@
 # EZ
 
-For educational purposes only.  Makes Rails a bit more beginner-friendly.
+**Version 0.9.8**
+
+For educational purposes only, but I'm now using it on small production apps with no problems.  Would love to get more real-world feedback.
+
+Makes domain modeling in Rails more beginner-friendly by avoiding migrations.
 
 ## Usage
 
 ```ruby
-gem 'ez', group: 'development'
+gem 'ez'
 ```
 
 ## Features
 
-### 1. Console Enhancements
 
-* Fixes 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. (Depends on 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')`.
+### 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.
+
+**Syntax Guide for `db/models.yml`**
+
+It's just YAML and the syntax is very simple:
+
+```
+Book:
+  title: string
+  copies_on_hand: integer
+  author_id: integer
+  created_at: datetime
+  updated_at: datetime
+  paperback: boolean
+
+Author:
+  last_name: string
+  first_name: string
+  book_count: integer
+```
 
-### 2. Route Enhancements
+**(Optional) Variations**
 
-* Patches the Rails dispatcher to avoid writing controllers for simple views by adding route support for `get "url" => "folder/file"`
+The colon after the model name is optional.
 
-### 3. Model Enhancements
+Also, you can often omit the column type and rely on conventions.  I don't recommend this for beginning students, but is very handy for experienced developers.  Rails conventions are embraced in `db/models.yml` resulting in these sensible defaults:
 
-* Run `rake ez:generate_yml` to generate a file named `db/models.yml`.  It will have some self-documenting comments inside of it.  This file is also automatically generated if you run `rake ez:tables` without an existing `models.yml` first.
-* Enables instant modeling without migrations via `models.yml` and `rake ez:tables`.  If things get messed up, use `rake ez:reset_tables` to drop the entire db first.
-* Columns default to type `string` if none is provided and the column name doesn't have a recognized suffix.
-* Column names ending in `_id` are assumed to be of type `integer`.
+* If a column type isn't specified, it's assumed to be a `string` column.
+* Column names ending in `_id` and `_count` are assumed to be of type `integer`.
 * Column names ending in `_at` are assumed to be of type `datetime`.
 * Column names ending in `_on` are assumed to be of type `date`.
-* Boolean columns are assumed to be given a default of `false`.
-* Adds ActiveRecord::Base `.read` method to provide symmetry with `.create`, `.update`, and `.delete`
+
+Also, note that `_id` columns are further assumed to be foreign keys and will **automatically generate a database index for that column**.
+
+So the above models could be written as:
+
+```
+Book
+  title
+  copies_on_hand: integer
+  author_id
+  created_at
+  updated_at
+  paperback: boolean
+
+Author
+  last_name
+  first_name
+  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:
+
+```
+Book
+  title
+  copies_on_hand: integer, default: 0
+  author_id
+  created_at
+  updated_at
+  paperback: boolean
+
+Author
+  last_name
+  first_name
+  book_count: integer, default: 0
+```
+
+The syntax is forgiving, so the comma and colon are just for readability; this would work too:
+
+```
+Book
+  title
+  copies_on_hand: integer default 0
+  author_id
+  created_at
+  updated_at
+  paperback: boolean
+
+Author
+  last_name
+  first_name
+  book_count: integer default 0
+```
+
+And for the extra lazy like me, you can use parentheses:
+
+```
+Book
+  title
+  copies_on_hand: integer(0)
+  author_id
+  created_at
+  updated_at
+  paperback: boolean
+
+Author
+  last_name
+  first_name
+  book_count(0)
+```
+
+* Boolean columns are assumed to be given a default of `false` if not otherwise specified.
+
+
+### 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.
+
+
+### 3. Beginner-friendly "It Just Works" 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.
+* 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')`.
+
 
 ### 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 controller and view helpers `current_user`, `user_signed_in?`, `sign_in_as`, and `sign_out` to avoid cookies/session hash details
-* Adds view helper `map` to display a quick static map of any address. Example: `<%= map('Millenium Park, Chicago, IL') %>`
+* Adds view helper `map` to display a static Google map of any address. Example: `<%= map('Millenium Park, Chicago, IL') %>`

data/lib/ez.rb

@@ -1,7 +1,7 @@
 require "ez/version"
 # require 'ez/dispatcher.rb'
 # require 'ez/mapper.rb'
-# require 'ez/controller.rb'
+require 'ez/controller.rb'
 
 require 'ez/apis.rb'
 require 'ez/domain_modeler.rb'
@@ -14,6 +14,7 @@ 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|

data/lib/ez/controller.rb

@@ -1,25 +1,17 @@
 module ActionController
   class Base
 
-    helper_method :current_user
-    helper_method :user_signed_in?
+    if Rails.env.development?
 
-    def user_signed_in?
-      session[:user_id].present?
-    end
-
-    def sign_in_as(user)
-      @current_user = user
-      session[:user_id] = user.try(:id)
-      user
-    end
+      before_action :ez_update_tables
 
-    def sign_out
-      sign_in_as nil
-    end
+      def ez_update_tables
+        Rails.cache.fetch('ez-generate-yml') do
+          EZ::DomainModeler.generate_models_yml
+        end
+        EZ::DomainModeler.update_tables
+      end
 
-    def current_user(klass = User)
-      @current_user ||= klass.send(:find_by, id: session[:user_id])
     end
 
   end

data/lib/ez/dispatcher.rb

@@ -1,28 +1,28 @@
 # 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
+# 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
+#         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

data/lib/ez/domain_modeler.rb

@@ -3,44 +3,117 @@ require_relative 'schema_modifier'
 module EZ
   class DomainModeler
 
+    DEFAULT_VALUE_REGEXES = [/\s*\((.+)?\)/, /\s+(.+)?\s*/, /,\s*default:\s*(.+)?\s*/]
+
+    attr_reader :spec
+
     def initialize
-      load_model_specs
+      begin
+        load_model_specs
+      rescue => e
+        puts e
+      end
     end
 
-    def self.update_tables
-      self.new.update_tables
+    def self.generate_models_yml
+      filename = Rails.root + "db/models.yml"
+      unless File.exist?(filename)
+        File.open(filename, "w") do |f|
+          f.puts <<-EOS
+  # Example table for a typical Book model.
+  #
+  Book
+    title: string
+    price: integer
+    author: string
+    summary: text
+    hardcover: boolean
+  #
+  # Indent consistently!  Follow the above syntax exactly.
+  # Typical column choices are: string, text, integer, boolean, date, and datetime.
+  #
+  # Default column values can be specified like this:
+  #    price: integer(0)
+  #
+  # Have fun!
+
+  EOS
+        end
+      end
     end
 
-    def update_tables
-      SchemaModifier.migrate(@spec)
+    def self.update_tables(silent = false)
+      self.new.update_tables(silent)
     end
 
-    def load_model_specs
-      @spec = YAML.load_file('db/models.yml')
-      @spec ||= {}
+    def update_tables(silent = false)
+      SchemaModifier.migrate(@spec, silent)
+
+      rescue => e
+        puts e.message unless silent
+        puts e.backtrace.first unless silent
+    end
+
+    def load_model_specs_from_string(s)
+
+      # Append missing colons
+      s.gsub!(/^((\s|\-)*\w[^\:]+?)$/, '\1:')
+
+      # Replace ", default:" syntax so YAML doesn't try to parse it
+      s.gsub!(/,?\s*(default)?:?\s(\S)\s*$/, '(\2)')
+
+      # For backward compatibility with old array syntax
+      s.gsub!(/^(\s*)\-\s*/, '\1')
+
+      @spec = YAML.load(s)
+      parse_model_spec
 
+      # puts "@spec:"
+      # puts @spec.inspect
+      # puts "-" * 10
+    end
+
+    def load_model_specs(filename = "db/models.yml")
+      load_model_specs_from_string(IO.read(filename))
+    end
+
+    def parse_model_spec
+      @spec ||= {}
       @spec.each do |model, columns|
-        @spec[model] = []
-        columns.each do |column|
-          if column.is_a?(String) || column.is_a?(Symbol)
-            if column.to_s =~ /_id$/ || column.to_s =~ /_count$/
-              @spec[model] << { column.to_s => 'integer' }
-            elsif column.to_s =~ /_at$/
-              @spec[model] << { column.to_s => 'datetime' }
-            elsif column.to_s =~ /_on$/
-              @spec[model] << { column.to_s => 'date' }
-            else
-              @spec[model] << { column.to_s => 'string' }
-            end
-          elsif column.is_a?(Hash) && column.keys.count == 1
-            @spec[model] << { column.keys.first.to_s => column.values.first.to_s }
-          else
-            raise "Bad syntax around `#{column.inspect}`"
-          end
+
+        if !columns.is_a?(Hash)
+          raise "Could not understand models.yml while parsing model: #{model}"
+        end
+
+        columns.each do |column_name, column_type|
+          interpret_column_spec column_name, column_type, model
         end
       end
+
     end
 
+    def interpret_column_spec(column_name, column_type, model)
+      column_type ||= begin
+        if column_name =~ /_id|_count$/
+          'integer'
+        elsif column_name =~ /_at$/
+          'datetime'
+        elsif column_name =~ /_on$/
+          'date'
+        elsif column_name =~ /\?$/
+          'boolean'
+        else
+          'string'
+        end
+      end
+
+      default_column_value = (column_type == 'boolean' ? true : 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'
+
+      @spec[model][column_name] = { type: column_type, default: default_column_value}
+    end
   end
 
 end

data/lib/ez/mapper.rb

@@ -1,22 +1,22 @@
-module ActionDispatch
-  module Routing
-    class Mapper
-      class Mapping
+# module ActionDispatch
+#   module Routing
+#     class Mapper
+#       class Mapping
 
-        def route_uses_slash_and_no_hash?
-          @options[:to].is_a?(String) &&
-            @options[:to].index('#').nil? &&
-            @options[:to].index('/')
-        end
+#         def route_uses_slash_and_no_hash?
+#           @options[:to].is_a?(String) &&
+#             @options[:to].index('#').nil? &&
+#             @options[:to].index('/')
+#         end
 
-        def to
-          if route_uses_slash_and_no_hash?
-            @options[:to].sub('/','#')
-          else
-            @options[:to]
-          end
-        end
-      end
-    end
-  end
-end
+#         def to
+#           if route_uses_slash_and_no_hash?
+#             @options[:to].sub('/','#')
+#           else
+#             @options[:to]
+#           end
+#         end
+#       end
+#     end
+#   end
+# end

data/lib/ez/model.rb

@@ -32,4 +32,22 @@ class ActiveRecord::Base
     offset(rand(0...count)).first
   end
 
+  def self.none?
+    self.count == 0
+  end
+
+  def self.to_ez
+    s = self.name + ":\n"
+    columns.each do |column|
+      s <<  "  - #{column.name}: #{column.type}\n" unless column.name == 'id'
+    end
+    s
+  end
+
+  def self.dump_tables_to_ez
+    (connection.tables - ['schema_migrations']).each do |table|
+      puts table.classify.constantize.to_ez
+    end
+  end
+
 end

data/lib/ez/schema_modifier.rb

@@ -3,13 +3,14 @@ module EZ
 
     attr_reader :db, :spec
 
-    def initialize(model_spec)
+    def initialize(model_spec, silent = false)
+      @silent = silent
       @spec = model_spec
       connect_to_database
     end
 
-    def self.migrate(model_spec)
-      self.new(model_spec).migrate
+    def self.migrate(model_spec, silent = false)
+      self.new(model_spec, silent).migrate
     end
 
     def migrate
@@ -21,7 +22,7 @@ module EZ
       if @changed
         update_schema_version
       else
-        puts "Everything is up-to-date."
+        puts "All tables are up-to-date."
       end
 
       return @changed
@@ -55,15 +56,15 @@ module EZ
     end
 
     def display_change(message)
-      puts message
+      puts message unless @silent
       @changed = true
     end
 
     def add_missing_columns(model_name, columns, assume_missing = false)
       table_name = model_name.tableize
-      columns.each do |column|
-        col_name = column.keys.first
-        col_type = column[col_name]
+      # {"nickname"=>{:type=>"string", :default=>nil}, "password_digest"=>{:type=>"string", :default=>nil}, "created_at"=>{:type=>"datetime", :default=>nil}, "updated_at"=>{:type=>"datetime", :default=>nil}, "course_id"=>{:type=>"integer", :default=>"(0)"}, "email"=>{:type=>"string", :default=>nil}, "full_name"=>{:type=>"string", :default=>nil}, "admin"=>{:type=>"boolean", :default=>true}}
+      columns.each do |col_name, data|
+        col_type = data[:type]
         if !assume_missing && db.column_exists?(table_name, col_name.to_sym)
           unless db.column_exists?(table_name, col_name.to_sym, col_type.to_sym)
             display_change "Changing column type for '#{col_name}' to #{col_type}"
@@ -93,16 +94,6 @@ module EZ
       display_change "Defining new table for model '#{model_name}'."
       db.create_table table_name
       add_missing_columns model_name, columns, true
-      #     columns.each do |column|
-      #       name = column.keys.first
-      #       col_type = column[name]
-      #       options = {}
-      #       options[:default] = false if col_type.to_sym == :boolean
-      #       t.send(col_type, name, options)
-      #     end
-      #     # t.timestamps
-      #   end
-      # end
       filename = "app/models/#{model_name.underscore}.rb"
       unless Rails.env.production? || File.exists?(filename)
         display_change "Creating new model file: #{filename}"
@@ -121,12 +112,12 @@ module EZ
     def remove_dead_columns
       tables.each do |table_name|
         model_name = table_name.classify.to_s
+
         if @spec.has_key?(model_name)
-          columns = db.columns(table_name).map { |column| column.name.to_sym } - [:id, :created_at, :updated_at]
-          spec_columns = @spec[model_name].map do |column_entry|
-            column_entry.is_a?(Hash) ? column_entry.keys.first.to_sym : column_entry.to_sym
-          end
-          dead_columns = columns - spec_columns
+          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)
+          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}'"
@@ -148,10 +139,26 @@ module EZ
 
       dead_tables.each do |table_name|
         model_name = table_name.classify
+        display_change "Yo"
         display_change "Dropping model #{model_name}"
         db.drop_table(table_name)
-        display_change "Deleting file #{model_name.underscore}.rb"
-        File.unlink "app/models/#{model_name.underscore}.rb" rescue nil
+        begin
+          filename = "app/models/#{model_name.underscore}.rb"
+          code = IO.read(filename)
+          matched = IO.read(filename) =~ /\s*class #{model_name} < ActiveRecord::Base\s+end\s*/
+
+          display_change "-" * 20
+          display_change matched
+          display_change code
+          display_change "-" * 20
+
+          if matched
+            display_change "Deleting file #{filename}"
+            File.unlink(filename)
+          end
+        rescue => e
+          display_change "Could not delete old model #{model_name.underscore}.rb."
+        end
       end
     end
 

data/lib/ez/version.rb

@@ -1,3 +1,3 @@
 module EZ
-  VERSION = "0.9.1"
+  VERSION = "0.9.5"
 end

data/lib/tasks/ez_tasks.rake

@@ -8,16 +8,21 @@ 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
+  price: integer
+  author: string
+  summary: text
+  hardcover: boolean
 #
-# Follow the syntax exactly (colons and spacing are important).
-# Column type choices are: string, text, integer, and boolean.
-# You can have as many models as you want in this file.
+# Indent consistently!  Follow the above syntax exactly.
+# Typical column choices are: string, text, integer, boolean, date, and datetime.
+#
+# Default column values can be specified like this:
+#    price: integer(0)
+#
+# Have fun!
+
 EOS
       end
     end
@@ -29,7 +34,8 @@ EOS
 
 
   desc "Attempts to update the database schema and model files with minimal data loss."
-  task :tables => [:environment, 'db:migrate'] do
+  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.1
+  version: 0.9.5
 platform: ruby
 authors:
 - Jeff Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb