miguel 0.1.0.pre4 → 0.1.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbf13dd299009fb0beefd95d64b4a1b3bfba5be5
-  data.tar.gz: 0f4558c6faa5826150e998fb900706ea84bb65a1
+  metadata.gz: a0ecd54548a6934b77b3f075d8b1fc74db7c555b
+  data.tar.gz: 87c76a4d8e883f01be334d3d07fd3be0598d5097
 SHA512:
-  metadata.gz: 30b5da0b99408f21db2c16658c1451f19c0e76dc3398c8edce4881d9339eb07a2ee113a4fcb8cd0aca1e16cd23d03432842169f780399c94580a0a92cf7ecee1
-  data.tar.gz: c6bf941afb95fa42763aa62c0d49376aacca8b32fe6d044d753fffbad2184f7a811edafc107ae46eb7572f44ba2b677cf901e5635572e848db0650c3ba23a2e1
+  metadata.gz: 1d8c0640ab68fe0d19b45a4f6ab05b34acba429d21dd3de9d30341eb64aab8127e2535ce416eb29ecdfb741d8d1f07fe624ba249ba45fce35a1d1689faaf0ad5
+  data.tar.gz: e3598249193c4e2edd85800f9b48c584526ab56045516c3910969a82ccf8ae11e79ca7dc27675e734727907303bcdf09bf43b4fe95368cbb3c43db1f4c208dc9

data/.travis.yml

@@ -20,5 +20,8 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-19mode
     - rvm: jruby-head
+before_script:
+  - mysql -e 'create database miguel_test;'
+  - psql -c 'create database miguel_test;' -U postgres
 
 # EOF #

data/README.md

@@ -102,7 +102,7 @@ end
 ```
 
 One enhancement is that it allows you to define `NULL` columns simply by adding `?` to the type name.
-Anything else is implicitly `NOT NULL`, which is a really wise default.
+Anything else is implicitly `NOT NULL`, which is a really wise default for many reasons.
 
 Another enhancement is that it allows you to set defaults and
 define custom shortcuts for types which you use frequently.
@@ -118,24 +118,26 @@ set_defaults :False, :TrueClass, default: false
 set_defaults :Signed, :integer, unsigned: false
 set_defaults :Unsigned, :integer, unsigned: true
 set_defaults :Text, :String, text: true
-set_defaults :Time, :timestamp, default: '0000-00-00 00:00:00'
+set_defaults :Time, :timestamp, default: '2000-01-01 00:00:00'
 set_defaults :Time?, :timestamp, default: nil
 
 set_defaults :unique, :index, unique: true
 
+set_defaults :Key, :integer, unsigned: false
 set_defaults :primary_key, type: :integer, unsigned: false
 set_defaults :foreign_key, key: :id, type: :integer, unsigned: false
 ```
 
 If you prefer unsigned keys instead and your database engine supports it,
-you can pass the `unsigned_keys: true` option to `define` to make it happen.
+you can pass the `unsigned_keys: true` option to `Schema.define` to make it happen.
 If you don't want any of these defaults set up for you,
-pass the `use_defaults: false` option to define instead.
+pass the `use_defaults: false` option to `define` instead.
 
 Finally, the `timestamps` helper can be used to create the
 `create_time` and `update_time` timestamps for you.
 If you pass the `mysql_timestamps: true` option to `define`,
-the `update_time` timestamp will have the MySQL auto-update feature enabled.
+the `update_time` timestamp will have the MySQL auto-update feature enabled,
+and timestamps will use the `'0000-00-00 00:00:00'` default by default.
 
 ## Using the command
 

data/lib/miguel/importer.rb

@@ -105,27 +105,24 @@ module Miguel
 
     # Convert given database default of given type to default used by our schema definitions.
     def revert_default( type, default, ruby_default )
-      default = ruby_default unless ruby_default.nil?
-      return if default.nil?
-
-      case default
-      when String, Numeric, TrueClass, FalseClass
-      when DateTime
-        default = default.strftime( '%F %T' )
-      else
-        default = default.to_s
-      end
-
       if type.to_s =~ /date|time/
         case default
-        when /\A'([-: \d]+)'\z/
-          default = $1
         when 'CURRENT_TIMESTAMP'
           # This matches our use of MySQL timestamps in schema definitions.
-          default = Sequel.lit('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP')
+          return Sequel.lit('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP')
         end
       end
-      default
+
+      default = ruby_default unless ruby_default.nil?
+
+      case default
+      when nil, String, Numeric, TrueClass, FalseClass
+        return default
+      when DateTime
+        return default.strftime( '%F %T' )
+      else
+        return default.to_s
+      end
     end
 
     # Import indexes of given table.
@@ -156,46 +153,55 @@ module Miguel
     # These are usually just schema hints which the user normally doesn't specify.
     IGNORED_OPTS = [ :max_length ]
 
-    # Import columns of given table.
-    def import_columns( table )
-      schema = db.schema( table.name )
+    # Import column type and options.
+    def import_column_type_and_options( opts )
+      opts = opts.dup
 
-      # Get info about primary key columns.
+      # Discard anything we don't need.
 
-      primary_key_columns = schema.select{ |name, opts| opts[ :primary_key ] }
+      opts.delete_if{ |key, value| IGNORED_OPTS.include? key }
 
-      multi_primary_key =  ( primary_key_columns.count > 1 )
+      # Import type.
 
-      # Import each column in sequence.
+      type = opts.delete( :type )
+      db_type = opts.delete( :db_type )
 
-      for name, opts in schema
+      type, type_opts = revert_type_literal( db_type, type )
+      opts.merge!( type_opts ) if type_opts
 
-        opts = opts.dup
+      # Import NULL option.
 
-        # Discard anything we don't need.
+      opts[ :null ] = opts.delete( :allow_null )
 
-        opts.delete_if{ |key, value| IGNORED_OPTS.include? key }
+      # Import default value.
 
-        # Import type.
+      default = opts.delete( :default )
+      ruby_default = opts.delete( :ruby_default )
+
+      default = revert_default( type, default, ruby_default )
+
+      opts[ :default ] = default unless default.nil?
+
+      [ type, opts ]
+    end
 
-        type = opts.delete( :type )
-        db_type = opts.delete( :db_type )
+    # Import columns of given table.
+    def import_columns( table )
+      schema = db.schema( table.name )
 
-        type, type_opts = revert_type_literal( db_type, type )
-        opts.merge!( type_opts ) if type_opts
+      # Get info about primary key columns.
 
-        # Import NULL option.
+      primary_key_columns = schema.select{ |name, opts| opts[ :primary_key ] }
 
-        opts[ :null ] = opts.delete( :allow_null )
+      multi_primary_key =  ( primary_key_columns.count > 1 )
 
-        # Import default value.
+      # Import each column in sequence.
 
-        default = opts.delete( :default )
-        ruby_default = opts.delete( :ruby_default )
+      for name, opts in schema
 
-        default = revert_default( type, default, ruby_default )
+        # Import column type and options.
 
-        opts[ :default ] = default unless default.nil?
+        type, opts = import_column_type_and_options( opts )
 
         # Deal with primary keys, which is a bit obscure because of the auto-increment handling.
 

data/lib/miguel/migrator.rb

@@ -111,7 +111,7 @@ module Miguel
     # Generate code for dropping given columns.
     def dump_drop_columns( out, columns )
       for column in columns
-        if column.type == :primary_key
+        if column.primary_key_constraint?
           out << "drop_constraint #{column.out_name}, :type => :primary_key#{column.out_opts(' # ')}"
         else
           out << "drop_column #{column.out_name} # #{column.out_type}#{column.out_opts}"
@@ -125,7 +125,7 @@ module Miguel
         if column.type == :primary_key
           out << "add_primary_key #{column.out_name}#{column.out_opts}"
         else
-          out << "add_column #{column.out_name}, #{column.out_type}#{column.out_opts}"
+          out << "add_column #{column.out_name}, #{column.out_type}#{column.out_default_opts}"
         end
       end
     end

data/lib/miguel/schema.rb

@@ -9,9 +9,12 @@ module Miguel
   # Class for defining database schema.
   class Schema
 
-    # String denoting zero time.
+    # String denoting zero time in MySQL.
     ZERO_TIME = '0000-00-00 00:00:00'.freeze
 
+    # String denoting default time.
+    DEFAULT_TIME = '2000-01-01 00:00:00'.freeze
+
     # Module for pretty printing of names, types, and especially options.
     module Output
 
@@ -45,6 +48,10 @@ module Miguel
         out_hash( canonic_opts, prefix )
       end
 
+      def out_default_opts( prefix = ', ' )
+        out_hash( default_opts, prefix )
+      end
+
       def out_name
         name.inspect
       end
@@ -81,6 +88,11 @@ module Miguel
         @opts = opts
       end
 
+      # Test if the column is in fact just a primary key constraint.
+      def primary_key_constraint?
+        type == :primary_key && name.is_a?( Array )
+      end
+
       # Get the column default.
       def default
         d = opts[ :default ]
@@ -159,7 +171,7 @@ module Miguel
 
       # Get the column options in a canonic way.
       def canonic_opts
-        return {} if type == :primary_key && name.is_a?( Array )
+        return {} if primary_key_constraint?
         o = { :type => canonic_type, :default => default, :null => true }
         o.merge!( DEFAULT_OPTS[ canonic_type ] || {} )
         o.merge!( opts )
@@ -167,6 +179,11 @@ module Miguel
         o.delete_if{ |key, value| IGNORED_OPTS.include? key }
       end
 
+      # Get options with default value included.
+      def default_opts
+        { :default => default }.merge( opts )
+      end
+
       # Compare one column with another one.
       def == other
         other.is_a?( Column ) &&
@@ -240,7 +257,7 @@ module Miguel
 
       # Options we ignore when comparing.
       # These are usually tied to the underlying column, not constraint.
-      IGNORED_OPTS = [ :null, :unsigned, :type ]
+      IGNORED_OPTS = [ :null, :unsigned, :type, :default ]
 
       # Get the foreign key options, in a canonic way.
       def canonic_opts
@@ -475,6 +492,7 @@ module Miguel
     # Also note that the defaults are applied in the instant the +table+ block is evaluated,
     # so it is eventually possible (though not necessarily recommended) to change them in between.
     def set_defaults( name, *args, &block )
+      clear_defaults( name )
       @aliases[ name ] = args.shift if args.first.is_a? Symbol
       @defaults[ name ] = args.pop if args.last.is_a? Hash
       @callbacks[ name ] = block
@@ -512,6 +530,7 @@ module Miguel
     #
     #   :unique, :index, :unique => true
     #
+    #   :Key, :integer, :unsigned => false
     #   :primary_key, :type => :integer, :unsigned => false
     #   :foreign_key, :key => :id, :type => :integer, :unsigned => false
     #
@@ -528,14 +547,17 @@ module Miguel
       # Unfortunately, :unsigned currently works only with :integer,
       # not the default :Integer, and :integer can't be specified for compound keys,
       # so we have to use the callback to set the type only at correct times.
+      # Furthermore, Postgres's autoincrementing serials only work with Integer,
+      # so we set the type only as long as the unsigned keys are not requested.
 
       unsigned_keys = !! opts[ :unsigned_keys ]
 
+      set_defaults :Key, :integer, :unsigned => unsigned_keys
       set_defaults :primary_key, :unsigned => unsigned_keys do |opts,args,table|
-        opts[ :type ] ||= :integer unless args.first.is_a? Array
+        opts[ :type ] ||= :integer unless args.first.is_a? Array or not opts[ :unsigned ]
       end
       set_defaults :foreign_key, :key => :id, :unsigned => unsigned_keys do |opts,args,table|
-        opts[ :type ] ||= :integer unless args.first.is_a? Array
+        opts[ :type ] ||= :integer unless args.first.is_a? Array or not opts[ :unsigned ]
       end
 
       # Save some typing for unique indexes.
@@ -557,7 +579,8 @@ module Miguel
       # we have to be careful to turn off the MySQL autoupdate behavior.
       # That's why we have to set defaults explicitly.
 
-      set_defaults :Time, :timestamp, :default => ZERO_TIME
+      default_time = opts[ :mysql_timestamps ] ? ZERO_TIME : DEFAULT_TIME
+      set_defaults :Time, :timestamp, :default => default_time
       set_defaults :Time?, :timestamp, :default => nil
 
       self

data/miguel.gemspec

@@ -4,7 +4,7 @@ require File.expand_path( '../lib/miguel/version', __FILE__ )
 
 Gem::Specification.new do |s|
   s.name        = 'miguel'
-  s.version     = Miguel::VERSION + '.pre4'
+  s.version     = Miguel::VERSION + '.pre5'
   s.summary     = 'Database migrator and migration generator for Sequel.'
   s.description = <<EOT
 This gem makes it easy to create and maintain an up-to-date database schema
@@ -22,6 +22,9 @@ EOT
   s.required_ruby_version = '>= 1.9.3'
   s.add_runtime_dependency 'sequel', '~> 4.0'
   s.add_development_dependency 'bacon', '~> 1.2'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
 end
 
 # EOF #

data/test/data/db.yml

@@ -0,0 +1,17 @@
+# Database configuration.
+
+development:
+  adapter: sqlite
+
+mysql:
+  adapter: mysql2
+  user: travis
+  password: ''
+  host: localhost
+  database: miguel_test
+  encoding: utf8
+
+postgres:
+  adapter: sqlite
+
+# EOF #

data/test/data/schema.rb

@@ -29,6 +29,7 @@ Miguel::Schema.define( use_defaults: false ) do
   set_defaults :Custom, :String, fixed: true, size: 3
 
   table :miguel_types do
+    Key :key
     String :string
     Text :text
     File :blob
@@ -74,8 +75,8 @@ Miguel::Schema.define( use_defaults: false ) do
   end
 
   table :compound do
-    Unsigned :a
-    Unsigned :b
+    Integer :a
+    Integer :b
     primary_key [:a, :b]
     foreign_key [:b, :a], :compound, key: [:a, :b]
     String :c

data/test/data/schema.txt

@@ -19,6 +19,7 @@ table :sequel_types do
   FalseClass :l
 end
 table :miguel_types do
+  integer :key, :null => false, :unsigned => false
   String :string, :null => false
   String :text, :null => false, :text => true
   File :blob, :null => false
@@ -29,7 +30,7 @@ table :miguel_types do
   TrueClass :bool, :null => false
   TrueClass :true, :null => false, :default => true
   TrueClass :false, :null => false, :default => false
-  timestamp :time, :null => false, :default => "0000-00-00 00:00:00"
+  timestamp :time, :null => false, :default => "2000-01-01 00:00:00"
   String :custom, :null => false, :fixed => true, :size => 3
 end
 table :native_types do
@@ -39,29 +40,29 @@ table :native_types do
   timestamp :timestamp, :null => false, :default => "1970-01-02 00:00:00"
 end
 table :timestamps do
-  timestamp :t1, :null => false, :default => "0000-00-00 00:00:00"
+  timestamp :t1, :null => false, :default => "2000-01-01 00:00:00"
   timestamp :t2, :null => true, :default => nil
-  timestamp :create_time, :null => false, :default => "0000-00-00 00:00:00"
-  timestamp :update_time, :null => false, :default => "0000-00-00 00:00:00"
+  timestamp :create_time, :null => false, :default => "2000-01-01 00:00:00"
+  timestamp :update_time, :null => false, :default => "2000-01-01 00:00:00"
 end
 table :users do
-  primary_key :id, :null => false, :unsigned => false, :type => :integer
+  primary_key :id, :null => false, :unsigned => false
   String :name, :null => false
   index [:name], :null => false, :unique => true
 end
 table :simple do
-  primary_key :id, :null => false, :unsigned => false, :type => :integer
-  integer :user_id, :null => false, :key => [:id], :unsigned => false, :type => :integer
+  primary_key :id, :null => false, :unsigned => false
+  integer :user_id, :null => false, :key => [:id], :unsigned => false
   index [:user_id], :null => false
-  foreign_key [:user_id], :users, :null => false, :key => [:id], :unsigned => false, :type => :integer
+  foreign_key [:user_id], :users, :null => false, :key => [:id], :unsigned => false
 end
 table :reuse do
-  primary_key :user_id, :null => false, :unsigned => false, :type => :integer
+  primary_key :user_id, :null => false, :unsigned => false
   foreign_key [:user_id], :users, :null => false, :key => [:id], :unsigned => false
 end
 table :compound do
-  integer :a, :null => false, :unsigned => true
-  integer :b, :null => false, :unsigned => true
+  Integer :a, :null => false
+  Integer :b, :null => false
   primary_key [:a, :b], :null => false, :unsigned => false
   String :c, :null => false
   integer :d, :null => false, :unsigned => false
@@ -82,8 +83,8 @@ table :null do
   TrueClass :true, :null => true, :default => true
   TrueClass :false, :null => true, :default => false
   timestamp :t, :null => true, :default => nil
-  integer :user_id, :null => true, :key => [:id], :unsigned => false, :type => :integer
-  foreign_key [:user_id], :users, :null => true, :key => [:id], :unsigned => false, :type => :integer
+  integer :user_id, :null => true, :key => [:id], :unsigned => false
+  foreign_key [:user_id], :users, :null => true, :key => [:id], :unsigned => false
 end
 table :defaults do
   String :string, :null => false, :default => "abc"
@@ -95,21 +96,21 @@ table :defaults do
   timestamp :time, :null => false, :default => "2037-12-31 23:59:59"
 end
 table :simple_users do
-  integer :user_id, :null => false, :key => [:id], :unsigned => false, :type => :integer
-  integer :simple_id, :null => false, :key => [:id], :unsigned => false, :type => :integer
+  integer :user_id, :null => false, :key => [:id], :unsigned => false
+  integer :simple_id, :null => false, :key => [:id], :unsigned => false
   primary_key [:user_id, :simple_id], :null => false, :unsigned => false
   index [:simple_id, :user_id], :null => false, :unique => true
-  foreign_key [:user_id], :users, :null => false, :key => [:id], :unsigned => false, :type => :integer
-  foreign_key [:simple_id], :simple, :null => false, :key => [:id], :unsigned => false, :type => :integer
+  foreign_key [:user_id], :users, :null => false, :key => [:id], :unsigned => false
+  foreign_key [:simple_id], :simple, :null => false, :key => [:id], :unsigned => false
 end
 table :self_join do
-  integer :left_id, :null => false, :key => [:id], :unsigned => false, :type => :integer
-  integer :right_id, :null => false, :key => [:id], :unsigned => false, :type => :integer
+  integer :left_id, :null => false, :key => [:id], :unsigned => false
+  integer :right_id, :null => false, :key => [:id], :unsigned => false
   primary_key [:left_id, :right_id], :null => false, :unsigned => false
-  timestamp :create_time, :null => false, :default => "0000-00-00 00:00:00"
-  timestamp :update_time, :null => false, :default => "0000-00-00 00:00:00"
+  timestamp :create_time, :null => false, :default => "2000-01-01 00:00:00"
+  timestamp :update_time, :null => false, :default => "2000-01-01 00:00:00"
   index [:right_id, :left_id], :null => false, :unique => true
   index [:create_time], :null => false
-  foreign_key [:left_id], :users, :null => false, :key => [:id], :unsigned => false, :type => :integer
-  foreign_key [:right_id], :users, :null => false, :key => [:id], :unsigned => false, :type => :integer
+  foreign_key [:left_id], :users, :null => false, :key => [:id], :unsigned => false
+  foreign_key [:right_id], :users, :null => false, :key => [:id], :unsigned => false
 end