dynamic_migrations 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971a68fa07394767b18c8781df8be28eada7a1024256698f63bc4c0b0c06a560
-  data.tar.gz: 266f91ca87e1da40a0fbd13a9cde183e167c2950f1d0718169fdb8e4ff4eec52
+  metadata.gz: ca3d0e63e744237ce50761c65a92516cc4c53bf5c3bc71b7108fc06220b65185
+  data.tar.gz: fc9ee993485d527e71558de3ac9d5f5e98b35f6fefadbaffe9a44a90fc44bcee
 SHA512:
-  metadata.gz: f4f5ca51ab18b44f7a832d9442c7412e725c6b4d688fd481d45752168a6fb6665b15cf288934399d0eb7ef64e8a78a44730fa138cb0f1ff0e1435c135a8b627e
-  data.tar.gz: 223b0432f2198a98f33dfeba24f156938b47d286908a62571f93b7acfebeef6fc5594f0eac8c47805e01c1038c25af6af68321e0e829d4f673b5a5292587eede
+  metadata.gz: '00922f2a680713f98d20258d25cc2a7be769a1c1088e7fd717f1de111dfc738301c45a9f022061670a67bd66882700df63b631728767e6591df8f677aaaf4c0f'
+  data.tar.gz: 449b4d2e2dc6d18a6d3a19f21b5800738b6bcd1e60d29440684f4286a0384bd22564589ad07b6b18122a26a1b5df4011a750468060c94ff9811daa59381c06bd

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [3.2.1](https://github.com/craigulliott/dynamic_migrations/compare/v3.2.0...v3.2.1) (2023-08-17)
+
+
+### Bug Fixes
+
+* making column descriptions optional ([c384225](https://github.com/craigulliott/dynamic_migrations/commit/c3842254841c677efb777a1beb519754a4e85cc1))
+* trimming object descriptions when saving ([c384225](https://github.com/craigulliott/dynamic_migrations/commit/c3842254841c677efb777a1beb519754a4e85cc1))
+
+## [3.2.0](https://github.com/craigulliott/dynamic_migrations/compare/v3.1.1...v3.2.0) (2023-08-16)
+
+
+### Features
+
+* adding a with_connection method to the database which yields to a block, and provides a connection object to that block ([fc1590a](https://github.com/craigulliott/dynamic_migrations/commit/fc1590a00be8d3f9f0ee0472a96be94b80e667e0))
+
 ## [3.1.1](https://github.com/craigulliott/dynamic_migrations/compare/v3.1.0...v3.1.1) (2023-08-16)
 
 

data/lib/dynamic_migrations/postgres/generator/column.rb

@@ -21,6 +21,15 @@ module DynamicMigrations
             options[:array] = true
           end
 
+          # comment has to be last
+          if column.description
+            options[:comment] = <<~RUBY
+              <<~COMMENT
+                #{indent column.description}
+              COMMENT
+            RUBY
+          end
+
           options_syntax = options.map { |k, v| "#{k}: #{v}" }.join(", ")
 
           data_type = column.data_type
@@ -34,9 +43,7 @@ module DynamicMigrations
             object: column,
             code_comment: code_comment,
             migration: <<~RUBY
-              add_column :#{column.table.name}, :#{column.name}, :#{data_type}, #{options_syntax}, comment: <<~COMMENT
-                #{indent column.description}
-              COMMENT
+              add_column :#{column.table.name}, :#{column.name}, :#{data_type}, #{options_syntax}
             RUBY
         end
 

data/lib/dynamic_migrations/postgres/server/database/connection.rb

@@ -32,6 +32,21 @@ module DynamicMigrations
               raise NotConnectedError
             end
           end
+
+          # Opens a connection to the database server, and yields the provided block
+          # before automatically closing the connection again. This is useful for
+          # executing one time queries against the database server.
+          def with_connection &block
+            # create a temporary connection to the server
+            connect
+            # perform work with the connection
+            # todo: `yield connection` would have been preferred, but rbs/steep doesnt understand that syntax
+            if block.is_a? Proc
+              block.call connection
+            end
+            # close the connection
+            disconnect
+          end
         end
       end
     end

data/lib/dynamic_migrations/postgres/server/database/schema/function.rb

@@ -38,7 +38,8 @@ module DynamicMigrations
 
               unless description.nil?
                 raise ExpectedStringError, description unless description.is_a? String
-                @description = description
+                @description = description.strip
+                @description = nil if description == ""
               end
             end
 

data/lib/dynamic_migrations/postgres/server/database/schema/table/column.rb

@@ -34,7 +34,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
 
                 @interval_type = interval_type

data/lib/dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraint.rb

@@ -72,7 +72,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
 
                 raise ExpectedBooleanError, deferrable unless [true, false].include?(deferrable)

data/lib/dynamic_migrations/postgres/server/database/schema/table/index.rb

@@ -61,7 +61,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
 
                 raise ExpectedBooleanError, unique unless [true, false].include?(unique)

data/lib/dynamic_migrations/postgres/server/database/schema/table/primary_key.rb

@@ -45,7 +45,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
               end
 

data/lib/dynamic_migrations/postgres/server/database/schema/table/trigger.rb

@@ -115,7 +115,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
               end
 

data/lib/dynamic_migrations/postgres/server/database/schema/table/unique_constraint.rb

@@ -50,7 +50,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
 
                 raise ExpectedBooleanError, deferrable unless [true, false].include?(deferrable)

data/lib/dynamic_migrations/postgres/server/database/schema/table/validation.rb

@@ -48,7 +48,8 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description
+                  @description = description.strip
+                  @description = nil if description == ""
                 end
 
                 raise ExpectedBooleanError, deferrable unless [true, false].include?(deferrable)

data/lib/dynamic_migrations/postgres/server/database/schema/table.rb

@@ -39,7 +39,8 @@ module DynamicMigrations
 
               unless description.nil?
                 raise ExpectedStringError, description unless description.is_a? String
-                @description = description
+                @description = description.strip
+                @description = nil if description == ""
               end
 
               @columns = {}

data/lib/dynamic_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DynamicMigrations
-  VERSION = "3.1.1"
+  VERSION = "3.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_migrations
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Craig Ulliott
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -142,13 +142,13 @@ files:
 - lib/dynamic_migrations/postgres/server/database/triggers_and_functions_loader.rb
 - lib/dynamic_migrations/postgres/server/database/validations_loader.rb
 - lib/dynamic_migrations/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/craigulliott/dynamic_migrations/
   changelog_uri: https://github.com/craigulliott/dynamic_migrations/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,8 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Manage your database schema through configuration
 test_files: []