postcode_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50a88a5da088eaac70d238ecb58e5b71ff66659b
+  data.tar.gz: 780447807f194f0935efdd21c2aaf62c8d0a331a
+SHA512:
+  metadata.gz: 9439a870c7659fdc4796d92bb3927f1d4cf6d58906d677d072360e9a5451151a0b21ad2114ec5a26a7caba17e09c0b5475bfd534d04d6abbf0a4f453154328b1
+  data.tar.gz: 4d9bbbee7d089c8c0545987e694cb5acf409e1a02a68bbb6c0e7b44554d1da67094c511f4b1d2b3d9dc301168d7319bc769599772645c58cf649c1cd742d26e6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+script: "bundle exec rake clean spec"
+
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zipcode_validator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    postcode_validator (0.1.0)
+      twitter_cldr (~> 4.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.0.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    thread_safe (0.3.6)
+    twitter_cldr (4.4.3)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.0)
+      tzinfo
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (> 3.2.0)
+  activesupport (> 3.2.0)
+  bundler (~> 1.16)
+  postcode_validator!
+  rake (~> 10.0)
+  rspec (~> 3.7.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018 notus.sh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,55 @@
+# PostcodeValidator
+
+A simple postcode validator based on the Unicode CLDR project, with an optional integration with ActiveModel.
+
+## Installation
+
+`PostcodeValidator` is distributed as a gem and available on [rubygems.org](https://rubygems.org/gems/postcode_validator) so you can add it to your `Gemfile` or install it manually with:
+
+```ruby
+gem install postcode_validator
+```
+
+## Usage
+
+You can use `PostcodeValidator` either as a stand-alone validator or integrated with ActiveModel.
+
+### Stand-alone
+
+```ruby
+require 'postcode_validator'
+
+validator = PostcodeValidator.new
+
+validator.valid?('98025', country: 'FR') # True
+validator.valid?('AB21 9BG', country: :GB) # True
+validator.valid?('AB21 9BG', country: :DE) # False
+validator.valid?('', country: 'PA') # True - Panama does not use postcodes.
+```
+
+The `:country` option is **required**. It can be anything that respond to `to_s`.
+If the supplied `:country` is not a valid [ISO-3166 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), a `PostcodeValidator::Error` will be raised.
+
+### ActiveModel integration
+
+```ruby
+class Address < ActiveRecord::Base
+
+  # With a dedicated helper
+  validates_as_postcode :zipcode, country: :US
+
+  # Or through the generic `validates` class method, mixed with other validators
+  validates :post_code,
+    presence: true,
+    postcode: { allow_nil: true, country: -> { |record| record.country_code } }
+end
+```
+
+The ActiveModel validator supports the same common arguments others standard validators do (`:if`, `:unless`, `:on`, `:allow_nil`, `:allow_blank` and `:strict`).
+The `:country` argument is **required**. It can be either a static value (anything that respond to `to_s`) or a lambda. The lambda will be called with the will be validated record as its first argument.
+
+If the supplied `:country` is not a valid [ISO-3166 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), the postcode validation will be skipped (It's your responsability to validate the value of `:country`).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/notus-sh/postcode_validator.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: :spec

data/lib/active_model/validations/postcode_validator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'active_model/validations'
+
+module ActiveModel
+  module Validations
+    class PostcodeValidator < ActiveModel::EachValidator # :nodoc:
+      def validate_each(record, attribute, value)
+        country = option_call(record, :country)
+        record.errors.add(attribute, :invalid_postcode) unless validator.valid?(value, country: country)
+      rescue ::PostcodeValidator::Error # rubocop:disable Lint/HandleExceptions
+        # When :country is not a valid country, just skip postcode validation
+        # :country validation is developer's responsability
+      end
+
+      def check_validity!
+        raise ArgumentError, ':country must be supplied' unless options.include?(:country)
+      end
+
+      private
+
+      def option_call(record, name)
+        option = options[name]
+        option.respond_to?(:call) ? option.call(record) : option
+      end
+
+      def validator
+        @validator ||= ::PostcodeValidator.new
+      end
+    end
+
+    module HelperMethods #:nodoc:
+      # Validates whether the value of the specified attribute is a valid zip code
+      #
+      #   class Address < ActiveRecord::Base
+      #
+      #     validates_as_postcode :zipcode, country: :US
+      #
+      #     validates :post_code,
+      #       presence: true,
+      #       postcode: { allow_nil: true, country: -> { |record| record.country_code } }
+      #   end
+      #
+      # Configuration:
+      # * <tt>:country</tt> - The ISO-3166-2 code of the country we will validate
+      #   the zip code for. Can be a static value or a lambda that may accept the
+      #   current record as its first argument.
+      def validates_as_postcode(*attr_names)
+        validates_with PostcodeValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/postcode_validator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'twitter_cldr'
+
+begin
+  # ActiveModel integration
+  require 'active_model'
+  require 'active_support/i18n'
+  require 'active_model/validations/postcode_validator'
+
+  ActiveSupport.on_load(:i18n) do
+    I18n.load_path << Dir[File.expand_path(File.join(__dir__, '..', 'locales', '*.yml')).to_s]
+  end
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
+# A simple  postcode validator
+#
+# Can be used to validate a post code, regarding a country specified through the
+# :country option as an ISO-3166-2 code.
+class PostcodeValidator
+  # Package specific error class
+  class Error < StandardError; end
+
+  def valid?(postcode, options = {})
+    iso = country_as_iso(options)
+    postcode = postcode.to_s.strip
+    validator = validator_for(iso)
+    validator ? validator.valid?(postcode) : postcode.blank?
+  end
+
+  protected
+
+  def country_as_iso(options)
+    raise Error, 'Missing :country option' unless options.key?(:country) && !options[:country].nil?
+    iso = TwitterCldr::Shared::Territories.normalize_territory_code(options[:country])
+
+    # raise ArgumentError if :iso is not a valid territory code
+    iso if TwitterCldr::Shared::TerritoriesContainment.contains?('001', iso.to_s.upcase)
+  rescue ArgumentError => e
+    raise Error, e.message
+  end
+
+  def validator_for(iso)
+    TwitterCldr::Shared::PostalCodes.for_territory(iso)
+  rescue TwitterCldr::Shared::InvalidTerritoryError
+    # No validator exists for :iso_code, this country may not use postcodes at all.
+    nil
+  end
+end

data/lib/postcode_validator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class PostcodeValidator
+  VERSION = '0.1.0'
+end

data/locales/en.yml

@@ -0,0 +1,5 @@
+---
+en:
+  errors:
+    messages:
+      invalid_postcode: "is not a valid postcode"

data/locales/fr.yml

@@ -0,0 +1,5 @@
+---
+fr:
+  errors:
+    messages:
+      invalid_zipcode: "n'est pas un code postal valide"

data/postcode_validator.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postcode_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postcode_validator'
+  spec.version       = PostcodeValidator::VERSION
+  spec.licenses      = ['Apache-2.0']
+  spec.authors       = ['Gaël-Ian Havard']
+  spec.email         = ['gael-ian@notus.sh']
+
+  spec.summary       = 'A simple postcode validator for Rails.'
+  spec.description   = 'A simple postcode validator based on ActiveModel and Unicode CLDR.'
+  spec.homepage      = 'https://github.com/notus-sh/postcode_validator'
+
+  raise 'RubyGems 2.0 or newer is required.' unless spec.respond_to?(:metadata)
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_runtime_dependency     'twitter_cldr',   '~> 4.4.3'
+
+  # Optional dependencies, used in tests
+  spec.add_development_dependency 'activemodel',    '> 3.2.0'
+  spec.add_development_dependency 'activesupport',  '> 3.2.0'
+
+  # Development tools
+  spec.add_development_dependency 'bundler',        '~> 1.16'
+  spec.add_development_dependency 'rake',           '~> 10.0'
+  spec.add_development_dependency 'rspec',          '~> 3.7.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: postcode_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gaël-Ian Havard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter_cldr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: A simple postcode validator based on ActiveModel and Unicode CLDR.
+email:
+- gael-ian@notus.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_model/validations/postcode_validator.rb
+- lib/postcode_validator.rb
+- lib/postcode_validator/version.rb
+- locales/en.yml
+- locales/fr.yml
+- postcode_validator.gemspec
+homepage: https://github.com/notus-sh/postcode_validator
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+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 simple postcode validator for Rails.
+test_files: []