istc 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,33 @@
+A small class for generating and validating Internation Standard Text
+Codes (ISTC).
+
+= Installation
+
+gem install istc
+
+= Usage
+
+  ISTC.new("0A9200800000007C").valid?
+  => true
+
+  ISTC.valid?("0A9200800000007C")
+  => true
+
+  ISTC.valid?("0A9200800000007B")
+  => false
+
+  ISTC.complete?("0A9200800000007")
+  => "0A9200800000007C"
+
+  ISTC.new("0A9200800000007").to_s
+  => "0A9-2008-00000007-C"
+
+= Further Reading
+
+- http://en.wikipedia.org/wiki/International_Standard_Text_Code
+- http://www.istcinfo.org/
+
+= Contributing
+
+Source code is publicly available @ http://github.com/yob/istc/tree/master.
+Patches welcome, preferably via a git repo I can pull from.

data/lib/istc.rb

@@ -0,0 +1,75 @@
+class ISTC
+
+  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?
+    ISTC.valid? @number
+  end
+
+  def agency
+    return nil unless valid?
+    @number[0,3]
+  end
+
+  def year
+    return nil unless valid?
+    @number[3,4]
+  end
+
+  def work
+    return nil unless valid?
+    @number[7,8]
+  end
+
+  def check
+    return nil unless valid?
+    @number[15,1]
+  end
+
+  # output a hyphenated version of this ISTC
+  def to_s
+    return nil unless valid?
+    "#{agency}-#{year}-#{work}-#{check}"
+  end
+
+  def self.valid?(istc)
+    istc = istc.to_s
+    istc.length == 16 && istc == ISTC.complete(istc[0,15])
+  end
+
+  # Purely for generating new ISTC numbers
+  #
+  def self.complete(num)
+    num = num.to_s
+    return nil unless num.length == 15 && num.match(/[\dA-Fa-f]{11}/)
+
+    #puts num
+    arr = (0..14).to_a.collect do |i|
+      if i == 0 || i % 4 == 0
+        num[i,1].hex * 11
+      elsif i % 4 == 1
+        num[i,1].hex * 9
+      elsif i % 4 == 2
+        num[i,1].hex * 3
+      else
+        num[i,1].hex * 1
+      end
+    end
+    #puts arr.inspect
+    sum = arr.inject { |sum, n| sum + n }
+    remainder = sum % 16
+    check = remainder.to_s(16).upcase
+
+    "#{num}#{check}"
+  end
+end

data/spec/istc_spec.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+
+require 'spec'
+require 'istc'
+
+describe "The ISTC class" do
+  it "should identify a valid ISTC" do
+    ISTC.new("0A9200112C4F1324").valid?.should be_true
+  end
+
+  it "should identify a valid ISTC" do
+    ISTC.valid?("0A9200112C4F1324").should be_true
+  end
+  
+  it "should identify an invalid ISTC" do
+    ISTC.valid?(nil).should       be_false
+    ISTC.valid?("902865").should  be_false
+    ISTC.valid?(Array).should     be_false
+    ISTC.valid?(Array.new).should be_false
+    ISTC.valid?("0A9200800000007B").should  be_false
+    ISTC.valid?("0A9200800000007").should   be_false
+  end
+
+  it "should calculate a ISTC check digit correctly" do
+    ISTC.complete("0A9200112C4F132").should eql("0A9200112C4F1324")
+  end
+
+  it "should hyphen a ISTC correctly" do
+    ISTC.new("0A9200112C4F1324").to_s.should eql("0A9-2001-12C4F132-4")
+  end
+
+  it "should return sections of an ISTC correctly" do
+    ISTC.new("0A9200112C4F1324").agency.should eql("0A9")
+    ISTC.new("0A9200112C4F1324").year.should eql("2001")
+    ISTC.new("0A9200112C4F1324").work.should eql("12C4F132")
+    ISTC.new("0A9200112C4F1324").check.should eql("4")
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: istc
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-06 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: a (very) small library for working with ISTC
+email: jimmy@deefa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/istc.rb
+- MIT-LICENSE
+- README.rdoc
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/yob/istc/tree/master
+post_install_message: 
+rdoc_options: 
+- --title
+- ISTC
+- --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 ISTC
+test_files: 
+- spec/istc_spec.rb