regional 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92ca6c0a9ea4d63e6c7997fcf9ffc947395082ad
+  data.tar.gz: ae05934e3d9ffaf5e1b51c158c96061e5e66b01b
+SHA512:
+  metadata.gz: 8ef941e925059cf5ffb7a2b732972c8c5721f3b1bff10934d428ae730fcd208efbf46cf2e94ea556be285e40d6723dcb7587bb0265e54687b43ee8c00fef5360
+  data.tar.gz: 5947eb692989ebf6dee865b2e77947a94cf8c5cd63c10a1696fea8580985bb882380b9fde8d13b806e6717001dd5527c3fd56a68651f8bce1e032307635fa379

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonathan Allard
+
+MIT License
+
+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,28 @@
+# Regional
+**Regional** tells you if a certain location is within a given
+territory.
+
+For now, territories are defined with Canadian postal codes only.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'regional'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install regional
+
+## Usage
+
+```rb
+plateau = Regional::Zone.new "H2H, H2J, H2T" 
+plateau.cover? "H2J 1L8"  #=> true
+plateau.cover? "H3A 1A1"  #=> false
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/features/determine_inclusion.feature

@@ -0,0 +1,34 @@
+Feature: Determine whether postal code is in range
+
+  Scenario: One FSA
+    Given the zone is J7Y
+    Then J7Y 4B1 should be included
+    But J7Z 1A1 shouldn't be included
+
+  Scenario: One letter
+    Given the zone is H
+    Then H2J 1B1 should be included
+    But J4C 1P3 shouldn't be included
+
+  Scenario: Hyphen range
+    Given the zone is G5U-G5X
+    Then G5V 1S1 should be included
+    But G5Z 0A0 shouldn't be included
+
+  Scenario: Multiple ranges
+    Given the zone is "H2, H3A-H3C"
+    Then H2J 1X1 should be included
+    And H3A 1B7 should be included
+    And H3B 2B9 should be included
+    And H3C 3B6 should be included
+    But H3D 5A5 should not be included
+
+  Scenario: Three ranges
+    Given the zone is "H2H, H2J, H2T"
+    Then H2J 1B9 should be included
+    But H2K 0A3 should not be included
+
+  Scenario: No range
+    Given the zone is ""
+    Then H0H 0H0 should be included
+    Then V1A 0B3 should be included

data/features/postal_codes.feature

@@ -0,0 +1,51 @@
+Feature: Understand Canadian postal codes
+
+  Scenario: Typical postal code
+    When I enter postal code J5L 1A8
+    Then it is valid
+
+  Scenario Outline: LDL DLD
+    When I enter postal code <input>
+    Then it's an error
+
+    Examples:
+      | input  |
+      | 11A 1A1 |
+      | AAA 1A1 |
+      | A11 1A1 |
+      | A1A AA1 |
+      | A1A 111 |
+      | A1A 1AA |
+      | 1A1 A1A |
+
+  Scenario: Gibberish
+    When I enter postal code BOB LOBLAW
+    Then it is an error
+
+  Scenario Outline: Forbidden letters
+    When I enter postal code <input>
+    Then it is softly invalid
+
+    Examples:
+      | input   |
+      | D1A 1A1 |
+      | F1A 1A1 |
+      | I1A 1A1 |
+      | O1A 1A1 |
+      | Q1A 1A1 |
+      | U1A 1A1 |
+      | W1A 1A1 |
+      | A1W 1A1 |
+      | A1A 1Q1 |
+
+  Scenario Outline: Spaces don't matter
+    When I enter postal code <input>
+    Then the canonical representation is "J7Y 6B1"
+
+    Examples:
+      | input   |
+      | J7Y 6B1 |
+      | J7Y6B1  |
+      | J7Y-6B1 |
+
+

data/features/step_definitions/postcode_steps.rb

@@ -0,0 +1,8 @@
+
+When(/^I enter postal code (.+)$/) do |postcode|
+  begin
+    @it = Regional::Postcode.new(postcode)
+  rescue => @error
+  end
+end
+

data/features/step_definitions/steps.rb

@@ -0,0 +1,19 @@
+Then(/^it is valid$/) do
+  @it.should be_valid
+end
+
+Then(/^it is \S* ?invalid$/) do
+  @it.should_not be_valid
+end
+
+Then(/^(?:it does ?n.t work|it ?[i']s an error)$/) do
+  @error.should_not be_nil
+end
+
+Then('the canonical representation is "$s"') do |s|
+  @it.to_s.should == s
+end
+
+Then(/^pry$/i) do
+  binding.pry
+end

data/features/step_definitions/zone_steps.rb

@@ -0,0 +1,14 @@
+Given(/^the zone is "?([^"]*)"?$/) do |zone|
+  @zone = Regional::Zone.new(zone)
+end
+
+Then(/^(.+) should be included$/) do |place|
+  place = Regional::Postcode.new(place)
+  @zone.should cover(place)
+end
+
+Then(/^(.+) should.?n.t be included$/) do |place|
+  place = Regional::Postcode.new(place)
+  @zone.should_not cover(place)
+end
+

data/features/support/env.rb

@@ -0,0 +1,4 @@
+
+require File.dirname(__FILE__) + '/../../lib/regional.rb'
+require 'rspec/expectations'
+require 'pry'

data/lib/regional/postcode.rb

@@ -0,0 +1,45 @@
+
+module Regional
+  # Canadian postal code
+  class Postcode
+    @@pattern = /[a-z][0-9][a-z][0-9][a-z][0-9]/i
+    
+    # returns `nil` if string is not a postal code
+    def initialize(string)
+      string = string.scan(/[a-z0-9]+/i).join.upcase
+      string = string.match(@@pattern).to_s
+      raise FormatDoesntMatch if string.empty?
+
+      @fsa = string[0..2]
+      @ldu = string[3..5]
+    end
+    
+    def to_s
+      @fsa + ' ' + @ldu
+    end
+    
+    def pp
+      @fsa + ' ' + @ldu
+    end
+
+    def squeeze
+      @fsa + @ldu
+    end
+
+    def valid?
+      !false && !illegal_characters?
+    end
+
+    def illegal_characters?
+      to_s =~ /[DFIOQUW]/
+    end
+
+    def inspect
+      "#<#{self.class.name} #{to_s}>"
+    end
+
+    class ParseError < StandardError; end
+
+    class FormatDoesntMatch < ParseError; end
+  end
+end

data/lib/regional/version.rb

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

data/lib/regional/zone.rb

@@ -0,0 +1,31 @@
+module Regional
+  class Zone
+    attr_reader :components
+
+    def initialize(zone)
+      @components = zone.split(/,\s*/).map do |str| 
+        array = str.split("-")
+
+        if array.count == 1
+          array.first...array.first.succ
+        elsif array.count == 2
+          array.first...array.last.succ
+        else
+          raise ArgumentError, "Range can only have one hyphen"
+        end
+      end
+
+      @components[0] ||= "0".."ZZZZZZ"
+    end
+
+    def cover?(area)
+      @components.map{ |c| c.cover?(area.squeeze) }.inject do |m,o|
+        m || o
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} #{@components.join(", ")}>"
+    end
+  end
+end

data/lib/regional.rb

@@ -0,0 +1,5 @@
+require "regional/version"
+require "regional/postcode"
+require "regional/zone"
+
+module Regional; end

data/regional.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'regional/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "regional"
+  spec.version       = Regional::VERSION
+  spec.authors       = ["Jonathan Allard"]
+  spec.email         = ["jonathan@allard.io"]
+  spec.description   = %q{Regional allows defining regions and testing what's inside it.}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec-expectations"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: regional
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Allard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Regional allows defining regions and testing what's inside it.
+email:
+- jonathan@allard.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/determine_inclusion.feature
+- features/postal_codes.feature
+- features/step_definitions/postcode_steps.rb
+- features/step_definitions/steps.rb
+- features/step_definitions/zone_steps.rb
+- features/support/env.rb
+- lib/regional.rb
+- lib/regional/postcode.rb
+- lib/regional/version.rb
+- lib/regional/zone.rb
+- regional.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Regional allows defining regions and testing what's inside it.
+test_files:
+- features/determine_inclusion.feature
+- features/postal_codes.feature
+- features/step_definitions/postcode_steps.rb
+- features/step_definitions/steps.rb
+- features/step_definitions/zone_steps.rb
+- features/support/env.rb
+has_rdoc: