transition_validator 1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE +22 -0
- data/README.md +53 -0
- data/Rakefile +2 -0
- data/lib/transition_validator/version.rb +5 -0
- data/lib/transition_validator.rb +29 -0
- data/transition_validator.gemspec +19 -0
- metadata +64 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2012 TODO: Write your name
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
# TransitionValidator
|
2
|
+
|
3
|
+
A custom validator for stateful attribute transitions.
|
4
|
+
It's use perfect with state_validator
|
5
|
+
for the State Machine implementation in your application.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'transition_validator'
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install transition_validator
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Place validator into your model:
|
24
|
+
|
25
|
+
validates :my_state_attribute, :transition => true
|
26
|
+
|
27
|
+
Place list of transitions:
|
28
|
+
|
29
|
+
def my_state_attribute_transitions
|
30
|
+
{
|
31
|
+
nil => ['on' , 'off'],
|
32
|
+
'on' => ['off'],
|
33
|
+
'off' => ['on']
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
Place required methods to do transition actions:
|
38
|
+
|
39
|
+
def off_to_on_my_state_attribute_transition
|
40
|
+
# Place actions for change a state of attribute "my_state_attribute" from "off" to "on"
|
41
|
+
end
|
42
|
+
|
43
|
+
def _to_on_my_state_attribute_transition
|
44
|
+
# Place actions for change a state of attribute "my_state_attribute" from nil to "on"
|
45
|
+
end
|
46
|
+
|
47
|
+
## Contributing
|
48
|
+
|
49
|
+
1. Fork it
|
50
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
51
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
52
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
53
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
require "transition_validator/version"
|
2
|
+
|
3
|
+
class TransitionValidator < ActiveModel::EachValidator
|
4
|
+
def validate_each(record, attribute, value)
|
5
|
+
from ||= record.changes[attribute].to_a.first
|
6
|
+
to ||= record.changes[attribute].to_a.last
|
7
|
+
if transition?(record, attribute, from, to)
|
8
|
+
if !transition!(record, attribute, from, to)
|
9
|
+
record.errors[attribute] << I18n.t('errors.messages.transition')
|
10
|
+
end
|
11
|
+
else
|
12
|
+
record.errors[attribute] << I18n.t('errors.messages.transition')
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def transition? record, attribute, from, to
|
17
|
+
transitions = eval "record.#{attribute}_transitions"
|
18
|
+
(from == to || (transitions.key?(from) && transitions[from].include?(to))) ? true : false
|
19
|
+
end
|
20
|
+
|
21
|
+
def transition! record, attribute, from, to
|
22
|
+
method = "record.#{from}_to_#{to}_#{attribute}_transition"
|
23
|
+
if record.methods.include?(method.to_sym) && from != to
|
24
|
+
eval(method)
|
25
|
+
else
|
26
|
+
true
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require File.expand_path('../lib/transition_validator/version', __FILE__)
|
3
|
+
|
4
|
+
Gem::Specification.new do |gem|
|
5
|
+
gem.authors = ['Nick Nizovtsev']
|
6
|
+
gem.email = ['nizovtsevnv@gmail.com']
|
7
|
+
gem.description = %q{A custom validator for stateful attribute transitions.}
|
8
|
+
gem.summary = %q{Validate changes of stateful attribute values.}
|
9
|
+
gem.homepage = 'http://github.com/nizovtsevnv/transition_validator'
|
10
|
+
|
11
|
+
gem.files = `git ls-files`.split($\)
|
12
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
13
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
14
|
+
gem.name = "transition_validator"
|
15
|
+
gem.require_paths = ["lib"]
|
16
|
+
gem.version = TransitionValidator::VERSION
|
17
|
+
|
18
|
+
gem.add_dependency('activemodel')
|
19
|
+
end
|
metadata
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: transition_validator
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: '1.0'
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Nick Nizovtsev
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2012-05-12 00:00:00.000000000Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: activemodel
|
16
|
+
requirement: &80187540 !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: *80187540
|
25
|
+
description: A custom validator for stateful attribute transitions.
|
26
|
+
email:
|
27
|
+
- nizovtsevnv@gmail.com
|
28
|
+
executables: []
|
29
|
+
extensions: []
|
30
|
+
extra_rdoc_files: []
|
31
|
+
files:
|
32
|
+
- .gitignore
|
33
|
+
- Gemfile
|
34
|
+
- LICENSE
|
35
|
+
- README.md
|
36
|
+
- Rakefile
|
37
|
+
- lib/transition_validator.rb
|
38
|
+
- lib/transition_validator/version.rb
|
39
|
+
- transition_validator.gemspec
|
40
|
+
homepage: http://github.com/nizovtsevnv/transition_validator
|
41
|
+
licenses: []
|
42
|
+
post_install_message:
|
43
|
+
rdoc_options: []
|
44
|
+
require_paths:
|
45
|
+
- lib
|
46
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
47
|
+
none: false
|
48
|
+
requirements:
|
49
|
+
- - ! '>='
|
50
|
+
- !ruby/object:Gem::Version
|
51
|
+
version: '0'
|
52
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
53
|
+
none: false
|
54
|
+
requirements:
|
55
|
+
- - ! '>='
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
version: '0'
|
58
|
+
requirements: []
|
59
|
+
rubyforge_project:
|
60
|
+
rubygems_version: 1.8.17
|
61
|
+
signing_key:
|
62
|
+
specification_version: 3
|
63
|
+
summary: Validate changes of stateful attribute values.
|
64
|
+
test_files: []
|