upc 1.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v1.0 (26th September 2008)
+- Initial Release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Peter Yandell
+
+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.rdoc

@@ -0,0 +1,23 @@
+A small class for generating and validating Universal Product Codes (UPCs),
+the 12 digit codes found on many older US products.
+
+= Usage
+
+  UPC.new("632737715836").valid?
+  => true
+
+  UPC.valid?("632737715836")
+  => true
+
+  UPC.valid?("632737715837")
+  => false
+
+  UPC.complete("63273771583")
+  => "632737715836"
+
+  UPC.new("632737715836").to_ean
+  => "0632737715836"
+
+= Further Reader
+
+- http://en.wikipedia.org/wiki/Universal_Product_Code

data/lib/upc.rb

@@ -0,0 +1,51 @@
+class UPC
+
+  class Version #:nodoc:
+    Major = 1
+    Minor = 0
+    Tiny  = 0
+
+    String = [Major, Minor, Tiny].join('.')
+  end
+
+  def initialize(str)
+    @number = str.to_s
+  end
+
+  def valid?
+    UPC.valid? @number
+  end
+
+  def self.valid?(upc)
+    upc = upc.to_s
+    upc.length == 12 && upc == UPC.complete(upc[0,11])
+  end
+
+  # Purely for generating new UPC numbers
+  def self.complete(eleven)
+    eleven = eleven.to_s
+    return nil unless eleven.length == 11 && eleven.match(/\d{11}/)
+
+    arr = (0..10).to_a.collect do |i|
+      if (i+1).odd?
+        eleven[i,1].to_i * 3
+      else
+        eleven[i,1].to_i
+      end
+    end
+    sum = arr.inject { |sum, n| sum + n }
+    remainder = sum % 10
+    if remainder == 0
+      check = 0
+    else
+      check = 10 - remainder
+    end
+
+    eleven + check.to_s
+  end
+
+  def to_ean
+    return nil unless self.valid?
+    "0#{@number}"
+  end
+end

data/spec/upc_spec.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+
+require 'spec'
+require 'upc'
+
+describe "The UPC class" do
+  it "should identify a valid UPC" do
+    UPC.new("632737715836").valid?.should be_true
+  end
+
+  it "should identify a valid UPC" do
+    UPC.valid?("632737715836").should be_true
+    UPC.valid?(632737715836).should   be_true
+  end
+  
+  it "should identify an invalid UPC" do
+    UPC.valid?(nil).should       be_false
+    UPC.valid?("902865").should  be_false
+    UPC.valid?(Array).should     be_false
+    UPC.valid?(Array.new).should be_false
+    UPC.valid?("632737715837").should  be_false
+    UPC.valid?("63273771583").should   be_false
+  end
+
+  it "should calculate a UPC check digit correctly" do
+    UPC.complete("63273771583").should eql("632737715836")
+    UPC.complete(63273771583).should   eql("632737715836")
+    UPC.complete("63273720503").should eql("632737205030")
+    UPC.complete("63273712223").should eql("632737122238")
+  end
+
+  it "should convert to an EAN correctly" do
+    UPC.new("632737715836").to_ean.should eql("0632737715836")
+    UPC.new(632737715836).to_ean.should   eql("0632737715836")
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: upc
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-26 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: a (very) small library for working with Universal Product Codes
+email: jimmy@deefa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/upc.rb
+- MIT-LICENSE
+- README.rdoc
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/yob/upc/tree/master
+post_install_message: 
+rdoc_options: 
+- --title
+- UPC
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yob-projects
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a (very) small library for working with Universal Product Codes
+test_files: 
+- spec/upc_spec.rb