declare_schema 0.12.1 → 0.13.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bace1c4f410e4766d4b9aa1414a5394414e8294db88ccd3d168d6db5d9802f6
-  data.tar.gz: da2b3467c656b0bad95b85627c341fb4d447872b144a452e3569a85a7369c452
+  metadata.gz: fef97a705f29e37659ade688c2c64b30f0df1eabc76ab47ceb1272f2eec10845
+  data.tar.gz: 3602d932b5bae67c6cfd367750e399d44ab65afa4fd19c4923ff5e447b79ca40
 SHA512:
-  metadata.gz: cf6eb2e6b67bd3071b9261a5d07eaa56dc019c148b02bbc11e70dd929934855e0b48a0c4c178d348286ec7bba4ed25f90c8041d855150c6b23c1aa81f26af25f
-  data.tar.gz: 3517a656b7b7edda5ed4164495747b0d879329d96bb44294f5b347acacc96a983e3cb6ab99fad8bf6e7b9fe998634ceb7cbd4ad79383164ab05ea6b273974c9f
+  metadata.gz: 770d10d283e399d3ca37537e7ed4c68d0dde1a6ba28e033148ed7ed86d0e0833256d0b2446688538ef34f39cac9c1fe535914824d4bf7e6de17d11554b876ec2
+  data.tar.gz: 134add2558ab3374d741e04839913257eb48e8b98d4b80a3bc3c35927369032fd9549d9a1dd2768c702386f44b4265c0379475cd01f8097288cad53b479a4ee9

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.13.0] - Unreleased
+### Added
+- Added support for `default_schema =` to apply a default schema to every model, unless disabld for that model with `declare_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,
@@ -179,6 +183,7 @@ 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.12.1)
+    declare_schema (0.13.0.pre.1)
       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,26 @@ 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
+```
+
 ### Global Configuration
 Configurations can be set at the global level to customize default declaration for the following values:
 

data/lib/declare_schema.rb

@@ -37,7 +37,7 @@ module DeclareSchema
 
   class << self
     attr_reader :default_charset, :default_collation, :default_text_limit, :default_string_limit, :default_null,
-                :default_generate_foreign_keys, :default_generate_indexing, :db_migrate_command
+                :default_generate_foreign_keys, :default_generate_indexing, :default_schema, :db_migrate_command
 
     def to_class(type)
       case type
@@ -85,6 +85,11 @@ module DeclareSchema
       @default_generate_indexing = generate_indexing
     end
 
+    def default_schema=(default_schema)
+      default_schema.nil? || default_schema.respond_to?(:call) or raise "default_schema must be nil or a block that responds to call"
+      @default_schema = default_schema
+    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/version.rb

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

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.default_schema = nil
+      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.1
+  version: 0.13.0.pre.1
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails