declare_schema 0.12.0.pre.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e55426213e7d15730b0531d3dba4036a4b18f3967b73a7619e60f27d15fc5b55
-  data.tar.gz: 294eef4ce49c912df24403ab59998e61641c681ea1e98fa6c9fa00d66a4c4502
+  metadata.gz: dc0328d501bd76426598e121bc75283089a2a1b7c72781ce9b29ae4e60f8dff2
+  data.tar.gz: a734efaadde7dae50ee1cf512a52858eabc7c7315e6b5dbf3a8f6660eda32da4
 SHA512:
-  metadata.gz: 3a3ebaa029176ff322a396baf65aaca878f631ae3ac0acad2a2290fc73275c56c312a00e1423219a30055f39ca17f1873a55f0d8be8a4dfeb38f821718c57128
-  data.tar.gz: 25d48b29e96b5508b52c07ca869221d506f05370a38af76994a33bbfcb67153f379b9605a60e9169876bebb63e6db5bf9acbf1f09aab900d03fc05be404cd643
+  metadata.gz: 697da828c1b2fe88048a4c66cccda205adc809d449361294fc4e0e0c69d229bb97ed8b861979ab85eed6c8bd30d5dd942ed2791b8ded632eb371f084215e56c8
+  data.tar.gz: 5ff7eb9bc51daba2f0544e093baf38e2b181b2631683d3e2548d2054c4da70036ed98cdc7223658c93f5cb9423a79081c67e600629e0441dd505b09b82039bc1

data/CHANGELOG.md

@@ -4,7 +4,16 @@ 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.0] - Unreleased
+## [0.13.0] - 2020-06-11
+### Added
+- Added support for `default_schema` block to apply a default schema to every model, unless disabled for that model with `default_schema: false`.
+
+## [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.
  Note: this isn't possible for polymorphic foreign keys, so it assumes `limit: 8` there...unless the schema
@@ -174,6 +183,8 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.13.0]: https://github.com/Invoca/declare_schema/compare/v0.12.1...v0.13.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.pre.2)
+    declare_schema (0.13.0)
       rails (>= 4.2)
 
 GEM

data/README.md

@@ -62,7 +62,7 @@ trigger the `eager_load!` on the `Rails` application and all `Rails::Engine`s lo
 into scope.  If you need to generate migrations for models that aren't automatically loaded by `eager_load!`,
 load them in the `before_generating_migration` block.
 
-**Example Configuration**
+For example:
 
 ```ruby
 DeclareSchema::Migration::Migrator.before_generating_migration do
@@ -70,6 +70,32 @@ DeclareSchema::Migration::Migrator.before_generating_migration do
 end
 ```
 
+### default_schema
+If there are default columns you would like in the schema for every model, you can define them in a block that is registered with
+`DeclareSchema.default_schema`. For example:
+
+```ruby
+DeclareSchema.default_schema do
+  timestamps
+  optimistic_lock
+end
+```
+This will add these fields to the schema of each model (if not already there).
+If you have a model where you don't want the defaults applied, that can be set with the `default_schema:` boolean option to `declare_schema` (the default value is true). For example:
+```ruby
+class User < ActiveRecord::Base
+  declare_schema default_schema: false do
+    ...
+  end
+end
+```
+
+### clear_default_schema
+This method clears out any previously declared `default_schema`.
+```ruby
+DeclareSchema.clear_default_schema
+```
+
 ### Global Configuration
 Configurations can be set at the global level to customize default declaration for the following values:
 

data/lib/declare_schema.rb

@@ -85,6 +85,19 @@ module DeclareSchema
       @default_generate_indexing = generate_indexing
     end
 
+    def default_schema(&block)
+      if block.nil?
+        @default_schema # equivalent to attr_reader :default_schema
+      else
+        block.respond_to?(:call) or raise "default_schema must be passed a block that responds to call"
+        @default_schema = block
+      end
+    end
+
+    def clear_default_schema
+      @default_schema = nil
+    end
+
     def db_migrate_command=(db_migrate_command)
       db_migrate_command.is_a?(String) or raise ArgumentError, "db_migrate_command must be a string (got #{db_migrate_command.inspect})"
       @db_migrate_command = db_migrate_command

data/lib/declare_schema/dsl.rb

@@ -7,7 +7,7 @@ module DeclareSchema
     include ::Kernel      # but we need the basic class methods
 
     instance_methods.each do |m|
-      unless m.to_s.starts_with?('__') || m.in?([:object_id, :instance_eval])
+      unless m.to_s.starts_with?('__') || m.in?([:object_id, :instance_eval, :instance_exec])
         undef_method(m)
       end
     end
@@ -32,8 +32,11 @@ module DeclareSchema
       @model.declare_field(name, type, *(args + [@options.merge(options)]))
     end
 
-    def method_missing(type, name, *args)
-      field(name, type, *args)
+    # TODO: make [:required] just another option. Either 'required: true] or 'optional: false'?
+    def method_missing(*args, **options)
+      args.count(&:itself) >= 2 or raise ::ArgumentError, "fields in declare_schema block must be declared as: type name, [:required], options (got #{args.inspect}, #{options.inspect})"
+      type, name, *required = args
+      field(name, type, *required, options)
     end
   end
 end

data/lib/declare_schema/extensions/active_record/fields_declaration.rb

@@ -27,7 +27,7 @@ module DeclareSchema
     end
     deprecate :fields, deprecator: ActiveSupport::Deprecation.new('1.0', 'DeclareSchema')
 
-    def declare_schema(table_options = {}, &block)
+    def declare_schema(default_schema: true, **table_options, &block)
       # Any model that calls 'fields' gets DeclareSchema::Model behavior
       DeclareSchema::Model.mix_in(self)
 
@@ -37,10 +37,9 @@ module DeclareSchema
 
       if block
         dsl = DeclareSchema::Dsl.new(self, null: false)
-        if block.arity == 1
-          yield dsl
-        else
-          dsl.instance_eval(&block)
+        dsl.instance_eval(&block)
+        if default_schema && DeclareSchema.default_schema
+          dsl.instance_exec(&DeclareSchema.default_schema)
         end
       end
     end

data/lib/declare_schema/model.rb

@@ -34,19 +34,16 @@ module DeclareSchema
           # supported options include :charset and :collation
           inheriting_cattr_reader table_options: HashWithIndifferentAccess.new
 
-          # eval avoids the ruby 1.9.2 "super from singleton method ..." error
-
-          eval <<~EOS
-            def self.inherited(klass)
-              unless klass.field_specs.has_key?(inheritance_column)
-                declare_schema do |f|
-                  f.field(inheritance_column, :string, limit: 255, null: true)
-                end
-                index(inheritance_column)
+          def self.inherited(klass)
+            unless klass.field_specs.has_key?(inheritance_column)
+              ic = inheritance_column
+              declare_schema do
+                field(ic, :string, limit: 255, null: true)
               end
-              super
+              index(ic)
             end
-          EOS
+            super
+          end
         end
       end
     end

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.pre.2"
+  VERSION = "0.13.0"
 end

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

@@ -343,16 +343,15 @@ module Generators
 
           db_columns = model.connection.columns(current_table_name).index_by(&:name)
           if (pk = model._declared_primary_key.presence)
-            key_was_in_db_columns = db_columns.delete(pk)
+            pk_was_in_db_columns = db_columns.delete(pk)
           end
 
           model_column_names = model.field_specs.keys.map(&:to_s)
           db_column_names = db_columns.keys.map(&:to_s)
 
           to_add = model_column_names - db_column_names
-          to_add << pk if pk && !key_was_in_db_columns
+          to_add << pk if pk && !pk_was_in_db_columns
           to_remove = db_column_names - model_column_names
-          to_remove -= [pk.to_sym] if pk    # TODO: The .to_sym here means this code is always a no-op, right? -Colin
 
           to_rename = extract_column_renames!(to_add, to_remove, new_table_name)
 

data/spec/lib/declare_schema/api_spec.rb

@@ -40,8 +40,6 @@ RSpec.describe 'DeclareSchema API' do
       load_models
 
       if ActiveSupport::VERSION::MAJOR == 5
-        # TODO: get this to work on Travis for Rails 6
-        # TODO: uncomment since we're not on Travis any more? -Colin
         generate_migrations '-n', '-m'
       end
 
@@ -50,8 +48,6 @@ RSpec.describe 'DeclareSchema API' do
 
       ## The Basics
 
-      # The main feature of DeclareSchema, aside from the migration generator, is the ability to declare rich types for your fields. For example, you can declare that a field is an email address, and the field will be automatically validated for correct email address syntax.
-
       ### Field Types
 
       # Field values are returned as the type you specify.

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

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -1860,6 +1860,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       class SuperFancyAdvert < FancyAdvert
       end
 
+      expect(Generators::DeclareSchema::Migration::Migrator.run.first).to be_present
+
       up, _ = Generators::DeclareSchema::Migration::Migrator.run do |migrations|
         expect(migrations).to(
           migrate_up(<<~EOS.strip)
@@ -2491,5 +2493,78 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         end
       end
     end
+
+    context 'default_schema' do
+      let(:default_schema_block) { nil }
+      let(:declare_model) do
+        -> do
+          class Advert < active_record_base_class.constantize
+            declare_schema do
+              integer :price, limit: 8
+            end
+          end
+        end
+      end
+
+      before do
+        DeclareSchema.default_schema(&default_schema_block)
+      end
+
+      after do
+        DeclareSchema.clear_default_schema
+      end
+
+      context 'when unset' do
+        it 'adds nothing' do
+          declare_model.call
+
+          expect(Advert.field_specs.keys).to eq(['price'])
+        end
+      end
+
+      context 'when set to a block' do
+        let(:default_schema_block) do
+          -> do
+            timestamps
+            field :lock_version, :integer, default: 1
+          end
+        end
+
+        it 'adds the fields in that block' do
+          declare_model.call
+
+          expect(Advert.field_specs.keys).to eq(['price', 'created_at', 'updated_at', 'lock_version'])
+        end
+
+        context 'and the model sets default_schema: false' do
+          before do
+            class Advert < active_record_base_class.constantize
+              declare_schema default_schema: false do
+                integer :price, limit: 8
+              end
+            end
+          end
+
+          it 'does not add the default schema fields' do
+            expect(Advert.field_specs.keys).to eq(['price'])
+          end
+        end
+
+        context 'and the block has redundant fields' do
+          before do
+            class Advert < active_record_base_class.constantize
+              declare_schema do
+                integer :price, limit: 8
+                timestamps
+              end
+            end
+          end
+
+          it 'is a no-op' do
+            expect(Advert.field_specs.keys).to eq(['price', 'created_at', 'updated_at', 'lock_version'])
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.12.0.pre.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails