is_uen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5213b05265043b416745ec8cd324ae95f524e97c6de9298064888b77037edd6
+  data.tar.gz: 32761c20a08d9b6485ab866386bb0104f90d3f3a30b40646178b5d1a0fd5358e
+SHA512:
+  metadata.gz: a8328e5526347500e2882442ddbe17d8d43a91e17cecab907621c2bd102600232ae1eb891b88514b145fc82e1467734e98f4d11524e95ff4d366f095409f9c24
+  data.tar.gz: b03bd3b4d13b42c51b998adc2c0a26c94642757190eb3907d8a0118289e80545c22b5957e0741e51aa48514e494ea79f727c2797ee50a1a890bec85c34484773

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in is_uen.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    is_uen (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  is_uen!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.33

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 yaojie
+
+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,55 @@
+# IsUen
+
+Simple gem to check whether an UEN has a valid format and date.
+
+Format is obtained from [https://www.uen.gov.sg/ueninternet/faces/pages/admin/aboutUEN.jspx](https://www.uen.gov.sg/ueninternet/faces/pages/admin/aboutUEN.jspx), last updated/reviewed on 08 Jan 2018.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'is_uen'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install is_uen
+
+## Usage
+
+```ruby
+IsUen.uen?('12345678A') # business? || company? || new_uen?
+IsUen.business?('12345678A')
+IsUen.company?('123456789A')
+IsUen.new_uen?('T12GB1234X')
+```
+
+The library also provides convenience functions to check for a specific entity type (obtain the full list [here](https://www.uen.gov.sg/ueninternet/faces/pages/admin/aboutUEN.jspx)).
+
+```ruby
+IsUen.ll?('T12LL1234X') # returns true
+IsUen.lp?('T12AA1234X') # returns false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Caveats
+
+This gem does not verify the existence of UENs.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/causztic/is_uen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "is_uen"
+
+# 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(__FILE__)

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/lib/is_uen/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IsUen
+  VERSION = "0.1.0"
+end

data/lib/is_uen.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "is_uen/version"
+
+# Suite of convenience functions to test if a UEN is for a specific entity
+module IsUen
+  VALID_ENTITIES = %w[LP LL FC PF RF MQ MM NB CC CS MB FM GS DP CP NR CM CD MD HS VH CH MH CL XL
+                      CX HC RP TU TC FB FN PA PB SS MC SM GA GB].freeze
+
+  YEARS = { "R" => "18", "S" => "19", "T" => "20" }.freeze
+  ENTITY_REGEX = /^(?<year>R|S|T)(?<decade>\d{2})(?<entity>[A-Z]{2})\d{4}[A-Z]$/.freeze
+
+  def uen?(id)
+    business?(id) || company?(id) || new_uen?(id)
+  end
+
+  def new_uen?(id)
+    match = ENTITY_REGEX.match(id)
+    return false unless match
+
+    VALID_ENTITIES.include?(match[:entity]) && valid_new_uen_year?(match)
+  end
+
+  def business?(id)
+    /^\d{8}[A-Z]$/.match?(id)
+  end
+
+  def company?(id)
+    match = /^(?<year>\d{4})\d{5}[A-Z]$/.match(id)
+    return false unless match
+
+    valid_year?(match[:year])
+  end
+
+  # FIXME: not sure how to effectively test these! will revisit
+  VALID_ENTITIES.each do |entity|
+    define_singleton_method "#{entity.downcase}?" do |id|
+      match = ENTITY_REGEX.match(id)
+      return false unless match
+
+      entity == match[:entity] && valid_new_uen_year?(match)
+    end
+  end
+
+  def self.valid_new_uen_year?(match)
+    year = YEARS[match[:year]] + match[:decade]
+    valid_year?(year)
+  end
+
+  def self.valid_year?(year_string)
+    year_string.to_i <= Time.now.year
+  end
+
+  private_class_method :valid_year?, :valid_new_uen_year?
+  module_function :uen?, :business?, :company?, :new_uen?
+end

data/sig/is_uen.rbs

@@ -0,0 +1,4 @@
+module IsUen
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: is_uen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yaojie
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-24 00:00:00.000000000 Z
+dependencies: []
+description: |
+  In Singapore, UEN is the standard identification number of an entity.
+  UEN shall be for registered entities as NRIC is for Singapore citizens.
+  The UEN uniquely identifies the entity.
+  From https://www.uen.gov.sg/ueninternet/faces/pages/admin/aboutUEN.jspx
+email:
+- limyaojie93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/is_uen.rb
+- lib/is_uen/version.rb
+- sig/is_uen.rbs
+homepage: https://www.github.com/causztic/is_uen
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.github.com/causztic/is_uen
+  source_code_uri: https://www.github.com/causztic/is_uen
+  changelog_uri: https://www.github.com/causztic/is_uen/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: Checks whether a string is a valid UEN
+test_files: []