gtiny 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ad87eddcdf736731b8e49e2eef1478b57d19145123dc615e2e8a194d7421bce
+  data.tar.gz: b894ad68e5e3f8e572a9199f0f48b2e006b8c3cafacf6ff44e302a0acc15e3b4
+SHA512:
+  metadata.gz: 6795f9ab893d2d68907fe5f7d8fca39ab9ce66b8c41bf64df439b0a86eb9b23e65607a92feda80be3518fe63b89e91e075b78e841644efbf76ae92b45e601632
+  data.tar.gz: a7e5bf1d437244da76ef62a92a670602bc93b6fd1a9daca620431a997e8ffbb965e5acb0d6e9a0e3c053511644dfb37347cc1b0c7d54e6f9a5a4e9089aeeba2b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+RSpec/NestedGroups:
+  AllowedGroups:
+    - describe
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-16
+
+- Initial release!
+- Support for all GTIN formats: GTIN-8, GTIN-12, GTIN-13, and GTIN-14
+- Support for all ISBN formats: ISBN-10 and ISBN-13

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at clayton@juniphq.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gtiny.gemspec
+gemspec
+
+gem "faker" # Lorem ipsum and more!
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "steep" # Type checking with .rbs files

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    gtiny (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    csv (3.2.6)
+    diff-lcs (1.5.0)
+    faker (3.1.0)
+      i18n (>= 1.8.11, < 2)
+    ffi (1.15.5)
+    fileutils (1.7.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    language_server-protocol (3.17.0.2)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.8.3)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.17.1)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    securerandom (0.2.2)
+    steep (1.3.0)
+      activesupport (>= 5.1)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.5)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker
+  gtiny!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
+  steep
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Junip Inc.
+
+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,57 @@
+[![CI](https://github.com/junip-inc/gtiny/actions/workflows/main.yml/badge.svg)](https://github.com/junip-inc/gtiny/actions/workflows/main.yml)
+
+# Gtiny
+
+A tiny gem for identifying and validating GTINs in the wild.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gtiny'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gtiny
+
+## Usage
+
+Parse barcodes:
+
+```ruby
+id = Gtiny.parser.parse!('30152700')
+id.type # => "GTIN-8"
+id.check_digit # => "0"
+id.valid? # => true
+```
+
+Validate barcode check digits:
+
+```ruby
+id = Gtiny::ISBN10.new('0-13-445647-8')
+id.valid? # => false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gtiny. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gtiny/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gtiny project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gtiny/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+# Steep doesn't have a legit rake task class, so we're just invoking the CLI
+# class directly.
+require "steep"
+require "steep/cli"
+
+Steep::CLI.new(
+  argv: ["check"],
+  stdout: $stdout,
+  stderr: $stderr,
+  stdin: $stdin
+).run

data/Steepfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib"
+
+  configure_code_diagnostics(D::Ruby.lenient)
+end

data/lib/gtiny/encoding.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Gtiny
+  # An abstract class that defines the base for various types of text-based
+  # identifier encodings like GTIN-8, ISBN-10, etc.
+  class Encoding
+    def self.matches?(candidate)
+      regex.match?(candidate)
+    end
+
+    def self.normalize(string)
+      string
+    end
+
+    def self.regex
+      raise(NotImplementedError, "not implemented")
+    end
+
+    private
+
+    attr_reader :string
+
+    public
+
+    def initialize(string, check: true)
+      raise(EncodingError, "not a valid encoding") if check && !self.class.matches?(string)
+
+      @string = self.class.normalize(string.freeze)
+    end
+
+    def to_s
+      string
+    end
+
+    def type; end
+    def valid?; end
+  end
+end

data/lib/gtiny/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Gtiny
+  class Error < StandardError; end
+  class EncodingError < Error; end
+  class InsufficientData < Error; end
+  class ParseError < EncodingError; end
+end

data/lib/gtiny/gtin.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "encoding"
+
+module Gtiny
+  # Any of GTIN 8, 12, 13, and 14 may be used in an ITF-14 or GS1-128, as long
+  # as they are formatted in 14 digits.
+  #
+  # Any GTIN can be formatted as 14 digits by padding the left hand side with
+  # zeroes.
+  #
+  # A GTIN may be encoded in EAN/UPC, ITF-14, GS1-128, GS1 DataBar, and GS1
+  # DataMatrix. The GTIN may also be encoded in EPC scheme for RFID tags or in
+  # QR Code and Data Matrix when using GS1 Digital Link URI.
+  class GTIN < Encoding
+    def valid?
+      self.class.regex.match?(string) && valid_check_digit?
+    end
+
+    def check_digit
+      string[-1]
+    end
+
+    def company_prefix_and_item_reference
+      string[0..-2]
+    end
+
+    private
+
+    def valid_check_digit?
+      sum = string.reverse.each_char.with_index.sum do |digit, idx|
+        multiplier = (idx % 2).zero? ? 1 : 3
+        multiplier * digit.to_i
+      end
+
+      (sum % 10).zero?
+    end
+  end
+end

data/lib/gtiny/gtin12.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "gtin"
+
+module Gtiny
+  # GTIN-12: Used for UPC-A barcodes
+  class GTIN12 < GTIN
+    def self.regex
+      /\A[0-9]{12}\z/
+    end
+
+    def type
+      "GTIN-12"
+    end
+  end
+end

data/lib/gtiny/gtin13.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "gtin"
+
+module Gtiny
+  # GTIN-13: Used for EAN-13 barcodes.
+  class GTIN13 < GTIN
+    # GS1 company prefix starts with 1-9.
+    def self.regex
+      /\A[1-9][0-9]{12}\z/
+    end
+
+    def type
+      "GTIN-13"
+    end
+  end
+end

data/lib/gtiny/gtin14.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "gtin"
+
+module Gtiny
+  # GTIN-14: Cannot be used in EAN/UPC barcodes
+  class GTIN14 < GTIN
+    def self.regex
+      /\A[0-9]{14}\z/
+    end
+
+    def type
+      "GTIN-14"
+    end
+
+    # Indicator digit indicates packagaing level.
+    # -> A value of 0 indicates absence of information.
+    # -> A value of 9 indicates variable measure.
+    def indicator_digit
+      string[0]
+    end
+
+    def company_prefix_and_item_reference
+      string[1..-2]
+    end
+  end
+end

data/lib/gtiny/gtin8.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "gtin"
+
+module Gtiny
+  # GTIN-8: Used for EAN-8 barcodes.
+  class GTIN8 < GTIN
+    def self.regex
+      /\A[0-9]{8}\z/
+    end
+
+    def type
+      "GTIN-8"
+    end
+  end
+end

data/lib/gtiny/isbn.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "encoding"
+
+module Gtiny
+  # It seems like GTINs can also be encoded as ISBNs, which are either 10 or 13
+  # digits.
+  #
+  # A 10 digit ISBN can be converted to 13 digits by prefixing it with 978.
+  #
+  # ISBN-13s always have a 978 or 979 prefix, though that may be expanded in
+  # the future.
+  #
+  # Prior to ISBNs, "SBNs" were used and were either 9 or 12 digits. A 9 digit
+  # SBN can be converted to an ISBN by prefixing it with a single zero. A 12
+  # digit SBN can be converted to a 9 digit SBN by dropping the last three
+  # digits, which were often the price of the book.
+  class ISBN < Encoding
+    def self.normalize(string)
+      string.downcase.gsub(" ", "-")
+    end
+
+    def check_digit
+      string[-1]
+    end
+
+    def group_identifier
+      check_number_of_groups!
+
+      groups[-4]
+    end
+
+    def publisher_identifier
+      check_number_of_groups!
+
+      groups[-3]
+    end
+
+    def title_identifier
+      check_number_of_groups!
+
+      groups[-2]
+    end
+
+    def valid?
+      self.class.regex.match?(string) &&
+        digits.size == canonical_digits_size &&
+        valid_check_digit?
+    end
+
+    private
+
+    def digits
+      @digits ||= string.gsub("-", "")
+    end
+
+    def groups
+      @groups ||= string.split("-")
+    end
+
+    def canonical_digits_size; end
+    def canonical_groups_size; end
+
+    def check_number_of_groups!
+      return if groups.size == canonical_groups_size
+
+      raise(InsufficientData, "initialized with ambiguous format")
+    end
+  end
+end

data/lib/gtiny/isbn10.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "isbn"
+
+module Gtiny
+  # ISBN-10: Used for books published before 2007.
+  class ISBN10 < ISBN
+    # The ISBN-10 format consists of 4 groups, separated by hyphens (or spaces).
+    # 1. The group identifier, up to five digits
+    # 2. The publisher identifier, up to seven digits
+    # 3. The title identifier, up to 6 digits
+    # 4. The check digit
+    def self.regex
+      /\A[0-9]{1,5}[- ]?[0-9]{1,7}[- ]?[0-9]{1,6}[- ]?[0-9xX]\z/
+    end
+
+    def type
+      "ISBN-10"
+    end
+
+    private
+
+    # Since ISBN-10 uses mod 11 to calculate the check digit, the last digit
+    # can be 10, which is represented with an 'x'.
+    def valid_check_digit?
+      sum = digits.reverse.each_char.with_index.sum do |digit, idx|
+        multiplier = idx + 1
+        value = digit == "x" ? 10 : digit.to_i
+
+        multiplier * value
+      end
+
+      (sum % 11).zero?
+    end
+
+    def canonical_digits_size
+      10
+    end
+
+    def canonical_groups_size
+      4
+    end
+  end
+end

data/lib/gtiny/isbn13.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "isbn"
+
+module Gtiny
+  # ISBN-13: Used for all books published on or after January 1st, 2007.
+  class ISBN13 < ISBN
+    # The ISBN-13 format consists of 5 groups, separated by hyphens (or spaces).
+    # 1. The prefix element, 3 digits - so far only 978 and 979 are used.
+    # 2. The group identifier, up to five digits
+    # 3. The publisher identifier, up to seven digits
+    # 4. The title identifier, up to 6 digits
+    # 5. The check digit
+    def self.regex
+      /\A97(?:8|9)[- ]?[0-9]{1,5}[- ]?[0-9]{1,7}[- ]?[0-9]{1,6}[- ]?[0-9]\z/
+    end
+
+    def type
+      "ISBN-13"
+    end
+
+    def prefix_element
+      check_number_of_groups!
+
+      groups[0]
+    end
+
+    private
+
+    # This is effectively a GTIN-13, so the check digit algorithm is the same.
+    def valid_check_digit?
+      sum = digits.reverse.each_char.with_index.sum do |digit, idx|
+        multiplier = (idx % 2).zero? ? 1 : 3
+        multiplier * digit.to_i
+      end
+
+      (sum % 10).zero?
+    end
+
+    def canonical_digits_size
+      13
+    end
+
+    def canonical_groups_size
+      5
+    end
+  end
+end

data/lib/gtiny/parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Gtiny
+  # A class that will check a string against registered encoding classes.
+  class Parser
+    def initialize
+      @registrants = []
+    end
+
+    def register(klass)
+      @registrants << klass
+    end
+
+    def parse(string)
+      @registrants.each do |registrant|
+        next unless registrant.matches?(string)
+
+        identifier = registrant.new(string, check: false)
+        next unless identifier.valid?
+
+        return identifier
+      end
+
+      nil
+    end
+
+    def parse!(string)
+      identifier = parse(string)
+      return identifier unless identifier.nil?
+
+      raise(ParseError, "not a known identifier")
+    end
+  end
+end

data/lib/gtiny/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gtiny
+  VERSION = "0.1.0"
+end

data/lib/gtiny.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "gtiny/errors"
+require_relative "gtiny/parser"
+require_relative "gtiny/version"
+
+require_relative "gtiny/gtin8"
+require_relative "gtiny/gtin12"
+require_relative "gtiny/gtin13"
+require_relative "gtiny/gtin14"
+require_relative "gtiny/isbn10"
+require_relative "gtiny/isbn13"
+
+# A tiny gem for identifying and validating GTINs in the wild.
+module Gtiny
+  def self.parser
+    @parser ||= Parser.new.tap do |parser|
+      parser.register(ISBN10)
+      parser.register(ISBN13)
+      parser.register(GTIN8)
+      parser.register(GTIN12)
+      parser.register(GTIN13)
+      parser.register(GTIN14)
+    end
+  end
+end

data/sig/gtiny/encoding.rbs

@@ -0,0 +1,25 @@
+module Gtiny
+  # An abstract class that defines the base for various types of text-based
+  # identifier encodings like GTIN-8, ISBN-10, etc.
+  class Encoding
+    def self.matches?: (String candidate) -> bool
+
+    def self.normalize: (String string) -> String
+
+    def self.regex: () -> Regexp
+
+    private
+
+    attr_reader string: String
+
+    public
+
+    def initialize: (String string, ?check: bool) -> void
+
+    def to_s: () -> String
+
+    def type: () -> nil
+
+    def valid?: () -> nil
+  end
+end

data/sig/gtiny/errors.rbs

@@ -0,0 +1,10 @@
+module Gtiny
+  class Error < StandardError
+  end
+
+  class EncodingError < Error
+  end
+
+  class InsufficientData < Error
+  end
+end

data/sig/gtiny/gtin.rbs

@@ -0,0 +1,22 @@
+module Gtiny
+  # Any of GTIN 8, 12, 13, and 14 may be used in an ITF-14 or GS1-128, as long
+  # as they are formatted in 14 digits.
+  #
+  # Any GTIN can be formatted as 14 digits by padding the left hand side with
+  # zeroes.
+  #
+  # A GTIN may be encoded in EAN/UPC, ITF-14, GS1-128, GS1 DataBar, and GS1
+  # DataMatrix. The GTIN may also be encoded in EPC scheme for RFID tags or in
+  # QR Code and Data Matrix when using GS1 Digital Link URI.
+  class GTIN < Encoding
+    def valid?: () -> bool
+
+    def check_digit: () -> (String | nil)
+
+    def company_prefix_and_item_reference: () -> (String | nil)
+
+    private
+
+    def valid_check_digit?: () -> bool
+  end
+end

data/sig/gtiny/gtin12.rbs

@@ -0,0 +1,8 @@
+module Gtiny
+  # GTIN-12: Used for UPC-A barcodes
+  class GTIN12 < GTIN
+    def self.regex: () -> ::Regexp
+
+    def type: () -> "GTIN-12"
+  end
+end

data/sig/gtiny/gtin13.rbs

@@ -0,0 +1,8 @@
+module Gtiny
+  # GTIN-13: Used for EAN-13 barcodes.
+  class GTIN13 < GTIN
+    def self.regex: () -> ::Regexp
+
+    def type: () -> "GTIN-13"
+  end
+end

data/sig/gtiny/gtin14.rbs

@@ -0,0 +1,12 @@
+module Gtiny
+  # GTIN-14: Cannot be used in EAN/UPC barcodes
+  class GTIN14 < GTIN
+    def self.regex: () -> ::Regexp
+
+    def type: () -> "GTIN-14"
+
+    def indicator_digit: () -> (String | nil)
+
+    def company_prefix_and_item_reference: () -> (String | nil)
+  end
+end

data/sig/gtiny/gtin8.rbs

@@ -0,0 +1,8 @@
+module Gtiny
+  # GTIN-8: Used for EAN-8 barcodes.
+  class GTIN8 < GTIN
+    def self.regex: () -> ::Regexp
+
+    def type: () -> "GTIN-8"
+  end
+end

data/sig/gtiny/isbn.rbs

@@ -0,0 +1,42 @@
+module Gtiny
+  # It seems like GTINs can also be encoded as ISBNs, which are either 10 or 13
+  # digits.
+  #
+  # A 10 digit ISBN can be converted to 13 digits by prefixing it with 978.
+  #
+  # ISBN-13s always have a 978 or 979 prefix, though that may be expanded in
+  # the future.
+  #
+  # Prior to ISBNs, "SBNs" were used and were either 9 or 12 digits. A 9 digit
+  # SBN can be converted to an ISBN by prefixing it with a single zero. A 12
+  # digit SBN can be converted to a 9 digit SBN by dropping the last three
+  # digits, which were often the price of the book.
+  class ISBN < Encoding
+    def self.normalize: (String string) -> String
+
+    def check_digit: () -> (String | nil)
+
+    def group_identifier: () -> (String | nil)
+
+    def publisher_identifier: () -> (String | nil)
+
+    def title_identifier: () -> (String | nil)
+
+    def valid?: () -> bool
+
+    private
+
+    @digits: String
+    @groups: Array[String]
+
+    def digits: () -> String
+
+    def groups: () -> Array[String]
+
+    def canonical_digits_size: () -> nil
+
+    def canonical_groups_size: () -> nil
+
+    def check_number_of_groups!: () -> untyped
+  end
+end

data/sig/gtiny/isbn10.rbs

@@ -0,0 +1,16 @@
+module Gtiny
+  # ISBN-10: Used for books published before 2007.
+  class ISBN10 < ISBN
+    def self.regex: () -> ::Regexp
+
+    def type: () -> "ISBN-10"
+
+    private
+
+    def valid_check_digit?: () -> bool
+
+    def canonical_digits_size: () -> 10
+
+    def canonical_groups_size: () -> 4
+  end
+end

data/sig/gtiny/isbn13.rbs

@@ -0,0 +1,18 @@
+module Gtiny
+  # ISBN-13: Used for all books published on or after January 1st, 2007.
+  class ISBN13 < ISBN
+    def self.regex: () -> ::Regexp
+
+    def type: () -> "ISBN-13"
+
+    def prefix_element: () -> (String | nil)
+
+    private
+
+    def valid_check_digit?: () -> bool
+
+    def canonical_digits_size: () -> 13
+
+    def canonical_groups_size: () -> 5
+  end
+end

data/sig/gtiny/parser.rbs

@@ -0,0 +1,14 @@
+module Gtiny
+  # A class that will check a string against registered encoding classes.
+  class Parser
+    @registrants: Array[singleton(Encoding)]
+
+    def initialize: () -> void
+
+    def register: (singleton(Encoding) klass) -> untyped
+
+    def parse: (String string) -> (Encoding | nil)
+
+    def parse!: (String string) -> Encoding
+  end
+end

data/sig/gtiny.rbs

@@ -0,0 +1,9 @@
+module Gtiny
+  VERSION: String
+
+  # This syntax was a guess and steep seems to be accepting it. Not sure if
+  # this was a lucky guess or if the type checker is just choking on it.
+  self.@parser: Parser
+
+  def self.parser: () -> Parser
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: gtiny
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clayton Passmore
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-24 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- clayton@juniphq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/gtiny.rb
+- lib/gtiny/encoding.rb
+- lib/gtiny/errors.rb
+- lib/gtiny/gtin.rb
+- lib/gtiny/gtin12.rb
+- lib/gtiny/gtin13.rb
+- lib/gtiny/gtin14.rb
+- lib/gtiny/gtin8.rb
+- lib/gtiny/isbn.rb
+- lib/gtiny/isbn10.rb
+- lib/gtiny/isbn13.rb
+- lib/gtiny/parser.rb
+- lib/gtiny/version.rb
+- sig/gtiny.rbs
+- sig/gtiny/encoding.rbs
+- sig/gtiny/errors.rbs
+- sig/gtiny/gtin.rbs
+- sig/gtiny/gtin12.rbs
+- sig/gtiny/gtin13.rbs
+- sig/gtiny/gtin14.rbs
+- sig/gtiny/gtin8.rbs
+- sig/gtiny/isbn.rbs
+- sig/gtiny/isbn10.rbs
+- sig/gtiny/isbn13.rbs
+- sig/gtiny/parser.rbs
+homepage: https://github.com/junip-inc/gtiny
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/junip-inc/gtiny
+  source_code_uri: https://github.com/junip-inc/gtiny
+  changelog_uri: https://github.com/junip-inc/gtiny/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A tiny gem for identifying and validating GTINs in the wild.
+test_files: []