declare_schema 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 741e1030227b2cd6e472d1f3cc9a8f3838c927b3702087428f01b2af09a7c758
-  data.tar.gz: 439d95f21fd5e8f677aea5c1ef4bb52fc37c8321b0066876f0970028e75a654a
+  metadata.gz: 2bace1c4f410e4766d4b9aa1414a5394414e8294db88ccd3d168d6db5d9802f6
+  data.tar.gz: da2b3467c656b0bad95b85627c341fb4d447872b144a452e3569a85a7369c452
 SHA512:
-  metadata.gz: b332745b815b6ac442158727c4d6ded6f320144f40b895ff4e303bd0e67a25d305fbed845ab3eedb9d49754078fff0f2b25b58f417fd42e00552b58b4bd67d1a
-  data.tar.gz: 600fb3635f8a65defcb0643501553e73befc7548da6a6821840b3a487c80e66a0933f51cbde7a83679a2ac2dc69f7f54e71aab2d878dd03b9742308cb0d845f5
+  metadata.gz: cf6eb2e6b67bd3071b9261a5d07eaa56dc019c148b02bbc11e70dd929934855e0b48a0c4c178d348286ec7bba4ed25f90c8041d855150c6b23c1aa81f26af25f
+  data.tar.gz: 3517a656b7b7edda5ed4164495747b0d879329d96bb44294f5b347acacc96a983e3cb6ab99fad8bf6e7b9fe998634ceb7cbd4ad79383164ab05ea6b273974c9f

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.12.1] - 2021-05-10
+### Fixed
+- When an `enum` type field is declared, there is now enforcement that its `limit:` must be an array of 1 or more Symbols,
+  and its `default:`--if given--must be a Symbol or `nil`.
+
 ## [0.12.0] - 2021-04-28
 ### Added
 - `belongs_to` now always infers the `limit:` of the foreign key to match that of the primary key it points to.
@@ -174,6 +179,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.12.1]: https://github.com/Invoca/declare_schema/compare/v0.12.0...v0.12.1
 [0.12.0]: https://github.com/Invoca/declare_schema/compare/v0.11.1...v0.12.0
 [0.11.1]: https://github.com/Invoca/declare_schema/compare/v0.11.0...v0.11.1
 [0.11.0]: https://github.com/Invoca/declare_schema/compare/v0.10.1...v0.11.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.12.0)
+    declare_schema (0.12.1)
       rails (>= 4.2)
 
 GEM

data/lib/declare_schema/model/field_spec.rb

@@ -76,12 +76,19 @@ module DeclareSchema
         when :bigint
           @type = :integer
           @options[:limit] = 8
+        when :enum
+          @options[:default].nil? || @options[:default].is_a?(Symbol) or
+            raise ArgumentError, "enum default: must be nil or a Symbol; got #{@options[:default].inspect}"
+          @options[:limit].is_a?(Array) && @options[:limit].size >= 1 && @options[:limit].all? { |value| value.is_a?(Symbol) } or
+            raise ArgumentError, "enum limit: must be an array of 1 or more Symbols; got #{@options[:limit].inspect}"
         end
 
         Column.native_type?(@type) or raise UnknownTypeError, "#{@type.inspect} not found in #{Column.native_types.inspect} for adapter #{ActiveRecord::Base.connection.class.name}"
 
-        if @type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
+        if @type.in?([:string, :text, :binary, :varbinary, :integer])
           @options[:limit] ||= Column.native_types.dig(@type, :limit)
+        elsif @type.in?([:enum])
+          # nothing to do
         else
           @type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@type} in field #{model}##{@name}")
           @options.delete(:limit)

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.12.0"
+  VERSION = "0.12.1"
 end

data/spec/lib/declare_schema/field_spec_spec.rb

@@ -115,6 +115,48 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
       end
     end
 
+    describe 'enum' do
+      before do
+        allow(::DeclareSchema::Model::Column).to receive(:native_types).and_wrap_original do |m, *_args|
+          result = m.call
+          if result.has_key?(:enum)
+            result
+          else
+            result.merge(enum: { name: "enum" })
+          end
+        end
+      end
+
+      describe 'default' do
+        it 'allows default of nil or a Symbol' do
+          [nil, :first].each do |default|
+            expect do
+              subject = described_class.new(model, :status, :enum, limit: [:first, :second, :third], default: default, null: false, position: 2)
+              expect(subject.default).to eq(default)
+            end.to_not raise_exception
+          end
+        end
+
+        it 'raises ArgumentError if default is not nil or a Symbol' do
+          ["first", 1].each do |default|
+            expect do
+              described_class.new(model, :status, :enum, limit: [:first, :second, :third], default: default, null: false, position: 2)
+            end.to raise_exception(ArgumentError, /enum default: must be nil or a Symbol; got #{Regexp.escape(default.inspect)}/)
+          end
+        end
+      end
+
+      describe 'limit' do
+        it 'raises ArgumentError if any of the limit values are not Symbols' do
+          [['first', 'second', 'third'], [1, 2, 3], nil, []].each do |limit|
+            expect do
+              described_class.new(model, :status, :enum, limit: limit, null: false, position: 2)
+            end.to raise_exception(ArgumentError, /enum limit: must be an array of 1 or more Symbols; got #{Regexp.escape(limit.inspect)}/)
+          end
+        end
+      end
+    end
+
     if defined?(Mysql2)
       describe 'varbinary' do # TODO: :varbinary is an Invoca addition to Rails; make it a configurable option
         it 'is supported' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails