declare_schema 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae6f3f47d3ad4fa0b1d2e30d8f34b7ac5825b690838492ac57846dcd53396e9a
-  data.tar.gz: 129d77729c08d2fb41e506571ead2a82dd76c0c1675c18556bc3811e0adf3362
+  metadata.gz: 516d119d979224ddbe841b2dd5117fc5891b5c79e09261443c7df6f3c2335910
+  data.tar.gz: 32621c93b56814f9a8dd30b2d622d2c6a4c536cdc40b2145d078134252e14401
 SHA512:
-  metadata.gz: 5b145fdd60646c467772034afa2a29e30d29a4d35445c7e769bab731c043cb38c8e0b365ac7f6dc416e93fafdc1edd6e77724085054a6a442934cc191e335fdf
-  data.tar.gz: 1356d29f00f1eb4a72b567c48c57c6683bcc56852dfb68a3252b521a74c6c0afcfdf5765d94a31d3322ee297465c3ca60ec611090cf3ad5dd935e2bc343285ed
+  metadata.gz: 912c885f9fea463bae49937b6cb85ba6f7ab8cd4739327e6c662eb7b3cece701e1d42be9f251b97ba4a7b544eddd2a854a99ad8992d4a1fa5563acfd81cff989
+  data.tar.gz: 7429b27a56a0cfc27f8af16216528ee7137e5f9d0f20301f5c6177decc816c09b663bf78e5ea22d955b03ed58a7a103663980ec08ab14bb2d27f6d6ccb581787

data/.github/workflows/declare_schema_build.yml

@@ -57,4 +57,4 @@ jobs:
           git config --global user.email "dummy@example.com"
           git config --global user.name "dummy"
           MYSQL_PORT=3306 bundle exec rake test:prepare_testapp[force]
-          bundle exec rake test:all < test_responses.txt
+          bundle exec rake test:all

data/CHANGELOG.md

@@ -4,6 +4,39 @@ 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.11.0] - 2021-03-22
+### Removed
+- Removed `g|m|c` prompt entirely, since it was confusing. Instead, the migration is
+ always generated; the user may press ^C at the filename prompt to cancel.
+ The migration will be run if `--migrate` is passed; otherwise, the migrate command will be displayed to be run later.
+### Added
+- Added the new configuration option `DeclareSchema.@db_migrate_command =`.
+### Fixed 
+- Fixed bug where foreign key constraint names are not globally unique
+
+## [0.10.1] - 2021-03-18
+### Fixed
+- Migration steps are now generated in a defined dependency order, so that--for example--indexes that depend
+ on columns are deleted first, before the columns themselves are deleted (since the latter implicitly does the former, which would break the migration when run).
+- Related to the above, down migration steps are now always generated in exactly the reverse order of the up migration steps.
+
+## [0.10.0] - 2021-03-17
+### Deprecated
+- Deprecated the `fields` DSL method in favor of `declare_schema`.
+
+### Added
+- Added the `declare_schema` method to replace `fields`. We now expect a column's type to come before the name
+i.e. `declare schema { string :title }`. Otherwise, there is no difference between `fields` and `declare_schema`.
+
+## [0.9.0] - 2021-03-01
+### Added
+- Added configurable default settings for `default_text_limit`, `default_string_limit`, `default_null`,
+`default_generate_foreign_keys` and `default_generate_indexing` to allow developers to adhere to project conventions.
+
+### Changed
+- Moved and deprecated default settings for `default_charset` and `default_collation` from
+`Generators::DeclareSchema::Migration::Migrator` to `::DeclareSchema`
+
 ## [0.8.0] - 2021-02-22
 ### Removed
 - Removed assumption that primary key is named 'id'.
@@ -131,6 +164,10 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.11.0]: https://github.com/Invoca/declare_schema/compare/v0.10.1...v0.11.0
+[0.10.1]: https://github.com/Invoca/declare_schema/compare/v0.10.0...v0.10.1
+[0.10.0]: https://github.com/Invoca/declare_schema/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/Invoca/declare_schema/compare/v0.8.0...v0.9.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

data/Gemfile.lock

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

data/README.md

@@ -57,7 +57,7 @@ during the initialization of your Rails application.
 
 ### before_generating_migration callback
 
-During the initializtion process for generating migrations, `DeclareSchema` will
+During the initialization process for generating migrations, `DeclareSchema` will
 trigger the `eager_load!` on the `Rails` application and all `Rails::Engine`s loaded
 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.
@@ -70,18 +70,85 @@ DeclareSchema::Migration::Migrator.before_generating_migration do
 end
 ```
 
-## Declaring Character Set and Collation
-_Note: This feature currently only works for MySQL database configurations._
+### Global Configuration
+Configurations can be set at the global level to customize default declaration for the following values:
 
-MySQL originally supported UTF-8 in the range of 1-3 bytes (`mb3` or "multi-byte 3")
-which covered the full set of Unicode code points at the time: U+0000 - U+FFFF.
-But later, Unicode was extended beyond U+FFFF to make room for emojis, and with that
-UTF-8 require 1-4 bytes (`mb4` or "multi-byte 4"). With this addition, there has
-come a need to dynamically define the character set and collation for individual
-tables and columns in the database. With `declare_schema` this can be configured
-at three separate levels
+#### Text Limit
+The default text limit can be set using the `DeclareSchema.default_text_limit=` method.
+Note that a `nil` default means that there is no default-- so every declaration must be explicit.
+This will `raise` a `limit: must be provided for field :text...` error when the default value is `nil` and there is no explicit
+declaration.
 
-### Global Configuration
+For example, adding the following to your `config/initializers` directory will
+set the default `text limit` value to `0xffff`:
+ 
+**declare_schema.rb**
+```ruby
+# frozen_string_literal: true
+
+DeclareSchema.default_text_limit = 0xffff
+```
+
+#### String Limit
+The default string limit can be set using the `DeclareSchema.default_string_limit=` method.
+Note that a `nil` default means that there is no default-- so every declaration must be explicit.
+This will `raise` a `limit: must be provided for field :string...` error when the default value is `nil` and there is no explicit
+declaration.
+
+For example, adding the following to your `config/initializers` directory will
+set the default `string limit` value to `255`:
+ 
+**declare_schema.rb**
+```ruby
+# frozen_string_literal: true
+
+DeclareSchema.default_string_limit = 255
+```
+
+#### Null
+The default null value can be set using the `DeclareSchema.default_null=` method.
+Note that a `nil` default means that there is no default-- so every declaration must be explicit.
+This will `raise` a `null: must be provided for field...` error when the default value is `nil` and there is no explicit
+declaration.
+
+For example, adding the following to your `config/initializers` directory will
+set the default `null` value to `true`:
+ 
+**declare_schema.rb**
+```ruby
+# frozen_string_literal: true
+
+DeclareSchema.default_null = true
+```
+
+#### Generate Foreign Keys
+The default value for generate foreign keys can be set using the `DeclareSchema.default_generate_foreign_keys=` method.
+This value defaults to `true` and can only be set at the global level.
+
+For example, adding the following to your `config/initializers` directory will set
+the default `generate foreign keys` value to `false`:
+ 
+**declare_schema.rb**
+```ruby
+# frozen_string_literal: true
+
+DeclareSchema.default_generate_foreign_keys = false
+```
+
+#### Generate Indexing
+The default value for generate indexing can be set using the `DeclareSchema.default_generate_indexing=` method.
+This value defaults to `true` and can only be set at the global level.
+
+For example, adding the following to your `config/initializers` directory will
+set the default `generate indexing` value to `false`:
+ 
+**declare_schema.rb**
+```ruby
+# frozen_string_literal: true
+
+DeclareSchema.default_generate_indexing = false
+```
+#### Character Set and Collation
 The character set and collation for all tables and fields can be set at the global level
 using the `Generators::DeclareSchema::Migrator.default_charset=` and
 `Generators::DeclareSchema::Migrator.default_collation=` configuration methods.
@@ -93,9 +160,30 @@ turn all tables into `utf8mb4` supporting tables:
 ```ruby
 # frozen_string_literal: true
 
-Generators::DeclareSchema::Migration::Migrator.default_charset   = "utf8mb4"
-Generators::DeclareSchema::Migration::Migrator.default_collation = "utf8mb4_bin"
+DeclareSchema.default_charset   = "utf8mb4"
+DeclareSchema.default_collation = "utf8mb4_bin"
 ```
+#### db:migrate Command
+`declare_schema` can run the migration once it is generated, if the `--migrate` option is passed.
+If not, it will display the command to run later. By default this command is
+```
+bundle exec rails db:migrate
+```
+If your repo has a different command to run for migrations, you can configure it like this:
+```ruby
+`DeclareSchema.db_migrate_command = "bundle exec rails db:migrate_immediate"`
+```
+
+## Declaring Character Set and Collation
+_Note: This feature currently only works for MySQL database configurations._
+
+MySQL originally supported UTF-8 in the range of 1-3 bytes (`mb3` or "multi-byte 3")
+which covered the full set of Unicode code points at the time: U+0000 - U+FFFF.
+But later, Unicode was extended beyond U+FFFF to make room for emojis, and with that
+UTF-8 require 1-4 bytes (`mb4` or "multi-byte 4"). With this addition, there has
+come a need to dynamically define the character set and collation for individual
+tables and columns in the database. With `declare_schema` this can be configured
+at three separate levels
 
 ### Table Configuration
 In order to configure a table's default character set and collation, the `charset` and
@@ -150,5 +238,5 @@ or add it to your `bundler` Gemfile:
 To run tests:
 ```
 rake test:prepare_testapp[force]
-rake test:all < test_responses.txt
+rake test:all
 ```

data/lib/declare_schema.rb

@@ -21,7 +21,24 @@ module DeclareSchema
     text:     String
   }.freeze
 
+  @default_charset               = "utf8mb4"
+  @default_collation             = "utf8mb4_bin"
+  @default_text_limit            = 0xffff_ffff
+  @default_string_limit          = nil
+  @default_null                  = false
+  @default_generate_foreign_keys = true
+  @default_generate_indexing     = true
+  @db_migrate_command            =
+    if ActiveSupport::VERSION::MAJOR < 5
+      "bundle exec rake db:migrate"
+    else
+      "bundle exec rails db:migrate"
+    end
+
   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
+
     def to_class(type)
       case type
       when Class
@@ -32,6 +49,46 @@ module DeclareSchema
         raise ArgumentError, "expected Class or Symbol or String: got #{type.inspect}"
       end
     end
+
+    def default_charset=(charset)
+      charset.is_a?(String) or raise ArgumentError, "charset must be a string (got #{charset.inspect})"
+      @default_charset = charset
+    end
+
+    def default_collation=(collation)
+      collation.is_a?(String) or raise ArgumentError, "collation must be a string (got #{collation.inspect})"
+      @default_collation = collation
+    end
+
+    def default_text_limit=(text_limit)
+      text_limit.nil? or text_limit.is_a?(Integer) or raise ArgumentError, "text limit must be an integer or nil (got #{text_limit.inspect})"
+      @default_text_limit = text_limit
+    end
+
+    def default_string_limit=(string_limit)
+      string_limit.nil? or string_limit.is_a?(Integer) or raise ArgumentError, "string limit must be an integer or nil (got #{string_limit.inspect})"
+      @default_string_limit = string_limit
+    end
+
+    def default_null=(null)
+      null.in?([true, false, nil]) or raise ArgumentError, "null must be either true, false, or nil (got #{null.inspect})"
+      @default_null = null
+    end
+
+    def default_generate_foreign_keys=(generate_foreign_keys)
+      generate_foreign_keys.in?([true, false]) or raise ArgumentError, "generate_foreign_keys must be either true or false (got #{generate_foreign_keys.inspect})"
+      @default_generate_foreign_keys = generate_foreign_keys
+    end
+
+    def default_generate_indexing=(generate_indexing)
+      generate_indexing.in?([true, false]) or raise ArgumentError, "generate_indexing must be either true or false (got #{generate_indexing.inspect})"
+      @default_generate_indexing = generate_indexing
+    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
+    end
   end
 end
 

data/lib/declare_schema/dsl.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'active_support/proxy_object'
+
+module DeclareSchema
+  class Dsl < BasicObject # avoid Object because that gets extended by lots of gems
+    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])
+        undef_method(m)
+      end
+    end
+
+    def initialize(model, options = {})
+      @model = model
+      @options = options
+    end
+
+    attr_reader :model
+
+    def timestamps
+      field(:created_at, :datetime, null: true)
+      field(:updated_at, :datetime, null: true)
+    end
+
+    def optimistic_lock
+      field(:lock_version, :integer, default: 1, null: false)
+    end
+
+    def field(name, type, *args, **options)
+      @model.declare_field(name, type, *(args + [@options.merge(options)]))
+    end
+
+    def method_missing(type, name, *args)
+      field(name, type, *args)
+    end
+  end
+end

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

@@ -1,21 +1,40 @@
 # frozen_string_literal: true
 
 require 'active_record'
+require 'declare_schema/dsl'
 require 'declare_schema/model'
 require 'declare_schema/field_declaration_dsl'
 
 module DeclareSchema
-  module FieldsDsl
+  module Macros
     def fields(table_options = {}, &block)
       # Any model that calls 'fields' gets DeclareSchema::Model behavior
       DeclareSchema::Model.mix_in(self)
 
-      # @include_in_migration = false #||= options.fetch(:include_in_migration, true); options.delete(:include_in_migration)
       @include_in_migration = true
       @table_options        = table_options
 
       if block
-        dsl = DeclareSchema::FieldDeclarationDsl.new(self, null: false)
+        dsl = DeclareSchema::FieldDeclarationDsl.new(self)
+        if block.arity == 1
+          yield dsl
+        else
+          dsl.instance_eval(&block)
+        end
+      end
+    end
+    deprecate :fields, deprecator: ActiveSupport::Deprecation.new('1.0', 'DeclareSchema')
+
+    def declare_schema(table_options = {}, &block)
+      # Any model that calls 'fields' gets DeclareSchema::Model behavior
+      DeclareSchema::Model.mix_in(self)
+
+      # @include_in_migration = false #||= options.fetch(:include_in_migration, true); options.delete(:include_in_migration)
+      @include_in_migration = true # TODO: Add back or delete the include_in_migration feature
+      @table_options        = table_options
+
+      if block
+        dsl = DeclareSchema::Dsl.new(self, null: false)
         if block.arity == 1
           yield dsl
         else
@@ -26,4 +45,4 @@ module DeclareSchema
   end
 end
 
-ActiveRecord::Base.singleton_class.prepend DeclareSchema::FieldsDsl
+ActiveRecord::Base.singleton_class.prepend DeclareSchema::Macros

data/lib/declare_schema/model.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails'
-
 require 'declare_schema/extensions/module'
 
 module DeclareSchema
@@ -41,7 +39,7 @@ module DeclareSchema
           eval <<~EOS
             def self.inherited(klass)
               unless klass.field_specs.has_key?(inheritance_column)
-                fields do |f|
+                declare_schema do |f|
                   f.field(inheritance_column, :string, limit: 255, null: true)
                 end
                 index(inheritance_column)
@@ -130,7 +128,7 @@ module DeclareSchema
 
         fk_options[:dependent] = options.delete(:far_end_dependent) if options.has_key?(:far_end_dependent)
 
-        if Rails::VERSION::MAJOR >= 5
+        if ActiveSupport::VERSION::MAJOR >= 5
           super
         else
           super(name, scope, options.except(:optional))
@@ -149,7 +147,7 @@ module DeclareSchema
         end
       end
 
-      if ::Rails::VERSION::MAJOR < 5
+      if ::ActiveSupport::VERSION::MAJOR < 5
         def primary_key
           super || 'id'
         end
@@ -227,7 +225,7 @@ module DeclareSchema
                   ActiveRecord::Coders::JSON
                 elsif [:load, :dump].all? { |x| class_name_or_coder.respond_to?(x) }
                   class_name_or_coder
-                elsif Rails::VERSION::MAJOR >= 5
+                elsif ActiveSupport::VERSION::MAJOR >= 5
                   ActiveRecord::Coders::YAMLColumn.new(attr_name, class_name_or_coder)
                 else
                   ActiveRecord::Coders::YAMLColumn.new(class_name_or_coder)

data/lib/declare_schema/model/column.rb

@@ -53,7 +53,7 @@ module DeclareSchema
         def deserialize_default_value(column, type, default_value)
           type or raise ArgumentError, "must pass type; got #{type.inspect}"
 
-          case Rails::VERSION::MAJOR
+          case ActiveSupport::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 type as below. -Colin

data/lib/declare_schema/model/field_spec.rb

@@ -58,18 +58,21 @@ module DeclareSchema
         @position = position
         @options = options.dup
 
-        @options.has_key?(:null) or @options[:null] = false
+        @options.has_key?(:null) or @options[:null] = ::DeclareSchema.default_null
+        @options[:null].nil? and raise "null: must be provided for field #{model}##{@name}: #{@options.inspect} since ::DeclareSchema#default_null is set to 'nil'; do you want `null: false`?"
 
         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)
+            @options[:limit] ||= ::DeclareSchema.default_text_limit or
+                  raise("limit: must be provided for :text field #{model}##{@name}: #{@options.inspect} since ::DeclareSchema#default_text_limit is set to 'nil'; do you want `limit: 0xffff_ffff`?")
+            @options[:limit] = self.class.round_up_mysql_text_limit(@options[:limit])
           else
             @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`?"
+          @options[:limit] ||= ::DeclareSchema.default_string_limit or raise "limit: must be provided for :string field #{model}##{@name}: #{@options.inspect} since ::DeclareSchema#default_string_limit is set to 'nil'; do you want `limit: 255`?"
         when :bigint
           @type = :integer
           @options[:limit] = 8
@@ -96,15 +99,15 @@ module DeclareSchema
 
         if @type.in?([:text, :string])
           if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
-            @options[:charset]   ||= model.table_options[:charset]   || Generators::DeclareSchema::Migration::Migrator.default_charset
-            @options[:collation] ||= model.table_options[:collation] || Generators::DeclareSchema::Migration::Migrator.default_collation
+            @options[:charset]   ||= model.table_options[:charset]   || ::DeclareSchema.default_charset
+            @options[:collation] ||= model.table_options[:collation] || ::DeclareSchema.default_collation
           else
             @options.delete(:charset)
             @options.delete(:collation)
           end
         else
           @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}")
+          @options[:collation] and warn("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 }]