digest-crc 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5090c17bdfb58a94270e81bab8753095324379c5
-  data.tar.gz: ec891e2886a61cd48e28f2a119ebb48bd01f68b7
+SHA256:
+  metadata.gz: 965bc1999bc4bdcb3ea1ffa8eab25d428fc2682357732bdd2b9c86b0d7363a9a
+  data.tar.gz: 6deaae2d1bb8cd247ae74f4feea6d0cef835996066a50e5f5d8f24efb3d87a62
 SHA512:
-  metadata.gz: 5539def533acad46a8a1ac25c602bee61832c9912598975884c25388e369658ce59245f6160ef1341b216a8b3e6aceb59c23f9b8b1e62dece990dad3ac3d2742
-  data.tar.gz: bf09d57ef56303bd70d0df44fa20a1e2d2fd107bf052fa31ba6191a827cbaa81659eb7aa2fb795f694f0f036abd653b425cd60388106df30275aadb343eaeded
+  metadata.gz: 715571c3f3ac67ec6b69879b09ecdfb3bb57813bf5f5b0f2266ff8109cffa4a186fa4058c5bedee86a84fecce8296a0d0349c0dcba63fd1958816e823e8c5669
+  data.tar.gz: 56f85ea3dc41925c9a496066790f6b11c891ea85eabcff566177cefa537c16bb417503a39a9b4561d61d596e0865d837b06bbbc79839c3c6d1859e4aa52cceb8

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 doc
 pkg
 .bundle

data/.travis.yml

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

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 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.

data/Gemfile

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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2014 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)
@@ -112,6 +114,6 @@ including their CRC Tables.
 
 ## License
 
-Copyright (c) 2010-2014 Hal Brodigan
+Copyright (c) 2010-2020 Hal Brodigan
 
-See [LICENSE.txt](LICENSE.txt) for license information.
+See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -1,40 +1,21 @@
 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
-    puts e.message
-  end
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 task :test => :spec
 task :default => :spec
 
-begin
-  gem 'yard', '~> 0.8'
-  gem 'redcarpet'
-  gem 'github-markup'
-  require 'yard'
-  require 'redcarpet'
-  require 'github-markup'
-
-  YARD::Rake::YardocTask.new
-rescue LoadError => e
-  task :yard do
-    puts e.message
-  end
-end
+require 'yard'
+require 'redcarpet'
+require 'github-markup'
+YARD::Rake::YardocTask.new

data/benchmarks.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+require 'benchmark'
+$LOAD_PATH.unshift(File.expand_path('lib'))
+
+CRCs = {
+  'crc1'         => 'CRC1',
+  'crc5'         => 'CRC5',
+  'crc8'         => 'CRC8',
+  'crc8_1wire'   => 'CRC81Wire',
+  'crc16'        => 'CRC16',
+  'crc16_ccitt'  => 'CRC16CCITT',
+  'crc16_dnp'    => 'CRC16DNP',
+  'crc16_modbus' => 'CRC16Modbus',
+  'crc16_qt'     => 'CRC16QT',
+  'crc16_usb'    => 'CRC16USB',
+  'crc16_xmodem' => 'CRC16XModem',
+  'crc16_zmodem' => 'CRC16ZModem',
+  'crc24'        => 'CRC24',
+  'crc32'        => 'CRC32',
+  'crc32c'       => 'CRC32c',
+  'crc32_mpeg'   => 'CRC32Mpeg',
+  'crc64'        => 'CRC64',
+}
+
+puts "Loading Digest::CRC classes ..."
+CRCs.each_key { |crc| require "digest/#{crc}" }
+
+puts "Generating random lengthed strings ..."
+SAMPLES = Array.new(100) do
+  Array.new(100 * rand(1024)) { 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/gemspec.yml

@@ -1,9 +1,9 @@
 name: digest-crc
-version: 0.4.1
+version: 0.4.2
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.
 description:
-  Adds support for calculating Cyclic Redundancy Check (CRC) to the
-  Digest module.
+  Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
+  module.
 
 license: MIT
 authors: Postmodern
@@ -12,6 +12,4 @@ homepage: https://github.com/postmodern/digest-crc#readme
 has_yard: true
 
 development_dependencies:
-  rubygems-tasks: ~> 0.2
-  rspec: ~> 2.4
-  yard: ~> 0.8
+  bundler: ~> 1.0

data/lib/digest/crc.rb

@@ -39,11 +39,16 @@ module Digest
     #
     # Packs the given CRC checksum.
     #
+    # @param [Integer] crc
+    #   The raw CRC checksum.
+    #
     # @return [String]
     #   The packed CRC checksum.
     #
+    # @abstract
+    #
     def self.pack(crc)
-      ''
+      raise(NotImplementedError,"#{self.class}##{__method__} not implemented")
     end
 
     #
@@ -83,11 +88,14 @@ module Digest
     # @param [String] data
     #   The data to update the CRC checksum with.
     #
+    # @abstract
+    #
     def update(data)
+      raise(NotImplementedError,"#{self.class}##{__method__} not implemented")
     end
 
     #
-    # @see {#update}
+    # @see #update
     #
     def <<(data)
       update(data)
@@ -117,7 +125,7 @@ module Digest
     #
     # Finishes the CRC checksum calculation.
     #
-    # @see {pack}
+    # @see pack
     #
     def finish
       self.class.pack(checksum)

data/lib/digest/crc16_ccitt.rb

@@ -8,7 +8,7 @@ module Digest
 
     INIT_CRC = 0xffff
 
-    # Generated by `./pycrc.py --algorithm=table-driven --model=ccitt --generate=c`
+    # Generated by `./pycrc.py --algorithm=table-driven --model=crc-16-ccitt --generate=c`
     TABLE = [
       0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
       0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,

data/lib/digest/crc16_qt.rb

@@ -10,10 +10,7 @@ module Digest
 
     FINAL_XOR = 0xffff
 
-    REVERSE_CRC_RESULT = true
-
-    REVERSE_DATA = true
-
+    #
     # Updates the CRC16 checksum.
     #
     # @param [String] data
@@ -21,17 +18,22 @@ module Digest
     #
     def update(data)
       data.each_byte do |b|
-        b = revert_byte(b) if REVERSE_DATA
+        b = revert_byte(b)
         @crc = ((@table[((@crc >> 8) ^ b) & 0xff] ^ (@crc << 8)) & 0xffff)
       end
 
       return self
     end
 
+    #
+    # Calculates the CRC checksum value.
+    #
+    # @return [Integer]
+    #
     def checksum
-      crc = @crc + 0
-      crc ^= FINAL_XOR      if FINAL_XOR
-      crc = revert_bits crc if REVERSE_CRC_RESULT
+      crc = super
+      crc ^= FINAL_XOR
+      crc = revert_bits(crc)
       return crc
     end
 

data/lib/digest/crc32.rb

@@ -108,7 +108,7 @@ module Digest
     #
     def update(data)
       data.each_byte do |b|
-        @crc = (((@crc >> 8) & 0x00ffffff) ^ @table[(@crc ^ b) & 0xff])
+        @crc = @table[(@crc ^ b) & 0xff] ^ ((@crc >> 8) & 0xffffffff)
       end
 
       return self

data/lib/digest/crc32_mpeg.rb

@@ -8,6 +8,7 @@ module Digest
 
     XOR_MASK = 0x00000000
 
+    # Generated by `./pycrc.py --algorithm=table-driven --model=crc-32-mpeg --generate=c`
     TABLE = [
       0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9,
       0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,

data/lib/digest/crc5.rb

@@ -43,6 +43,19 @@ module Digest
       super
     end
 
+    #
+    # Packs the CRC8 checksum.
+    #
+    # @param [Integer] crc
+    #   The checksum to pack.
+    #
+    # @return [String]
+    #   The packed checksum.
+    #
+    def self.pack(crc)
+      (crc & CRC_MASK).chr
+    end
+
     #
     # Updates the CRC5 checksum.
     #

data/lib/digest/crc8_1wire.rb

@@ -1,4 +1,4 @@
-require 'digest/crc'
+require 'digest/crc8'
 
 module Digest
   #

data/spec/crc_examples.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 shared_examples_for "CRC" do
   it "should calculate a checksum for text" do
-    described_class.hexdigest(string).should == expected
+    expect(described_class.hexdigest(string)).to be == expected
   end
 
   it "should calculate a checksum for multiple data" do
@@ -15,13 +15,13 @@ shared_examples_for "CRC" do
     crc << chunk1
     crc << chunk2
 
-    crc.hexdigest.should == expected
+    expect(crc.hexdigest).to be == expected
   end
 
   it "should provide direct access to the checksum value" do
     crc = subject
     crc << string
 
-    crc.checksum.should == expected.to_i(16)
+    expect(crc.checksum).to be == expected.to_i(16)
   end
 end

data/spec/crc_spec.rb

@@ -2,14 +2,22 @@ require 'spec_helper'
 require 'digest/crc'
 
 describe Digest::CRC do
-  it "should define block_length of 1" do
-    crc = subject
+  describe "#block_length" do
+    it { expect(subject.block_length).to be 1 }
+  end
+
+  describe ".pack" do
+    subject { described_class }
 
-    crc.block_length.should == 1
+    it do
+      expect { subject.pack(0) }.to raise_error(NotImplementedError)
+    end
   end
 
-  it "should pack to an empty String by default" do
-    described_class.pack(0).should be_empty
+  describe "#update" do
+    it do
+      expect { subject.update('') }.to raise_error(NotImplementedError)
+    end
   end
 
   context "when inherited" do
@@ -26,38 +34,38 @@ describe Digest::CRC do
     end
 
     it "should override WIDTH" do
-      subject::WIDTH.should_not == described_class::WIDTH
+      expect(subject::WIDTH).not_to be described_class::WIDTH
     end
 
     it "should override INIT_CRC" do
-      subject::INIT_CRC.should_not == described_class::INIT_CRC
+      expect(subject::INIT_CRC).not_to be described_class::INIT_CRC
     end
 
     it "should override XOR_MASK" do
-      subject::XOR_MASK.should_not == described_class::XOR_MASK
+      expect(subject::XOR_MASK).not_to be described_class::XOR_MASK
     end
 
     it "should override TABLE" do
-      subject::TABLE.should_not == described_class::TABLE
+      expect(subject::TABLE).not_to be described_class::TABLE
     end
 
     describe "#initialize" do
       let(:instance) { subject.new }
 
       it "should initialize @init_crc" do
-        instance.instance_variable_get("@init_crc").should == subject::INIT_CRC
+        expect(instance.instance_variable_get("@init_crc")).to be subject::INIT_CRC
       end
 
       it "should initialize @xor_mask" do
-        instance.instance_variable_get("@xor_mask").should == subject::XOR_MASK
+        expect(instance.instance_variable_get("@xor_mask")).to be subject::XOR_MASK
       end
 
       it "should initialize @width" do
-        instance.instance_variable_get("@width").should == subject::WIDTH
+        expect(instance.instance_variable_get("@width")).to be subject::WIDTH
       end
 
       it "should initialize @table" do
-        instance.instance_variable_get("@table").should == subject::TABLE
+        expect(instance.instance_variable_get("@table")).to be subject::TABLE
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,2 +1 @@
-gem 'rspec', '~> 2.4'
 require 'rspec'

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: digest-crc
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubygems-tasks
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 description: Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
   module.
 email: postmodern.mod3@gmail.com
@@ -62,14 +34,16 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .gemtest
-- .gitignore
-- .rspec
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - ChangeLog.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks.rb
 - digest-crc.gemspec
 - gemspec.yml
 - lib/digest/crc.rb
@@ -116,20 +90,20 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
+- ext
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.