generated_schema_validations 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6695669fe5683c58ba70f717c3025fff4e51baa0684842603cede227bfed0b83
-  data.tar.gz: 80b7ee3f1f023b56704928fc02ddd1930028449ab4162bb9ab48fd0c8ef3049b
+  metadata.gz: 5eb0b94787c5c2fa3dd63dfd3b0f60f15b4b109813ffcc9839bb28491eb11924
+  data.tar.gz: 247d7ce6faf3829e0710ed5c6ed1d962b7ffc5e3e2b7baeb72b0b44d69f6887b
 SHA512:
-  metadata.gz: 48749688026b1328a620e9d820367e5dc2adbe294a38265aecc3e1d3755d227671b86cf104788d8dce9165d87ca0b5d9ba8a2e4387a02b0538ce830dc1ed7196
-  data.tar.gz: fa8fbd3809827765f766962bd928157a058ef68b41e0dc414de706d178b2b64884cf519d4069d54493dcfe851d95f33e571036cfec2f10b413b8bbaf5a455227
+  metadata.gz: 8d7baeb772e414b39dd83be6e1bbd40af2494b227de222c6c3ed907ea5b2598d976cfde3c5f74df57280413366b3ec194f9b8324bba71ec772cead68e1b3c311
+  data.tar.gz: 7d87b3e7dfe1392ff49871f362658abcf712484c7f89bacf0124d52cb5c06cf18196ea25a5649b9d70fccbdba9b69cc9a81587caab8a9abd7fda292292c31d35

data/README.md

@@ -97,6 +97,21 @@ You can watch changes on `schema_validations.rb` to understand the generated val
 
 ## Changelog
 
+### 0.5.1
+
+* raise info about where-unique conditions only in local envs
+
+### 0.5
+
+* Enables automatic testing after deployment using Capistrano to compare the online database with the local one and automatically warn of any differences.
+
+```ruby
+# Add to Capfile
+
+require 'generated_schema_validations/capistrano_tasks'
+
+```
+
 ### 0.4
 
 * JSON and JSONB fields can have an empty hash and still be considered present

data/generated_schema_validations.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'generated_schema_validations'
-  spec.version       = '0.4.0'
+  spec.version       = '0.5.1'
   spec.authors       = ['Georg Limbach']
   spec.email         = ['georg.limbach@lichtbit.com']
 

data/lib/generated_schema_validations/capistrano_tasks.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+namespace :generated_schema_validations do
+  desc 'compare remove dump with local variant'
+  task :compare_dumper do
+    on roles(:app) do
+      begin
+        require 'diff/lcs'
+        require 'diff/lcs/hunk'
+        diff_lcs_available = true
+      rescue LoadError
+        diff_lcs_available = false
+      end
+
+      local_file = 'app/models/concerns/schema_validations.rb'
+      local_content = File.read(local_file).strip
+
+      within release_path do
+        with(
+          rails_env: fetch(:rails_env),
+          rails_groups: fetch(:rails_assets_groups),
+          disable_database_environment_check: 1
+        ) do
+          dump_output = capture(:rake, 'db:validation_dump_direct').strip
+
+          if dump_output != local_content
+            warn '❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌'
+            warn 'The online version of the automatically generated validations differs from the local version.'
+            warn 'Please check immediately.'
+
+            if diff_lcs_available
+              old_lines = local_content.lines
+              new_lines = dump_output.lines
+              diffs = Diff::LCS.diff(old_lines, new_lines)
+
+              if diffs.any?
+                info '----- DIFF START -----'
+
+                file_length_difference = 0
+
+                diffs.each do |piece|
+                  hunk = Diff::LCS::Hunk.new(
+                    old_lines, new_lines, piece,
+                    3,  # context lines
+                    file_length_difference
+                  )
+
+                  file_length_difference = hunk.file_length_difference
+
+                  info hunk.diff(:unified)
+                end
+
+                info '----- DIFF END -----'
+              end
+            end
+            warn '❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌'
+          else
+            info '✔ Schema OK'
+          end
+        end
+      end
+    end
+  end
+end
+
+after 'deploy:publishing', 'generated_schema_validations:compare_dumper'

data/lib/generated_schema_validations/dump_checker.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class GeneratedSchemaValidations::DumpChecker < GeneratedSchemaValidations::Dumper
+  def self.read_schema_content
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.rewind
+    stream.read
+  end
+
+  def write_schema_validations(template_ruby)
+    puts template_ruby
+  end
+end

data/lib/generated_schema_validations/dumper.rb

@@ -2,12 +2,9 @@
 
 class GeneratedSchemaValidations::Dumper
   def self.generate
-    return unless Rails.env.development?
-
     file = Tempfile.new(['schema', '.rb'])
     begin
-      schema_content = File.read(Rails.root.join('db/schema.rb'))
-      schema_content.gsub!(/ActiveRecord::Schema(\[[^\]]+\])?/, 'GeneratedSchemaValidations::Dumper')
+      schema_content = read_schema_content.gsub(/ActiveRecord::Schema(\[[^\]]+\])?/, self.name)
       raise 'The scheme is not well-formed.' if schema_content.include?('ActiveRecord')
 
       file.write(schema_content)
@@ -19,6 +16,10 @@ class GeneratedSchemaValidations::Dumper
     end
   end
 
+  def self.read_schema_content
+    File.read(Rails.root.join('db/schema.rb'))
+  end
+
   def self.define(info = {}, &block)
     new.define(info, &block)
   end
@@ -34,6 +35,12 @@ class GeneratedSchemaValidations::Dumper
     end.join
     template_ruby.gsub!("#{indention_spaces}TABLE_VALIDATIONS", table_validations_ruby)
 
+    write_schema_validations(template_ruby)
+  end
+
+  def write_schema_validations(template_ruby)
+    return unless Rails.env.development?
+
     File.write(Rails.root.join('app/models/concerns/schema_validations.rb'), template_ruby)
   end
 

data/lib/generated_schema_validations/table.rb

@@ -151,7 +151,7 @@ class GeneratedSchemaValidations::Table
     return unless index_options[:unique]
     return unless names.all? { |name| name.to_s.in?(@column_names) }
 
-    if defined?(Rails::Railtie) && (Rails.env.development? || Rails.env.test?) && index_options[:where]
+    if index_options[:where]
       @bad_indexes.push(names.map(&:to_s))
     else
       @unique_indexes.push(names.map(&:to_s))

data/lib/generated_schema_validations/tasks.rb

@@ -6,3 +6,15 @@ Rake::Task['db:schema:dump'].enhance do
   require_relative 'table'
   GeneratedSchemaValidations::Dumper.generate
 end
+
+namespace :db do
+  desc 'Dump validations to stdout'
+  task validation_dump_direct: :environment do
+    require 'generated_schema_validations'
+    require_relative 'dumper'
+    require_relative 'dump_checker'
+    require_relative 'table'
+
+    GeneratedSchemaValidations::DumpChecker.generate
+  end
+end

data/lib/generated_schema_validations/template.rb

@@ -55,6 +55,8 @@ module SchemaValidations
       unique_indexes.each do |names|
         names.each do |name|
           next if name.to_sym.in?(schema_validations_excluded_columns)
+          next unless defined?(Rails::Railtie)
+          next unless (Rails.env.development? || Rails.env.test?)
 
           raise "Unique index with where clause is outside the scope of this gem.\n\n" \
                 "You can exclude this column: `schema_validations exclude: [:#{name}]`"
@@ -102,7 +104,7 @@ module SchemaValidations
     def validate_each(record, attr_name, value)
       return if value.nil?
       return unless value.is_a?(DateTime) || value.is_a?(Time)
-      return if value.year.between?(-4711, 294275) # see https://www.postgresql.org/docs/9.3/datatype-datetime.html
+      return if value.year.between?(-4711, 294_275) # see https://www.postgresql.org/docs/9.3/datatype-datetime.html
 
       record.errors.add(attr_name, :invalid, options)
     end
@@ -112,7 +114,7 @@ module SchemaValidations
     def validate_each(record, attr_name, value)
       return if value.nil?
       return unless value.is_a?(Date)
-      return if value.year.between?(-4711, 5874896) # see https://www.postgresql.org/docs/9.3/datatype-datetime.html
+      return if value.year.between?(-4711, 5_874_896) # see https://www.postgresql.org/docs/9.3/datatype-datetime.html
 
       record.errors.add(attr_name, :invalid, options)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generated_schema_validations
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Georg Limbach
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-21 00:00:00.000000000 Z
+date: 2025-12-04 00:00:00.000000000 Z
 dependencies: []
 description: After each migration it generates a file with some validations. Each
   active record should include this file and can uns generated validations.
@@ -27,6 +27,8 @@ files:
 - Rakefile
 - generated_schema_validations.gemspec
 - lib/generated_schema_validations.rb
+- lib/generated_schema_validations/capistrano_tasks.rb
+- lib/generated_schema_validations/dump_checker.rb
 - lib/generated_schema_validations/dumper.rb
 - lib/generated_schema_validations/railtie.rb
 - lib/generated_schema_validations/table.rb