upc_tools 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed3fa91c8d56d01afc5b7c44b768a2fcec6011de
-  data.tar.gz: 331515539dd02cab7be75e08befb01c62b0cb607
+SHA256:
+  metadata.gz: 41d8d28e5df44b15dcfbaad11704f0b1912a9ec0364093937169e9f5bc12089c
+  data.tar.gz: 55a445a4593fed4189bf779f64b9d09d3aa75f2a79a715fc099f17c29b3fb72a
 SHA512:
-  metadata.gz: a6e9c7e542fdfd7aa4f12e16fa1c1e98e958e3fc7c7643706eb3c73f8868223aae0668cc1d95d3323afad1613b935e148e7b622cd6fa8fbc1a4bafbf9a29df6b
-  data.tar.gz: 2d46596725e21caf305d2d9fc91f661329ddf3a373810594d8af4ddce0290006d8c9c104169a230d06a214080a1de635c1c4846485b1c898241b11c76ea414a3
+  metadata.gz: 9f0224a9c626287503c2582a1be18b27e4f4717725442420fb5daa84bef98a9dfdcc37a30495bf59b5d82a696bb8b68da919fdc1ead50382992ad9aa2f709b19
+  data.tar.gz: 515b79461f5c139548615c07afffbfcd8ee9389ae11220895a920c54f0cc4ea9b4f83cb709e5addc014eaf5b6a25eb896fda471fc074c8da7f6dcb4760d9d539

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+<!-- *Before creating an issue please make sure you are using the latest version of sopstool.* -->
+
+## Current Behavior
+
+<!-- Describe the current behavior relevant to the issue -->
+
+## Expected Behavior
+
+<!-- Describe what you expect it to do, if it is in error -->
+
+## Steps to reproduce
+
+<!-- Please provide the steps necessary to reproduce this issue if it is a bug. -->
+<!-- If you can, provide a link to a public repository which contains the files necessary to reproduce this. -->
+<!-- Please mention your operating system and sops versions -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,41 @@
+Story/Issue Link
+-----
+
+[#]()
+
+Background
+-----
+
+Add background information that will be helpful to reviewers:
+
+* Why are we making this change?
+* How you arrived at this solution
+* High level overview of when / how this code is executed
+* Link to related Stories/Issues/PRs
+
+Versioning
+-----
+
+Indicate the intended next version, and any special considerations
+
+* Review the [Contributing Guide on Versioning](CONTRIBUTING.md#versioning)
+* Ensure you are ready to increment an appropriate part of the version to release
+
+Additional Requests to Reviewers
+-----
+
+Add any additional high-level requests for reviewers.
+
+Tasks
+-----
+
+* [ ] Specs written
+* [ ] Manual testing
+
+/cc
+-----
+
+@mention any specific individuals you'd like to be aware of this change:
+
+* Who is impacted by the work?
+* Who knows this code best and can provide useful feedback?

data/.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
 cache: bundler
 rvm:
-  - "1.9.3"
-  - "2.1.9"
-  - "2.2.4"
-  - "2.3.1"
-  - "jruby-9.0.5.0"
-before_install:
+  - "2.4"
+  - "2.5"
+  - "2.6"
+  - "2.7"
+  # - "jruby-9.1" #jruby can't run rake for some reason. skip it for now
+before_install:  # For jruby-head to work.
   - gem install bundler
+  - gem update bundler
+
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,46 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at jhart@onyxraven.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at osscompliance@ibotta.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -1,21 +1,201 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Ibotta, 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.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,7 @@
 # UpcTools
 
 [![Build Status](https://travis-ci.org/Ibotta/ruby_upc_tools.svg?branch=master)](https://travis-ci.org/Ibotta/ruby_upc_tools)
+[![Gem Version](https://badge.fury.io/rb/upc_tools.svg)](https://badge.fury.io/rb/upc_tools)
 
 Utilities to generate, convert and validate UPCs.
 

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/upc_tools.rb

@@ -1,85 +1,84 @@
 require "upc_tools/version"
 
-#UPC Tools
+# UPC Tools
 module UpcTools
-
-  #Generate one UPC check digit
+  # Generate one UPC check digit
   # @see http://www.gs1.org/barcodes/support/check_digit_calculator/
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf section 3.A.1.1
   # @param num [String] base number to generate check digit for
   # @return [Integer] check digit (always between 0-9)
   def self.generate_upc_check_digit(num)
     even = odd = 0
-    #pad everything to max (13)
-    num.to_s.rjust(13, '0').split('').each_with_index do |item, index|
+    # pad everything to max (13)
+    num.to_s.rjust(13, "0").split("").each_with_index do |item, index|
       item = item.to_i
-      even += item if index.odd? #opposite because of 0 indexing
+      even += item if index.odd? # opposite because of 0 indexing
       odd += item if index.even?
     end
     chk_total = (odd * 3) + even
     (10 - (chk_total % 10)) % 10
   end
 
-  #Validate UPC check digit
+  # Validate UPC check digit
   # @see http://www.gs1.org/barcodes/support/check_digit_calculator/
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf section 3.A.1.1
   # @param upc [String] UPC with check digit to check
   # @return [Boolean] truth of valid check digit
   def self.valid_upc_check_digit?(upc)
-    full_upc = upc.to_s.rjust(14, '0') #extend to full 14 digits first
+    full_upc = upc.to_s.rjust(14, "0") # extend to full 14 digits first
     gen_check = generate_upc_check_digit(full_upc[0, full_upc.size - 1])
     full_upc[-1] == gen_check.to_s
   end
 
-  #Add check digit and properly pad
+  # Add check digit and properly pad
   # @param num [String] base number to extend
   # @param extended_length [Integer] resulting target to pad number to
   # @return [String] resulting UPC with check digit
-  def self.extend_upc_with_check_digit(num, extended_length=12)
+  def self.extend_upc_with_check_digit(num, extended_length = 12)
     upc = num.to_s << generate_upc_check_digit(num).to_s
-    upc.rjust(extended_length, '0') #extend to at least the given length
+    upc.rjust(extended_length, "0") # extend to at least the given length
   end
 
-  #Type 2 format 2 | ID3456 | X | 000P | C (Check X is optional, price can overflow in some cases)
+  # Type 2 format 2 | ID3456 | X | 000P | C (Check X is optional, price can overflow in some cases)
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf section 3.A.1.2
 
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf Figure 3.A.1.2 – 1 Weight Factor 2-
-  WEIGHT_FACTOR_2 = [0,2,4,6,8,9,1,3,5,7]
+  WEIGHT_FACTOR_2 = [0, 2, 4, 6, 8, 9, 1, 3, 5, 7]
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf Figure 3.A.1.2 – 2 Weight Factor 3
-  WEIGHT_FACTOR_3 = [0,3,6,9,2,5,8,1,4,7]
+  WEIGHT_FACTOR_3 = [0, 3, 6, 9, 2, 5, 8, 1, 4, 7]
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf Figure 3.A.1.2 – 2 Weight Factor 5+
-  WEIGHT_FACTOR_5plus = [0,5,1,6,2,7,3,8,4,9]
+  WEIGHT_FACTOR_5plus = [0, 5, 1, 6, 2, 7, 3, 8, 4, 9]
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf Figure 3.A.1.2 – 4 Weight Factor 5-
-  WEIGHT_FACTOR_5mins = [0,5,9,4,8,3,7,2,6,1]
+  WEIGHT_FACTOR_5mins = [0, 5, 9, 4, 8, 3, 7, 2, 6, 1]
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf Figure 3.A.1.2 – 4 inverse Weight Factor 5-
-  WEIGHT_FACTOR_5mins_opposite = [0,9,7,5,3,1,8,6,4,2]
+  WEIGHT_FACTOR_5mins_opposite = [0, 9, 7, 5, 3, 1, 8, 6, 4, 2]
 
-  #Trim UPC to proper length for type2 checking
+  # Trim UPC to proper length for type2 checking
   # @param upc [String] UPC
   # @return [String] trimmed string
   def self.trim_type2_upc(upc)
-    #if length is > 12, strip leading 0
+    # if length is > 12, strip leading 0
     upc = upc.to_s
-    upc = upc.gsub(/^0+/, '') if upc.size > 12
+    upc = upc.gsub(/^0+/, "") if upc.size > 12
     upc
   end
 
-  #Is this a type2 UPC?
+  # Is this a type2 UPC?
   # @param upc [String] upc to check
   # @return [Boolean] is UPC a type-2?
   def self.type2_upc?(upc)
     upc = trim_type2_upc(upc)
-    return false if upc.size > 13 || upc.size < 12 #length is wrong
-    upc.start_with?('2')
+    return false if upc.size > 13 || upc.size < 12 # length is wrong
+    upc.start_with?("2")
   end
 
-  #Validate UPC and Price check digit for a type 2 upc. Does NOT also check the UPC itself
+  # Validate UPC and Price check digit for a type 2 upc. Does NOT also check the UPC itself
   # @param upc [String] Type 2 UPC to check with check digit(s)
   # @return [Boolean] matching check digit(s)?
   def self.valid_type2_upc_check_digit?(upc)
     upc = trim_type2_upc(upc)
     return false unless type2_upc?(upc)
-    plu, price, chk, price_chk = split_type2_upc(upc)
+    _plu, price, _chk, price_chk = split_type2_upc(upc)
     price_chk_calc = if price.size == 4
       generate_type2_upc_price_check_digit_4(price)
     elsif price.size == 5
@@ -90,20 +89,20 @@ module UpcTools
     price_chk == price_chk_calc.to_s
   end
 
-  #Convenience method validates that upc is type2 with valid check digit
+  # Convenience method validates that upc is type2 with valid check digit
   # @param upc [String] Type 2 UPC to check
   # @return [Boolean] is UPC a type-2 with valid check digit(s)?
   def self.valid_type2_upc?(upc)
     type2_upc?(upc) && valid_type2_upc_check_digit?(upc)
   end
 
-  #Convert item ID (PLU) and price to type2 UPC string
+  # Convert item ID (PLU) and price to type2 UPC string
   # @param plu [String] item identifier (not including leading 2)
   # @param price [String] price as integer (in cents). Will be 0 padded if necessary
   # @param opts [Hash] options hash
   # @option opts [Integer] :price_length (4) price length (4 or 5). Will override given price length.
   # @option opts [Integer] :upc_length (12) price length (12 or 13)
-  def self.item_price_to_type2(plu, price, opts={})
+  def self.item_price_to_type2(plu, price, opts = {})
     upc_length = opts[:upc_length] || 12
     price_length = opts[:price_length] || 4
     raise ArgumentError, "opts[:upc_length] must be 12 or 13" if upc_length != 12 && upc_length != 13
@@ -117,7 +116,7 @@ module UpcTools
     plu = plu.to_s
     raise ArgumentError, "plu must be 5 digits long" if plu.size != 5
 
-    price = price.to_s.rjust(price_length, '0')
+    price = price.to_s.rjust(price_length, "0")
     raise ArgumentError, "price must be less than or equal to 5 digits long" if price.size > 5
 
     price_chk_calc = if price.size == 4
@@ -125,38 +124,38 @@ module UpcTools
     elsif price.size == 5 && upc_length == 13
       generate_type2_upc_price_check_digit_5(price)
     else
-      ''
+      ""
     end
 
     upc = "2#{plu}#{price_chk_calc}#{price}"
     upc << generate_upc_check_digit(upc).to_s
   end
 
-  #Split a Type2 UPC into its component parts
+  # Split a Type2 UPC into its component parts
   # @see http://www.meattrack.com/Background/UPC.php
   # @see http://www.iddba.org/upccharacter2.aspx
   # @param upc [String] UPC to split up
   # @param skip_price_check [Boolean] Ignore price check digit (include digit in price field)
   # @return [Array<String>] elements of array: ItemID/PLU (not including leading 2), Price, UPC Check Digit, Price Check Digit
-  def self.split_type2_upc(upc, skip_price_check=false)
+  def self.split_type2_upc(upc, skip_price_check = false)
     upc = trim_type2_upc(upc)
-    plu = upc[1,5]
+    plu = upc[1, 5]
     chk = upc[-1]
     if upc.size == 13 || skip_price_check
       price = upc[-6, 5]
       price_chk = upc[-7] unless skip_price_check
     else
-      price = upc[-5,4]
+      price = upc[-5, 4]
       price_chk = upc[-6] unless skip_price_check
     end
     [plu, price, chk, price_chk]
   end
 
-  #Get the float price from a Type2 UPC
+  # Get the float price from a Type2 UPC
   # @param upc [String] UPC to get price from
   # @param skip_price_check [Boolean] Ignore price check digit (include digit in price field)
   # @return [Float] calculated price (rounded to nearest cent)
-  def self.get_price_from_type2_upc(upc, skip_price_check=false)
+  def self.get_price_from_type2_upc(upc, skip_price_check = false)
     _, price = UpcTools.split_type2_upc(upc, skip_price_check)
     (price.to_f / 100.0).round(2)
   end
@@ -166,25 +165,25 @@ module UpcTools
   # @return [Array<String,Float>] elements of array: type2 UPC string, Price. The UPC ends up with a 0 price if it is type2. The Price will be nil if the number passed in is not type2.
   def self.type2_number_price(number)
     if type2_upc?(number) && valid_type2_upc_check_digit?(number)
-      #looks like a type-2 and the price chk is valid
+      # looks like a type-2 and the price chk is valid
       item_code, price = split_type2_upc(number)
       price = (price.to_f / 100.0).round(2)
 
-      upc = item_price_to_type2(item_code, 0).rjust(14, '0')
+      upc = item_price_to_type2(item_code, 0).rjust(14, "0")
       [upc, price]
     else
       [number, nil]
     end
   end
 
-  #Generate price check digit for type 2 upc price of 4 digits
+  # Generate price check digit for type 2 upc price of 4 digits
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf section 3.A.1.3
   # @see http://barcodes.gs1us.org/GS1%20US%20BarCodes%20and%20eCom%20-%20The%20Global%20Language%20of%20Business.htm
   # @param price [String] price as integer (in cents)
   # @return [Integer] calculated price check digit
   def self.generate_type2_upc_price_check_digit_4(price)
-    #digit weighting factors 2-, 2-, 3, 5-
-    digits = price.to_s.rjust(4, '0').split('').map(&:to_i)
+    # digit weighting factors 2-, 2-, 3, 5-
+    digits = price.to_s.rjust(4, "0").split("").map(&:to_i)
     sum = 0
     sum += WEIGHT_FACTOR_2[digits[0]]
     sum += WEIGHT_FACTOR_2[digits[1]]
@@ -193,13 +192,13 @@ module UpcTools
     (sum * 3) % 10
   end
 
-  #Generate price check digit for type 2 upc price of 5 digits
+  # Generate price check digit for type 2 upc price of 5 digits
   # @see http://www.gs1tw.org/twct/web/BarCode/GS1_Section3V6-0.pdf section 3.A.1.4
   # @param price [String] price as integer (in cents)
   # @return [Integer] calculated price check digit
   def self.generate_type2_upc_price_check_digit_5(price)
-    #digit weighting factors 5+, 2-, 5-, 5+, 2- => opposite of 5-
-    digits = price.to_s.rjust(5, '0').split('').map(&:to_i)
+    # digit weighting factors 5+, 2-, 5-, 5+, 2- => opposite of 5-
+    digits = price.to_s.rjust(5, "0").split("").map(&:to_i)
     sum = 0
     sum += WEIGHT_FACTOR_5plus[digits[0]]
     sum += WEIGHT_FACTOR_2[digits[1]]
@@ -215,7 +214,7 @@ module UpcTools
   # maps as A  BCDEFG  H
   # ABC and H never change
 
-  #position conversions
+  # position conversions
   # G =  0  XXNNN0  A + BC000-00DEF + H
   # G =  1  XXNNN1  A + BC100-00DEF + H
   # G =  2  XXNNN2  A + BC200-00DEF + H
@@ -227,63 +226,62 @@ module UpcTools
   # G =  8  XXXXX8  A + BCDEF-00008 + H
   # G =  9  XXXXX9  A + BCDEF-00009 + H
 
-  #Convert short (8 digit) UPC-E to 12 digit UPC-A
+  # Convert short (8 digit) UPC-E to 12 digit UPC-A
   # @see http://www.taltech.com/barcodesoftware/symbologies/upc
   # @see http://en.wikipedia.org/wiki/Universal_Product_Code#UPC-E
   # @param upc_e [String] 8 digit UPC-E to convert
   # @return [String] 12 digit UPC-A
   def self.convert_upce_to_upca(upc_e)
-    #todo should i zero pad upc_e?
-    #todo allow without check digit?
+    # todo should i zero pad upc_e?
+    # todo allow without check digit?
     upc_e = upc_e.to_s
     raise ArgumentError, "UPC-E must be 8 digits" unless upc_e.size == 8
 
-    map_id = upc_e[-2].to_i #G
-    chk = upc_e[-1] #H
-    prefix = upc_e[0,3] #ABC
-    prefix_next = upc_e[3,3] #DEF
+    map_id = upc_e[-2].to_i # G
+    chk = upc_e[-1] # H
+    prefix = upc_e[0, 3] # ABC
+    prefix_next = upc_e[3, 3] # DEF
 
     if map_id >= 5
       "#{prefix}#{prefix_next}0000#{map_id}#{chk}"
     elsif map_id <= 2
       "#{prefix}#{map_id}0000#{prefix_next}#{chk}"
     elsif map_id == 3
-      "#{prefix}#{upc_e[3]}00000#{upc_e[4,2]}#{chk}"
+      "#{prefix}#{upc_e[3]}00000#{upc_e[4, 2]}#{chk}"
     elsif map_id == 4
-      "#{prefix}#{upc_e[3,2]}00000#{upc_e[5]}#{chk}"
+      "#{prefix}#{upc_e[3, 2]}00000#{upc_e[5]}#{chk}"
     end
   end
 
-  #Convert (zero-suppress) 12 digit UPC-A to 8 digit UPC-E
+  # Convert (zero-suppress) 12 digit UPC-A to 8 digit UPC-E
   # @see http://www.taltech.com/barcodesoftware/symbologies/upc
   # @see http://en.wikipedia.org/wiki/Universal_Product_Code#UPC-E
   # @see http://www.barcodeisland.com/upce.phtml#Conversion
   # @param upc_a [String] 12 digit UPC-A to convert
   # @return [String] 8 digit UPC-E
   def self.convert_upca_to_upce(upc_a)
-    #todo should i zero pad upc_a?
-    #todo allow without check digit?
+    # todo should i zero pad upc_a?
+    # todo allow without check digit?
     upc_a = upc_a.to_s
     raise ArgumentError, "Must be 12 characters long" unless upc_a.size == 12
-    start = upc_a[0] #first char
+    start = upc_a[0] # first char
     raise ArgumentError, "Must be type 0 or 1" unless ["0", "1"].include?(start)
 
-    chk = upc_a[-1] #last char
-    mfr = upc_a[1...6] #next 5 characters
-    prod = upc_a[6...11] #last 4 characters w/o chk
-
-    upc_e = if ["000", "100", "200"].include?(mfr[-3,3])
-      "#{mfr[0,2]}#{prod[-3,3]}#{mfr[2]}"
-    elsif mfr[-2,2] == '00' && prod.to_i <= 99
-      "#{mfr[0,3]}#{prod[-2,2]}3"
-    elsif mfr[-1] == '0' && prod.to_i <= 9
-      "#{mfr[0,4]}#{prod[-1]}4"
-    elsif mfr[-1] != '0' && [5,6,7,8,9].include?(prod.to_i)
+    chk = upc_a[-1] # last char
+    mfr = upc_a[1...6] # next 5 characters
+    prod = upc_a[6...11] # last 4 characters w/o chk
+
+    upc_e = if ["000", "100", "200"].include?(mfr[-3, 3])
+      "#{mfr[0, 2]}#{prod[-3, 3]}#{mfr[2]}"
+    elsif mfr[-2, 2] == "00" && prod.to_i <= 99
+      "#{mfr[0, 3]}#{prod[-2, 2]}3"
+    elsif mfr[-1] == "0" && prod.to_i <= 9
+      "#{mfr[0, 4]}#{prod[-1]}4"
+    elsif mfr[-1] != "0" && [5, 6, 7, 8, 9].include?(prod.to_i)
       "#{mfr}#{prod[-1]}"
     end
     raise ArgumentError, "Must meet formatting requirements" unless upc_e
 
     "#{start}#{upc_e}#{chk}"
   end
-
 end

data/lib/upc_tools/version.rb

@@ -1,3 +1,3 @@
 module UpcTools
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/upc_tools.gemspec

@@ -1,25 +1,22 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'upc_tools/version'
+require "upc_tools/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "upc_tools"
-  spec.version       = UpcTools::VERSION
-  spec.authors       = ["Justin Hart", "Ibotta, Inc."]
-  spec.email         = ["jhart@ibotta.com"]
-  spec.summary       = %q{UPC validation and creation utilities}
-  spec.description   = %q{create, validate, convert UPCs}
-  spec.homepage      = "https://github.com/Ibotta/ruby_upc_tools"
-  spec.license       = "MIT"
+  spec.name = "upc_tools"
+  spec.version = UpcTools::VERSION
+  spec.authors = ["Justin Hart", "Ibotta, Inc."]
+  spec.email = ["jhart@ibotta.com"]
+  spec.summary = "UPC validation and creation utilities"
+  spec.description = "create, validate, convert UPCs"
+  spec.homepage = "https://github.com/Ibotta/ruby_upc_tools"
+  spec.licenses = ["Apache-2.0"]
 
-  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.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_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upc_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin Hart
@@ -9,36 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2020-02-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.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,20 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  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: create, validate, convert UPCs
 email:
 - jhart@ibotta.com
@@ -74,12 +46,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -91,7 +64,7 @@ files:
 - upc_tools.gemspec
 homepage: https://github.com/Ibotta/ruby_upc_tools
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -108,10 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: UPC validation and creation utilities
 test_files: []
-has_rdoc: