digest-crc 0.4.0 → 0.6.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f3a74146b25bc84927e5f441f7a31a23a4465aafeba993d7d9b0b390f81afde
+  data.tar.gz: d7a9d4dc7e435698dfc8e784464f16c1e2dbf394e93c6889bcaaf00fd3e1887e
+SHA512:
+  metadata.gz: 4ba2b78693fb9af7e7eda4950fcf5d0e46d5c8ed6ad1469d1da444212396a2cf28308e97a055504cf0d04f0f1cfa6f192b2a4414ab9c6328a0d7a285048e5926
+  data.tar.gz: d04e97f73061f3617bab9d4371fb03463a2b366103ca4e4c8344a9b6d4ccb80e7919c76443cdb311a64a856c951980732e34289bab5fa69b3d3070aa3c8a4130

data/.gitignore

@@ -1,4 +1,10 @@
+Gemfile.lock
 doc
 pkg
 .bundle
 .yardoc
+/ext/digest/crc*/Makefile
+/ext/digest/crc*/mkmf.log
+/ext/digest/crc*/extconf.h
+/ext/digest/crc*/*.o
+/ext/digest/crc*/*.so

data/.travis.yml

@@ -0,0 +1,24 @@
+---
+before_install:
+  - gem update --system
+  - gem install bundler -v "~> 2.0"
+
+language: ruby
+sudo: false
+cache:
+  - bundler
+
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby
+
+matrix:
+  include:
+    - os: linux
+    - os: osx
+  allow_failures:
+    - rvm: jruby
+
+script: bundle exec rake spec

data/ChangeLog.md

@@ -1,3 +1,105 @@
+### 0.6.0 / 2020-06-16
+
+* Implement _optional_ C extensions for all CRC algorithms, resulting in an
+  average performance improvement of ~40x. Note, if for whatever reason the
+  C extensions cannot be compiled, they will be skipped and the pure-Ruby
+  CRC algorithms will be used instead. If the C extensions were successfully
+  compiled, then they will be loaded and override the pure-Ruby CRC methods with
+  the C equivalents.
+
+#### Pure Ruby
+
+           user     system      total        real
+    Digest::CRC1#update  0.412953   0.000000   0.412953 (  0.414688)
+    Digest::CRC5#update  1.116375   0.000003   1.116378 (  1.120741)
+    Digest::CRC8#update  0.994263   0.000013   0.994276 (  1.001079)
+    Digest::CRC8_1Wire#update  0.974115   0.000004   0.974119 (  0.978186)
+    Digest::CRC15#update  1.139402   0.000927   1.140329 (  1.146608)
+    Digest::CRC16#update  0.967836   0.000000   0.967836 (  0.971792)
+    Digest::CRC16CCITT#update  1.118851   0.000000   1.118851 (  1.123217)
+    Digest::CRC16DNP#update  0.922211   0.000000   0.922211 (  0.925739)
+    Digest::CRC16Genibus#update  1.120580   0.000000   1.120580 (  1.124771)
+    Digest::CRC16Modbus#update  0.955612   0.000000   0.955612 (  0.959463)
+    Digest::CRC16QT#update  8.153403   0.000012   8.153415 (  8.189977)
+    Digest::CRC16USB#update  0.952557   0.000000   0.952557 (  0.956145)
+    Digest::CRC16X25#update  0.962295   0.000000   0.962295 (  0.970401)
+    Digest::CRC16XModem#update  1.120531   0.000000   1.120531 (  1.124494)
+    Digest::CRC16ZModem#update  1.124226   0.000000   1.124226 (  1.128632)
+    Digest::CRC24#update  1.126317   0.000000   1.126317 (  1.130794)
+    Digest::CRC32#update  0.960015   0.000000   0.960015 (  0.964803)
+    Digest::CRC32BZip2#update  1.128626   0.000000   1.128626 (  1.133641)
+    Digest::CRC32c#update  0.964047   0.000000   0.964047 (  0.967456)
+    Digest::CRC32Jam#update  0.959141   0.000972   0.960113 (  0.967444)
+    Digest::CRC32MPEG#update  1.131119   0.000002   1.131121 (  1.137440)
+    Digest::CRC32POSIX#update  1.126019   0.000000   1.126019 (  1.130549)
+    Digest::CRC32XFER#update  1.116598   0.000000   1.116598 (  1.120595)
+    Digest::CRC64#update  2.665880   0.000928   2.666808 (  2.680942)
+    Digest::CRC64Jones#update  2.678003   0.000000   2.678003 (  2.691390)
+    Digest::CRC64XZ#update  2.671395   0.000000   2.671395 (  2.682684)
+
+#### C extensions
+
+           user     system      total        real
+    Digest::CRC1#update  0.407438   0.000000   0.407438 (  0.410495)
+    Digest::CRC5#update  0.022873   0.000000   0.022873 (  0.023796)
+    Digest::CRC8#update  0.020129   0.000000   0.020129 (  0.020887)
+    Digest::CRC8_1Wire#update  0.020106   0.000000   0.020106 (  0.020897)
+    Digest::CRC15#update  0.028765   0.000003   0.028768 (  0.029549)
+    Digest::CRC16#update  0.022176   0.000856   0.023032 (  0.023153)
+    Digest::CRC16CCITT#update  0.028570   0.000000   0.028570 (  0.028691)
+    Digest::CRC16DNP#update  0.023240   0.000001   0.023241 (  0.024008)
+    Digest::CRC16Genibus#update  0.028692   0.000000   0.028692 (  0.029575)
+    Digest::CRC16Modbus#update  0.023928   0.000000   0.023928 (  0.024859)
+    Digest::CRC16QT#update  7.965822   0.000968   7.966790 (  8.001781)
+    Digest::CRC16USB#update  0.023448   0.000001   0.023449 (  0.024420)
+    Digest::CRC16X25#update  0.023061   0.000000   0.023061 (  0.023861)
+    Digest::CRC16XModem#update  0.029407   0.000000   0.029407 (  0.030583)
+    Digest::CRC16ZModem#update  0.029522   0.000000   0.029522 (  0.030438)
+    Digest::CRC24#update  0.029528   0.000000   0.029528 (  0.030504)
+    Digest::CRC32#update  0.023306   0.000000   0.023306 (  0.024278)
+    Digest::CRC32BZip2#update  0.026346   0.000000   0.026346 (  0.027293)
+    Digest::CRC32c#update  0.023525   0.000000   0.023525 (  0.024489)
+    Digest::CRC32Jam#update  0.023348   0.000000   0.023348 (  0.023477)
+    Digest::CRC32MPEG#update  0.026287   0.000000   0.026287 (  0.027394)
+    Digest::CRC32POSIX#update  0.026063   0.000000   0.026063 (  0.026986)
+    Digest::CRC32XFER#update  0.026374   0.000000   0.026374 (  0.027314)
+    Digest::CRC64#update  0.023523   0.000000   0.023523 (  0.024484)
+    Digest::CRC64Jones#update  0.023479   0.000000   0.023479 (  0.024432)
+    Digest::CRC64XZ#update  0.024146   0.000000   0.024146 (  0.025129)
+
+### 0.5.1 / 2020-03-03
+
+* Fixed XOR logic in {Digest::CRC16Genibus}.
+* Freeze all `TABLE` constants.
+* Added missing documentation.
+
+### 0.5.0 / 2020-03-01
+
+* Added {Digest::CRC15}.
+* Added {Digest::CRC16Genibus}.
+* Added {Digest::CRC16Kermit}.
+* Added {Digest::CRC16X25}.
+* Added {Digest::CRC32BZip2}.
+* Added {Digest::CRC32Jam}.
+* Added {Digest::CRC32POSIX}.
+* Added {Digest::CRC32XFER}.
+* Added {Digest::CRC64Jones}.
+* Added {Digest::CRC64XZ}.
+* Renamed `Digest::CRC32Mpeg` to {Digest::CRC32MPEG}.
+* Renamed `Digest::CRC81Wire` to {Digest::CRC8_1Wire}.
+
+### 0.4.2 / 2020-03-01
+
+* Corrected the logic in {Digest::CRC32#update}.
+* Added missing {Digest::CRC5.pack} method.
+* Fixed a require in `digest/crc8_1wire.rb`.
+
+### 0.4.1 / 2014-04-16
+
+* Allow Digest CRC classes to be extended and their constants overriden.
+* Allow {Digest::CRC5::CRC_MASK} to be overriden by subclasses.
+* {Digest::CRC81Wire} now inherites from {Digest::CRC8}.
+
 ### 0.4.0 / 2013-02-13
 
 * Added {Digest::CRC16QT}.

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+
+  gem 'rspec', '~> 3.0'
+
+  gem 'yard', '~> 0.9'
+  gem 'kramdown'
+  gem 'kramdown-parser-gfm'
+  gem 'github-markup', '~> 1.1'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2013 Hal Brodigan
+Copyright (c) 2010-2020 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,7 @@
 # Digest CRC
 
+[![Build Status](https://travis-ci.org/postmodern/digest-crc.svg?branch=master)](https://travis-ci.org/postmodern/digest-crc)
+
 * [Source](https://github.com/postmodern/digest-crc)
 * [Issues](https://github.com/postmodern/digest-crc/issues)
 * [Documentation](http://rubydoc.info/gems/digest-crc/frames)
@@ -16,54 +18,106 @@ module.
   * {Digest::CRC1 CRC1}
   * {Digest::CRC5 CRC5}
   * {Digest::CRC8 CRC8}
-  * {Digest::CRC81Wire CRC8 1-Wire}
+  * {Digest::CRC8_1Wire CRC8 1-Wire}
+  * {Digest::CRC15 CRC15}
   * {Digest::CRC16 CRC16}
   * {Digest::CRC16CCITT CRC16 CCITT}
   * {Digest::CRC16DNP CRC16 DNP}
+  * {Digest::CRC16Genibus CRC16 Genibus}
+  * {Digest::CRC16Kermit CRC16 Kermit}
   * {Digest::CRC16Modbus CRC16 Modbus}
   * {Digest::CRC16USB CRC16 USB}
+  * {Digest::CRC16X25 CRC16 X25}
   * {Digest::CRC16XModem CRC16 XModem}
   * {Digest::CRC16ZModem CRC16 ZModem}
   * {Digest::CRC16QT CRC16 QT}
   * {Digest::CRC24 CRC24}
   * {Digest::CRC32 CRC32}
+  * {Digest::CRC32BZip2 CRC32 BZip2}
   * {Digest::CRC32c CRC32c}
-  * {Digest::CRC32Mpeg CRC32 Mpeg}
+  * {Digest::CRC32Jam CRC32 Jam}
+  * {Digest::CRC32MPEG CRC32 MPEG}
+  * {Digest::CRC32POSIX CRC32 POSIX}
+  * {Digest::CRC32XFER CRC32 XFER}
   * {Digest::CRC64 CRC64}
+  * {Digest::CRC64Jones CRC64 Jones}
+  * {Digest::CRC64XZ CRC64 XZ}
 * Pure Ruby implementation.
 * Provides CRC Tables for optimized calculations.
+* Supports _optional_ C extensions which increases performance by ~40x.
+  * If the C extensions cannot be compiled for whatever reason, digest-crc
+    will automatically fallback to the pure-Ruby implementation.
 
 ## Install
 
-    $ gem install digest-crc
+```
+gem install digest-crc
+```
 
 ## Examples
 
 Calculate a CRC32:
 
-    require 'digest/crc32'
+```ruby
+require 'digest/crc32'
 
-    Digest::CRC32.hexdigest('hello')
-    # => "3610a686"
+Digest::CRC32.hexdigest('hello')
+# => "3610a686"
+```
 
 Calculate a CRC32 of a file:
 
-    Digest::CRC32.file('README.md')
-    # => #<Digest::CRC32: 127ad531>
+```ruby
+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"
+```ruby
+crc = Digest::CRC32.new
+crc << 'one'
+crc << 'two'
+crc << 'three'
+crc.hexdigest
+# => "09e1c092"
+```
 
 Directly access the checksum:
 
-    crc.checksum
-    # => 165789842
+```ruby
+crc.checksum
+# => 165789842
+```
+
+Defining your own CRC class:
+
+```ruby
+require 'digest/crc32'
+
+module Digest
+  class CRC3000 < CRC32
+
+    WIDTH = 4
+
+    INIT_CRC = 0xffffffff
+
+    XOR_MASK = 0xffffffff
+
+    TABLE = [
+      # ....
+    ].freeze
+
+    def update(data)
+      data.each_byte do |b|
+        @crc = (((@crc >> 8) & 0x00ffffff) ^ @table[(@crc ^ b) & 0xff])
+      end
+
+      return self
+    end
+  end
+end
+```
 
 ## Thanks
 
@@ -73,6 +127,6 @@ including their CRC Tables.
 
 ## License
 
-Copyright (c) 2010-2013 Hal Brodigan
+Copyright (c) 2010-2020 Hal Brodigan
 
 See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -1,36 +1,44 @@
 require 'rubygems'
-require 'rake'
 
 begin
-  gem 'rubygems-tasks', '~> 0.1'
-  require 'rubygems/tasks'
-
-  Gem::Tasks.new
+  require 'bundler/setup'
 rescue LoadError => e
-  warn e.message
-  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
+  abort e.message
 end
 
-begin
-  gem 'rspec', '~> 2.4'
-  require 'rspec/core/rake_task'
+require 'rake'
+require 'rubygems/tasks'
+Gem::Tasks.new
 
-  RSpec::Core::RakeTask.new
-rescue LoadError => e
-  task :spec do
-    abort "Please run `gem install rspec` to install RSpec."
+namespace :build do
+  desc "Builds the C extensions"
+  task :c_exts do
+    Dir.chdir('ext/digest') { sh 'rake' }
   end
 end
-task :test => :spec
-task :default => :spec
 
-begin
-  gem 'yard', '~> 0.8'
-  require 'yard'
+require 'rake/clean'
+CLEAN.include('ext/digest/crc*/extconf.h')
+CLEAN.include('ext/digest/crc*/Makefile')
+CLEAN.include('ext/digest/crc*/*.o')
+CLEAN.include('ext/digest/crc*/*.so')
 
-  YARD::Rake::YardocTask.new  
-rescue LoadError => e
-  task :yard do
-    abort "Please run `gem install yard` to install YARD."
+require 'rspec/core/rake_task'
+namespace :spec do
+  RSpec::Core::RakeTask.new(:pure)
+  task :pure => :clean
+
+  if RUBY_ENGINE == 'ruby'
+    RSpec::Core::RakeTask.new(:c_exts)
+    task :c_exts => 'build:c_exts'
   end
 end
+
+task :spec => 'spec:pure'
+task :spec => 'spec:c_exts' if RUBY_ENGINE == 'ruby'
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :doc => :yard

data/benchmarks.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+require 'benchmark'
+$LOAD_PATH.unshift(File.expand_path('../ext',__FILE__))
+$LOAD_PATH.unshift(File.expand_path('../lib',__FILE__))
+
+CRCs = {
+  'crc1'          => 'CRC1',
+  'crc5'          => 'CRC5',
+  'crc8'          => 'CRC8',
+  'crc8_1wire'    => 'CRC81Wire',
+  'crc15'         => 'CRC15',
+  'crc16'         => 'CRC16',
+  'crc16_ccitt'   => 'CRC16CCITT',
+  'crc16_dnp'     => 'CRC16DNP',
+  'crc16_genibus' => 'CRC16Genibus',
+  'crc16_modbus'  => 'CRC16Modbus',
+  'crc16_qt'      => 'CRC16QT',
+  'crc16_usb'     => 'CRC16USB',
+  'crc16_x_25'    => 'CRC16X25',
+  'crc16_xmodem'  => 'CRC16XModem',
+  'crc16_zmodem'  => 'CRC16ZModem',
+  'crc24'         => 'CRC24',
+  'crc32'         => 'CRC32',
+  'crc32_bzip2'   => 'CRC32BZip2',
+  'crc32c'        => 'CRC32c',
+  'crc32_jam'     => 'CRC32Jam',
+  'crc32_mpeg'    => 'CRC32Mpeg',
+  'crc32_posix'   => 'CRC32POSIX',
+  'crc32_xfer'    => 'CRC32XFER',
+  'crc64'         => 'CRC64',
+  'crc64_jones'   => 'CRC64Jones',
+  'crc64_xz'      => 'CRC64XZ',
+}
+
+puts "Loading Digest::CRC classes ..."
+CRCs.each_key { |crc| require "digest/#{crc}" }
+
+N = 1000
+BLOCK_SIZE = 8 * 1024
+
+puts "Generating #{N} #{BLOCK_SIZE / 1024}Kb lengthed strings ..."
+SAMPLES = Array.new(N) do
+  Array.new(BLOCK_SIZE) { rand(256).chr }.join
+end
+
+puts "Benchmarking Digest::CRC classes ..."
+Benchmark.bm do |b|
+  CRCs.each_value do |crc|
+    crc_class = Digest.const_get(crc)
+    crc = crc_class.new
+
+    b.report("#{crc_class}#update") do
+      SAMPLES.each do |sample|
+        crc.update(sample)
+      end
+    end
+  end
+end

data/digest-crc.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
                   $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
                   require 'digest/crc/version'
-                  Digest::Crc::VERSION
+                  Digest::CRC::VERSION
                 end
 
   gem.summary     = gemspec['summary']
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.authors     = Array(gemspec['authors'])
   gem.email       = gemspec['email']
   gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }