number_plate_validator 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28c143b186ad31f5a75070038a748bb12c031fea
-  data.tar.gz: 3684c2428985b85bcaf6f91d798218063cac689f
+  metadata.gz: a607f35f638f4e293f00a6cdc59c809963ee544b
+  data.tar.gz: 77e1816956a297fb6aa53fd685d8c8f4421c5608
 SHA512:
-  metadata.gz: 52dcfe935f18eee48c9e190664c8391a9cfce94de70ce024ac20f954f105107e9b147c413897cf7090f3234dd0f1b70dbb66b84241c541a3ad367f94ac090849
-  data.tar.gz: 0dd935f2db1e1b59d7c7cfa05b7869cc710c4810bde5cb4470652925253ff26163c430eb2da9c7e97c3c609fc6b373e68285f71cd88546ca8ce53c146eeca225
+  metadata.gz: d1a13dc0f92365be40cf10b68f63fad00c13b7588c69fe113ba0eff55d0868a41cd1ac050499febe12b57410c7f5e43f4bba694f4b2608cc6774b569c76747e8
+  data.tar.gz: '06946cbe93a5cff0c766f655c0331009c873740ee781c35019091d440f59c49bfa7e9632f83a03e95438d05f4b36bbb0495c8d48ee82d55c4211b5ff10aeb159'

data/README.md

@@ -1,6 +1,12 @@
 # NumberPlateValidator
 
-This gem provides a validator for license plate validation. At the moment it only supports Singapore plates with a checksum. But work is ongoing to expand it to special plates and other countries and regions.
+This gem provides a validator for license plate validation. It iss being actively developed to expand to special plates and more countries and regions. Contributions are welcome.
+
+## Country Support
+
+Singapore: checksumed plates
+Malaysia: Not exhaustive. Please check the specs for examples of covered cases
+
 
 ## Installation
 
@@ -31,6 +37,10 @@ Use standard country code to spcify the country.
    
   validator.is_valid?("EJ81E")
   #=> false
+
+  ##get the current country code
+  validator.country
+  #=> "SG"
 ```
 
 ## ActiveModel
@@ -47,6 +57,16 @@ class Vehicle < ActiveRecord::Base
 end
 
 ```
+
+## Command Line Interface
+A CLI is provided to check the plate validity
+
+```
+$number_plate validate -c SG EJ81E
+$true
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/number_plate

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'number_plate_validator/cli'
+
+NumberPlateValidator::CLI.start

data/lib/number_plate_validator.rb

@@ -3,14 +3,18 @@ require "active_support/inflector"
 require "active_model"
 require "active_support/core_ext/string"
 require "number_plate_validator/validator"
+require "number_plate_validator/country_validator_base"
 require "number_plate_validator/sg_validator"
+require "number_plate_validator/my_validator"
 require "number_plate_validator/active_model"
 
 module NumberPlateValidator
 
 	class << self
     def validator(country_code)
-			Validator.new(country_code)
+			validator_class = eval "NumberPlateValidator::#{country_code}Validator"
+			validator = validator_class.new
+			Validator.new(validator)
 		end
 	end
 	

data/lib/number_plate_validator/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require 'number_plate_validator'
+
+module NumberPlateValidator
+	class CLI < Thor
+		desc "validate -c CC PLATE", "validate if a PLATE is valid in the country CC"
+		method_option :country, aliases: "-c", desc: "standard country code in capital letters", required: true
+		def validate(plate)
+      validator = NumberPlateValidator.validator(options[:country])
+			puts(validator.is_valid? plate)
+		end
+
+	end
+end
+

data/lib/number_plate_validator/country_validator_base.rb

@@ -0,0 +1,12 @@
+module NumberPlateValidator 
+	class CountryValidatorBase
+
+		attr_reader :country	
+
+		def is_valid?(registration_number)
+			@license = registration_number.gsub(/\s/, "").upcase if registration_number.present?
+			@license.present?
+		end
+
+	end
+end

data/lib/number_plate_validator/my_validator.rb

@@ -0,0 +1,29 @@
+module NumberPlateValidator 
+	class MYValidator < CountryValidatorBase
+
+    PATTERNS = [
+      /^[A,B,C,D,F,J,K,M,N,P,R,T,V][A-Y]{0,2}([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])$/,
+			/^W[A-Y]{0,2}([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])[A-Y]{0,1}$/,
+			/^KV([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])[A-Y]$/,
+			/^Q[A,K,B,C,L,M,P,R,S,T][A-Y]([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])[A-Y]$/,
+			/^S[A,B,D,G,K,L,S,T,U][^QSZ]([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])[^QSZ]$/,
+			/^H[^FGHIOUVXYZ][A-Y]([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])$/,
+			/^(1[0-2]|1[4-9]|[2-9][0-9]|10[1,2,3,4,5,7]|11[0,1])-\d{2}-DC$/,
+			/^(1[0-2]|1[4-9]|[2-9][0-9]|10[1,2,3,4,5,7]|11[0,1])-\d{2}-CC$/,
+			/^(1[0-2]|1[4-9]|[2-9][0-9]|10[1,2,3,4,5,7]|11[0,1])-\d{2}-UN$/,
+			/^Z[A-D,L,U,Z]([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])$/,
+			/^E[D,J]([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])$/,
+			/^LIMO([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9])[W,B]$/
+		]
+
+		def initialize
+      @country = "MY"
+		end
+
+		def is_valid?(registration_number)
+			return false unless super
+      PATTERNS.any? { |pattern| @license =~ pattern } 
+		end
+
+  end
+end

data/lib/number_plate_validator/sg_validator.rb

@@ -1,20 +1,22 @@
 module NumberPlateValidator 
-	class SGValidator
+	class SGValidator < CountryValidatorBase
 		CHECK_SUM = { 0 => "A", 1 => "Z", 2 => "Y", 3 => "X", 4 => "U", 5 => "T", 6 => "S", 7 => "R", 8 => "P", 9 => "M", 10 => "L", 11 => "K", 12 => "J", 13 => "H", 14 => "G", 15 => "E", 16 => "D", 17 => "C", 18 => "B" }
 		MULTIPLIER = [9, 4, 5, 4, 3, 2]
 
-		attr_reader :license
+		def initialize
+      @country = "SG"
+		end
 
 		def is_valid?(registration_number)
-			@license = registration_number.gsub(/\s/, "").upcase if registration_number.present?
-			return false if license.blank? || license.length > 8 || license.length < 4
-			test = /^[A-Z]{1,3}[1-9]{1}\d{0,3}[A-Z]$/ =~ license
+			return false unless super
+			return false if @license.length > 8 || @license.length < 4
+			test = /^[A-Z]{1,3}[1-9]{1}\d{0,3}[A-Z]$/ =~ @license
 			return false unless test == 0
-			letters = license[/[A-Z]+/]
-			numerals = license[/\d+/]
+			letters = @license[/[A-Z]+/]
+			numerals = @license[/\d+/]
 
 			checksum = get_checksum(letters, numerals)
-			checksum == license[-1]
+			checksum == @license[-1]
 		end
 
 		def get_checksum(letters, numerals)
@@ -34,8 +36,7 @@ module NumberPlateValidator
 				numbers = [1] + numbers
 			end
 
-			numerals = "000" + numerals
-			numerals = numerals[-4,4]
+			numerals = ("000" + numerals)[-4,4]
 			numbers + numerals.split(//).map(&:to_i)
 		end
 

data/lib/number_plate_validator/validator.rb

@@ -1,12 +1,10 @@
 module NumberPlateValidator
 	class Validator 
 
-		attr_reader :region, :validator
+		attr_reader :validator
 
-		def initialize(region)
-			@region = region
-			validator_class = eval "NumberPlateValidator::#{region}Validator"
-			@validator = validator_class.new
+		def initialize(validator)
+			@validator = validator 
 		end
 
 		def is_valid?(registration_number)

data/lib/number_plate_validator/version.rb

@@ -1,3 +1,3 @@
 module NumberPlateValidator
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/number_plate_validator.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["zorro.ej@gmail.com"]
 
 	spec.summary       = %q{This gem validates vehicle number/license plates. }
-	spec.description   = %q{This gem allows you to validate a license plate number from a chosen country/region. It also provides a validator for ActiveModel. It currently only supports Singapore.}
+	spec.description   = %q{This gem allows you to validate a license plate number from a chosen country/region. It also provides a validator for ActiveModel and a CLI. It currently only supports Singapore and Malaysia (not exhaustive.}
   spec.homepage      = "https://github.com/ej2015/number_plate_validator.git"
   spec.license       = "MIT"
 
@@ -20,11 +20,16 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+	
+	spec.required_ruby_version = '>=2.3.0'
 
-	spec.add_dependency "activesupport", "~>4.2"
-	spec.add_dependency "activemodel", "~>4.2"
+	spec.add_dependency "activesupport", ">=4.2"
+	spec.add_dependency "activemodel", ">=4.2"
+	spec.add_dependency "thor"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
 	spec.add_development_dependency "pry", "~>0.11"
+	spec.add_development_dependency "cucumber", '~>3.1.0'
+	spec.add_development_dependency "aruba", '~>0.14.0'
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: number_plate_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Edgar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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
@@ -94,9 +108,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 description: This gem allows you to validate a license plate number from a chosen
-  country/region. It also provides a validator for ActiveModel. It currently only
-  supports Singapore.
+  country/region. It also provides a validator for ActiveModel and a CLI. It currently
+  only supports Singapore and Malaysia (not exhaustive.
 email:
 - zorro.ej@gmail.com
 executables: []
@@ -111,9 +153,13 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/number_plate
 - bin/setup
 - lib/number_plate_validator.rb
 - lib/number_plate_validator/active_model.rb
+- lib/number_plate_validator/cli.rb
+- lib/number_plate_validator/country_validator_base.rb
+- lib/number_plate_validator/my_validator.rb
 - lib/number_plate_validator/sg_validator.rb
 - lib/number_plate_validator/validator.rb
 - lib/number_plate_validator/version.rb
@@ -130,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="