declare_schema 1.0.1 → 1.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165053edc0bb071619bb898609cd3e8d489589509de8a386e3cfe97c63efd372
-  data.tar.gz: '05338b95ee665d86973b61aa36c35189f531660f325c3849890ae38cc356c5b8'
+  metadata.gz: 8e34615eda56bac536ac728a8edcddcec4cad606257a3fbb0769024a1837f0dc
+  data.tar.gz: e54fb15d2400b5edf651678d4249b75cbeb014cfe4faa4fbfe6558f19af97e45
 SHA512:
-  metadata.gz: f84b58499f9d1e5b4e5d5c74af3c4e3cedbbc839076f09d128be9f92df7f7a61354d5de0531804ce3d2a3b6ec8c437a35c5d777cb44b5c1c2eb7d8a28f310095
-  data.tar.gz: 0b2403c1d17d52cecc73ab7be84729cba4979c34c9e48d1099f0ffaf4c97721f698dbced48e7f70571c476e3139829183fcac6b2957a5cea103b9cd8f49ba845
+  metadata.gz: 67cef61d9e6dc3bcdc4d1b8f39cf3f4abf43917df38ec5b0f1503f0c275ae94d27501fd10a654eff5ee4ca4c4105bebc1db7031c77112b562a55be8127269893
+  data.tar.gz: c511dc4230e52796249f9f5e260ccdef4c21b963b5564236ee2e601366efcc6823470711bc1116947cf9fe97f6ac1a0ec9d9341eee4fa713192be97aece7c762

data/CHANGELOG.md

@@ -4,6 +4,21 @@ 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).
 
+## [1.2.0] - Unreleased
+### Added
+- Added a rake task definition that can be optionally included into a non-Rails project to generate
+  schema migrations.
+
+## [1.1.0] - 2022-07-22
+### Changed
+- Fixed a bug where `DeclareSchema::Model::HabtmModelShim` `indexes` and `integer limits` were not being generated properly. Use `limit 8` for ids and primary composite key for habtm model.
+- `index_definitions_with_primary_key`
+
+## [1.0.2] - 2022-07-18
+### Fixed
+- Fixed a bug where `SchemaChange::ColumnRemove` was not loaded and causing an exception to raise
+when a column was being removed during migration generation
+
 ## [1.0.1] - 2022-07-12
 ### Fixed
 - Remove lingering usage of `fallback_find_primary_key` method that was removed in `0.14.0`
@@ -219,6 +234,9 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[1.2.0]: https://github.com/Invoca/declare_schema/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/Invoca/declare_schema/compare/v1.0.2...v1.1.0
+[1.0.2]: https://github.com/Invoca/declare_schema/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/Invoca/declare_schema/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/Invoca/declare_schema/compare/v0.14.3...v1.0.0
 [0.14.3]: https://github.com/Invoca/declare_schema/compare/v0.14.2...v0.14.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (1.0.1)
+    declare_schema (1.2.0.pre.1)
       rails (>= 5.0)
 
 GEM

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -36,7 +36,7 @@ module DeclareSchema
               parent_table:    parent_table,
               foreign_key:     foreign_key
             }
-            options[:dependent] = :delete if fkc['ON DELETE CASCADE']
+            options[:dependent] = :delete if fkc['ON DELETE CASCADE'] || model.is_a?(DeclareSchema::Model::HabtmModelShim)
 
             new(model, foreign_key, **options)
           end

data/lib/declare_schema/model/habtm_model_shim.rb

@@ -37,9 +37,13 @@ module DeclareSchema
         join_table
       end
 
+      def index_name
+        "index_#{table_name}_on_#{foreign_keys.first}_#{foreign_keys.last}"
+      end
+
       def field_specs
         foreign_keys.each_with_index.each_with_object({}) do |(v, position), result|
-          result[v] = ::DeclareSchema::Model::FieldSpec.new(self, v, :integer, position: position, null: false)
+          result[v] = ::DeclareSchema::Model::FieldSpec.new(self, v, :bigint, position: position, null: false)
         end
       end
 
@@ -53,7 +57,7 @@ module DeclareSchema
 
       def index_definitions_with_primary_key
         [
-          IndexDefinition.new(self, foreign_keys, unique: true, name: ::DeclareSchema::Model::IndexDefinition::PRIMARY_KEY_NAME),
+          IndexDefinition.new(self, foreign_keys, unique: true, name: index_name), # creates a primary composite key on both foriegn keys
           IndexDefinition.new(self, foreign_keys.last) # not unique by itself; combines with primary key to be unique
         ]
       end

data/lib/declare_schema/model/index_definition.rb

@@ -33,11 +33,14 @@ module DeclareSchema
 
       class << self
         # extract IndexSpecs from an existing table
-        # always includes the PRIMARY KEY index
+        # always includes the PRIMARY KEY index for Model unless it is a HABTM Model.
         def for_model(model, old_table_name = nil)
           t = old_table_name || model.table_name
 
-          primary_key_columns = Array(model.connection.primary_key(t)).presence or
+          habtm_model = model.is_a?(DeclareSchema::Model::HabtmModelShim)
+
+          primary_key_columns = Array(model.connection.primary_key(t)).presence
+          primary_key_columns || habtm_model or
             raise "could not find primary key for table #{t} in #{model.connection.columns(t).inspect}"
 
           primary_key_found = false
@@ -47,14 +50,14 @@ module DeclareSchema
               i.columns == primary_key_columns && i.unique or
                 raise "primary key on #{t} was not unique on #{primary_key_columns} (was unique=#{i.unique} on #{i.columns})"
               primary_key_found = true
-            elsif i.columns == primary_key_columns && i.unique
+            elsif i.columns == primary_key_columns && i.unique && !habtm_model
               # skip this primary key index since we'll create it below, with PRIMARY_KEY_NAME
               next
             end
             new(model, i.columns, name: i.name, unique: i.unique, where: i.where, table_name: old_table_name)
           end.compact
 
-          if !primary_key_found
+          if !primary_key_found && !habtm_model
             index_definitions << new(model, primary_key_columns, name: PRIMARY_KEY_NAME, unique: true, where: nil, table_name: old_table_name)
           end
           index_definitions

data/lib/declare_schema/rake.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "declare_schema"
+require "declare_schema/schema_change/all"
+require "declare_schema/schema_change/column_remove"
+require "generators/declare_schema/migration/migrator"
+require "erb"
+
+namespace :declare_schema do
+  desc 'Generate migrations for the database schema'
+  task :generate => 'db:load_config' do
+    up, down = Generators::DeclareSchema::Migration::Migrator.new(renames: {}).generate
+
+    if up.blank?
+      puts "Database and models match -- nothing to change"
+      return
+    end
+
+    puts "\n---------- Up Migration ----------"
+    puts up
+    puts "----------------------------------"
+
+    puts "\n---------- Down Migration --------"
+    puts down
+    puts "----------------------------------"
+
+    final_migration_name = default_migration_name
+    migration_template   = ERB.new(<<~EOF.chomp)
+      # frozen_string_literal: true
+      class <%= @migration_class_name %> < (ActiveRecord::Migration[4.2])
+        def self.up
+      <%= @up.presence or raise "no @up given!" %>
+        end
+        def self.down
+      <%= @down.presence or raise "no @down given!" %>
+        end
+      end
+    EOF
+
+    @up = "    #{up.strip.split("\n").join("\n    ")}"
+    @down = "    #{down.strip.split("\n").join("\n    ")}"
+    @migration_class_name = final_migration_name.camelize
+
+    File.write("db/migrate/#{Time.now.to_i}_#{final_migration_name.underscore}.rb", migration_template.result(binding))
+  end
+end
+
+def default_migration_name
+  existing = Dir["db/migrate/*declare_schema_migration*"]
+  max = existing.grep(/([0-9]+)\.rb$/) { Regexp.last_match(1).to_i }.max.to_i
+  "declare_schema_migration_#{max + 1}"
+end

data/lib/declare_schema/schema_change/all.rb

@@ -7,6 +7,7 @@ module DeclareSchema
     autoload :Base, 'declare_schema/schema_change/base'
     autoload :ColumnAdd, 'declare_schema/schema_change/column_add'
     autoload :ColumnChange, 'declare_schema/schema_change/column_change'
+    autoload :ColumnRemove, 'declare_schema/schema_change/column_remove'
     autoload :ColumnRename, 'declare_schema/schema_change/column_rename'
     autoload :ForeignKeyAdd, 'declare_schema/schema_change/foreign_key_add'
     autoload :ForeignKeyRemove, 'declare_schema/schema_change/foreign_key_remove'

data/lib/declare_schema/version.rb

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

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

@@ -55,9 +55,10 @@ module Generators
 
         def load_rails_models
           ActiveRecord::Migration.verbose = false
-
-          Rails.application.eager_load!
-          Rails::Engine.subclasses.each(&:eager_load!)
+          if defined?(Rails)
+            Rails.application.eager_load!
+            Rails::Engine.subclasses.each(&:eager_load!)
+          end
           self.class.before_generating_migration_callback&.call
         end
 

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

@@ -102,14 +102,9 @@ RSpec.describe DeclareSchema::Model::HabtmModelShim do
         expect(result.size).to eq(2), result.inspect
 
         expect(result.first).to be_a(::DeclareSchema::Model::IndexDefinition)
-        expect(result.first.name).to eq('PRIMARY')
+        expect(result.first.name).to eq('index_parent_1_parent_2_on_parent_1_id_parent_2_id')
         expect(result.first.fields).to eq(['parent_1_id', 'parent_2_id'])
         expect(result.first.unique).to be_truthy
-
-        expect(result.last).to be_a(::DeclareSchema::Model::IndexDefinition)
-        expect(result.last.name).to eq('on_parent_2_id')
-        expect(result.last.unique).to be_falsey
-        expect(result.last.fields).to eq(['parent_2_id'])
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0.pre.1
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,7 +33,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
-- ".github/dependabot.yml"
 - ".github/workflows/declare_schema_build.yml"
 - ".github/workflows/gem_release.yml"
 - ".gitignore"
@@ -68,6 +67,7 @@ files:
 - lib/declare_schema/model/index_definition.rb
 - lib/declare_schema/model/table_options_definition.rb
 - lib/declare_schema/railtie.rb
+- lib/declare_schema/rake.rb
 - lib/declare_schema/schema_change/all.rb
 - lib/declare_schema/schema_change/base.rb
 - lib/declare_schema/schema_change/column_add.rb
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Database schema declaration and migration generator for Rails

data/.github/dependabot.yml

@@ -1,14 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: weekly
-    day: friday
-    time: "22:00"
-    timezone: PST8PDT
-  open-pull-requests-limit: 99
-  versioning-strategy: lockfile-only
-  commit-message:
-    prefix: No-Jira
-    include: scope