barcodevalidation
A RubyGem to parse and validate barcodes.
Installation
Add this line to your application's Gemfile:
gem "barcodevalidation"
And then execute:
$ bundle
Or install it yourself as:
$ gem install barcodevalidation
Usage
The main API is BarcodeValidation.scan
. It accepts a single argument,
and it's pretty flexible about what you give it.
gtin = BarcodeValidation.scan("937179-004167")
# => #<BarcodeValidation::GTIN::GTIN12(937179004167)>
gtin.to_s # => "937179004167"
gtin.valid? # => true
gtin.check_digit # => #<BarcodeValidation::GTIN::CheckDigit(7)>
gtin.first(6) # => #<BarcodeValidation::DigitSequence(937179)>
gtin.slice(0..5) # => #<BarcodeValidation::DigitSequence(937179)>
gtin.to_gtin_13 # => #<BarcodeValidation::GTIN::GTIN13(0937179004167)>
gtin.to_all_valid
# => [#<BarcodeValidation::GTIN::GTIN12(937179004167)>,
#<BarcodeValidation::GTIN::GTIN123(0937179004167)>]
bad = BarcodeValidation.scan(937_179_004_162)
# => #<BarcodeValidation::InvalidGTIN(937179004162)>
bad.valid? # => false
bad.check_digit # => #<BarcodeValidation::GTIN::CheckDigit(2) invalid: expected 7>
bad.check_digit.valid? # => false
bad.check_digit.actual # => #<BarcodeValidation::Digit(2)>
bad.check_digit.expected # => #<BarcodeValidation::Digit(7)>
bad.to_gtin_13 # => #<BarcodeValidation::InvalidGTIN(937179004162)>
bad.to_all_valid # => []
Development
Download the code from GitHub:
git clone git@github.com:marketplacer/.git
Set up dependencies using Bundler:
cd
bin/setup
Start the interactive development console:
bin/console
Run a build:
bin/rake
Code Quality Checks
Rubocop is used to enforce coding standards.
bin/rubocop
bin/rubocop --help
Tests & Publishing
Code is automatically tested with each push on Buildkite. Assuming all tests pass, commits on main
will be parsed with Semantic Release to produce new Git tags, and to publish to RubyGems.
Project Structure
This project's structure is inspired by the Bundler skeleton for a new
Gem, created using bundler gem barcodevalidation
.
.bundle/config
: Configuration for Bundler.ruby-version
: Gives rvm, rbenv, chruby etc. a Ruby version to useGemfile
: Lists RubyGem dependencies, to be installed by BundlerRakefile
: Defines Rake tasksbin/
: Contains binstubs, useful for development tasksbundle
: Runs Bundler, in the correct wayconsole
: development console (equiv. tobin/bundle exec pry
)rake
: Runs Rake (equivalent tobin/bundle exec rake
)rubocop
: Runs Rubocop (equivalent tobin/bundle exec rubocop
)setup
: Sets up the project to be ready for development
config/boot.rb
: Prepares dependencies before loading the librarylib/
: Source files; this directory is added to Ruby's load pathscript/ci
: The script run by Buildkite to start a build
License
This project is licensed under the MIT License. See LICENSE.md for the full text.