generated_schema_validations 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be368a0917bd00a79be8fc0ab6ac7ab4530bff7c3feec32fa731a5ccee2d5e3
-  data.tar.gz: 4cb0120a7cacd178b16253d04bdab2e5aed1edc37195609bf176b510700b4824
+  metadata.gz: 0ab852e62f93186581c39db4f69ba44c3d14a7cdfa70af2964c44c6ce33dea8c
+  data.tar.gz: b1825adcc71a209f86861ff198c282e90ac08a178915166e5b08d689cb1ed0f4
 SHA512:
-  metadata.gz: 542791763e87ecc0f8f54fd18e3df3d41aaf4db6c7e146f158d1d4b2d74f75f1e7d69ea6f5aa2235cdcad18fa454849cd3b93396d75d7b67e1570918713d4d48
-  data.tar.gz: bd238fa0f5cc5953202e96893070e1c1c30b823949a11889854ccdba5765ec277192743bad6e018c8c7e287306ea9731716dd91664e9810f6f352368f78c2a59
+  metadata.gz: 6192c01bbaf71055b38e23a6c7cf29dcd3781f2a9a2cd17932af868c7db50747a79591309549ae35fbe1bc9a3dfeea688974e5c3f6024e98a6fcb76f8fd3c986
+  data.tar.gz: cb4c78ea96469157aaf66d14589cfaef5edc0c8532f9f159f67795cac70e7c669377a639829bb124dd8f103df481988669e7947c9471c89842b18afa6bce37ec

data/README.md

@@ -97,6 +97,21 @@ You can watch changes on `schema_validations.rb` to understand the generated val
 
 ## Changelog
 
+### 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
+
 ### 0.3.1
 
 * Add exclusion for enum fields

data/generated_schema_validations.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'generated_schema_validations'
-  spec.version       = '0.3.1'
+  spec.version       = '0.5.0'
   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)
+
+      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'
+
+          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

@@ -55,6 +55,8 @@ class GeneratedSchemaValidations::Table
     @possible_belongs_to_not_null_columns.push(name.to_sym) if datatype.in?(%i[bigint integer uuid])
     if datatype == :boolean
       validates name, :inclusion, in: [true, false], message: :blank
+    elsif datatype.in?(%i[json jsonb])
+      validates name, :exclusion, in: [nil], message: :blank
     else
       validates name, :presence
     end

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

@@ -102,7 +102,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 +112,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.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Georg Limbach
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2025-12-03 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
@@ -38,7 +40,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Lichtbit/generated_schema_validations
   source_code_uri: https://github.com/Lichtbit/generated_schema_validations
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -54,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.26
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Generate rails validations from schema.rb file
 test_files: []