declare_schema 0.6.4 → 0.7.0

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -47,6 +47,13 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       ", id: :integer" unless Rails::VERSION::MAJOR < 5
     end
   end
+  let(:lock_version_limit) do
+    if defined?(Mysql2)
+      ", limit: 4"
+    else
+      ''
+    end
+  end
 
   # DeclareSchema - Migration Generator
   it 'generates migrations' do
@@ -74,7 +81,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       expect(migrations).to(
         migrate_up(<<~EOS.strip)
           create_table :adverts, id: :bigint do |t|
-            t.string :name, limit: 250#{charset_and_collation}
+            t.string :name, limit: 250, null: true#{charset_and_collation}
           end#{charset_alter_table}
         EOS
         .and migrate_down("drop_table :adverts")
@@ -107,8 +114,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(migrate).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :body, :text#{text_limit}#{charset_and_collation}
-        add_column :adverts, :published_at, :datetime
+        add_column :adverts, :body, :text#{text_limit}, null: true#{charset_and_collation}
+        add_column :adverts, :published_at, :datetime, null: true
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :body
@@ -126,7 +133,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(migrate).to(
       migrate_up("remove_column :adverts, :published_at").and(
-        migrate_down("add_column :adverts, :published_at, :datetime#{datetime_precision}")
+        migrate_down("add_column :adverts, :published_at, :datetime#{datetime_precision}, null: true")
       )
     )
 
@@ -140,12 +147,12 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
         remove_column :adverts, :name
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :title
-        add_column :adverts, :name, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :name, :string, limit: 250, null: true#{charset_and_collation}
       EOS
     )
 
@@ -165,8 +172,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     end
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
-      migrate_up("change_column :adverts, :title, :text#{text_limit}#{charset_and_collation}").and(
-        migrate_down("change_column :adverts, :title, :string, limit: 250#{charset_and_collation}")
+      migrate_up("change_column :adverts, :title, :text#{text_limit}, null: true#{charset_and_collation}").and(
+        migrate_down("change_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}")
       )
     )
 
@@ -179,10 +186,10 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(migrate).to(
       migrate_up(<<~EOS.strip)
-        change_column :adverts, :title, :string, limit: 250, default: "Untitled"#{charset_and_collation}
+        change_column :adverts, :title, :string, limit: 250, null: true, default: "Untitled"#{charset_and_collation}
       EOS
       .and migrate_down(<<~EOS.strip)
-        change_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        change_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
       EOS
     )
 
@@ -195,7 +202,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     end
 
     up, _ = Generators::DeclareSchema::Migration::Migrator.run.tap do |migrations|
-      expect(migrations).to migrate_up("add_column :adverts, :price, :integer, limit: 2")
+      expect(migrations).to migrate_up("add_column :adverts, :price, :integer, limit: 2, null: true")
     end
 
     # Now run the migration, then change the limit:
@@ -209,24 +216,20 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        change_column :adverts, :price, :integer, limit: 3
+        change_column :adverts, :price, :integer, limit: 3, null: true
       EOS
       .and migrate_down(<<~EOS.strip)
-        change_column :adverts, :price, :integer, limit: 2
+        change_column :adverts, :price, :integer, limit: 2, null: true
       EOS
     )
 
-    # Note that limit on a decimal column is ignored (use :scale and :precision)
-
     ActiveRecord::Migration.class_eval("remove_column :adverts, :price")
     class Advert < ActiveRecord::Base
       fields do
-        price :decimal, null: true, limit: 4
+        price :decimal, precision: 4, scale: 1, null: true
       end
     end
 
-    expect(Generators::DeclareSchema::Migration::Migrator.run).to migrate_up("add_column :adverts, :price, :decimal")
-
     # Limits are generally not needed for `text` fields, because by default, `text` fields will use the maximum size
     # allowed for that database type (0xffffffff for LONGTEXT in MySQL unlimited in Postgres, 1 billion in Sqlite).
     # If a `limit` is given, it will only be used in MySQL, to choose the smallest TEXT field that will accommodate
@@ -245,9 +248,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :price, :decimal
-        add_column :adverts, :notes, :text, null: false#{text_limit}#{charset_and_collation}
-        add_column :adverts, :description, :text, null: false#{', limit: 65535' if defined?(Mysql2)}#{charset_and_collation}
+        add_column :adverts, :price, :decimal, precision: 4, scale: 1, null: true
+        add_column :adverts, :notes, :text#{text_limit}, null: false#{charset_and_collation}
+        add_column :adverts, :description, :text#{', limit: 65535' if defined?(Mysql2)}, null: false#{charset_and_collation}
       EOS
     )
 
@@ -269,8 +272,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
       expect(Generators::DeclareSchema::Migration::Migrator.run).to(
         migrate_up(<<~EOS.strip)
-          add_column :adverts, :notes, :text, null: false, limit: 4294967295#{charset_and_collation}
-          add_column :adverts, :description, :text, null: false, limit: 255#{charset_and_collation}
+          add_column :adverts, :notes, :text, limit: 4294967295, null: false#{charset_and_collation}
+          add_column :adverts, :description, :text, limit: 255, null: false#{charset_and_collation}
         EOS
       )
 
@@ -313,7 +316,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
           change_column :adverts, :description, :text, limit: 4294967295, null: false#{charset_and_collation}
         EOS
         .and migrate_down(<<~EOS.strip)
-          change_column :adverts, :description, :text#{', limit: 255' if defined?(Mysql2)}#{charset_and_collation}
+          change_column :adverts, :description, :text#{', limit: 255' if defined?(Mysql2)}, null: true#{charset_and_collation}
         EOS
       )
 
@@ -330,7 +333,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
           change_column :adverts, :description, :text, limit: 4294967295, null: false#{charset_and_collation}
         EOS
         .and migrate_down(<<~EOS.strip)
-          change_column :adverts, :description, :text#{', limit: 255' if defined?(Mysql2)}#{charset_and_collation}
+          change_column :adverts, :description, :text#{', limit: 255' if defined?(Mysql2)}, null: true#{charset_and_collation}
         EOS
       )
     end
@@ -461,9 +464,9 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :created_at, :datetime
-        add_column :adverts, :updated_at, :datetime
-        add_column :adverts, :lock_version, :integer, null: false, default: 1
+        add_column :adverts, :created_at, :datetime, null: true
+        add_column :adverts, :updated_at, :datetime, null: true
+        add_column :adverts, :lock_version, :integer#{lock_version_limit}, null: false, default: 1
 
         #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
           "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
@@ -494,7 +497,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
 
         add_index :adverts, [:title], name: 'on_title'
 
@@ -515,7 +518,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
 
         add_index :adverts, [:title], unique: true, name: 'on_title'
 
@@ -536,7 +539,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
 
         add_index :adverts, [:title], name: 'my_index'
 
@@ -555,7 +558,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
 
         add_index :adverts, [:title], name: 'on_title'
 
@@ -574,7 +577,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
 
         add_index :adverts, [:title], unique: true, name: 'my_index'
 
@@ -593,7 +596,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
     expect(Generators::DeclareSchema::Migration::Migrator.run).to(
       migrate_up(<<~EOS.strip)
-        add_column :adverts, :title, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :title, :string, limit: 250, null: true#{charset_and_collation}
 
         add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
 
@@ -627,8 +630,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       migrate_up(<<~EOS.strip)
         rename_table :adverts, :ads
 
-        add_column :ads, :title, :string, limit: 250#{charset_and_collation}
-        add_column :ads, :body, :text#{', limit: 4294967295' if defined?(Mysql2)}#{charset_and_collation}
+        add_column :ads, :title, :string, limit: 250, null: true#{charset_and_collation}
+        add_column :ads, :body, :text#{', limit: 4294967295' if defined?(Mysql2)}, null: true#{charset_and_collation}
 
         #{if defined?(SQLite3)
             "add_index :ads, [:id], unique: true, name: 'PRIMARY'\n"
@@ -681,8 +684,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       migrate_up(<<~EOS.strip)
         rename_table :adverts, :advertisements
 
-        add_column :advertisements, :title, :string, limit: 250#{charset_and_collation}
-        add_column :advertisements, :body, :text#{', limit: 4294967295' if defined?(Mysql2)}#{charset_and_collation}
+        add_column :advertisements, :title, :string, limit: 250, null: true#{charset_and_collation}
+        add_column :advertisements, :body, :text#{', limit: 4294967295' if defined?(Mysql2)}, null: true#{charset_and_collation}
         remove_column :advertisements, :name
 
         #{if defined?(SQLite3)
@@ -694,7 +697,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       .and migrate_down(<<~EOS.strip)
         remove_column :advertisements, :title
         remove_column :advertisements, :body
-        add_column :adverts, :name, :string, limit: 250#{charset_and_collation}
+        add_column :adverts, :name, :string, limit: 250, null: true#{charset_and_collation}
 
         rename_table :advertisements, :adverts
 
@@ -748,7 +751,7 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     up, _ = Generators::DeclareSchema::Migration::Migrator.run do |migrations|
       expect(migrations).to(
         migrate_up(<<~EOS.strip)
-          add_column :adverts, :type, :string, limit: 250#{charset_and_collation}
+          add_column :adverts, :type, :string, limit: 250, null: true#{charset_and_collation}
 
           add_index :adverts, [:type], name: 'on_type'
         EOS
@@ -795,11 +798,11 @@ RSpec.describe 'DeclareSchema Migration Generator' do
     expect(Generators::DeclareSchema::Migration::Migrator.run(adverts: { title: :name })).to(
       migrate_up(<<~EOS.strip)
         rename_column :adverts, :title, :name
-        change_column :adverts, :name, :string, limit: 250, default: "No Name"#{charset_and_collation}
+        change_column :adverts, :name, :string, limit: 250, null: true, default: "No Name"#{charset_and_collation}
       EOS
       .and migrate_down(<<~EOS.strip)
         rename_column :adverts, :name, :title
-        change_column :adverts, :title, :string, limit: 250, default: "Untitled"#{charset_and_collation}
+        change_column :adverts, :title, :string, limit: 250, null: true, default: "Untitled"#{charset_and_collation}
       EOS
     )
 

data/spec/lib/declare_schema/model/column_spec.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+begin
+  require 'mysql2'
+rescue LoadError
+end
+
+require_relative '../../../../lib/declare_schema/model/column'
+
+RSpec.describe DeclareSchema::Model::Column do
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+  end
+
+  describe 'class methods' do
+    describe '.native_type?' do
+      if Rails::VERSION::MAJOR >= 5
+        let(:native_types) { [:string, :text, :integer, :float, :decimal, :datetime, :time, :date, :binary, :boolean, :json] }
+      else
+        let(:native_types) { [:string, :text, :integer, :float, :decimal, :datetime, :time, :date, :binary, :boolean] }
+      end
+
+      it 'is falsey for :primary_key' do
+        expect(described_class.native_type?(:primary_key)).to be_falsey
+      end
+
+      it 'is truthy for native types' do
+        native_types.each do |type|
+          expect(described_class.native_type?(type)).to be_truthy, type.inspect
+        end
+      end
+
+      it 'is falsey for other types' do
+        [:email, :url].each do |type|
+          expect(described_class.native_type?(type)).to be_falsey
+        end
+      end
+    end
+
+    describe '.native_types' do
+      subject { described_class.native_types }
+
+      it 'returns the native type for :primary_key' do
+        expect(subject[:primary_key]).to match(/auto_increment PRIMARY KEY|PRIMARY KEY AUTOINCREMENT NOT NULL/)
+      end
+
+      it 'returns the native type for :string' do
+        expect(subject.dig(:string, :name)).to eq('varchar')
+      end
+
+      it 'returns the native type for :integer' do
+        expect(subject.dig(:integer, :name)).to match(/int/)
+      end
+
+      it 'returns the native type for :datetime' do
+        expect(subject.dig(:datetime, :name)).to eq('datetime')
+      end
+    end
+
+    describe '.sql_type' do
+      it 'returns the sql type for :string' do
+        expect(described_class.sql_type(:string)).to eq(:string)
+      end
+
+      it 'returns the sql type for :integer' do
+        expect(described_class.sql_type(:integer)).to match(:integer)
+      end
+
+      it 'returns the sql type for :datetime' do
+        expect(described_class.sql_type(:datetime)).to eq(:datetime)
+      end
+
+      it 'raises UnknownSqlType' do
+        expect do
+          described_class.sql_type(:email)
+        end.to raise_exception(::DeclareSchema::UnknownSqlTypeError, /:email for type :email/)
+      end
+    end
+
+    describe '.deserialize_default_value' do
+      require 'rails'
+
+      if ::Rails::VERSION::MAJOR >= 5
+        it 'deserializes :boolean' do
+          expect(described_class.deserialize_default_value(nil, :boolean, 'true')).to eq(true)
+          expect(described_class.deserialize_default_value(nil, :boolean, 'false')).to eq(false)
+        end
+
+        it 'deserializes :integer' do
+          expect(described_class.deserialize_default_value(nil, :integer, '12')).to eq(12)
+        end
+
+        it 'deserializes :json' do
+          expect(described_class.deserialize_default_value(nil, :json, '{}')).to eq({})
+        end
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    before do
+      class ColumnTestModel < ActiveRecord::Base
+        fields do
+          title :string, limit: 127, null: false
+          count :integer, null: false
+        end
+      end
+    end
+    let(:model) { ColumnTestModel }
+    let(:current_table_name) { model.table_name }
+    let(:column) { double("ActiveRecord Column",
+                          name: 'count',
+                          type: :integer,
+                          limit: nil,
+                          precision: nil,
+                          scale: nil,
+                          type_cast_from_database: nil,
+                          null: false,
+                          default: nil,
+                          sql_type_metadata: {}) }
+    subject { described_class.new(model, current_table_name, column) }
+
+    describe '#sql_type' do
+      it 'returns sql type' do
+        expect(subject.sql_type).to match(/int/)
+      end
+    end
+
+    describe '#schema_attributes' do
+      it 'returns a hash with relevant key/values' do
+        if defined?(Mysql2)
+          expect(subject.schema_attributes).to eq(type: :integer, null: false, limit: 4)
+        else
+          expect(subject.schema_attributes).to eq(type: :integer, null: false)
+        end
+      end
+    end
+  end
+end

data/spec/lib/generators/declare_schema/migration/migrator_spec.rb

@@ -18,17 +18,8 @@ module Generators
         subject { described_class.new }
 
         describe 'format_options' do
-          let(:mysql_longtext_limit) { 0xffff_ffff }
-          let(:limit_option) do
-            if defined?(Mysql2)
-              ["limit: #{mysql_longtext_limit}"]
-            else
-              []
-            end
-          end
-
-          it 'returns text limits if supported' do
-            expect(subject.format_options({ limit: mysql_longtext_limit }, :text)).to eq(limit_option)
+          it 'returns an array of option .inspect strings, with symbols using the modern : hash notation' do
+            expect(subject.format_options({ limit: 4, 'key' => 'value "quoted"' })).to eq(["limit: 4", '"key" => "value \"quoted\""'])
           end
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,6 +61,7 @@ files:
 - lib/declare_schema/extensions/module.rb
 - lib/declare_schema/field_declaration_dsl.rb
 - lib/declare_schema/model.rb
+- lib/declare_schema/model/column.rb
 - lib/declare_schema/model/field_spec.rb
 - lib/declare_schema/model/foreign_key_definition.rb
 - lib/declare_schema/model/index_definition.rb
@@ -82,6 +83,7 @@ files:
 - spec/lib/declare_schema/generator_spec.rb
 - spec/lib/declare_schema/interactive_primary_key_spec.rb
 - spec/lib/declare_schema/migration_generator_spec.rb
+- spec/lib/declare_schema/model/column_spec.rb
 - spec/lib/declare_schema/model/foreign_key_definition_spec.rb
 - spec/lib/declare_schema/model/index_definition_spec.rb
 - spec/lib/declare_schema/model/table_options_definition_spec.rb