reference_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e3962ba0650c8a47c881a274a0b5c41394d884c37ecf638b87d4714ba5ebe96
+  data.tar.gz: be925dbdf2260dce92fc3830b08a7ad0df92124681042e2dea77fa5dece3a0dc
+SHA512:
+  metadata.gz: 1854275fb7f7a1cc3e0d5e16d7ba69ee680b0f965433b00e655c2034b91a1dd858be2af4531f00d2d51da920ab3c9ed866605b39ecf66db769f584bad543665b
+  data.tar.gz: bc1dbd9e2c79d0a47da94d539220b1cde91bd04d230813aaaf792d17046ac3d789e4bbbd563dd1f17088609623fd4e928da6b76339b9653803cd7e07f7d8d042

data/README.md

@@ -0,0 +1,26 @@
+# ReferenceValidator
+
+A gem to be used for the validation of product references.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reference_validator'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+```ruby
+ReferenceValidator::ValidateEan.validate!(<ean>)
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/reference_validator.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'reference_validator/validate_ean'

data/lib/reference_validator/validate_ean.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# https://en.wikipedia.org/wiki/Check_digit
+# SSCC codes (18 digits) are treated as invalid
+
+module ReferenceValidator
+  class ValidateEan
+    attr_reader :code
+
+    DEFAULT_CODE_LENGTH = 18
+    MAX_CODE_LENGTH = 13
+
+    def initialize(code)
+      @code = code
+    end
+
+    def validate!
+      return true if code.present? && format_valid? && checksum_valid?
+
+      false
+    end
+
+    private
+
+    def format_valid?
+      return false unless code.length == MAX_CODE_LENGTH
+
+      code.match?(/\A\d{1,#{DEFAULT_CODE_LENGTH}}\z/)
+    end
+
+    def checksum_valid?
+      digits    = Array.new(DEFAULT_CODE_LENGTH - code.length, 0) + code.split('').map(&:to_i)
+      remainder = data_digits_sum(digits[0..-2]) % 10
+
+      digits[-1] == (remainder.zero? ? remainder : 10 - remainder)
+    end
+
+    def data_digits_sum(data_digits)
+      data_digits.each_with_index.reduce(0) do |sum, (digit, index)|
+        sum + ((index % 2).zero? ? digit * 3 : digit)
+      end
+    end
+  end
+end

data/lib/reference_validator/version.rb

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: reference_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- emiel hagen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+description:
+email:
+- emiel.hagen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/reference_validator.rb
+- lib/reference_validator/validate_ean.rb
+- lib/reference_validator/version.rb
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A gem to validate product references, such as EAN.
+test_files: []