changes_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9232b72a8a820e08048cd79cc4f970a1f74e7b4
+  data.tar.gz: 1dac8a68b32ae3f430ac4d7122b14175dbac8fcd
+SHA512:
+  metadata.gz: 61a6eea8080594c5975109fdc8a6818b11f89b9d672607830880a84ccce4d42ef53d4dc37ab52a6b0d8cc61cbe9d3eda4885f1271e2f772209e35a0fe374d7c5
+  data.tar.gz: 36bd3f37116a16085165378ed4c3bf0cf17fa87d813b8880fa6ad6a75871ef4cc33926bd1e4cd1c8ecac152a797d222eeadae26de1debd615f38757694b34997

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in changes_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bogdan Gusiev
+
+MIT License
+
+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,67 @@
+# ChangesValidator
+
+ChangesValidator is the most minimalistic state machine implementation focused on validating a state changes rather than define API methods and logic.
+
+
+## Why ChangesValidator?
+
+The best way to define API and logic in Ruby is using Ruby.
+ChangesValidator does only validation that Object can move from one state to another.
+
+## Dependencies
+
+ActiveModel
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'changes_validator'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+
+### Basic setup
+
+If the state machine's main goal is to validate changess than let's implement it as a validation:
+
+``` ruby
+class Reward < AR::Base
+  validates! :state, :changes => { 
+    nil => [:pending], # Initial state is always pending
+    :pending => [:approved, :rejected], # Pending can be changesed to to approved and rejected
+    :approved => :paid # Approved can only be changesed to paid
+  }
+end
+```
+
+Recommended to use with strict validation method: `validates!` as wrong state changes use to be programmer mistake but not user input mistake.
+In this case exception will be raise and logged.
+
+
+### Advanced Options
+
+* `:message` - validation message.  Can have %{value} and %{old\_value} interpolation variables.
+  * Default: "Can not be changesed to %{value}"
+  * Example: "Can not be changesed from %{old\_value} to %{value}"
+* `:allow_nil` - don't apply validator if value is nil
+* `:allow_blank` - don't apply validator if value is blank
+* `:if` - only apply validator if specified method return true
+* `:unless` - only apply validator if specified method return false
+* `:strict` - if true this validator will always raise  when record is invalid
+  * Default:
+  
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/changes_validator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'changes_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "changes_validator"
+  spec.version       = ChangesValidator::VERSION
+  spec.authors       = ["Bogdan Gusiev"]
+  spec.email         = ["agresso@gmail.com"]
+  spec.description   = %q{ActiveModel validator that acts like state machine}
+  spec.summary       = %q{This validator allows to specify a mapping of allowed changess for given attribute and validate that this attribute can only be transfered according to changess map}
+  spec.homepage      = "https://github.com/bogdan/changes_validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activemodel"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug" if RUBY_VERSION >= "2.0"
+end

data/lib/changes_validator.rb

@@ -0,0 +1,39 @@
+require "active_model"
+
+class ChangesValidator < ActiveModel::EachValidator
+
+  def initialize(*)
+    super
+    normalize_options
+  end
+
+  def validate_each(record, attribute, value)
+    ensure_supports_dirty(record)
+    changes = record.changes[attribute.to_s]
+    return unless changes
+    changess = options[:with]
+    start = changes.first
+    destination = value
+
+    allowed_changess = changess[start]
+    if !allowed_changess || !Array(allowed_changess).map {|s| s.to_s }.include?(destination.to_s)
+      record.errors.add(attribute, :changes, :old_value => start, :message => options[:message])
+    end
+  end
+
+  def ensure_supports_dirty(record)
+    unless record.respond_to?(:changes)
+      raise ConfigurationError, "ChangesValidator can only be applied to model with dirty support (ActiveModel::Dirty)"
+    end
+  end
+
+  class ConfigurationError < Exception; end
+
+  def normalize_options
+    unless options[:with]
+      @options = {:with => options}
+    end
+  end
+end
+
+I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)

data/lib/changes_validator/version.rb

@@ -0,0 +1,4 @@
+require "active_model"
+class ChangesValidator < ActiveModel::EachValidator
+  VERSION = "0.0.1"
+end

data/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  errors:
+    # The values :model, :attribute, :value and :old_value are always available for interpolation
+    messages:
+      changes: "can't be changesed to %{value}"

data/spec/changes_validator_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+class User
+  include ActiveModel::Dirty
+  include ActiveModel::Validations
+
+  define_attribute_methods [:state]
+
+  def state
+    @state
+  end
+
+  def state=(val)
+    state_will_change! unless val == @state
+    @state = val
+  end
+
+  def save!
+    raise 'invalid' unless valid?
+    @previously_changed = changes
+    @changed_attributes.clear
+  end
+
+  def truthly?
+    true
+  end
+
+  def falsy?
+    false
+  end
+
+
+end
+
+
+describe ChangesValidator do
+  before do
+    User.clear_validators! 
+  end
+  let!(:user) { User.new }
+  it "should work" do
+    user.should be_valid
+  end
+
+  it "should support state change according to changess table" do
+    User.validates :state, :changes => {nil => [:pending, :approved]}
+    user.state = "pending"
+    user.should be_valid
+    user.state = "approved"
+    user.should be_valid
+  end
+
+  it "should return record invalid if changesed to wrong state" do
+    User.validates :state, :changes => {nil => [:pending, :approved]}
+    user.state = "voided"
+    user.should_not be_valid
+    user.errors[:state].should_not be_empty
+    user.errors[:state].first.should == "can't be changesed to voided"
+  end
+
+
+  it "should raise exception when model don't support dirty" do
+    klass = Class.new {
+      include ActiveModel::Validations
+      attr_accessor :state
+      validates :state, :changes => {nil => :pending}
+    }
+    proc  {
+      klass.new.valid?
+    }.should raise_error(ChangesValidator::ConfigurationError)
+  end
+  it "should be able to use custom message" do
+    User.validates :state, :changes => {:with => {nil => [:pending, :approved]}, :message => "can not be changesed like this"}
+    user.state = 'declined'
+    user.should_not be_valid
+    user.errors[:state].should_not be_empty
+    user.errors[:state].first.should == "can not be changesed like this"
+  end
+  it "should be able to use old_value interpolation in custom message" do
+    User.validates :state, :changes => {:with => {nil => :pending, :pending => [:approved]}, :message => "can not be changesed from %{old_value} to %{value}"}
+    user.state = 'pending'
+    user.save!
+    user.state = 'declined'
+    user.should_not be_valid
+    user.errors[:state].should_not be_empty
+    user.errors[:state].first.should == "can not be changesed from pending to declined"
+  end
+  it "should be able to use allow_nil option" do
+    User.validates :state, :changes => {:with => {nil => :pending, :pending => [:approved]}}, :allow_nil => true
+    user.state = 'pending'
+    user.save!
+    user.state = nil
+    user.should be_valid
+  end
+  it "should be able to use allow_blank option" do
+    User.validates :state, :changes => {:with => {nil => :pending, :pending => [:approved]}}, :allow_blank => true
+    user.state = 'pending'
+    user.save!
+    user.state = ' '
+    user.should be_valid
+  end
+  it "should be able to use if option" do
+    User.validates :state, :changes => {:with => {nil => :pending, :pending => [:approved]}}, :if => :falsy?
+    user.state = 'approved'
+    user.should be_valid
+  end
+  it "should be able to use unless option" do
+    User.validates :state, :changes => {:with => {nil => :pending, :pending => [:approved]}}, :unless => :truthly?
+    user.state = 'approved'
+    user.should be_valid
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'bundler/setup'
+require 'changes_validator' # and any other gems you need
+
+RSpec.configure do |config|
+ I18n.enforce_available_locales = true
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: changes_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bogdan Gusiev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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
+  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: byebug
+  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: ActiveModel validator that acts like state machine
+email:
+- agresso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- changes_validator.gemspec
+- lib/changes_validator.rb
+- lib/changes_validator/version.rb
+- locales/en.yml
+- spec/changes_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bogdan/changes_validator
+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.2.2
+signing_key: 
+specification_version: 4
+summary: This validator allows to specify a mapping of allowed changess for given
+  attribute and validate that this attribute can only be transfered according to changess
+  map
+test_files:
+- spec/changes_validator_spec.rb
+- spec/spec_helper.rb