digest-crc 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+doc
+pkg
+.yardoc

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Digest CRC Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,18 @@
+### 0.1.0 / 2010-06-01
+
+* Initial release.
+  * CRC1
+  * CRC5
+  * CRC8
+  * CRC16
+  * CRC16 CCITT
+  * CRC16 DNP
+  * CRC16 Modbus
+  * CRC16 USB
+  * CRC16 XModem
+  * CRC16 ZModem
+  * CRC24
+  * CRC32
+  * CRC32 Mpeg
+  * CRC64
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+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.md

@@ -0,0 +1,73 @@
+# Digest CRC
+
+* [github.com/postmodern/digest-crc](http://github.com/postmodern/digest-crc)
+* [github.com/postmodern/digest-crc/issues](http://github.com/postmodern/digest-crc/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
+module.
+
+## Features
+
+* Provides support for the following CRC algorithms:
+  * CRC1
+  * CRC5
+  * CRC8
+  * CRC16
+  * CRC16 CCITT
+  * CRC16 DNP
+  * CRC16 Modbus
+  * CRC16 USB
+  * CRC16 XModem
+  * CRC16 ZModem
+  * CRC24
+  * CRC32
+  * CRC32 Mpeg
+  * CRC64
+* Pure Ruby implementation.
+* Provides CRC Tables for optimized calculations.
+
+## Install
+
+    $ sudo gem install digest-crc
+
+## Examples
+
+Calculate a CRC32:
+
+    require 'digest/crc32'
+
+    Digest::CRC32.hexdigest('hello')
+    # => "3610a686"
+
+Calculate a CRC32 of a file:
+
+    Digest::CRC32.file('README.md')
+    # => #<Digest::CRC32: 127ad531>
+
+Incrementally calculate a CRC32:
+
+    crc = Digest::CRC32.new
+    crc << 'one'
+    crc << 'two'
+    crc << 'three'
+    crc.hexdigest
+    # => "09e1c092"
+
+Directly access the checksum:
+
+    crc.checksum
+    # => 165789842
+
+## Thanks
+
+Special thanks go out to the [pycrc](http://www.tty1.net/pycrc/) library
+which is able to generate C source-code for all of the CRC algorithms,
+including their CRC Tables.
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'digest-crc'
+    gem.license = 'MIT'
+    gem.summary = %Q{A Cyclic Redundancy Check (CRC) library for Ruby.}
+    gem.description = %Q{Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest module.}
+    gem.email = 'postmodern.mod3@gmail.com'
+    gem.homepage = 'http://github.com/postmodern/digest-crc'
+    gem.authors = ['Postmodern']
+    gem.add_development_dependency 'rspec', '>= 1.3.0'
+    gem.has_rdoc = 'yard'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs += ['lib', 'spec']
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', '.specopts']
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/digest-crc.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{digest-crc}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-06-01}
+  s.description = %q{Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest module.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     ".specopts",
+     ".yardopts",
+     "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "digest-crc.gemspec",
+     "lib/digest/crc.rb",
+     "lib/digest/crc1.rb",
+     "lib/digest/crc16.rb",
+     "lib/digest/crc16_ccitt.rb",
+     "lib/digest/crc16_dnp.rb",
+     "lib/digest/crc16_modbus.rb",
+     "lib/digest/crc16_usb.rb",
+     "lib/digest/crc16_xmodem.rb",
+     "lib/digest/crc16_zmodem.rb",
+     "lib/digest/crc24.rb",
+     "lib/digest/crc32.rb",
+     "lib/digest/crc32_mpeg.rb",
+     "lib/digest/crc5.rb",
+     "lib/digest/crc64.rb",
+     "lib/digest/crc8.rb",
+     "spec/crc16_ccitt_spec.rb",
+     "spec/crc16_modbus_spec.rb",
+     "spec/crc16_spec.rb",
+     "spec/crc16_usb_spec.rb",
+     "spec/crc16_xmodem_spec.rb",
+     "spec/crc16_zmodem_spec.rb",
+     "spec/crc1_spec.rb",
+     "spec/crc24_spec.rb",
+     "spec/crc32_mpeg_spec.rb",
+     "spec/crc32_spec.rb",
+     "spec/crc5_spec.rb",
+     "spec/crc64_spec.rb",
+     "spec/crc8_spec.rb",
+     "spec/crc_examples.rb",
+     "spec/crc_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/digest-crc}
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Cyclic Redundancy Check (CRC) library for Ruby.}
+  s.test_files = [
+    "spec/crc_spec.rb",
+     "spec/crc8_spec.rb",
+     "spec/crc64_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/crc32_mpeg_spec.rb",
+     "spec/crc_examples.rb",
+     "spec/crc16_spec.rb",
+     "spec/crc16_xmodem_spec.rb",
+     "spec/crc5_spec.rb",
+     "spec/crc1_spec.rb",
+     "spec/crc16_usb_spec.rb",
+     "spec/crc16_zmodem_spec.rb",
+     "spec/crc32_spec.rb",
+     "spec/crc24_spec.rb",
+     "spec/crc16_ccitt_spec.rb",
+     "spec/crc16_modbus_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

data/lib/digest/crc.rb

@@ -0,0 +1,116 @@
+require 'digest'
+
+module Digest
+  class CRC < Digest::Class
+
+    include Digest::Instance
+
+    # The initial value of the CRC checksum
+    INIT_CRC = 0x00
+
+    # The XOR mask to apply to the resulting CRC checksum
+    XOR_MASK = 0x00
+
+    # The bit width of the CRC checksum
+    WIDTH = 0
+
+    #
+    # Calculates the CRC checksum.
+    #
+    # @param [String] data
+    #   The given data.
+    #
+    # @return [Integer]
+    #   The CRC checksum.
+    #
+    def self.checksum(data)
+      crc = self.new
+      crc << data
+
+      return crc.checksum
+    end
+
+    #
+    # Packs the given CRC checksum.
+    #
+    # @return [String]
+    #   The packed CRC checksum.
+    #
+    def self.pack(crc)
+      ''
+    end
+
+    #
+    # Initializes the CRC checksum.
+    #
+    def initialize
+      @crc = self.class.const_get(:INIT_CRC)
+    end
+
+    #
+    # The input block length.
+    #
+    # @return [1]
+    #
+    def block_length
+      1
+    end
+
+    #
+    # The length of the digest.
+    #
+    # @return [Integer]
+    #   The length in bytes.
+    #
+    def digest_length
+      (self.class.const_get(:WIDTH) / 8.0).ceil
+    end
+
+    #
+    # Updates the CRC checksum with the given data.
+    #
+    # @param [String] data
+    #   The data to update the CRC checksum with.
+    #
+    def update(data)
+    end
+
+    #
+    # @see {#update}
+    #
+    def <<(data)
+      update(data)
+      return self
+    end
+
+    #
+    # Resets the CRC checksum.
+    #
+    # @return [Integer]
+    #   The default value of the CRC checksum.
+    #
+    def reset
+      @crc = self.class.const_get(:INIT_CRC)
+    end
+
+    #
+    # The resulting CRC checksum.
+    #
+    # @return [Integer]
+    #   The resulting CRC checksum.
+    #
+    def checksum
+      @crc ^ self.class.const_get(:XOR_MASK)
+    end
+
+    #
+    # Finishes the CRC checksum calculation.
+    #
+    # @see {pack}
+    #
+    def finish
+      self.class.pack(checksum)
+    end
+
+  end
+end

data/lib/digest/crc1.rb

@@ -0,0 +1,35 @@
+require 'digest/crc'
+
+module Digest
+  class CRC1 < CRC
+
+    TABLE = []
+    CRC_MASK = 0x00
+
+    #
+    # Packs the CRC1 checksum.
+    #
+    # @return [String]
+    #   The CRC1 checksum.
+    #
+    def self.pack(crc)
+      [crc].pack('c*')
+    end
+
+    #
+    # Updates the CRC1 checksum.
+    #
+    # @param [String] data
+    #   The data to update the checksum with.
+    #
+    def update(data)
+      accum = 0
+      data.each_byte { |b| accum += b }
+
+      @crc += (accum % 256)
+
+      return self
+    end
+
+  end
+end

data/lib/digest/crc16.rb

@@ -0,0 +1,79 @@
+require 'digest/crc'
+
+module Digest
+  class CRC16 < CRC
+
+    WIDTH = 16
+
+    INIT_CRC = 0x0000
+
+    # Generated by `./pycrc.py --algorithm=table-driven --model=crc-16`
+    TABLE = [
+      0x0000, 0xc0c1, 0xc181, 0x0140, 0xc301, 0x03c0, 0x0280, 0xc241,
+      0xc601, 0x06c0, 0x0780, 0xc741, 0x0500, 0xc5c1, 0xc481, 0x0440,
+      0xcc01, 0x0cc0, 0x0d80, 0xcd41, 0x0f00, 0xcfc1, 0xce81, 0x0e40,
+      0x0a00, 0xcac1, 0xcb81, 0x0b40, 0xc901, 0x09c0, 0x0880, 0xc841,
+      0xd801, 0x18c0, 0x1980, 0xd941, 0x1b00, 0xdbc1, 0xda81, 0x1a40,
+      0x1e00, 0xdec1, 0xdf81, 0x1f40, 0xdd01, 0x1dc0, 0x1c80, 0xdc41,
+      0x1400, 0xd4c1, 0xd581, 0x1540, 0xd701, 0x17c0, 0x1680, 0xd641,
+      0xd201, 0x12c0, 0x1380, 0xd341, 0x1100, 0xd1c1, 0xd081, 0x1040,
+      0xf001, 0x30c0, 0x3180, 0xf141, 0x3300, 0xf3c1, 0xf281, 0x3240,
+      0x3600, 0xf6c1, 0xf781, 0x3740, 0xf501, 0x35c0, 0x3480, 0xf441,
+      0x3c00, 0xfcc1, 0xfd81, 0x3d40, 0xff01, 0x3fc0, 0x3e80, 0xfe41,
+      0xfa01, 0x3ac0, 0x3b80, 0xfb41, 0x3900, 0xf9c1, 0xf881, 0x3840,
+      0x2800, 0xe8c1, 0xe981, 0x2940, 0xeb01, 0x2bc0, 0x2a80, 0xea41,
+      0xee01, 0x2ec0, 0x2f80, 0xef41, 0x2d00, 0xedc1, 0xec81, 0x2c40,
+      0xe401, 0x24c0, 0x2580, 0xe541, 0x2700, 0xe7c1, 0xe681, 0x2640,
+      0x2200, 0xe2c1, 0xe381, 0x2340, 0xe101, 0x21c0, 0x2080, 0xe041,
+      0xa001, 0x60c0, 0x6180, 0xa141, 0x6300, 0xa3c1, 0xa281, 0x6240,
+      0x6600, 0xa6c1, 0xa781, 0x6740, 0xa501, 0x65c0, 0x6480, 0xa441,
+      0x6c00, 0xacc1, 0xad81, 0x6d40, 0xaf01, 0x6fc0, 0x6e80, 0xae41,
+      0xaa01, 0x6ac0, 0x6b80, 0xab41, 0x6900, 0xa9c1, 0xa881, 0x6840,
+      0x7800, 0xb8c1, 0xb981, 0x7940, 0xbb01, 0x7bc0, 0x7a80, 0xba41,
+      0xbe01, 0x7ec0, 0x7f80, 0xbf41, 0x7d00, 0xbdc1, 0xbc81, 0x7c40,
+      0xb401, 0x74c0, 0x7580, 0xb541, 0x7700, 0xb7c1, 0xb681, 0x7640,
+      0x7200, 0xb2c1, 0xb381, 0x7340, 0xb101, 0x71c0, 0x7080, 0xb041,
+      0x5000, 0x90c1, 0x9181, 0x5140, 0x9301, 0x53c0, 0x5280, 0x9241,
+      0x9601, 0x56c0, 0x5780, 0x9741, 0x5500, 0x95c1, 0x9481, 0x5440,
+      0x9c01, 0x5cc0, 0x5d80, 0x9d41, 0x5f00, 0x9fc1, 0x9e81, 0x5e40,
+      0x5a00, 0x9ac1, 0x9b81, 0x5b40, 0x9901, 0x59c0, 0x5880, 0x9841,
+      0x8801, 0x48c0, 0x4980, 0x8941, 0x4b00, 0x8bc1, 0x8a81, 0x4a40,
+      0x4e00, 0x8ec1, 0x8f81, 0x4f40, 0x8d01, 0x4dc0, 0x4c80, 0x8c41,
+      0x4400, 0x84c1, 0x8581, 0x4540, 0x8701, 0x47c0, 0x4680, 0x8641,
+      0x8201, 0x42c0, 0x4380, 0x8341, 0x4100, 0x81c1, 0x8081, 0x4040
+    ]
+
+    #
+    # Packs the CRC16 checksum.
+    #
+    # @param [Integer] crc
+    #   The CRC16 checksum to pack.
+    #
+    # @return [String]
+    #   The packed CRC16 checksum.
+    #
+    def self.pack(crc)
+      buffer = ''
+
+      buffer << ((crc & 0xff00) >> 8).chr
+      buffer << (crc & 0xff).chr
+
+      buffer
+    end
+
+    #
+    # Updates the CRC16 checksum.
+    #
+    # @param [String] data
+    #   The data to update the checksum with.
+    #
+    def update(data)
+      data.each_byte do |b|
+        @crc = ((TABLE[(@crc ^ b) & 0xff] ^ (@crc >> 8)) & 0xffff)
+      end
+
+      return self
+    end
+
+  end
+end