ca_postal_code 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: febd2f0c9952da899878811be706b93622be5e59
-  data.tar.gz: 03c4462db8563c7eee93b4d3acd52241bd5d3c0b
+SHA256:
+  metadata.gz: 74e23617eab8b83ff3803b444f697de1d8ce0447446caa0c23aa205582f4f28c
+  data.tar.gz: fcba68f76741640a368e4b299a05e6cb519c1c413965929beab6daa345a374f4
 SHA512:
-  metadata.gz: 187b930c59b4a1d1cdf6b624c2810166e553f8cf6d43faad1a6ca9f07b1455357dee95fd9a3866709df7fd0bce72efa27c766fd0157ab7be44201338de6bb39e
-  data.tar.gz: aad6f9d97f0b60df1ef231394df32b69bd1d5330d01c80a4c7130ff345a26a4f2f0a2191e71485412b737051f40878451dc31e017aada18cc1ac20bdccd69042
+  metadata.gz: 29f745dd7c28c4f0cb11ce71efca289232d913469ff7ea6efb1c5bc3db7e5fbc98c0df9e0762ad64ef0dffebaf985594cf0dca76bd5560c27d92b325a7f83dd7
+  data.tar.gz: e114ca30469b342af67b21966a6f28338e9985d009ca195dd835d516139a967fceb51e3d584a4c02486e119b37aefa7ad0c6a8fe132501927423d8d2b998d0bb

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    ca_postal_code (0.1.0)
+    ca_postal_code (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
     interception (0.5)
-    method_source (0.9.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-rescue (1.4.5)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-rescue (1.5.2)
       interception (>= 0.5)
-      pry
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+      pry (>= 0.12.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
 
 PLATFORMS
   ruby
@@ -39,8 +39,8 @@ DEPENDENCIES
   ca_postal_code!
   pry
   pry-rescue
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.2.22

data/README.md

@@ -1,9 +1,60 @@
 # CAPostalCode
+A toolbox for Canadian postal codes: validating, normalizing and guessing their region.
+
+```ruby
+CAPostalCode.valid?("h1b2p3")
+# => true
+
+CAPostalCode.normalize("e3b.4k5 ")
+# => "E3B 4K5"
+
+CAPostalCode.guess_region("K1A 0B3")
+# => "ON"
+
+CAPostalCode.guess_region("X0C 1A1")
+# => "NU"
+```
+
+## Usage
+### Validity
+After normalizing the string, verifies if it fits the format for a postal code.
+
+Strings containing letters D, F, I, O, Q, and those starting with W or Z are invalid.
+```ruby
+CAPostalCode.valid?("h1b2p3")
+# => true
+
+CAPostalCode.valid?("F8G 1A1")
+# => false
+
+CAPostalCode.valid?("potato")
+# => false
+
+CAPostalCode.valid?("P0T 4T0")
+# => true
+```
+
+### Normalization
+Normalize the string to look like a postal code.
+
+It does not check for validity. Rather, the `.valid?` method relies on this one to make its work easier.
+
+```ruby
+CAPostalCode.normalize("e3b.4k5 ")
+# => "E3B 4K5"
+
+CAPostalCode.normalize("g1c 4z9")
+# => "G1C 4Z9"
+
+CAPostalCode.normalize("potato")
+# => "POT ATO"
+```
+
+### Region guessing
 Guesses the Canadian province or territory (*region*) based on the postal code.
 
 For provinces and Yukon, it will guess based on the first letter. For Northwest Territories and Nunavut, it will check the first two or three characters.
 
-## Usage
 ```ruby
 CAPostalCode.guess_region("G1A 1A1")
 # => "QC"

data/ca_postal_code.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_development_dependency "pry"

data/lib/ca_postal_code/region_guessing.rb

@@ -0,0 +1,59 @@
+module CAPostalCode
+  module RegionGuessing
+
+    REGIONS = {
+      NL: ?A,
+      NS: ?B,
+      PE: ?C,
+      NB: ?E,
+      QC: [?G, ?H, ?J],
+      ON: [?K, ?L, ?M, ?N, ?P],
+      MB: ?R,
+      SK: ?S,
+      AB: ?T,
+      BC: ?V,
+      NU: /^X0[A-C]/,
+      NT: [/^X0[EG]/, /^X1A/],
+      YT: ?Y,
+    }
+
+    # Guesses province or territory based on postal code first characters.
+    #
+    # Output is defined for valid, normalized postal codes only.
+    def guess_region(string)
+      entry = region_patterns.detect do |pattern, region|
+        pattern.match?(string)
+      end
+
+      entry[1] if entry
+    end
+
+    # Lists the patterns the library will use. It is made public only to
+    # make the implementation visible.
+    def region_patterns
+      @@region_patterns
+    end
+
+    private
+
+    def self.add_pattern(pattern, region)
+      unless pattern.is_a?(Regexp)
+        pattern = Regexp.new("^" + pattern)
+      end
+
+      @@region_patterns[pattern] = region.to_s
+    end
+
+    @@region_patterns = {}
+
+    REGIONS.each do |region, patterns|
+      unless patterns.is_a?(Array)
+        patterns = [patterns]
+      end
+
+      patterns.each do |pattern|
+        add_pattern(pattern, region)
+      end
+    end
+  end
+end

data/lib/ca_postal_code/version.rb

@@ -1,3 +1,3 @@
 module CAPostalCode
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ca_postal_code.rb

@@ -1,55 +1,41 @@
 require "ca_postal_code/version"
+require "ca_postal_code/region_guessing"
 
 module CAPostalCode
-  REGIONS = {
-    NL: ?A,
-    NS: ?B,
-    PE: ?C,
-    NB: ?E,
-    QC: [?G, ?H, ?J],
-    ON: [?K, ?L, ?M, ?N, ?P],
-    MB: ?R,
-    SK: ?S,
-    AB: ?T,
-    BC: ?V,
-    NU: /^X0[A-C]/,
-    NT: [/^X0[EG]/, /^X1A/],
-    YT: ?Y,
-  }
-
-  def self.guess_region(string)
-    entry = patterns.detect do |pattern, region|
-      pattern.match?(string)
-    end
-
-    entry[1] if entry
-  end
-
-  # Lists the patterns the library will use. It is made public only to
-  # make the implementation visible.
-  def self.patterns
-    @@patterns
+  extend RegionGuessing
+
+  # > Postal codes do not include the letters D, F, I, O, Q or U,
+  # > and the first position also does not make use of the letters W or Z.
+  PATTERN = %r{
+    [ABCEGHJKLMNPRSTVXY]
+    [0-9]
+    [ABCEGHJKLMNPRSTVWXYZ]
+    \ ?
+    [0-9]
+    [ABCEGHJKLMNPRSTVWXYZ]
+    [0-9]
+  }x
+
+  def self.valid?(string)
+    return false unless string = normalize(string)
+    strict_valid?(string)
   end
 
-  private
-
-  def self.add_pattern(pattern, region)
-    unless pattern.is_a?(Regexp)
-      pattern = Regexp.new("^" + pattern)
-    end
-
-    @@patterns[pattern] = region.to_s
+  def self.strict_valid?(string)
+    string.match? PATTERN
   end
 
-  @@patterns = {}
+  # Normalize postal code into "A1A 1A1" format.
+  #
+  # Will return `nil` if the normalized string does not have 6 characters.
+  def self.normalize(string)
+    string.strip!
+    string.upcase!
+    string.gsub!(/\W/, '')
 
-  REGIONS.each do |region, patterns|
-    unless patterns.is_a?(Array)
-      patterns = [patterns]
-    end
+    return unless string.length == 6
 
-    patterns.each do |pattern|
-      add_pattern(pattern, region)
-    end
+    string = string[0..2] + " " + string[3..5]
+    string
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ca_postal_code
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Allard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2021-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jonathan@allard.io
 executables: []
@@ -89,7 +89,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rspec_status"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -100,11 +99,12 @@ files:
 - bin/setup
 - ca_postal_code.gemspec
 - lib/ca_postal_code.rb
+- lib/ca_postal_code/region_guessing.rb
 - lib/ca_postal_code/version.rb
 homepage: https://github.com/joallard/ca-postal-code
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,9 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Guesses the Canadian province or territory (region) based on the postal code.
 test_files: []

data/.rspec_status

@@ -1,8 +0,0 @@
-example_id                           | status | run_time        |
------------------------------------- | ------ | --------------- |
-./spec/ca_postal_code_spec.rb[1:1:1] | passed | 0.00186 seconds |
-./spec/ca_postal_code_spec.rb[1:1:2] | passed | 0.0001 seconds  |
-./spec/ca_postal_code_spec.rb[1:1:3] | passed | 0.00007 seconds |
-./spec/ca_postal_code_spec.rb[1:1:4] | passed | 0.00007 seconds |
-./spec/ca_postal_code_spec.rb[1:1:5] | passed | 0.0001 seconds  |
-./spec/ca_postal_code_spec.rb[1:2:1] | passed | 0.00016 seconds |