codez-validates_by_schema 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmU4ZTkyMzRhOWI4MWQxMGFhZGE1NTZlOWQyM2VmODA2ZDkwYzY4Nw==
+  data.tar.gz: !binary |-
+    MjZhMWQ2ZDYxM2I4NmNmYTc5NDEzYWZkYjE4NjZjYzE2ODM2ZGQwYw==
+SHA512:
+  metadata.gz: !binary |-
+    YWJjM2FmYTEyZmE5Yzc4M2FjMjQzMjA3ZTU3N2RhMDc0ZGRmMzI3OWQyY2Fl
+    ZjQzYTEwZDgxOWI0MTA4MDJjNTgzMTA4NGVhMGFkM2YxZjk1ZGY3ZjE1Y2Nm
+    YWI4ZWUxNWM3YmVjZjg1ZmY0YTdlYjJmZGViNjM5MjY5NjhmNWY=
+  data.tar.gz: !binary |-
+    MTMyNGQwYWEwNTM2Y2M5ZTVlZmE2NDBjNTA5OWY2NjdlYzU0MDgzYjFmMjE3
+    OTg3ZDI3MWE5NGM2ODg4YjdhYTNjMDFkOTg4MjlkOGQ1ODY4MTg3NGUwN2Q4
+    ZjkyNTM2YTY4Y2VkYWM3Yjg0MmI4YmY5YWQ3NzI0NDg0YjIxZjY=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,65 @@
+# Validates By Schema (validates_by_schema)
+[![Build Status](https://secure.travis-ci.org/joshwlewis/validates_by_schema.png)](http://travis-ci.org/joshwlewis/validates_by_schema) 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/joshwlewis/validates_by_schema)
+[![Dependency Status](https://gemnasium.com/joshwlewis/validates_by_schema.png)](https://gemnasium.com/joshwlewis/validates_by_schema)
+[![Gem Version](https://badge.fury.io/rb/validates_by_schema.png)](http://badge.fury.io/rb/validates_by_schema)
+
+Automatic validation based on your database schema column types and limits. Keep your code DRY by inferring column validations from table properties!
+
+## Example
+
+Say you had a table setup like this:
+
+```ruby
+create_table "widgets", :force => true do |t|
+  t.integer  "quantity", :limit => 2
+  t.decimal  "thickness", :precision => 4, :scale => 4
+  t.string   "color", :null => false
+end
+```
+
+Then these validations are inferred when you add `validates_by_schema` to your model:
+
+```ruby
+validates :quantity, numericality: { allow_nil: true,
+  greater_than: -32768, less_than: 32768}
+validates :thickness, numericality: {allow_nil: true, 
+  less_than_or_equal_to: 0.999, greater_than_or_equal_to: -0.999}
+validates :color, presence: true, length: {allow_nil: false, maximum: 255}
+```
+
+## Installation
+
+1. Add it to your Gemfile:
+
+```ruby
+gem "validates_by_schema"
+```
+
+2. Then `bundle`
+
+3. Call it from your ActiveRecord model:
+
+```ruby
+class Widget < ActiveRecord::Base
+  validates_by_schema
+end
+```
+
+## Usage
+
+You can also whitelist or blacklist columns with :only or :except options, respectively:
+
+```ruby
+validates_by_schema only: [:body, :description]
+```
+
+```ruby
+validates_by_schema except: [:name, :title]
+```
+
+## Notes
+
+Column properties are inferred by your database adapter (like pg, mysql2, sqlite3), and does not depend on migration files or schema.rb. As such, you could use this on projects where the database where Rails is not in control of the database configuration.
+
+This has been tested with mysql, postgresql, and sqlite3. It should work with any other database that has reliable adapter.

data/Rakefile

@@ -0,0 +1,44 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesBySchema'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = ['--backtrace']
+end
+
+task default: :spec
+
+
+namespace :db do
+  task :create do
+    case ENV['DB']
+    when'postgresql'
+      exec "psql -c 'create database validates_by_schema_test;' -U postgres"
+    when 'mysql'
+      exec "mysql -e 'create database validates_by_schema_test;'"
+    end
+  end
+end

data/lib/validates_by_schema.rb

@@ -0,0 +1,61 @@
+module ValidatesBySchema
+  autoload :ValidationOption, 'validates_by_schema/validation_option'
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def validates_by_schema(options = {})
+      return unless table_exists?
+
+      columns = schema_validateable_columns
+      customize_columns(columns, options)
+      define_validations(columns)
+      define_association_validations
+    end
+
+    def schema_validateable_columns
+      # Don't auto validate primary, foreign keys or timestamps
+      foreign_keys = all_foreign_keys
+      columns.reject do |c|
+        c.name == primary_key.to_s ||
+        %w(updated_at created_at).include?(c.name) ||
+        foreign_keys.include?(c.name)
+      end
+    end
+
+    def customize_columns(columns, options)
+      # Allow user to specify :only or :except options
+      { only: :select!, except: :reject! }.each do |k, v|
+        if options[k]
+          attrs = Array(options[k]).collect(&:to_s)
+          columns.send(v) { |c| attrs.include?(c.name) }
+        end
+      end
+    end
+
+    def define_validations(columns)
+      columns.each do |c|
+        vo = ValidationOption.new(c).to_hash
+        validates c.name, vo if vo.present?
+      end
+    end
+
+    def define_association_validations
+      reflect_on_all_associations(:belongs_to).each do |association|
+        column = columns_hash[association.foreign_key.to_s]
+        next unless column
+        validates association.name, presence: true unless column.null
+      end
+    end
+
+    def all_foreign_keys
+      reflect_on_all_associations(:belongs_to).collect do |association|
+        association.foreign_key.to_s
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  include ValidatesBySchema
+end

data/lib/validates_by_schema/validation_option.rb

@@ -0,0 +1,71 @@
+class ValidatesBySchema::ValidationOption
+  # column here must be an ActiveRecord column
+  # i.e. MyARModel.columns.first
+  attr_accessor :column
+
+  def initialize(column)
+    @column = column
+  end
+
+  def presence?
+    presence && column.type != :boolean
+  end
+
+  def presence
+    !column.null
+  end
+
+  def numericality?
+    [:integer, :decimal, :float].include? column.type
+  end
+
+  def numericality
+    numericality = {}
+    if column.type == :integer
+      numericality[:only_integer] = true
+      if integer_max
+        numericality[:less_than] = integer_max
+        numericality[:greater_than] = -integer_max
+      end
+    elsif column.type == :decimal
+      numericality[:less_than_or_equal_to] = decimal_max
+      numericality[:greater_than_or_equal_to] = -decimal_max
+    end
+    numericality[:allow_nil] = true
+    numericality
+  end
+
+  def length?
+    [:string, :text].include?(column.type) && column.limit
+  end
+
+  def length
+    { maximum: column.limit, allow_nil: true }
+  end
+
+  def inclusion?
+    column.type == :boolean
+  end
+
+  def inclusion
+    { in: [true, false], allow_nil: column.null }
+  end
+
+  def integer_max
+    (2**(8 * column.limit)) / 2 if column.limit
+  end
+
+  def decimal_max
+    10.0**(column.precision - column.scale) - 10.0**(-column.scale)
+  end
+
+  def to_hash
+    [:presence, :numericality, :length, :inclusion].inject({}) do |h, k|
+      send(:"#{k}?") ? h.merge(k => send(k)) : h
+    end
+  end
+
+  def to_s
+    to_hash.inspect
+  end
+end

data/lib/validates_by_schema/version.rb

@@ -0,0 +1,3 @@
+module ValidatesBySchema
+  VERSION = '0.3.0'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: codez-validates_by_schema
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Josh Lewis
+- Pascal Zumkehr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keep your code DRY by inferring column validations from table properties!
+  Automagically validate presence, length, numericality, and inclusion of ActiveRecord
+  backed columns.
+email:
+- josh.w.lewis@gmail.com
+- spam@codez.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/validates_by_schema.rb
+- lib/validates_by_schema/validation_option.rb
+- lib/validates_by_schema/version.rb
+homepage: http://github.com/codez/validates_by_schema
+licenses: []
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Automatic validation based on your database schema column types and limits.
+test_files: []