ea-validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a379bb01041037ee305bf378b726d07b479126f0
+  data.tar.gz: 8d03132732b65747ca9d2eaeb8266dacb6afba1c
+SHA512:
+  metadata.gz: 18aee70ad6eba15e46640b97222a268ce48415acae8249d98c7eebd94bd54ebfec3ecf00ff7959eddcb4cd09874bb4dd071836bf3b255443f0dffda9775872de
+  data.tar.gz: d91eb8c5fd2a43e4f209d4d75597e2460682109019eacefa5836d1e03000a954a55cad054f938f8f28cbd9c0ba3c89c286e258e647ac5942f4e1dbc2cc1bfd98

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Overcommit configuration files
+.overcommit*
+.git-hooks/
+rubocop/
+.rubocop.yml
+.htmlhintrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ea-validation.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2014 Environment Agency
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,65 @@
+# Ea::Validation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ea-validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ea-validation
+
+## Usage
+
+With this gem installed, a number of active model based validators become
+available:
+
+### Companies House Name
+
+There are a number of restrictions as to what comprises a company name valid
+for Companies House registration. This validator checks that the name complies
+to these restrictions.
+
+```ruby
+validates :company_name, "ea/validation/companies_house_name" => true
+```
+### Companies House number
+
+As with company names, there are also restrictions to the form of a company
+registration number. This validator checks that the company registration
+number complies to these restrictions.
+
+```ruby
+validates :number, "ea/validation/companies_house_number" => true
+```
+
+### Grid Reference
+
+A grid reference should be of the form AA 12345 67890 (spaces optional).
+The validator checks the format, and the the grid reference is valid.
+
+```ruby
+validates :grid_reference, "ea/validation/grid_reference" => true
+```
+
+## Modifications
+
+Options can be passed into validation by replacing `true` with an options
+hash. For example:
+
+```ruby
+validates(
+  :grid_reference,
+  "ea/validation/grid_reference" => {
+    message: "Custom",
+    allow_blank: true
+  }
+)
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "before_commit"
+spec = Gem::Specification.find_by_name "before_commit"
+load "#{spec.gem_dir}/lib/tasks/before_commit.rake"
+
+task test: :spec
+
+task :rubocop do
+  sh 'rubocop -D'
+end
+
+task default: [:rubocop, :test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ea/validation"
+
+# 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

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/ea-validation.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ea/validation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ea-validation"
+  spec.version       = Ea::Validation::VERSION
+  spec.authors       = ["Rob Nichols"]
+  spec.email         = ["git@nicholshayes.co.uk"]
+  spec.license       = "LICENSE"
+  spec.summary       = "Package of validations commonly used in EA projects"
+  spec.description   = "Package containing validations: ."
+  spec.homepage      = "https://github.com/reggieb/ea-validation"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "os_map_ref"
+  spec.add_dependency "activemodel"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "before_commit"
+  spec.add_development_dependency "virtus"
+  spec.add_development_dependency "rubocop"
+end

data/lib/ea/validation/companies_house_name_validator.rb

@@ -0,0 +1,34 @@
+# Validates a company name.
+# Allowed characters in legislation:
+#   http://www.legislation.gov.uk/uksi/2009/1085/schedule/1/made'
+#
+# rubocop:disable Style/AsciiComments
+#
+# Illegal characters - the company name cannot contain any of these characters: ^ | _ ~ ¬ or `
+#
+module Ea
+  module Validation
+    class CompaniesHouseNameValidator < ActiveModel::EachValidator
+
+      VALID_COMPANIES_HOUSE_NAME_REGEX = Regexp.new(/[\^|_~¬`]/).freeze
+
+      def validate_each(record, attribute, value)
+        if VALID_COMPANIES_HOUSE_NAME_REGEX.match(value)
+          record.errors.add(
+            attribute,
+            (options[:message] || I18n.t("ea.validation.errors.companies_house_name.#{attribute}.invalid"))
+          )
+        end
+      end
+
+      def self.name_max_length
+        170
+      end
+
+      def self.disallowed_chars
+        @disallowed_chars ||= ["^", "|", "_", "~", "¬", "`"]
+      end
+    end
+  end
+end
+# rubocop:enable Style/AsciiComments

data/lib/ea/validation/companies_house_number_validator.rb

@@ -0,0 +1,30 @@
+# Validates a company number.
+#   Valid numbers are:
+#     - two characters and 6 digits
+#     - 8 digits
+#
+# A company number consists of eight digits.
+# The first of these digits is usually a zero and because of this, in most cases only
+# the last seven numbers are usually required to be noted.
+# The certificate of incorporation of a new company will show only
+# the last seven numbers although the company number is actually eight digits and has a leading zero which is omitted.
+#
+module Ea
+  module Validation
+    class CompaniesHouseNumberValidator < ActiveModel::EachValidator
+
+      VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX = Regexp.new(/\A(\d{8,8}$)|([a-zA-Z]{2}\d{6}$)\z/i).freeze
+
+      def validate_each(record, attribute, value)
+        value.strip!
+        unless value =~ VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX
+          record.errors.add(
+            attribute,
+            (options[:message] || I18n.t("ea.validation.errors.companies_house_number.#{attribute}.invalid_html"))
+          )
+        end
+      end
+    end
+
+  end
+end

data/lib/ea/validation/grid_reference_validator.rb

@@ -0,0 +1,55 @@
+# Validate that a grid reference can be processed.
+module Ea
+  module Validation
+    class GridReferenceValidator < ActiveModel::EachValidator
+      require "os_map_ref"
+
+      attr_reader :message, :allow_blank, :value
+      def initialize(options)
+        @message = options[:message]
+        @allow_blank = options[:allow_blank]
+        super options
+      end
+
+      def validate_each(record, attribute, value)
+        @value = value
+        return true if allow_blank && value.blank?
+        return true unless os_map_ref_detects_error? || invalid_pattern?
+        record.errors.add attribute, message
+      end
+
+      private
+
+      def os_map_ref_detects_error?
+        OsMapRef::Location.for(value).easting
+        false
+      rescue OsMapRef::Error => e
+        @message ||= e.message
+      end
+
+      # Note that OsMapRef will work with less stringent coordinates than are
+      # specified for this application - so need to add an additional check.
+      def invalid_pattern?
+        /\A#{grid_reference_pattern}\z/ !~ value.strip
+      end
+
+      def grid_reference_pattern
+        [
+          two_letters, optional_space, five_digits, optional_space, five_digits
+        ].join
+      end
+
+      def two_letters
+        "[A-Za-z]{2}"
+      end
+
+      def five_digits
+        '\d{5}'
+      end
+
+      def optional_space
+        '\s*'
+      end
+    end
+  end
+end

data/lib/ea/validation/version.rb

@@ -0,0 +1,5 @@
+module Ea
+  module Validation
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/ea/validation.rb

@@ -0,0 +1,10 @@
+require "active_model"
+require "ea/validation/version"
+require "ea/validation/companies_house_name_validator"
+require "ea/validation/companies_house_number_validator"
+require "ea/validation/grid_reference_validator"
+
+module Ea
+  module Validation
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: ea-validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os_map_ref
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: before_commit
+  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: virtus
+  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: 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: 'Package containing validations: .'
+email:
+- git@nicholshayes.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ea-validation.gemspec
+- lib/ea/validation.rb
+- lib/ea/validation/companies_house_name_validator.rb
+- lib/ea/validation/companies_house_number_validator.rb
+- lib/ea/validation/grid_reference_validator.rb
+- lib/ea/validation/version.rb
+homepage: https://github.com/reggieb/ea-validation
+licenses:
+- LICENSE
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Package of validations commonly used in EA projects
+test_files: []