container_number_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09d51e852c15fc8b6107f0c5f39bff77f983777f
+  data.tar.gz: 4c910afd9c3e6b1c712fab7cb94bce20c0b0ca94
+SHA512:
+  metadata.gz: 4f7dbd3f2dda073ef24b6f63691d9ec37fbfacb324b94212ad20d8d5e27555e09ca39b333355bc36190826634e25b0b8379e37df1cad6762189a48994045604f
+  data.tar.gz: 3ad5790ac27db6afc84bff75c66bf68c7c6c951ce089f4b09c93e6003436e3f2ec0689e551365b4d32dba164676c6c08a3c8af31f2b083165894af0049778401

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Niels Stevens
+
+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,70 @@
+# Container Number Validator
+
+This gem allows you to easily validate container number fields to be valid
+container numbers.
+
+It validates Container Number according to [ISO_6346](http://en.wikipedia.org/wiki/ISO_6346)
+
+    NYKU5824120
+
+Also supports format where checkdigit is seperated with a dash like this
+
+    NYKU582412-0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'container_number_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install container_number_validator
+
+## Usage
+
+    ContainerNumberValidator.validate('NYKU582412-0')
+    #=> true
+
+    ContainerNumberValidator.validate('NYKU582412-3')
+    #=> false
+
+### Rails 3.x / 4.x
+
+You can use ContainerNumberValidator with any ActiveModel class, including
+ActiveRecord models:
+
+    class Container < ActiveRecord::Base
+      validates :container_no, container_number: true
+    end
+
+### Edge cases
+
+ * When no container number is present (or set to `nil`), all container numbers are considered **INVALID**.
+
+## Contributing
+
+### Wishlist
+
+ Nothing specific in mind yet ;-)
+
+If you're unsure what to contribute, contact me. :-)
+
+### How to contribute
+
+I prefer a pull request with added, but failing, specs to code without
+specs.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See [LICENSE.txt](https://github.com/kabisaict/container_number_validator/blob/master/LICENSE.txt)

data/Rakefile

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

data/container_number_validator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'container_number_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'container_number_validator'
+  spec.version       = ContainerNumberValidator::VERSION
+  spec.authors       = ['Niels Stevens', 'Michel De Graaf']
+  spec.email         = ['niels@kabisa.nl', 'michel@kabisa.nl']
+  spec.description   = %q{This gems validates Sea Container Numbers. It adds a Rails validator for this to your project.}
+  spec.summary       = %q{Validate Sea Container numbers}
+  spec.homepage      = 'https://github.com/kabisaict/container_number_validator'
+  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 'rspec', '~> 2.14.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'activemodel', '~> 4.0.0'
+end

data/container_number_validator.iml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.3.5, RVM: ruby-2.0.0-p247 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.1.0, RVM: ruby-2.0.0-p247 [global]) [gem]" level="application" />
+  </component>
+</module>
+

data/lib/container_number_validator/adapters/active_model.rb

@@ -0,0 +1,11 @@
+require 'active_model'
+
+module ActiveModel
+  module Validations
+    class ContainerNumberValidator < ::ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        record.errors.add(attribute, :invalid_container_number, message: 'is invalid') unless ::ContainerNumberValidator.validate(value)
+      end
+    end
+  end
+end

data/lib/container_number_validator/version.rb

@@ -0,0 +1,3 @@
+module ContainerNumberValidator
+  VERSION = "0.0.1"
+end

data/lib/container_number_validator.rb

@@ -0,0 +1,64 @@
+module ContainerNumberValidator
+
+  LETTERS = {
+      'A' => 10,
+      'B' => 12,
+      'C' => 13,
+      'D' => 14,
+      'E' => 15,
+      'F' => 16,
+      'G' => 17,
+      'H' => 18,
+      'I' => 19,
+      'J' => 20,
+      'K' => 21,
+      'L' => 23,
+      'M' => 24,
+      'N' => 25,
+      'O' => 26,
+      'P' => 27,
+      'Q' => 28,
+      'R' => 29,
+      'S' => 30,
+      'T' => 31,
+      'U' => 32,
+      'V' => 34,
+      'W' => 35,
+      'X' => 36,
+      'Y' => 37,
+      'Z' => 38
+  }.freeze
+
+  WEIGHTS = %w{1 2 4 8 16 32 64 128 256 512}.freeze
+
+  def validate(container_no)
+    return false unless container_no.to_s =~ /^[a-zA-Z]{4}\d{6}\-?\d$/
+
+    checksum = container_no[-1, 1].to_i
+    number   = container_no[0..-1]
+
+    calculate_checksum(number) == checksum
+  end
+  module_function :validate
+
+  private
+
+  def calculate_checksum(container_no)
+    chars = container_no.chars
+    digits, weights = [], []
+
+    chars[0..3].each  { |char| digits << LETTERS[char.upcase] }
+    chars[4..10].each { |char| digits << char }
+
+    digits.each_with_index do |digit, i|
+      weights[i] = digit.to_i * WEIGHTS[i].to_i
+    end
+
+    weights.reduce(:+) % 11
+  end
+  module_function :calculate_checksum
+
+end
+
+require 'container_number_validator/version'
+require 'container_number_validator/adapters/active_model' if defined?(ActiveModel)

data/spec/container_number_validator/adapters/active_model_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+if defined?(ActiveModel)
+
+  class Container < ModelBase
+    validates :container_no, container_number: true
+  end
+
+  describe Container do
+    it 'accepts only valid container numbers' do
+      obj = Container.new(container_no: 'TCLU812975-4')
+      expect(obj).to be_valid
+
+      obj = Container.new(container_no: 'TCLU812975-7')
+      expect(obj).not_to be_valid
+    end
+  end
+end

data/spec/container_number_validator/container_number_validator_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe ContainerNumberValidator do
+
+  context 'fails on nil and empty values' do
+    it 'with nil' do
+      expect(subject.validate(nil)).to be_false
+    end
+
+    it 'with empty string' do
+      expect(subject.validate('')).to be_false
+    end
+  end
+
+  context 'fails on invalid owner code and category indentifier' do
+    %w{1CLU812975-4 TCLU81A975-4 TCLU81-975-4 T3LU812975-4}.each do |value|
+      it "with #{value}" do
+        expect(subject.validate(value)).to be_false
+      end
+    end
+  end
+
+  context 'fails on invalid checksum' do
+    %w{TCLU812975-1 MOFU587008-2 DRYU413526-6 NYKU561651-8}.each do |value|
+      it "with #{value}" do
+        expect(subject.validate(value)).to be_false
+      end
+    end
+  end
+
+  context 'passes on valid owner code and category identifier' do
+    %w{MOFU587008-7 DRYU413526-5 NYKU644101-8 KKFU137865-2 NYKU561651-2 KKFU760143-9 TCLU250850-8}.each do |value|
+      it "with #{value}" do
+        expect(subject.validate(value)).to be_true
+      end
+    end
+  end
+
+  context 'passes on mixed case valid owner code and category identifier' do
+    %w{TCLU812975-4 TCLU8129754 tclu8129754 tclu812975-4}.each do |value|
+      it "with #{value}" do
+        expect(subject.validate(value)).to be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require 'rspec'
+
+begin
+  require 'active_model'
+rescue LoadError => err
+  puts 'Running specs without active_model extension'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'container_number_validator'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+if defined?(ActiveModel)
+  class ModelBase
+    include ActiveModel::Serialization
+    include ActiveModel::Validations
+
+    attr_accessor :attributes
+
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+    def read_attribute_for_validation(key)
+      @attributes[key.to_sym]
+    end
+
+    def method_missing(method_name, *args, &block)
+      return super unless @attributes.keys.any? { |k| k == method_name }
+      @attributes[method_name.to_sym]
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: container_number_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niels Stevens
+- Michel De Graaf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: This gems validates Sea Container Numbers. It adds a Rails validator
+  for this to your project.
+email:
+- niels@kabisa.nl
+- michel@kabisa.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- container_number_validator.gemspec
+- container_number_validator.iml
+- lib/container_number_validator.rb
+- lib/container_number_validator/adapters/active_model.rb
+- lib/container_number_validator/version.rb
+- spec/container_number_validator/adapters/active_model_spec.rb
+- spec/container_number_validator/container_number_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kabisaict/container_number_validator
+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.6
+signing_key: 
+specification_version: 4
+summary: Validate Sea Container numbers
+test_files:
+- spec/container_number_validator/adapters/active_model_spec.rb
+- spec/container_number_validator/container_number_validator_spec.rb
+- spec/spec_helper.rb