generated_schema_validations 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc227cec06fe251e20eef36cd0d21b05f5014ed6d8a91d18ce23eab11055f99f
-  data.tar.gz: ba0b6b325854965b6c9f30d0341c049396757480a0b9cec0428dfc4ec800ef95
+  metadata.gz: 4be368a0917bd00a79be8fc0ab6ac7ab4530bff7c3feec32fa731a5ccee2d5e3
+  data.tar.gz: 4cb0120a7cacd178b16253d04bdab2e5aed1edc37195609bf176b510700b4824
 SHA512:
-  metadata.gz: 21dc22f43b73d4782f1ca0b4071f53efbb17b84255d94c8a9f5c97cfed19e24871b10ba0c85bd7354cb3ad9b480406b521b2408e9e57fbd6e58b1f18aa3b22f6
-  data.tar.gz: d1b6d05f58c67a63d04429c4c4ddf4b91edf8838c9bd7a15216045277a077ef52aced4ede41b9a0c0c7a24cdff0844bd67bc14f25136059bd37d03c69c66a81c
+  metadata.gz: 542791763e87ecc0f8f54fd18e3df3d41aaf4db6c7e146f158d1d4b2d74f75f1e7d69ea6f5aa2235cdcad18fa454849cd3b93396d75d7b67e1570918713d4d48
+  data.tar.gz: bd238fa0f5cc5953202e96893070e1c1c30b823949a11889854ccdba5765ec277192743bad6e018c8c7e287306ea9731716dd91664e9810f6f352368f78c2a59

data/README.md

@@ -36,13 +36,15 @@ class ApplicationRecord < ActiveRecord::Base
 end
 ```
 
-Use it in a model **after** you defined the associations:
+Use it in a model **after** you defined the associations and enums:
 
 ```ruby
 class User < ApplicationRecord
   belongs_to :client
   belongs_to :other
 
+  enum :actived, no: 0, yes: 1
+
   validate :email_address, email_format: true
 
   schema_validations # to use auto generated validations
@@ -95,6 +97,15 @@ You can watch changes on `schema_validations.rb` to understand the generated val
 
 ## Changelog
 
+### 0.3.1
+
+* Add exclusion for enum fields
+
+### 0.3.0
+
+* Check usage of schema_validations (see #3)
+* Force excluding unique validations with where clause (see #2)
+
 ### 0.2.3
 
 * Add `jsonb` and `xml` as possible field type

data/generated_schema_validations.gemspec

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

data/lib/generated_schema_validations/table.rb

@@ -7,12 +7,19 @@ class GeneratedSchemaValidations::Table
     end
   end
 
+  ValidationWithoutEnum = Struct.new(:attribute, :validator, :options) do
+    def to_s
+      "validates_with_filter #{attribute.to_sym.inspect}, #{{ validator => options }.inspect} unless enums.include?(#{attribute.to_sym.inspect})"
+    end
+  end
+
   attr_reader :table_name
 
   def initialize(table_name, &block)
     @table_name = table_name
     @column_names = []
     @possible_belongs_to_not_null_columns = []
+    @bad_indexes = []
     @unique_indexes = []
     @validations = []
 
@@ -21,10 +28,11 @@ class GeneratedSchemaValidations::Table
 
   def to_s
     string = "\n"
-    string += "def dbv_#{table_name}_validations\n"
+    string += "def dbv_#{table_name}_validations(enums: [])\n"
     if @possible_belongs_to_not_null_columns.present?
       string += "  belongs_to_presence_validations_for(#{@possible_belongs_to_not_null_columns.inspect})\n"
     end
+    string += "  bad_uniqueness_validations_for(#{@bad_indexes.inspect})\n" if @bad_indexes.present?
     string += "  belongs_to_uniqueness_validations_for(#{@unique_indexes.inspect})\n" if @unique_indexes.present?
     string += "  uniqueness_validations_for(#{@unique_indexes.inspect})\n" if @unique_indexes.present?
     string += @validations.uniq.map { |v| "  #{v}\n" }.join
@@ -35,6 +43,10 @@ class GeneratedSchemaValidations::Table
     @validations.push(Validation.new(attribute, validator, options))
   end
 
+  def validates_without_enum(attribute, validator, options = {})
+    @validations.push(ValidationWithoutEnum.new(attribute, validator, options))
+  end
+
   def null_validation(datatype, name, column_options)
     @column_names.push(name.to_s)
 
@@ -55,7 +67,7 @@ class GeneratedSchemaValidations::Table
   def bigint(name, column_options = {})
     null_validation(:bigint, name, column_options)
 
-    validates name, :numericality, allow_nil: true
+    validates_without_enum name, :numericality, allow_nil: true
   end
 
   def integer(name, column_options = {})
@@ -71,7 +83,7 @@ class GeneratedSchemaValidations::Table
       options[:less_than_or_equal_to] = integer_range.end
     end
 
-    validates name, :numericality, options
+    validates_without_enum name, :numericality, options
   end
 
   def datetime(name, column_options = {})
@@ -137,6 +149,10 @@ class GeneratedSchemaValidations::Table
     return unless index_options[:unique]
     return unless names.all? { |name| name.to_s.in?(@column_names) }
 
-    @unique_indexes.push(names.map(&:to_s))
+    if defined?(Rails::Railtie) && (Rails.env.development? || Rails.env.test?) && index_options[:where]
+      @bad_indexes.push(names.map(&:to_s))
+    else
+      @unique_indexes.push(names.map(&:to_s))
+    end
   end
 end

data/lib/generated_schema_validations/template.rb

@@ -11,12 +11,27 @@ module SchemaValidations
 
   included do
     class_attribute :schema_validations_excluded_columns, default: %i[id created_at updated_at type]
+    class_attribute :schema_validations_called, default: false
+
+    if defined?(Rails::Railtie) && (Rails.env.development? || Rails.env.test?)
+      TracePoint.trace(:end) do |t|
+        if t.self.respond_to?(:schema_validations_called) && t.self < ApplicationRecord &&
+           !t.self.schema_validations_called
+          raise "#{t.self}: schema_validations or skip_schema_validations missing"
+        end
+      end
+    end
   end
 
   class_methods do
     def schema_validations(exclude: [], schema_table_name: table_name)
-      self.schema_validations_excluded_columns += exclude
-      send("dbv_#{schema_table_name}_validations")
+      self.schema_validations_called = true
+      self.schema_validations_excluded_columns += exclude.map(&:to_sym)
+      send("dbv_#{schema_table_name}_validations", enums: defined_enums.keys.map(&:to_sym))
+    end
+
+    def skip_schema_validations
+      self.schema_validations_called = true
     end
 
     TABLE_VALIDATIONS
@@ -36,6 +51,17 @@ module SchemaValidations
       end
     end
 
+    def bad_uniqueness_validations_for(unique_indexes)
+      unique_indexes.each do |names|
+        names.each do |name|
+          next if name.to_sym.in?(schema_validations_excluded_columns)
+
+          raise "Unique index with where clause is outside the scope of this gem.\n\n" \
+                "You can exclude this column: `schema_validations exclude: [:#{name}]`"
+        end
+      end
+    end
+
     def belongs_to_uniqueness_validations_for(unique_indexes)
       reflect_on_all_associations(:belongs_to).each do |association|
         dbv_uniqueness_validations_for(unique_indexes, foreign_key: association.foreign_key.to_s,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generated_schema_validations
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Georg Limbach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2024-05-13 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.
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Generate rails validations from schema.rb file