gtin 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-04-25
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+lib/gtin.rb
+lib/gtin/gtin.rb
+lib/gtin/version.rb
+Manifest.txt
+Rakefile
+README.rdoc
+script/console
+script/destroy
+script/generate
+test/test_gtin.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,63 @@
+= gtin
+
+* http://github.com/hmasing/gtin
+
+== DESCRIPTION:
+
+The GTIN gem provides very simple functionality for verifying checksums on EAN-13 and UPC-A barcode values.
+It also does very simple conversion between the two by left-padding with zeroes.  This is not intended to 
+be a complex gem, but is certainly functional for applications that require that barcode values be
+checked for valid checksums and length.
+
+http://www.gtin.info/
+
+Inspired by the EAN gem by Pascal Belloncle (nano RAILS)
+
+== FEATURES/PROBLEMS:
+
+	* ---
+
+== SYNOPSIS:
+
+  	'731346000101'.ean?    ==> false
+  	'731346000101'.upc?    ==> true
+	'731346000101'.to_ean  ==> '0731346000101'
+	'731346000101'.to_gtin ==> '000731346000101'
+
+	'0731346000101'.valid_checksum? ==> true
+	'0731346000105'.valid_checksum? ==> false
+	
+	Also adds .odd? and .even? to the Integer class
+	
+== REQUIREMENTS:
+
+	none
+
+== INSTALL:
+
+	sudo gem install gtin
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Hans C. Masing & Dragonfly Depot, LLC
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/gtin'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'gtin' do
+  self.developer 'FIXME full name', 'FIXME email'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/gtin.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Gtin
+  VERSION = '0.0.1'
+end

data/lib/gtin/gtin.rb

@@ -0,0 +1,107 @@
+# GTIN-12 (UPC-A): this is a 12-digit number used primarily in North America
+# GTIN-8 (EAN/UCC-8): this is an 8-digit number used predominately outside of North America
+# GTIN-13 (EAN/UCC-13): this is a 13-digit number used predominately outside of North America
+# GTIN-14 (EAN/UCC-14 or ITF-14): this is a 14-digit number used to identify trade items at various packaging levels
+
+module GTIN
+  def generate_check_digit
+    numbers = self.to_s.gsub(/[\D]+/, "").split(//)
+
+    checksum = 0
+    case numbers.length
+    when 7
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 11
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 12
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * (i%2*3 +(i-1)%2) end
+    when 13
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    else
+      0
+    end
+
+    return ((10 - checksum % 10)%10).to_s
+  end
+
+  def ean?
+    numbers = self.to_s.gsub(/[\D]+/, "").split(//)
+
+    checksum = 0
+    case numbers.length
+    when 8
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 13
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * (i%2*3 +(i-1)%2) end
+    when 14
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    else
+      return false
+    end
+
+    return numbers[-1].to_i == (10 - checksum % 10)%10
+  end
+  
+  def upc?
+    value = self.to_s.gsub(/[\D]+/, "").split(//)
+    return false if value.length != 12
+    valid_checksum? value
+  end
+
+  # Determine if a gtin value has a valid checksum
+  def valid_checksum?(value)
+    checksum = 0
+    0.upto(value.length-2) do |i| 
+      value%2 == 0 ? 
+        (checksum += value[i].to_i * ((i-1)%2*3 +i%2)) :
+        (checksum += numbers[i].to_i * (i%2*3 +(i-1)%2))
+    end
+    value[-1].to_i == (10 - checksum % 10)%10    
+  end
+
+
+  # GTIN-12 (UPC-A): this is a 12-digit number used primarily in North America
+  def to_gtin_12(number)
+    to_gtin(number, 12)
+  end
+  alias :to_upc   :to_gtin_12
+  alias :to_upc_a :to_gtin_12
+  
+  
+  # GTIN-8 (EAN/UCC-8): this is an 8-digit number used predominately outside of North America
+  def to_gtin_8(number)
+    to_gtin(number, 8)
+  end
+  alias :to_ean_8 :to_gtin_8
+  alias :to_ucc_8 :to_gtin_8
+  
+  
+  # GTIN-13 (EAN/UCC-13): this is a 13-digit number used predominately outside of North America
+  def to_gtin_13(number)
+    to_gtin(number, 13)
+  end
+  alias :to_ean_13 :to_gtin_13
+  alias :to_ucc_13 :to_gtin_13
+  alias :to_ean    :to_gtin_13
+
+
+  # GTIN-14 (EAN/UCC-14 or ITF-14): this is a 14-digit number used to identify trade items at various packaging levels
+  def to_gtin_14(number)
+    to_gtin(number, 14)
+  end
+  alias :to_gtin :to_gtin_14
+  
+  def to_gtin(number, size)
+    "%0#{size}d" % number.to_s.gsub(/[\D]+/, "")
+  end
+end
+
+# Extend String to include these methods
+class String
+  include GTIN
+end
+
+# Extend Numberic to include these methods
+class Numeric
+  include GTIN
+end

data/lib/gtin/version.rb

@@ -0,0 +1,9 @@
+module GTIN #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/gtin.rb'}"
+puts "Loading gtin gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_gtin.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGtin < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/gtin'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gtin
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Hans Masing
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: GTIN provides basic validation, checksum and conversion functionality for UPC, EAN and GTIN barcode values.
+email: rubygems@dragonflydepot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- lib/gtin.rb
+- lib/gtin/gtin.rb
+- lib/gtin/version.rb
+- Manifest.txt
+- Rakefile
+- README.rdoc
+- script/console
+- script/destroy
+- script/generate
+- test/test_gtin.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://www.dragonflydepot.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: GTIN provides basic validation, checksum and conversion functionality for UPC, EAN and GTIN barcode values.
+test_files: []
+