ca_postal_code 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: febd2f0c9952da899878811be706b93622be5e59
-  data.tar.gz: 03c4462db8563c7eee93b4d3acd52241bd5d3c0b
+SHA256:
+  metadata.gz: 66677149dbc296b6a8c1861898aa7083ca454c253d440742e53f41b0116ddd6d
+  data.tar.gz: b81e91e584af729de3bd05c9a8ef58b80583aa562d194cc742131be5a2a1ea8d
 SHA512:
-  metadata.gz: 187b930c59b4a1d1cdf6b624c2810166e553f8cf6d43faad1a6ca9f07b1455357dee95fd9a3866709df7fd0bce72efa27c766fd0157ab7be44201338de6bb39e
-  data.tar.gz: aad6f9d97f0b60df1ef231394df32b69bd1d5330d01c80a4c7130ff345a26a4f2f0a2191e71485412b737051f40878451dc31e017aada18cc1ac20bdccd69042
+  metadata.gz: 753a836aaa71e3949be86d120ff950f28da4a47bbd05f609b3794975158a4f945d5d8f92dafa7838b4050691981823b51bed63f6326e33d4d1a5ccd80a19cc78
+  data.tar.gz: 20533950465b7ea1c97ab55f4cd58e197a97e825f0f66965aac359a2a12ead8c2f56bf412f78100397fc4ab87bf3b80689470e92f8a9f616a175a24a8514ced5

data/Gemfile.lock

@@ -1,46 +1,46 @@
 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.5.0)
     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.14.2)
+      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.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.4)
   ca_postal_code!
   pry
   pry-rescue
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.4.8

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonathan Allard
+
+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

@@ -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"
@@ -22,7 +73,7 @@ In your Gemfile:
 
 Or install it yourself:
 
-    $ gem install ca_postal_code
+    gem install ca_postal_code
 
 ## 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/ca_postal_code.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = CAPostalCode::VERSION
   spec.authors       = ["Jonathan Allard"]
   spec.email         = ["jonathan@allard.io"]
+  spec.license       = "MIT"
 
   spec.summary       = %q{Guesses the Canadian province or territory (region) based on the postal code.}
   # spec.description   = %q{Write a longer description or delete this line.}
@@ -21,8 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+
+
+  spec.add_development_dependency "bundler", "~> 2.4"
+  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,30 @@
+module CAPostalCode
+  module RegionGuessing
+    PATTERNS = {
+      /^A/ => "NL",
+      /^B/ => "NS",
+      /^C/ => "PE",
+      /^E/ => "NB",
+      /^[GHJ]/ => "QC",
+      /^[KLMNP]/ => "ON",
+      /^R/ => "MB",
+      /^S/ => "SK",
+      /^T/ => "AB",
+      /^V/ => "BC",
+      /^X0[A-C]/ => "NU",
+      /^X0[EG]|^X1A/ => "NT",
+      /^Y/ => "YT",
+    }
+
+    # Guesses province or territory based on postal code first characters.
+    #
+    # Output is defined for valid, normalized postal codes only.
+    def guess_region(string)
+      entry = PATTERNS.detect do |pattern, region|
+        pattern.match?(string)
+      end
+
+      entry[1] if entry
+    end
+  end
+end

data/lib/ca_postal_code/version.rb

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

data/lib/ca_postal_code.rb

@@ -1,55 +1,40 @@
 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.gsub!(/[^a-zA-Z0-9]/, '')
+    string.upcase!
 
-  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.3.0
 platform: ruby
 authors:
 - Jonathan Allard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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,10 +89,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rspec_status"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
@@ -100,11 +100,13 @@ 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: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,9 +121,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.4.1
+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 |