number_plate_sg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b740675607e5e7713a8d8064195bd7baa3922ce7
+  data.tar.gz: 4a987fe8f19cd107b8f012ace6ad8abde3b47db2
+SHA512:
+  metadata.gz: 7c802bd9efa81260b73ab1495865241c39feb9b206b008075be1c5c7f2c6a799d257ebc4b9e7eecee41f6b9533a5deb574caa163497645b3d45a3d4e7acbb1d6
+  data.tar.gz: 14930b996ae3434bf0f957efe2f4a0ee586f5461e9a8a968cff9e723b430deab6b9b66438896bb0b480a7e7541c1ae2c58cf7cd772d9e2a3895f7a7aae6a7fe1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+before_install: gem install bundler -v 1.13.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Edgar
+
+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,90 @@
+# NumberPlateSg
+[![CodeFactor](https://www.codefactor.io/repository/github/ej2015/number_plate_sg/badge)](https://www.codefactor.io/repository/github/ej2015/number_plate_sg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/eba3926f39c9682e47ed/maintainability)](https://codeclimate.com/github/ej2015/my_age/maintainability)
+[![Build Status](https://travis-ci.org/ej2015/number_plate_sg.svg?branch=master)](https://travis-ci.org/ej2015/number_plate_sg)
+
+A little utility to validate a Singpaore number plate or to generate a random number
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'number_plate_sg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install number_plate_sg
+
+## Usage
+Use the validator
+```
+  ##Initialize validator:
+  validator =  NumberPlate.validator("SG")
+
+  ##Check if it is valid:
+  validator.is_valid?("EJ81D")
+  #=> true
+   
+  validator.is_valid?("EJ81E")
+  #=> false
+
+  ##get the current country code
+  validator.country
+  #=> "SG"
+```
+Use the generator
+```
+  ##Initialize generator
+  generator = NumberPlate.generator('SG')
+  
+  generator.generate
+  #=> SFZ999K
+```
+## ActiveModel
+
+A `NumberPlateSgValidator` is provided with this gem to be used with ActiveModel. 
+
+```
+class Vehicle < ActiveRecord::Base
+  validates :plate_number, number_plate_sg: true 
+  ...
+end
+
+```
+
+## Command Line Interface
+A CLI is provided to check the plate validity
+
+```
+$number_plate_sg validate EJ81D
+$true
+
+```
+A CLI is also provided to generate a random number
+
+```
+$number_plate_sg generate
+$SFZ999K
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ej2015/number_plate_sg.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "number_plate_sg"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/number_plate_sg

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'number_plate/sg/cli'
+NumberPlate::SG::CLI.start

data/lib/number_plate/sg/active_model.rb

@@ -0,0 +1,12 @@
+module ActiveModel
+  module Validations
+    class NumberPlateSgValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+
+        val = ::NumberPlate.validator('SG')
+
+        record.errors.add attribute, (options[:message] || "is not a valid number plate") unless val.is_valid?(value)
+      end
+    end
+  end
+end

data/lib/number_plate/sg/base_generator.rb

@@ -0,0 +1,13 @@
+module NumberPlate
+  module SG 
+    class BaseGenerator
+
+      attr_reader :country
+
+      def generate
+        raise 'this method is not defined yet'
+      end
+
+    end
+  end
+end

data/lib/number_plate/sg/base_validator.rb

@@ -0,0 +1,21 @@
+module NumberPlate
+  module SG
+    class BaseValidator
+
+      attr_reader :country
+
+      def is_valid?(registration_number)
+        setup(registration_number) if registration_number.present?
+        @license.present?
+      end
+
+      private
+      def setup(registration_number)
+        @license = registration_number.gsub(/\s/, "").upcase
+        @letters = @license[/[A-Z]+/]
+        @numerals = @license[/\d+/]
+      end
+
+    end
+  end
+end

data/lib/number_plate/sg/checksum.rb

@@ -0,0 +1,36 @@
+module NumberPlate
+  module SG
+    module Checksum
+      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]
+
+      def checksum
+        get_checksum_from_numbers(numbers)
+      end
+
+      def numbers
+        numbers = []
+        @letters.split(//).each do |alphebat|
+          numbers << (alphebat.ord - 64)
+        end
+
+        if numbers.length == 3
+          numbers = numbers[1,2]
+        elsif numbers.length == 1
+          numbers = [1] + numbers
+        end
+
+        numerals = ("000" + @numerals)[-4,4]
+        numbers + numerals.split(//).map(&:to_i)
+      end
+
+      def get_checksum_from_numbers(numbers)
+        checksum_array = []
+        numbers.zip(MULTIPLIER) { |x, y| checksum_array << (x * y) }
+        checksum_key = checksum_array.reduce(:+) % 19
+        CHECK_SUM[checksum_key]
+      end
+
+    end
+  end
+end

data/lib/number_plate/sg/cli.rb

@@ -0,0 +1,19 @@
+require 'thor'
+require 'number_plate_sg'
+
+module NumberPlate
+  module SG
+    class CLI < Thor
+      desc "validate", "validate if a PLATE is valid"
+      def validate(plate)
+        validator = NumberPlate.validator('SG')
+        puts(validator.is_valid? plate)
+      end
+
+      desc "generate", "generate a random plate"
+      def generate
+        puts NumberPlate.generator('SG').generate
+      end
+    end
+  end
+end

data/lib/number_plate/sg/generator.rb

@@ -0,0 +1,37 @@
+require_relative "base_generator"
+require_relative "checksum"
+
+module NumberPlate
+  module SG 
+    class Generator < NumberPlate::SG::BaseGenerator
+      include NumberPlate::SG::Checksum
+
+      def initialize
+        @country = "SG"
+      end
+
+      def generate
+        letters + numerals + checksum
+      end
+
+      def prefix
+        'S'
+      end
+
+      def letters 
+        @letters = prefix + random_letters
+      end
+
+      def numerals
+        @numerals =  rand(1..9999).to_s
+      end
+
+      private
+      def random_letters
+        (0..rand(2)).map do
+          rand(65..90).chr
+        end.join
+      end
+    end
+  end
+end

data/lib/number_plate/sg/validator.rb

@@ -0,0 +1,33 @@
+require_relative "base_validator"
+require_relative "checksum"
+
+module NumberPlate
+  module SG
+    class Validator < NumberPlate::SG::BaseValidator
+      include NumberPlate::SG::Checksum
+
+      def initialize
+        @country = "SG"
+      end
+
+      def is_valid?(registration_number)
+        super &&
+          valid_length? &&
+          valid_pattern? &&
+          valid_checksum?
+      end
+
+      def valid_length?
+        @license.length <= 8 && @license.length >= 4
+      end
+
+      def valid_pattern?
+        0  == (/^[A-Z]{1,3}[1-9]{1}\d{0,3}[A-Z]$/ =~ @license)
+      end
+
+      def valid_checksum?
+        checksum == @license[-1]
+      end
+    end
+  end
+end

data/lib/number_plate/version.rb

@@ -0,0 +1,3 @@
+module NumberPlateSg
+  VERSION = "0.1.0"
+end

data/lib/number_plate_sg.rb

@@ -0,0 +1,22 @@
+require "number_plate/version"
+require "number_plate/sg/validator"
+require "number_plate/sg/generator"
+require "active_support/core_ext/string"
+require "active_model"
+require "number_plate/sg/active_model"
+
+module NumberPlate
+
+  class << self
+    def validator(country)
+      Object.const_get("NumberPlate::#{country}::Validator").new
+    end
+
+    def generator(country)
+      Object.const_get("NumberPlate::#{country}::Generator").new
+    end
+  end
+
+
+
+end

data/number_plate_sg.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'number_plate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "number_plate_sg"
+  spec.version       = NumberPlateSg::VERSION
+  spec.authors       = ["Edgar"]
+  spec.email         = ["zorro.ej@gmail.com"]
+
+  spec.summary       = %q{A little utility for Singpaore number plate.}
+  spec.description   = %q{It can validate a number or generate a random number.}
+  spec.homepage      = "https://github.com/ej2015/number_plate_sg.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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.0"
+  spec.add_development_dependency "pry-byebug", "~>3.6.0"
+  spec.add_development_dependency "cucumber", "~>3.1.0"
+  spec.add_development_dependency "aruba", "~>0.14.0"
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: number_plate_sg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edgar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-11 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !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: It can validate a number or generate a random number.
+email:
+- zorro.ej@gmail.com
+executables:
+- number_plate_sg
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/number_plate_sg
+- lib/number_plate/sg/active_model.rb
+- lib/number_plate/sg/base_generator.rb
+- lib/number_plate/sg/base_validator.rb
+- lib/number_plate/sg/checksum.rb
+- lib/number_plate/sg/cli.rb
+- lib/number_plate/sg/generator.rb
+- lib/number_plate/sg/validator.rb
+- lib/number_plate/version.rb
+- lib/number_plate_sg.rb
+- number_plate_sg.gemspec
+homepage: https://github.com/ej2015/number_plate_sg.git
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A little utility for Singpaore number plate.
+test_files: []