declare_schema 0.7.1 → 0.8.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6317ef2d7c038120278bbff6547c042a3418369d1e0bd8527f10ab57d58aef62
-  data.tar.gz: 66ce3ad03f6fde8365b287deb682d85b4fd7e983d283447af769aed0ade61571
+  metadata.gz: 63c52c12c292be619b08901eb088c9957e8bfbc9708d087faa9d418704524175
+  data.tar.gz: 5a12e3d6cc67914e6b8c8739c17d89e2ea7886212f2abd90bd372f57fab808af
 SHA512:
-  metadata.gz: 1a87ecf0479b94324f43c42d309f254e8a3ca10f3766cc90a756b94505cb559406871eee47a58fa376640ad85acda3e81d771cb03ab92dc08f5253d81bd88079
-  data.tar.gz: 4cd449cb9543819dd78e51267357f676a7439c89f2ad021f59a5d0f49664a8c8b8141eeebde4184e3eaf1f3f616dfef8a7092f59cc6382c73504de5ffeb41dc3
+  metadata.gz: e33ae65cdfcb5fc56c24b4d62804ba28c77b29efc0a7659b45660c953f6310ae90b8b42a8d51f9f5331592e511ec33d56ff0f7b691dcb7aa8f299a5f7d523f22
+  data.tar.gz: 688ca01165e655ab6ff309f82ba336530bb44d695ac90de049cabc730850c7059c8789ef95bafbc02059b6329b4212d0e2ab726034b9c71d814a51fdaca02501

data/CHANGELOG.md

@@ -4,6 +4,11 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - UNRELEASED
+### Removed
+- Removed `sql_type` that was confusing because it was actually the same as `type` (ex: :string) and not
+  in fact the SQL type (ex: ``varchar(255)'`).
+
 ## [0.7.1] - 2021-02-17
 ### Fixed
 - Exclude unknown options from FieldSpec#sql_options and #schema_attributes.
@@ -125,6 +130,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.8.0]: https://github.com/Invoca/declare_schema/compare/v0.7.1...v0.8.0
 [0.7.1]: https://github.com/Invoca/declare_schema/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/Invoca/declare_schema/compare/v0.6.3...v0.7.0
 [0.6.4]: https://github.com/Invoca/declare_schema/compare/v0.6.3...v0.6.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.7.1)
+    declare_schema (0.8.0.pre.1)
       rails (>= 4.2)
 
 GEM

data/lib/declare_schema/model/column.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  class UnknownSqlTypeError < RuntimeError; end
+  class UnknownTypeError < RuntimeError; end
 
   module Model
     # This class is a wrapper for the ActiveRecord::...::Column class
     class Column
       class << self
         def native_type?(type)
-          type != :primary_key && native_types.has_key?(type)
+          type != :primary_key && native_types[type]
         end
 
         # MySQL example:
@@ -48,27 +48,17 @@ module DeclareSchema
           end
         end
 
-        def sql_type(type)
-          if native_type?(type)
-            type
-          else
-            if (field_class = DeclareSchema.to_class(type))
-              field_class::COLUMN_TYPE
-            end or raise UnknownSqlTypeError, "#{type.inspect} for type #{type.inspect}"
-          end
-        end
-
-        def deserialize_default_value(column, sql_type, default_value)
-          sql_type or raise ArgumentError, "must pass sql_type; got #{sql_type.inspect}"
+        def deserialize_default_value(column, type, default_value)
+          type or raise ArgumentError, "must pass type; got #{type.inspect}"
 
           case Rails::VERSION::MAJOR
           when 4
             # TODO: Delete this Rails 4 support ASAP! This could be wrong, since it's using the type of the old column...which
-            # might be getting migrated to a new type. We should be using just sql_type as below. -Colin
+            # might be getting migrated to a new type. We should be using just type as below. -Colin
             column.type_cast_from_database(default_value)
           else
-            cast_type = ActiveRecord::Base.connection.send(:lookup_cast_type, sql_type) or
-              raise "cast_type not found for #{sql_type}"
+            cast_type = ActiveRecord::Base.connection.send(:lookup_cast_type, type) or
+              raise "cast_type not found for #{type}"
             cast_type.deserialize(default_value)
           end
         end
@@ -103,13 +93,14 @@ module DeclareSchema
         end
       end
 
-      attr_reader :sql_type
+      attr_reader :type
 
       def initialize(model, current_table_name, column)
         @model = model or raise ArgumentError, "must pass model"
         @current_table_name = current_table_name or raise ArgumentError, "must pass current_table_name"
         @column = column or raise ArgumentError, "must pass column"
-        @sql_type = self.class.sql_type(@column.type)
+        @type = @column.type
+        self.class.native_type?(@type) or raise UnknownTypeError, "#{@type.inspect}"
       end
 
       SCHEMA_KEYS = [:type, :limit, :precision, :scale, :null, :default].freeze
@@ -120,7 +111,7 @@ module DeclareSchema
           value =
             case key
             when :default
-              self.class.deserialize_default_value(@column, @sql_type, @column.default)
+              self.class.deserialize_default_value(@column, @type, @column.default)
             else
               col_value = @column.send(key)
               if col_value.nil? && (native_type = self.class.native_types[@column.type])

data/lib/declare_schema/model/field_spec.rb

@@ -33,7 +33,7 @@ module DeclareSchema
         end
       end
 
-      attr_reader :model, :name, :type, :sql_type, :position, :options, :sql_options
+      attr_reader :model, :name, :type, :position, :options, :sql_options
 
       TYPE_SYNONYMS = { timestamp: :datetime }.freeze # TODO: drop this synonym. -Colin
 
@@ -62,13 +62,13 @@ module DeclareSchema
 
         @options.has_key?(:null) or @options[:null] = false
 
-        case type
+        case @type
         when :text
           if self.class.mysql_text_limits?
             @options[:default].nil? or raise MysqlTextMayNotHaveDefault, "when using MySQL, non-nil default may not be given for :text field #{model}##{@name}"
             @options[:limit] = self.class.round_up_mysql_text_limit(@options[:limit] || MYSQL_LONGTEXT_LIMIT)
           else
-            @options[:limit] = nil
+            @options.delete(:limit)
           end
         when :string
           @options[:limit] or raise "limit: must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want `limit: 255`?"
@@ -77,24 +77,23 @@ module DeclareSchema
           @options[:limit] = 8
         end
 
-        # TODO: Do we really need to support a :sql_type option? Ideally, drop it. -Colin
-        @sql_type = @options.delete(:sql_type) || Column.sql_type(@type)
+        Column.native_type?(@type) or raise UnknownTypeError, "#{@type.inspect}"
 
-        if @sql_type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
-          @options[:limit] ||= Column.native_types[@sql_type][:limit]
+        if @type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
+          @options[:limit] ||= Column.native_types[@type][:limit]
         else
-          @sql_type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@sql_type} in field #{model}##{@name}")
+          @type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@type} in field #{model}##{@name}")
           @options.delete(:limit)
         end
 
-        if @sql_type == :decimal
+        if @type == :decimal
           @options[:precision] or warn("precision: required for :decimal type in field #{model}##{@name}")
           @options[:scale] or warn("scale: required for :decimal type in field #{model}##{@name}")
         else
-          if @sql_type != :datetime
-            @options.has_key?(:precision) and warn("precision: only allowed for :decimal type or :datetime for SQL type #{@sql_type} in field #{model}##{@name}")
+          if @type != :datetime
+            @options.has_key?(:precision) and warn("precision: only allowed for :decimal type or :datetime for SQL type #{@type} in field #{model}##{@name}")
           end
-          @options.has_key?(:scale) and warn("scale: only allowed for :decimal type for SQL type #{@sql_type} in field #{model}##{@name}")
+          @options.has_key?(:scale) and warn("scale: only allowed for :decimal type for SQL type #{@type} in field #{model}##{@name}")
         end
 
         if @type.in?([:text, :string])
@@ -106,8 +105,8 @@ module DeclareSchema
             @options.delete(:collation)
           end
         else
-          @options[:charset]   and warn("charset may only given for :string and :text fields for SQL type #{@sql_type} in field #{model}##{@name}")
-          @options[:collation] and warne("collation may only given for :string and :text fields for SQL type #{@sql_type} in field #{model}##{@name}")
+          @options[:charset]   and warn("charset may only given for :string and :text fields for SQL type #{@type} in field #{model}##{@name}")
+          @options[:collation] and warne("collation may only given for :string and :text fields for SQL type #{@type} in field #{model}##{@name}")
         end
 
         @options = Hash[@options.sort_by { |k, _v| OPTION_INDEXES[k] || 9999 }]
@@ -120,7 +119,7 @@ module DeclareSchema
       # omits keys with nil values
       def schema_attributes(col_spec)
         @sql_options.merge(type: @type).tap do |attrs|
-          attrs[:default] = Column.deserialize_default_value(col_spec, @sql_type, attrs[:default])
+          attrs[:default] = Column.deserialize_default_value(col_spec, @type, attrs[:default])
         end.compact
       end
     end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.7.1"
+  VERSION = "0.8.0.pre.1"
 end

data/lib/generators/declare_schema/migration/migration_generator.rb

@@ -96,7 +96,7 @@ module DeclareSchema
           end
         end
       end
-    rescue ::DeclareSchema::UnknownSqlTypeError => ex
+    rescue ::DeclareSchema::UnknownTypeError => ex
       say "Invalid field type: #{ex}"
     end
 

data/lib/generators/declare_schema/migration/migrator.rb

@@ -328,7 +328,7 @@ module Generators
         end
 
         def create_table(model)
-          longest_field_name       = model.field_specs.values.map { |f| f.sql_type.to_s.length }.max
+          longest_field_name       = model.field_specs.values.map { |f| f.type.to_s.length }.max
           disable_auto_increment   = model.respond_to?(:disable_auto_increment) && model.disable_auto_increment
           table_options_definition = ::DeclareSchema::Model::TableOptionsDefinition.new(model.table_name, table_options_for_model(model))
           field_definitions        = [
@@ -379,7 +379,7 @@ module Generators
         def create_field(field_spec, field_name_width)
           options = field_spec.sql_options.merge(fk_field_options(field_spec.model, field_spec.name))
           args = [field_spec.name.inspect] + format_options(options.compact)
-          format("t.%-*s %s", field_name_width, field_spec.sql_type, args.join(', '))
+          format("t.%-*s %s", field_name_width, field_spec.type, args.join(', '))
         end
 
         def change_table(model, current_table_name)
@@ -417,7 +417,7 @@ module Generators
             args =
               if (spec = model.field_specs[c])
                 options = spec.sql_options.merge(fk_field_options(model, c))
-                [":#{spec.sql_type}", *format_options(options.compact)]
+                [":#{spec.type}", *format_options(options.compact)]
               else
                 [":integer"]
               end

data/spec/lib/declare_schema/field_spec_spec.rb

@@ -7,7 +7,7 @@ end
 
 RSpec.describe DeclareSchema::Model::FieldSpec do
   let(:model) { double('model', table_options: {}) }
-  let(:col_spec) { double('col_spec', sql_type: 'varchar') }
+  let(:col_spec) { double('col_spec', type: :string) }
 
   before do
     load File.expand_path('prepare_testapp.rb', __dir__)
@@ -127,7 +127,7 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
     end
 
     describe 'default:' do
-      let(:col_spec) { double('col_spec', sql_type: :integer) }
+      let(:col_spec) { double('col_spec', type: :integer) }
 
       it 'typecasts default value' do
         allow(col_spec).to receive(:type_cast_from_database) { |default| Integer(default) }

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

@@ -59,26 +59,6 @@ RSpec.describe DeclareSchema::Model::Column do
       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'
 
@@ -109,10 +89,11 @@ RSpec.describe DeclareSchema::Model::Column do
       end
     end
     let(:model) { ColumnTestModel }
+    let(:type) { :integer }
     let(:current_table_name) { model.table_name }
     let(:column) { double("ActiveRecord Column",
                           name: 'count',
-                          type: :integer,
+                          type: type,
                           limit: nil,
                           precision: nil,
                           scale: nil,
@@ -122,9 +103,9 @@ RSpec.describe DeclareSchema::Model::Column do
                           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/)
+    describe '#type' do
+      it 'returns type' do
+        expect(subject.type).to eq(type)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0.pre.1
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke