generated_schema_validations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 977b8c39503dc3cabfad86bc011240a877dfb84c49d12d4f9fe7f643426bbbc0
+  data.tar.gz: 5a6ab82e347f48f6bb7ff5c0308bbfeec6b9f20414967036a0149d2e56592224
+SHA512:
+  metadata.gz: 06345f91aaa7aa5a8d3b797a80bb70c55e58450aad7e1abf38c136373b3c7db3ed184bcc91ca7ba43f88611628e468700d6c909f30f2b9b06a5aa99749d84c85
+  data.tar.gz: e2ff2c3ed55bb9aa6af514f1ccdb19dc80eb0b098de3c2a141d00cd85cdb3ff01717f6986038619d0048c31b9519a348aff090f3785e725dcc61dc4f7350bd1e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in generated_schema_validations.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    generated_schema_validations (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  generated_schema_validations!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Georg Limbach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# GeneratedSchemaValidations
+
+This Gem helps to transfer the defaults from the database schema to the rails validations. To do this, it uses the information in schema.rb and transfers it to a concern file. This file should be included in the version control.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'generated_schema_validations'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install generated_schema_validations
+
+
+### Generate concern file
+
+To generate `app/models/concerns/schema_validations.rb`:
+
+    $ rails db:migrate
+
+### Use validations
+
+Add to `app/mode/application_record.rb`:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+  include SchemaValidations # to include auto generated validations
+end
+```
+
+Use it in a model **after** you defined the associations:
+
+```ruby
+class User < ApplicationRecord
+  belongs_to :client
+  belongs_to :other
+
+  validate :email_address, email_format: true
+
+  schema_validations # to use auto generated validations
+
+  def stuff; end
+end
+```
+
+### Exclude from rubocp and simplecov
+
+Add to simplecov config file (e.g. `.simplecov`):
+
+```
+  add_filter '/app/models/concerns/schema_validations.rb'
+```
+
+Add to rubocop config file (e. g. `config/rubocop.rb`):
+
+```
+AllCops:
+  Exclude:
+  - app/models/concerns/schema_validations.rb
+```
+
+
+## Usage
+
+Every time you change schema.rb file with rake tasks `db:schema:dump` the generated file `schema_validations.rb` will fresh created. The task `db:migrate` use intern `db:schema:dump`.
+
+It is hardcoded, that this will only run on development environment.
+
+
+## How it works
+
+```ruby
+t.text :stuff, null: false
+# results in
+validate :stuff, presence: true
+
+t.string :stuff, limit: 10
+# results in
+validate :stuff, length: { maximum: 10 }
+
+t.integer :stuff
+# results in
+validate :stuff, numericality: true
+```
+
+You can watch changes on `schema_validations.rb` to understand the generated validations.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Lichtbit/generated_schema_validations.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/generated_schema_validations.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'generated_schema_validations'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Georg Limbach']
+  spec.email         = ['georg.limbach@lichtbit.com']
+
+  spec.summary       = 'Generate rails validations from schema.rb file'
+  spec.description   = 'After each migration it generates a file with some validations. Each active record should ' \
+                       'include this file and can uns generated validations.'
+  spec.homepage      = 'https://github.com/Lichtbit/generated_schema_validations'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Lichtbit/generated_schema_validations'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+end

data/lib/generated_schema_validations/dumper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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')
+      raise 'The scheme is not well-formed.' if schema_content.include?('ActiveRecord')
+
+      file.write(schema_content)
+
+      load file.path
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+  def self.define(info = {}, &block)
+    new.define(info, &block)
+  end
+
+  def define(info, &block)
+    instance_eval(&block)
+
+    template_ruby = File.read(File.expand_path('template.rb', File.dirname(__FILE__)))
+    template_ruby.gsub!('VERSION_INFO', info[:version].to_s)
+    indention_spaces = template_ruby.match(/( +)TABLE_VALIDATIONS/)[1]
+    table_validations_ruby = @table_validations_ruby.lines.map do |line|
+      line.strip.present? ? "#{indention_spaces}#{line}" : "\n"
+    end.join
+    template_ruby.gsub!("#{indention_spaces}TABLE_VALIDATIONS", table_validations_ruby)
+
+    File.write(Rails.root.join('app/models/concerns/schema_validations.rb'), template_ruby)
+  end
+
+  def create_table(table_name, *, &block)
+    @table_validations_ruby ||= ''
+    @table_validations_ruby += GeneratedSchemaValidations::Table.new(table_name, &block).to_s
+  end
+
+  def do_nothing(*); end
+  alias enable_extension do_nothing
+  alias add_foreign_key do_nothing
+end

data/lib/generated_schema_validations/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'generated_schema_validations'
+require 'rails'
+
+class GeneratedSchemaValidations::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'generated_schema_validations/tasks.rb'
+  end
+end

data/lib/generated_schema_validations/table.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+class GeneratedSchemaValidations::Table
+  Validation = Struct.new(:attribute, :validator, :options) do
+    def to_s
+      "validates_with_filter #{attribute.to_sym.inspect}, #{{ validator => options }.inspect}"
+    end
+  end
+
+  attr_reader :table_name
+
+  def initialize(table_name, &block)
+    @table_name = table_name
+    @column_names = []
+    @possible_belongs_to_not_null_columns = []
+    @unique_indexes = []
+    @validations = []
+
+    instance_eval(&block)
+  end
+
+  def to_s
+    string = "\n"
+    string += "def dbv_#{table_name}_validations\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 += "  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
+    "#{string}end\n"
+  end
+
+  def validates(attribute, validator, options = {})
+    @validations.push(Validation.new(attribute, validator, options))
+  end
+
+  def null_validation(datatype, name, column_options)
+    @column_names.push(name.to_s)
+
+    return if column_options[:null] != false
+
+    @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
+    else
+      validates name, :presence
+    end
+  end
+
+  def uuid(name, column_options = {})
+    null_validation(:uuid, name, column_options)
+  end
+
+  def bigint(name, column_options = {})
+    null_validation(:bigint, name, column_options)
+
+    validates name, :numericality, allow_nil: true
+  end
+
+  def integer(name, column_options = {})
+    null_validation(:integer, name, column_options)
+
+    return if column_options[:array]
+
+    integer_range = ::ActiveRecord::Type::Integer.new.send(:range)
+    options = { allow_nil: true, only_integer: true, greater_than_or_equal_to: integer_range.begin }
+    if integer_range.exclude_end?
+      options[:less_than] = integer_range.end
+    else
+      options[:less_than_or_equal_to] = integer_range.end
+    end
+
+    validates name, :numericality, options
+  end
+
+  def datetime(name, column_options = {})
+    null_validation(:datetime, name, column_options)
+  end
+
+  def date(name, column_options = {})
+    null_validation(:date, name, column_options)
+  end
+
+  def boolean(name, column_options = {})
+    null_validation(:boolean, name, column_options)
+  end
+
+  def string(name, column_options = {})
+    text(name, column_options)
+  end
+
+  def json(name, column_options = {})
+    null_validation(:json, name, column_options)
+  end
+
+  def decimal(name, column_options = {})
+    null_validation(:decimal, name, column_options)
+    return if column_options[:array]
+    return if column_options[:precision].blank? || column_options[:scale].blank?
+
+    limit = 10**(column_options[:precision] - (column_options[:scale] || 0))
+    validates name, :numericality, allow_nil: true, greater_than: -limit, less_than: limit
+  end
+
+  def float(name, column_options = {})
+    null_validation(:float, name, column_options)
+    return if column_options[:array]
+
+    validates name, :numericality, allow_nil: true
+  end
+
+  def text(name, column_options = {})
+    null_validation(:text, name, column_options)
+    return if column_options[:array]
+    return if column_options[:limit].blank?
+
+    validates name, :length, allow_nil: true, maximum: column_options[:limit]
+  end
+
+  def index(names, index_options = {})
+    names = [names] unless names.is_a?(Array)
+    return unless index_options[:unique]
+    return unless names.all? { |name| name.to_s.in?(@column_names) }
+
+    @unique_indexes.push(names.map(&:to_s))
+  end
+end

data/lib/generated_schema_validations/tasks.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Rake::Task['db:schema:dump'].enhance do
+  require 'generated_schema_validations'
+  require_relative 'dumper'
+  require_relative 'table'
+  GeneratedSchemaValidations::Dumper.generate
+end

data/lib/generated_schema_validations/template.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+
+# generated from version VERSION_INFO
+
+module SchemaValidations
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :schema_validations_excluded_columns, default: %i[id created_at updated_at type]
+  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")
+    end
+
+    TABLE_VALIDATIONS
+
+    def validates_with_filter(attribute, options)
+      return if attribute.to_sym.in?(schema_validations_excluded_columns)
+
+      validates attribute, options
+    end
+
+    def belongs_to_presence_validations_for(not_null_columns)
+      reflect_on_all_associations(:belongs_to).each do |association|
+        if not_null_columns.include?(association.foreign_key.to_sym)
+          validates association.name, presence: true
+          schema_validations_excluded_columns.push(association.foreign_key.to_sym)
+        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,
+                                                       column: association.name)
+      end
+    end
+
+    def uniqueness_validations_for(unique_indexes)
+      unique_indexes.each do |names|
+        names.each do |name|
+          dbv_uniqueness_validations_for(unique_indexes, foreign_key: name, column: name)
+        end
+      end
+    end
+
+    def dbv_uniqueness_validations_for(unique_indexes, foreign_key:, column:)
+      unique_indexes.each do |names|
+        next unless foreign_key.in?(names)
+
+        scope = (names - [foreign_key]).map(&:to_sym)
+        options = { allow_nil: true }
+        options[:scope] = scope if scope.any?
+        options[:if] = (proc do |record|
+          if scope.all? { |scope_sym| record.public_send(:"#{scope_sym}?") }
+            record.public_send(:"#{foreign_key}_changed?")
+          else
+            false
+          end
+        end)
+
+        validates column, uniqueness: options
+      end
+    end
+  end
+end

data/lib/generated_schema_validations.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module GeneratedSchemaValidations
+end
+
+require_relative 'generated_schema_validations/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: generated_schema_validations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Limbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-07 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.
+email:
+- georg.limbach@lichtbit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- generated_schema_validations.gemspec
+- lib/generated_schema_validations.rb
+- lib/generated_schema_validations/dumper.rb
+- lib/generated_schema_validations/railtie.rb
+- lib/generated_schema_validations/table.rb
+- lib/generated_schema_validations/tasks.rb
+- lib/generated_schema_validations/template.rb
+homepage: https://github.com/Lichtbit/generated_schema_validations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Lichtbit/generated_schema_validations
+  source_code_uri: https://github.com/Lichtbit/generated_schema_validations
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Generate rails validations from schema.rb file
+test_files: []