pretty_validation 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.rubocop.yml +19 -0
- data/.travis.yml +11 -0
- data/Gemfile +4 -0
- data/README.md +94 -0
- data/Rakefile +9 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/gemfiles/rails_40.gemfile +5 -0
- data/gemfiles/rails_41.gemfile +5 -0
- data/gemfiles/rails_42.gemfile +5 -0
- data/lib/pretty_validation.rb +3 -0
- data/lib/pretty_validation/monkey/new_hash_syntax.rb +7 -0
- data/lib/pretty_validation/railtie.rb +15 -0
- data/lib/pretty_validation/renderer.rb +66 -0
- data/lib/pretty_validation/schema.rb +16 -0
- data/lib/pretty_validation/tasks/validation.rake +22 -0
- data/lib/pretty_validation/validation.rb +56 -0
- data/lib/pretty_validation/validation_findable.rb +16 -0
- data/lib/pretty_validation/version.rb +3 -0
- data/pretty_validation.gemspec +27 -0
- metadata +151 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 1a7a399de62c322c953c66ab905d303ba5e3a8ca
|
4
|
+
data.tar.gz: 9aff5cdff6ac4400dc7420ea60c7e6daf142f4ca
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b0a7112a9f57643e6c7d1756527a94810dcb4167add692a1a4fa1f446d1bd3210b26ed5a1cbcbd616fe77a8159d5dfec0715c31cd8402772009af571caaa694f
|
7
|
+
data.tar.gz: 89d5650ba05f43a1991ae4241abcb1adfebc3af78b3dbaff941436e03aa5877fd92a45e0f3429aaa532a40f42c0311517e9950c2051890f27e47b100ae3515ec
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
AllCops:
|
2
|
+
DisplayCopNames: true
|
3
|
+
|
4
|
+
Metrics/LineLength:
|
5
|
+
Max: 105
|
6
|
+
|
7
|
+
Style/Documentation:
|
8
|
+
Enabled: false
|
9
|
+
|
10
|
+
Lint/StringConversionInInterpolation:
|
11
|
+
Exclude:
|
12
|
+
# Refinements が文字列埋め込みで効かない
|
13
|
+
- 'lib/pretty_validation/validation.rb'
|
14
|
+
|
15
|
+
Metrics/AbcSize:
|
16
|
+
Max: 17
|
17
|
+
|
18
|
+
Lint/HandleExceptions:
|
19
|
+
Enabled: false
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,94 @@
|
|
1
|
+
# PrettyValidation
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/sinsoku/pretty_validation.svg?branch=master)](https://travis-ci.org/sinsoku/pretty_validation)
|
4
|
+
|
5
|
+
**"Make validations DRY"**
|
6
|
+
|
7
|
+
You need not write validations generated by database schema.
|
8
|
+
|
9
|
+
## Features
|
10
|
+
|
11
|
+
1. generate validation modules from database schema to `app/validations/` directory
|
12
|
+
1. automatically includes validation module into corresponding model
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
Add this line to your application's Gemfile:
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
gem 'pretty_validation'
|
20
|
+
```
|
21
|
+
|
22
|
+
And then execute:
|
23
|
+
|
24
|
+
$ bundle
|
25
|
+
|
26
|
+
Or install it yourself as:
|
27
|
+
|
28
|
+
$ gem install pretty_validation
|
29
|
+
|
30
|
+
## Usage
|
31
|
+
|
32
|
+
You can generate validation modules in two ways.
|
33
|
+
|
34
|
+
- run the `db:migrate` task, and then automatically generates the modules.
|
35
|
+
- run the `validation:generate` task
|
36
|
+
|
37
|
+
Note: The module is overwritten each time the task.
|
38
|
+
|
39
|
+
## Examples
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
# db/migrate/20151105090101_create_users.rb
|
43
|
+
class CreateUsers < ActiveRecord::Migration
|
44
|
+
def change
|
45
|
+
create_table :users do |t|
|
46
|
+
t.string :name, null: false
|
47
|
+
t.integer :age, null: false
|
48
|
+
t.boolean :admin
|
49
|
+
|
50
|
+
t.timestamps null: false
|
51
|
+
end
|
52
|
+
add_index :users, :name, unique: true
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
# app/validations/user_validation.rb
|
57
|
+
module UserValidation
|
58
|
+
extend ActiveSupport::Concern
|
59
|
+
|
60
|
+
included do
|
61
|
+
validates :name, presence: true
|
62
|
+
validates :age, presence: true, numericality: true
|
63
|
+
validates_uniqueness_of :name
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
# app/models/user.rb
|
68
|
+
class User < ActiveRecord::Base
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
And run `rails console`:
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
Loading development environment (Rails 4.2.4)
|
76
|
+
irb(main):001:0> user = User.new
|
77
|
+
=> #<User id: nil, name: nil, age: nil, admin: nil, created_at: nil, updated_at: nil>
|
78
|
+
irb(main):002:0> user.valid?
|
79
|
+
User Exists (0.1ms) SELECT 1 AS one FROM "users" WHERE "users"."name" IS NULL LIMIT 1
|
80
|
+
=> false
|
81
|
+
irb(main):003:0> p user.errors.full_messages
|
82
|
+
["Name can't be blank", "Age can't be blank", "Age is not a number"]
|
83
|
+
=> ["Name can't be blank", "Age can't be blank", "Age is not a number"]
|
84
|
+
```
|
85
|
+
|
86
|
+
## Supported versions
|
87
|
+
|
88
|
+
- Ruby 2.1.x, 2.2.x
|
89
|
+
- Rails 4+
|
90
|
+
|
91
|
+
## Contributing
|
92
|
+
|
93
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/sinsoku/pretty_validation.
|
94
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require 'bundler/setup'
|
4
|
+
require 'pretty_validation'
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require 'irb'
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'rails'
|
2
|
+
|
3
|
+
module PrettyValidation
|
4
|
+
class Railtie < Rails::Railtie
|
5
|
+
rake_tasks do
|
6
|
+
load 'pretty_validation/tasks/validation.rake'
|
7
|
+
end
|
8
|
+
|
9
|
+
initializer 'pretty_validation' do
|
10
|
+
ActiveSupport.on_load :active_record do
|
11
|
+
ActiveRecord::Base.include PrettyValidation::ValidationFindable
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
require 'pretty_validation/schema'
|
2
|
+
require 'pretty_validation/validation'
|
3
|
+
|
4
|
+
module PrettyValidation
|
5
|
+
class Renderer
|
6
|
+
attr_reader :table_name
|
7
|
+
|
8
|
+
def self.validations_path
|
9
|
+
Rails.root.join('app', 'validations')
|
10
|
+
end
|
11
|
+
|
12
|
+
def self.generate
|
13
|
+
FileUtils.mkdir_p validations_path unless File.directory? validations_path
|
14
|
+
Schema.table_names.each do |t|
|
15
|
+
r = new t
|
16
|
+
r.write! unless r.validations.empty?
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def initialize(table_name)
|
21
|
+
@table_name = table_name
|
22
|
+
end
|
23
|
+
|
24
|
+
def render
|
25
|
+
<<-EOF
|
26
|
+
module #{module_name}
|
27
|
+
extend ActiveSupport::Concern
|
28
|
+
|
29
|
+
included do
|
30
|
+
#{validations.join("\n ")}
|
31
|
+
end
|
32
|
+
end
|
33
|
+
EOF
|
34
|
+
end
|
35
|
+
|
36
|
+
def module_name
|
37
|
+
"#{table_name.classify}Validation"
|
38
|
+
end
|
39
|
+
|
40
|
+
def file_name
|
41
|
+
"#{module_name.underscore}.rb"
|
42
|
+
end
|
43
|
+
|
44
|
+
def file_path
|
45
|
+
Renderer.validations_path.join(file_name)
|
46
|
+
end
|
47
|
+
|
48
|
+
def write!
|
49
|
+
File.write(file_path, render)
|
50
|
+
end
|
51
|
+
|
52
|
+
def validations
|
53
|
+
sexy_validations + uniq_validations
|
54
|
+
end
|
55
|
+
|
56
|
+
private
|
57
|
+
|
58
|
+
def sexy_validations
|
59
|
+
Validation.sexy_validations(table_name)
|
60
|
+
end
|
61
|
+
|
62
|
+
def uniq_validations
|
63
|
+
Validation.unique_validations(table_name)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
module PrettyValidation
|
2
|
+
class Schema
|
3
|
+
def self.table_names
|
4
|
+
ActiveRecord::Base.connection.tables
|
5
|
+
.delete_if { |t| t == ActiveRecord::SchemaMigration.table_name }
|
6
|
+
end
|
7
|
+
|
8
|
+
def self.columns(table_name)
|
9
|
+
ActiveRecord::Base.connection.columns(table_name)
|
10
|
+
end
|
11
|
+
|
12
|
+
def self.indexes(table_name)
|
13
|
+
ActiveRecord::Base.connection.indexes(table_name)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
tasks = Rake.application.instance_variable_get '@tasks'
|
2
|
+
original_db_dump = tasks.delete 'db:_dump'
|
3
|
+
|
4
|
+
namespace :validation do
|
5
|
+
desc 'Generate validations from database schema'
|
6
|
+
task :generate do
|
7
|
+
require 'pretty_validation/renderer'
|
8
|
+
PrettyValidation::Renderer.generate
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
namespace :db do
|
13
|
+
task :_dump do
|
14
|
+
original_db_dump.invoke
|
15
|
+
# Allow this task to be called as many times as required. An example is the
|
16
|
+
# migrate:redo task, which calls other two internally that depend on this one.
|
17
|
+
original_db_dump.reenable
|
18
|
+
|
19
|
+
require 'pretty_validation/renderer'
|
20
|
+
PrettyValidation::Renderer.generate
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
require 'pretty_validation/monkey/new_hash_syntax'
|
2
|
+
|
3
|
+
module PrettyValidation
|
4
|
+
class Validation
|
5
|
+
using NewHashSyntax
|
6
|
+
|
7
|
+
attr_reader :method_name, :column_name, :options
|
8
|
+
|
9
|
+
def self.sexy_validations(table_name)
|
10
|
+
columns = Schema.columns(table_name)
|
11
|
+
columns = columns.reject { |x| x.name.in? %w(id created_at updated_at) }
|
12
|
+
|
13
|
+
columns.map do |column|
|
14
|
+
options = {}
|
15
|
+
options[:presence] = true unless column.null
|
16
|
+
options[:numericality] = true if column.type == :integer
|
17
|
+
|
18
|
+
Validation.new('validates', column.name.to_sym, options) if options.present?
|
19
|
+
end.compact
|
20
|
+
end
|
21
|
+
|
22
|
+
def self.unique_validations(table_name)
|
23
|
+
Schema.indexes(table_name).select(&:unique).reverse.map do |x|
|
24
|
+
column_name = x.columns[0]
|
25
|
+
scope = x.columns[1..-1].map(&:to_sym)
|
26
|
+
options = if scope.size > 1
|
27
|
+
{ scope: scope }
|
28
|
+
elsif scope.size == 1
|
29
|
+
{ scope: scope[0] }
|
30
|
+
end
|
31
|
+
|
32
|
+
Validation.new('validates_uniqueness_of', column_name.to_sym, options)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
def initialize(method_name, column_name, options = nil)
|
37
|
+
@method_name = method_name
|
38
|
+
@column_name = column_name
|
39
|
+
@options = options
|
40
|
+
end
|
41
|
+
|
42
|
+
def ==(other)
|
43
|
+
method_name == other.method_name &&
|
44
|
+
column_name == other.column_name &&
|
45
|
+
options == other.options
|
46
|
+
end
|
47
|
+
|
48
|
+
def to_s
|
49
|
+
if options.blank?
|
50
|
+
"#{method_name} #{column_name.inspect}"
|
51
|
+
else
|
52
|
+
"#{method_name} #{column_name.inspect}, #{options.to_s}"
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
module PrettyValidation
|
2
|
+
module ValidationFindable
|
3
|
+
extend ActiveSupport::Concern
|
4
|
+
|
5
|
+
module ClassMethods
|
6
|
+
def inherited(kls)
|
7
|
+
super(kls)
|
8
|
+
begin
|
9
|
+
kls.include "#{kls}Validation".constantize if kls.superclass == ::ActiveRecord::Base
|
10
|
+
rescue NameError
|
11
|
+
# nothing
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'pretty_validation/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'pretty_validation'
|
8
|
+
spec.version = PrettyValidation::VERSION
|
9
|
+
spec.authors = ['sinsoku']
|
10
|
+
spec.email = ['sinsoku.listy@gmail.com']
|
11
|
+
|
12
|
+
spec.summary = 'PrettyValidation generate validation modules from database schema'
|
13
|
+
spec.description = 'PrettyValidation generate validation modules from database schema'
|
14
|
+
spec.homepage = 'https://github.com/sinsoku/pretty_validation'
|
15
|
+
spec.license = 'MIT'
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.require_paths = ['lib']
|
19
|
+
|
20
|
+
spec.add_dependency 'rails', '>= 4.0.0'
|
21
|
+
|
22
|
+
spec.add_development_dependency 'bundler', '~> 1.10'
|
23
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
24
|
+
spec.add_development_dependency 'rspec'
|
25
|
+
spec.add_development_dependency 'sqlite3'
|
26
|
+
spec.add_development_dependency 'rubocop'
|
27
|
+
end
|
metadata
ADDED
@@ -0,0 +1,151 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: pretty_validation
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- sinsoku
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-11-12 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rails
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 4.0.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 4.0.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.10'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.10'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: sqlite3
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rubocop
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
description: PrettyValidation generate validation modules from database schema
|
98
|
+
email:
|
99
|
+
- sinsoku.listy@gmail.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".gitignore"
|
105
|
+
- ".rspec"
|
106
|
+
- ".rubocop.yml"
|
107
|
+
- ".travis.yml"
|
108
|
+
- Gemfile
|
109
|
+
- README.md
|
110
|
+
- Rakefile
|
111
|
+
- bin/console
|
112
|
+
- bin/setup
|
113
|
+
- gemfiles/rails_40.gemfile
|
114
|
+
- gemfiles/rails_41.gemfile
|
115
|
+
- gemfiles/rails_42.gemfile
|
116
|
+
- lib/pretty_validation.rb
|
117
|
+
- lib/pretty_validation/monkey/new_hash_syntax.rb
|
118
|
+
- lib/pretty_validation/railtie.rb
|
119
|
+
- lib/pretty_validation/renderer.rb
|
120
|
+
- lib/pretty_validation/schema.rb
|
121
|
+
- lib/pretty_validation/tasks/validation.rake
|
122
|
+
- lib/pretty_validation/validation.rb
|
123
|
+
- lib/pretty_validation/validation_findable.rb
|
124
|
+
- lib/pretty_validation/version.rb
|
125
|
+
- pretty_validation.gemspec
|
126
|
+
homepage: https://github.com/sinsoku/pretty_validation
|
127
|
+
licenses:
|
128
|
+
- MIT
|
129
|
+
metadata: {}
|
130
|
+
post_install_message:
|
131
|
+
rdoc_options: []
|
132
|
+
require_paths:
|
133
|
+
- lib
|
134
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
140
|
+
requirements:
|
141
|
+
- - ">="
|
142
|
+
- !ruby/object:Gem::Version
|
143
|
+
version: '0'
|
144
|
+
requirements: []
|
145
|
+
rubyforge_project:
|
146
|
+
rubygems_version: 2.4.5.1
|
147
|
+
signing_key:
|
148
|
+
specification_version: 4
|
149
|
+
summary: PrettyValidation generate validation modules from database schema
|
150
|
+
test_files: []
|
151
|
+
has_rdoc:
|