validate_me 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46224b477b30f3831acb3c3f3ef490a68f01aa399fec530cd551d52f3d664f6b
+  data.tar.gz: 6233623aa30e84088394572ece046713e04e164088036a509d439181c03108db
+SHA512:
+  metadata.gz: 68e21d06eed780d36af60d176ac6384e702ee1bbec79a43dfd11bbd1496263856808f64c1145eef64ef8a2316f613e4831c430e1e0bca787f7937af81c4e3a34
+  data.tar.gz: b08719330424c81f3e5b5c7958fc18cbfadf5561f02bd0f3b1f664feafff4e811766ae7ddfda1d2a75f5d549f7482c35a067909ebf92f67888b3ebb77f35dbea

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mike@lollar.codes. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in validate_me.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    validate_me (0.1.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activerecord (6.0.1)
+      activemodel (= 6.0.1)
+      activesupport (= 6.0.1)
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.5)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.13.0)
+    rake (10.5.0)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  sqlite3 (~> 1.4)
+  validate_me!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 lollar
+
+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,75 @@
+# ValidateMe
+
+ValidateMe offers common sense validations for your ActiveRecord models. Since it relies on different ActiveRecord abstractions it is database agnostic.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validate_me'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validate_me
+
+## Usage
+
+Usage is simple, just add `include ::ValidateMe` to whichever ActiveRecord models you would like to have the built-in validations that will match your database constraints.
+
+```ruby
+class User < ApplicationRecord
+  include ::ValidateMe
+end
+```
+
+## What is validated?
+
+ValidateMe will validate null constraints, uniqueness (including scope), and limits. See the below examples for more details
+
+Example migration:
+
+```ruby
+  create_table :users do |t|
+    t.string :first_name, limit: 10, null: false
+    t.string :last_name, null: false
+    t.string :email, null: false, index: { unique: true }
+    t.integer :phone_number, limit: 1
+  end
+```
+
+The following validations will be added to your model:
+
+```ruby
+validates :first_name, presence: true
+validates :last_name,  presence: true
+validates :email,      presence: true
+
+validates :first_name, length: { maximum: 10 }
+validates :phone_number, numericality: { greater_than: -127, less_than: 127 }, allow_nil: true
+
+validates :email, uniqueness: true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lollar/validate_me. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ValidateMe project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lollar/validate_me/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "validate_me"
+require "active_record"
+require "sqlite3"
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :first_name, limit: 10, null: false
+    t.string :last_name, null: false
+    t.string :email, null: false, index: { unique: true }
+    t.string :username
+    t.integer :phone_number, limit: 1, null: false
+  end
+end
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end
+
+class User < ApplicationRecord
+  include ValidateMe
+end
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/validate_me.rb

@@ -0,0 +1,23 @@
+require "validate_me/version"
+require "validate_me/presence_validations"
+require "validate_me/varchar_limit_validations"
+require "validate_me/integer_limit_validations"
+require "validate_me/uniqueness_validations"
+
+module ValidateMe
+  SKIPPED_COLUMNS = ["id"].freeze
+  class Error < StandardError; end
+
+  def self.included base_class
+    base_class.columns.each do |column|
+      next if ::ValidateMe::SKIPPED_COLUMNS.include? column.name
+
+      ::ValidateMe::PresenceValidations.call     base_class: base_class, column: column
+      ::ValidateMe::VarcharLimitValidations.call base_class: base_class, column: column
+      ::ValidateMe::IntegerLimitValidations.call base_class: base_class, column: column
+    end
+
+   indexes = ::ActiveRecord::Base.connection.indexes base_class.table_name
+   ::ValidateMe::UniquenessValidations.call base_class: base_class, indexes: indexes
+  end
+end

data/lib/validate_me/integer_limit_validations.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ValidateMe
+  class IntegerLimitValidations
+    def self.call base_class:, column:
+      return nil unless column.type == :integer && column.limit.present?
+
+      new(column).validate base_class
+    end
+
+    def initialize column
+      @column = column
+    end
+
+    def validate base_class
+      base_class.send(
+        :validates,
+        column.name,
+        numericality: {
+          greater_than: minimum_value,
+          less_than:    maximum_value
+        },
+        allow_nil: true
+      )
+    end
+
+    private
+
+    attr_reader :column
+
+    def maximum_value
+      (1 << column.limit * 8 - 1) - 1
+    end
+
+    def minimum_value
+      -(maximum_value + 1)
+    end
+  end
+end

data/lib/validate_me/presence_validations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ValidateMe
+  class PresenceValidations
+    def self.call base_class:, column:
+      return nil if column.null || column.null.nil?
+
+      new(column).validate base_class
+    end
+
+    def initialize column
+      @column = column
+    end
+
+    def validate base_class
+      base_class.send :validates, column.name, presence: true
+    end
+
+    private
+
+    attr_reader :column
+  end
+end

data/lib/validate_me/uniqueness_validations.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ValidateMe
+  class UniquenessValidations
+    def self.call base_class:, indexes:
+      indexes.each do |index|
+        next unless index.unique
+
+        new(index).validate base_class
+      end
+    end
+
+    def initialize index
+      @index = index
+    end
+
+    def validate base_class
+      columns = index.columns
+
+      if columns.one?
+        base_class.send :validates, columns.first, uniqueness: true
+      else
+        base_class.send :validates, columns.shift, uniqueness: { scope: columns }
+      end
+    end
+
+    private
+
+    attr_reader :index
+  end
+end

data/lib/validate_me/validations.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+

data/lib/validate_me/varchar_limit_validations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ValidateMe
+  class VarcharLimitValidations
+    def self.call base_class:, column:
+      return nil unless column.type == :string && column.limit.present?
+
+      new(column).validate base_class
+    end
+
+    def initialize column
+      @column = column
+    end
+
+    def validate base_class
+      base_class.send :validates, column.name, length: { maximum: column.limit }
+    end
+
+    private
+
+    attr_reader :column
+  end
+end

data/lib/validate_me/version.rb

@@ -0,0 +1,3 @@
+module ValidateMe
+  VERSION = "0.1.0"
+end

data/validate_me.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "validate_me/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "validate_me"
+  spec.version       = ValidateMe::VERSION
+  spec.authors       = ["lollar"]
+  spec.email         = ["mike@lollar.codes"]
+
+  spec.summary       = "Built-in validations for ActiveRecord models"
+  spec.description   = "Automatically adds validations to ActiveRecord models that match your database constraints"
+  spec.homepage      = "https://github.com/lollar/validate_me"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: validate_me
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lollar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Automatically adds validations to ActiveRecord models that match your
+  database constraints
+email:
+- mike@lollar.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/validate_me.rb
+- lib/validate_me/integer_limit_validations.rb
+- lib/validate_me/presence_validations.rb
+- lib/validate_me/uniqueness_validations.rb
+- lib/validate_me/validations.rb
+- lib/validate_me/varchar_limit_validations.rb
+- lib/validate_me/version.rb
+- validate_me.gemspec
+homepage: https://github.com/lollar/validate_me
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Built-in validations for ActiveRecord models
+test_files: []