mv-mysql 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6734508bbd406ea2b3098a8a4c7616b5fc671ac
-  data.tar.gz: 2739c21e946bec792a83c1b2304e82666894162d
+  metadata.gz: 9abdfb79935b4424eb3cd33e0e0106f889ca7821
+  data.tar.gz: 49f6d0fdbd344bbc69acfd15bf9b683e26cc9ede
 SHA512:
-  metadata.gz: 7ffdff553b0935411404f0b07006cd962c64734dd9024224fe9b2518a94ca12adcb45bd3e3f2cb7ce22502d3b64873086aedce4fcdf9e7400298df0de293b353
-  data.tar.gz: c41929b80547e334441ba0c3e1c95b31c218ffeca93017bfc443b8db88927b713e9ce422fa787f9ff63e02199820f6e28b2d1b430172c50f7d8bcd52ccf43ed8
+  metadata.gz: 121e6abffa04e9b126beff0a739192f356e1a7bb77c2a9247fc9818c4b3ad76f31a408b3b7db951857869de1c28fba41e3282e1c56029e6dc70d55efa0103089
+  data.tar.gz: 9db74d62911dcd927c259ba641c4914c388b12819f35b54672877538a2883e83b3fc8d7b4e72ae8f10e3b313b5d2dd066adaf598ee5024a43081976eb18c5fb8

data/README.md

@@ -0,0 +1,256 @@
+# Introduction
+
+mv-mysql is the MySQL driver for Migration Validators project (details here: https://github.com/vprokopchuk256/mv-core)
+
+# Validators
+
+### uniqueness
+
+  Examples:
+
+  validate uniqueness of the column 'column_name':
+
+  ```ruby
+  validate_column :table_name, :column_name, uniqueness: true
+  ```
+
+  define validation as trigger with specified failure message:
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+                  uniqueness: { message: 'Error message', as: :trigger }
+  ```
+
+  define validation as unique index: 
+
+  ```ruby
+  validate_column :table_name, :column_name, uniqueness: { as: :index }
+  ```
+
+  all above are available in a create and change table blocks: 
+
+  ```ruby
+  create_table :table_name do |t|
+     t.string :column_name, validates: { uniqueness: true }
+  end
+  ```
+
+  ```ruby
+  change :table_name do |t|
+     t.change :column_name, :string, :validates: { uniqueness: false }
+  end
+  ```
+
+  Options: 
+
+  * `:message` - text of the error message that will be shown if constraint violated.  Ignored unless `:as == :trigger`
+  * `:index_name` - name of the index that will be created for validator. Ignored unless `:as == :index`
+  * `:on` - validation event. Possible values `[:save, :update, :create]`. Ignored unless `:as == :trigger`. Default value `:save`
+  * `:create_tigger_name` - name of the 'before insert' trigger that will be created if `:as == :trigger` && `:on` in `[:save, :create]`
+  * `:update_tigger_name` - name of the 'before update' trigger that will be created if `:as == :trigger` && `:on` in `[:save, :update]`
+  * `:allow_nil` - ignore validation for nil values. Ignored unless `:as == :trigger`. Default value: `false`
+  * `:allow_blank` - ignore validation for blank values. Ignored unless `:as == :trigger`. Default value: `false`
+  * `:as` - defines the way how constraint will be implemented. Possible values: `[:index, :trigger]`. Default value: `:index`
+
+### length
+
+  Examples: 
+
+  column value length should be more than 4 symbols and less than 9. Otherwise 'Wrong length message' error will be raised: 
+
+ ```ruby 
+  validate_column :table_name, :column_name, 
+                               length: { in: 5..8, 
+                                         message: 'Wrong length message' }
+ ```
+
+ allow `NULL`:
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+                               length: { is: 3, allow_nil: true}
+  ```
+
+  allow blank values: 
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+                        length: { maximum: 3, 
+                                  too_long: 'Value is longer than 3 symbols' } 
+  ```
+
+  Options:
+
+  * `:in`- range or array that length of the value should be contained in.
+  * `:within` - synonym of `:in`
+  * `:is`- exact length of the value
+  * `:maximum`- maximum allowed length
+  * `:minimum`- minimum allowed length
+  * `:message`- message that should be shown if validation failed and specific message is not defined
+  * `:too_long`- message that will be shown if value longer than allowed. Ignored unless maximum value is defined
+  * `:too_short`- message that will be shown if value shorter than allowed. Ignored unless minimum value is defined
+  * `:on`- validation event. Possible values `[:save, :update, :create]`. Default value: `:save` 
+  * `:create_tigger_name`- Name of the 'before insert' trigger
+  * `:update_tigger_name`- Name of the 'before update' trigger
+  * `:allow_nil`- ignore validation for nil values. Default value: `false`
+  * `:allow_blank`- ignore validation for blank values. Default value: `false`
+  * `:as`- defines the way how constraint will be implemented. Possible values: `[:trigger]`
+
+### inclusion
+
+  Examples:
+
+  valid values array: 
+
+  ```ruby
+  validate_column :table_name, :column_name, inclusion: { in: [1, 2, 3]}
+  ```
+
+  with failure message specified: 
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+  inclusion: { in: [1, 2, 3], 
+               message: "Column 'column_name' should be equal to 1 or 2 or 3" }
+  ```
+
+  Options:
+
+  * `:in range` - or array that column value should be contained in.
+  * `:message message` - that should be shown if validation failed
+  * `:on  validation` - event. Possible values `[:save, :update, :create]`. Default value: `:save`
+  * `:create_tigger_name` - Name of the 'before insert' trigger 
+  * `:update_tigger_name` - Name of the 'before update' trigger
+  * `:allow_nil` - ignore validation for nil values. Default value: `false`
+  * `:allow_blank` - ignore validation for blank values. Default value: `false`
+  * `:as` - defines the way how constraint will be implemented. Possible values: `[:trigger]`
+
+  
+### exclusion
+
+  Examples:
+
+  exclude 1, 2, and 3: 
+
+  ```ruby
+  validate_column :table_name, :column_name, exclusion: { in: [1, 2, 3] }
+  ```
+
+  exclude values with specified failure message:
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+    exclusion: { 
+        in: [1, 2, 3], 
+        message: "Column 'column_name' should not  be equal to 1 or 2 or 3"
+    }
+  ```
+
+  performs verification on update only:
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+                               exclusion: { in: [1, 2, 3], 
+                                            on: :update }
+  ```
+
+  Options:
+
+  * `:in` - range or array that column value should NOT be contained in.
+  message: message that should be shown if validation failed
+  * `:on` - validation event. Possible values `[:save, :update, :create]`. Default value: :save
+  *`:create_tigger_name` - name of the 'before insert' trigger
+  *`:update_tigger_name` - name of the 'before update' trigger
+  *`:allow_nil` - ignore validation for nil values. Default value: false
+  *`:allow_blank` - ignore validation for blank values. Default value: false
+  *`:as` - defines the way how constraint will be implemented. Possible values: `[:trigger]`
+
+### presence
+
+  Examples:
+
+  simple presence validator: 
+
+  ```ruby
+  validate_column :table_name, :column_name, presence: true
+  ```
+
+  with failure message: 
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+                  :presence: { message: 'value should not be empty' }
+  ```
+
+  performs verification only when new record is inserted:
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+                  presence: { message: 'value should not be empty', 
+                              on: :create }
+  ```
+
+  Options:
+
+  * `:message` - message that should be shown if validation failed
+  `:on`  validation event. Possible values `[:save, :update, :create]`. Default value: `:save`
+  * `:create_tigger_name` - name of the 'before insert' trigger
+  * `:update_tigger_name` - name of the 'before update' trigger
+  * `:allow_nil` - ignore validation for nil values. Default value: false
+  * `:allow_blank` - ignore validation for blank values. Default value: `false`
+  * `:as` - defines the way how constraint will be implemented. Possible values: `[:trigger]`
+
+### format
+
+  Allows to define regular expression that column value will be mathed  with
+
+  Example:
+
+  simple custom format validator: 
+
+  ```ruby
+  validate_column :table_name, :column_name, format: { with: /word/ }
+  ```
+
+  with custom failure message: 
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+            format: { with: /word/, 
+                      messsage: 'Column_name value should contain start word' }
+  ```
+
+  implemented as trigger: 
+
+  ```ruby
+  validate_column :table_name, :column_name, 
+            format: { with: /word/, 
+                      messsage: 'Column_name value should contain start word', as: :trigger }
+  ```
+
+  Options:
+
+  * `:with` - regular expression that column value should be matched to
+  * `:message` - message that should be shown if validation failed
+  * `:on` - validation event. Possible values `[:save, :update, :create]`. Default value: `:save`
+  * `:create_tigger_name` - name of the 'before insert' trigger
+  * `:update_tigger_name` - name of the 'before update' trigger
+  * `:allow_nil` - ignore validation for nil values. Default value: `false`
+  * `:allow_blank` - ignore validation for blank values. Default value: `false`
+  * `:as` - defines the way how constraint will be implemented. Possible values: `[:trigger]`
+
+## Contributing to mv-mysql
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Valeriy Prokopchuk. See LICENSE.txt for
+further details.
+

data/lib/migration_validators/adapters/mysql.rb

@@ -66,7 +66,7 @@ module MigrationValidators
       end
 
 
-      route :presense, :trigger, :default => true do
+      route :presence, :trigger, :default => true do
         to :insert_trigger, :if => {:on => [:save, :create, nil]}
         to :update_trigger, :if => {:on => [:save, :update, nil]}
       end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: mv-mysql
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Valeriy Prokopchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mv-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Migration Validators project mysql driver
 email: vprokopchuk@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
+- LICENSE.txt
+- README.md
 - lib/migration_validators/adapters/mysql.rb
 - lib/mv-mysql.rb
-- LICENSE.txt
-- README.rdoc
 homepage: http://github.com/vprokopchuk256/mv-mysql
 licenses:
 - MIT
@@ -84,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: Migration Validators project mysql driver
+summary: Migration Validators project. MySQL driver
 test_files: []

data/README.rdoc

@@ -1,162 +0,0 @@
-= Introduction
-
-mv-mysql is the MySQL driver for Migration Validators project (details here: https://github.com/vprokopchuk256/mv-core)
-
-= Validators
-
-=== uniqueness
-
-  Value uniqueness validation
-
-  Usage:
-  
-  validate_column :table_name, :column_name, :uniqueness => true
-  validate_column :table_name, :column_name, :uniqueness => {:message => 'Error message', :as => :trigger}
-  validate_column :table_name, :column_name, :uniqueness => {:as => :index}
-
-  create_table :table_name do |t|
-     t.string :column_name, :validates => {uniqueness => true}
-  end
-
-  Options: 
-
-  message:  text of the error message that will be shown if constraint violated.  Ignored unless :as == :trigger
-  index_name:   name of the index that will be created for validator. Ignored unless :as == :index
-  on:  validation event. Possible values [:save, :update, :create]. Ignored unless :as == :trigger. Default value :save
-  create_tigger_name: Name of the 'before insert' trigger that will be created if :as == :trigger && :on in [:save, :create]
-  update_tigger_name: Name of the 'before update' trigger that will be created if :as == :trigger && :on in [:save, :update]
-  allow_nil: ignore validation for nil values. Ignored unless :as == :trigger. Default value: false
-  allow_blank: ignore validation for blank values. Ignored unless :as == :trigger. Default value: false
-  as: defines the way how constraint will be implemented. Possible values: [:index, :trigger]. Default value: :index
-
-=== length
-
-  Value length validation
-
-  Usage: 
-
-  validate_column :table_name, :column_name, :length => {:in => 5..8, :message => "Wrong length message"}
-  validate_column :table_name, :column_name, :length => {:is => 3, :allow_nil => true}
-  validate_column :table_name, :column_name, :length => {:maximum => 3, :too_long => "Value is longer than 3 symbols"} 
-
-  Options:
-
-  in: range or array that length of the value should be contained in.
-  within: synonym of :in
-  is: exact length of the value
-  maximum:  maximum allowed length
-  minimum: minimum allowed length
-  message: message that should be shown if validation failed and specific message is not defined
-  too_long: message that will be shown if value longer than allowed. Ignored unless maximum value is defined
-  too_short: message that will be shown if value shorter than allowed. Ignored unless minimum value is defined
-  on:  validation event. Possible values [:save, :update, :create]. Default value: :save 
-  create_tigger_name: Name of the 'before insert' trigger
-  update_tigger_name: Name of the 'before update' trigger
-  allow_nil: ignore validation for nil values. Default value: false
-  allow_blank: ignore validation for blank values. Default value: false
-  as: defines the way how constraint will be implemented. Possible values: [:trigger]
-
-=== inclusion
-
-  Value inclusion validation
-
-  Usage:
-
-  validate_column :table_name, :column_name, :inclusion => {:in => [1, 2, 3]}
-  validate_column :table_name, :column_name, :inclusion => {:in => [1, 2, 3], :message => "Column 'column_name' should be equal to 1 or 2 or 3"}
-  validate_column :table_name, :column_name, :inclusion => {:in => [1, 2, 3], :on => :update, :as => :check}
-  validate_column :table_name, :column_name, :inclusion => {:in => 1..3, :on => :create, :as => :trigger}
-
-  Options:
-
-  in: range or array that column value should be contained in.
-  message: message that should be shown if validation failed
-  on:  validation event. Possible values [:save, :update, :create]. Default value: :save
-  create_tigger_name: Name of the 'before insert' trigger 
-  update_tigger_name: Name of the 'before update' trigger
-  allow_nil: ignore validation for nil values. Default value: false
-  allow_blank: ignore validation for blank values. Default value: false
-  as: defines the way how constraint will be implemented. Possible values: [:trigger]
-
-  
-=== exclusion
-
-  Value exclusion validation
-
-  Usage:
-
-  validate_column :table_name, :column_name, :exclusion => {:in => [1, 2, 3]}
-  validate_column :table_name, :column_name, :exclusion => {:in => [1, 2, 3], :message => "Column 'column_name' should not  be equal to 1 or 2 or 3"}
-  validate_column :table_name, :column_name, :exclusion => {:in => [1, 2, 3], :on => :update, :as => :check}
-  validate_column :table_name, :column_name, :exclusion => {:in => 1..3, :on => :create, :as => :trigger}
-
-  Options:
-
-  in: range or array that column value should NOT be contained in.
-  message: message that should be shown if validation failed
-  on:  validation event. Possible values [:save, :update, :create]. Default value: :save
-  create_tigger_name: Name of the 'before insert' trigger
-  update_tigger_name: Name of the 'before update' trigger
-  allow_nil: ignore validation for nil values. Default value: false
-  allow_blank: ignore validation for blank values. Default value: false
-  as: defines the way how constraint will be implemented. Possible values: [:trigger]
-
-=== presense
-
-  Value presense validation
-
-  Usage:
-
-  validate_column :table_name, :column_name, :presense => true
-  validate_column :table_name, :column_name, :presense => {:message => "value should not be empty"}
-  validate_column :table_name, :column_name, :presense => {:message => "value should not be empty", :as=> :trigger}
-  validate_column :table_name, :column_name, :presense => {:message => "value should not be empty", :as=> :trigger, :on => :create}
-  
-
-  Options:
-
-  message: message that should be shown if validation failed
-  on:  validation event. Possible values [:save, :update, :create]. Default value: :save
-  create_tigger_name: Name of the 'before insert' trigger
-  update_tigger_name: Name of the 'before update' trigger
-  allow_nil: ignore validation for nil values. Default value: false
-  allow_blank: ignore validation for blank values. Default value: false
-  as: defines the way how constraint will be implemented. Possible values: [:trigger]
-
-=== format
-
-  Allows to define regular expression that column value will be mathed  with
-
-  Usage:
-
-  validate_column :table_name, :column_name, :format => {:with => /word/}
-  validate_column :table_name, :column_name, :format => {:with => /word/, :messsage => "Column_name value should contain start word"}
-  validate_column :table_name, :column_name, :format => {:with => /word/, :messsage => "Column_name value should contain start word", :as => :trigger}
-  
-
-  Options:
-
-  with: regular expression that column value should be matched to
-  message: message that should be shown if validation failed
-  on:  validation event. Possible values [:save, :update, :create]. Default value: :save
-  create_tigger_name: Name of the 'before insert' trigger
-  update_tigger_name: Name of the 'before update' trigger
-  allow_nil: ignore validation for nil values. Default value: false
-  allow_blank: ignore validation for blank values. Default value: false
-  as: defines the way how constraint will be implemented. Possible values: [:trigger]
-
-== Contributing to mv-mysql
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Valeriy Prokopchuk. See LICENSE.txt for
-further details.
-