syc-barcode 0.0.2 → 0.0.3

data/README.rdoc

@@ -22,5 +22,9 @@ The barcode can be used to create a graphical representation of the barcode.
 * Version 0.0.2
   Fix check digit calculation
 
+* Version 0.0.3
+  Add valid? to check whether a decoded value (e.g. by a barcode scanner) is
+  valid
+
 == Licencse
 Barcode is published under the MIT license

data/lib/interleave2of5.rb

@@ -1,11 +1,11 @@
 require_relative 'checked_attributes'
 require_relative 'barcode'
 
-# Creates a Interleave 2 of 5 barcode
+# Creates a Interleaved 2 of 5 barcode
 class Interleave2of5 < Barcode
   include CheckedAttributes
 
-  # Holds the options for an Interleave 2 of 5 barcode
+  # Holds the options for an Interleaved 2 of 5 barcode
   OPTIONS = {
     x: 0,
     y: 0,
@@ -104,18 +104,44 @@ class Interleave2of5 < Barcode
     @graph
   end
 
+  # Returns true if the decoded value (e.g. returned by a barcode scanner) is
+  # a valid barcode. Validity is identified by the check digit. If no check
+  # digit is given valid? will return true if the decoded value's size is even
+  #
+  # Example
+  #     Interleave2of5.valid? "002127", true -> true
+  #     Interleave2of5.valid? "002128", true -> false
+  #     Interleave2of5.valid? "00212", false -> false
+  def self.valid?(decoded, check_digit = true)
+    return false if decoded.size.odd?
+    if check_digit
+      value = decoded[0...decoded.size-1]
+      check = decoded[decoded.size-1]
+      return check_digit_for(value) == check
+    else
+      true
+    end
+  end
+
   private
     
     # Adds a check digit if check is true and ensures even digit size
     def add_check_digit_and_ensure_even_digit_size
-      reverse_value = @value.split('').reverse
-      @check_digit = 10 - reverse_value.each_with_index.collect do |v, i|
-        i.even? ? v.to_i * 3 : v.to_i
-      end.inject(:+) % 10 if @check
-      @check_digit = 0 if @check_digit == 10
+      @check_digit = self.class.check_digit_for @value
       @encodable = @value + (@check ? @check_digit.to_s : "")
       @encodable = "0" + @encodable if @encodable.size.odd?
       @encodable
     end
 
+    # Calculate the check digit for the provided value
+    def self.check_digit_for(value)
+      reverse_value = value.split('').reverse
+      check = 10 - reverse_value.each_with_index.collect do |v, i|
+        i.even? ? v.to_i * 3 : v.to_i
+      end.inject(:+) % 10
+      check = 0 if check == 10
+
+      check.to_s
+    end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syc-barcode
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-16 00:00:00.000000000 Z
+date: 2014-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -66,8 +66,9 @@ description: ! "= Barcode\nCreating barcodes (at the moment only Interleaved2of5
   \   require 'interleave2of5'\nto config/application.rb\n\nThe barcode can be used
   to create a graphical representation of the barcode.\n\n== Release Notes\n* Version
   0.0.1\n  Create barcode Interleaved 2 of 5 that can be added to a pdf file\n\n*
-  Version 0.0.2\n  Fix check digit calculation\n\n== Licencse\nBarcode is published
-  under the MIT license\n"
+  Version 0.0.2\n  Fix check digit calculation\n\n* Version 0.0.3\n  Add valid? to
+  check whether a decoded value (e.g. by a barcode scanner) is\n  valid\n\n== Licencse\nBarcode
+  is published under the MIT license\n"
 email: pierre@sugaryourcoffee.de
 executables: []
 extensions: []
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simple barcode creator