isaf_id_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96d8ad6c22ac5e40cacbdc20f6a5f8d56da5d79d
+  data.tar.gz: 672e8a7b7b060d9ef55ad26540850dcbf7434b19
+SHA512:
+  metadata.gz: 70bd52901497f5d2d44cdf9c4a10d1828e2fef5cc9c6f3a6ea6bfb435b99ad535756fe9583cf7a34657f585a6d1ec29619dbcb20b6982d97c826c10ac8480f83
+  data.tar.gz: d87b98ee9e49f3560bcded5ac0e14f0381081c5634885e376bd5bd8348e3220acab2ae5f8cb9de2430329046f5ab0c86bdd599f0fbe601f30e3ca3fd7865fc3e

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Sublime Text workspace
+project.sublime-workspace

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alexander Lazarov
+
+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,42 @@
+# Readme
+
+This gem is validator for [ISAF Sailor ID](http://www.sailing.org/isafsailor).
+It works with `Rails 4` but it should work with `Rails 3` too.
+
+## Usage
+
+Add to your Gemfile:
+
+```ruby
+gem 'isaf_id_validator'
+```
+
+Run:
+
+```bash
+bundle install
+```
+
+Then add the following to your model:
+
+```ruby
+validates :isaf_id_attribute, isaf_id: true
+```
+
+## Testing
+
+Use `rspec` to run the tests.
+
+```bash
+bundle exec rspec
+```
+
+## Credit
+
+Used [`email_validator`](https://github.com/balexand/email_validator) as a
+template for this.
+
+## Contributing
+
+Your contributions are welcome. Please fork the project, make a new branch and
+send me a pull request.

data/isaf_id_validator.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name = 'isaf_id_validator'
+  s.version = '0.0.1'
+  s.authors = ['Alexander Lazarov']
+  s.description = 'An ISAF ID validator for Rails 4. See homepage for details: https://github.com/alexander-lazarov/isaf_id_validator'
+  s.email = 'alexander.lazaroff@gmail.com'
+  s.extra_rdoc_files = [ 'LICENSE' ]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+
+  s.homepage = 'https://github.com/alexander-lazarov/isaf_id_validator'
+  s.require_paths = %w(lib)
+  s.summary = 'An ISAF ID validator for Rails 4.'
+
+  s.license = 'MIT'
+
+  s.add_dependency('activemodel', '>= 0')
+  s.add_development_dependency('rubysl', '~> 2.0') if RUBY_ENGINE == 'rbx'
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '>= 0')
+end

data/lib/isaf_id_validator.rb

@@ -0,0 +1,22 @@
+class IsafIdValidator < ActiveModel::EachValidator
+  @@default_options = {}
+
+  def self.valid?(value, options = {})
+    value = value.to_s.upcase
+    regexp = /^([A-Z]{3})([A-Z]{2})([1-9][0-9]*)$/
+
+    !!regexp.match(value)
+  end
+
+  def self.default_options
+    @@default_options
+  end
+
+  def validate_each(record, attribute, value)
+    options = @@default_options.merge(self.options)
+
+    unless self.class.valid?(value, self.options)
+      record.errors.add(attribute, options[:message] || :invalid)
+    end
+  end
+end

data/project.sublime-project

@@ -0,0 +1,13 @@
+{
+	"folders":
+	[
+		{
+			"path": "."
+		}
+	],
+  "settings":
+  {
+    "convert_tab_to_spaces": true,
+    "tab_size": 2
+  }
+}

data/spec/isaf_id_validator_spec.rb

@@ -0,0 +1,98 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+class TestUser < TestModel
+  validates :isaf_id, isaf_id: true
+end
+
+class TestUserAllowsNil < TestModel
+  validates :isaf_id, isaf_id: { allow_nil: true }
+end
+
+class TestUserAllowsNilFalse < TestModel
+  validates :isaf_id, isaf_id: { allow_nil: false}
+end
+
+class TestUserWithMessage < TestModel
+  validates :isaf_id, isaf_id: { message: 'this is not ok'}
+end
+
+describe IsafIdValidator do
+
+  describe 'validation' do
+    context 'given the valid IDs' do
+      [
+        'BULAL1',
+        'AUSMB11',
+        'bulal1',
+        'BulAl2'
+      ].each do |isaf_id|
+
+        it "#{isaf_id.inspect} should be valid" do
+          expect(TestUser.new(isaf_id: isaf_id)).to be_valid
+        end
+
+        it "#{isaf_id.inspect} should pass the class tester" do
+          expect(IsafIdValidator.valid?(isaf_id)).to eq(true)
+        end
+      end
+    end
+
+    context "given the invalid IDs" do
+      [
+        'asdffg',
+        'BULAL0',
+        'BULAL01',
+        'BUAL01',
+        'BUlAL1A',
+        'АСДФГ1'
+      ].each do |isaf_id|
+
+        it "#{isaf_id.inspect} should not be valid" do
+          expect(TestUser.new(:isaf_id => isaf_id)).not_to be_valid
+        end
+
+        it "#{isaf_id.inspect} should fail the class tester" do
+          expect(IsafIdValidator.valid?(isaf_id)).to be_falsy
+        end
+
+      end
+    end
+
+    context 'ID nil' do
+      [nil].each do |isaf_id|
+        it "#{isaf_id.inspect} should not be valid" do
+          expect(TestUser.new(:isaf_id => isaf_id)).not_to be_valid
+        end
+
+        it "#{isaf_id.inspect} should fail the class tester" do
+          expect(IsafIdValidator.valid?(isaf_id)).to be_falsy
+        end
+
+        it "#{isaf_id.inspect} should not be valid" do
+          expect(TestUserAllowsNil.new(:isaf_id => isaf_id)).to be_valid
+        end
+      end
+    end
+  end
+
+  describe "error messages" do
+    context "when the message is not defined" do
+      subject { TestUser.new isaf_id: 'invalid id' }
+      before { subject.valid? }
+
+      it "should add the default message" do
+        expect(subject.errors[:isaf_id]).to include "is invalid"
+      end
+    end
+
+    context "when the message is defined" do
+      subject { TestUserWithMessage.new isaf_id: 'invalid id' }
+      before { subject.valid? }
+
+      it "should add the customized message" do
+        expect(subject.errors[:isaf_id]).to include 'this is not ok'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rspec'
+require 'active_model'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'isaf_id_validator'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: isaf_id_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Lazarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-11 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: 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'
+description: 'An ISAF ID validator for Rails 4. See homepage for details: https://github.com/alexander-lazarov/isaf_id_validator'
+email: alexander.lazaroff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- isaf_id_validator.gemspec
+- lib/isaf_id_validator.rb
+- project.sublime-project
+- spec/isaf_id_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alexander-lazarov/isaf_id_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.4.5
+signing_key: 
+specification_version: 4
+summary: An ISAF ID validator for Rails 4.
+test_files: []