digest-crc 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d5a255ef5f82e672dc7d0f84078a9b94e7b33a2544224be87264678012bc018
-  data.tar.gz: 13541d0a4470c110b2dbbf4f6db220df74941941fadb050a2fc2d3f1296abed9
+  metadata.gz: 2f92ef55b3e61da5d83aca365fabce146aaa938ff0ee7f380496f30b2909cd8c
+  data.tar.gz: a34bfa0d5c6b86e29ee5cc27d157a8ea45596e03ffdd7d7d740eaeb9ccca8e6f
 SHA512:
-  metadata.gz: fef49b3b834f178e99d911ed9c7f6fd6c62c1901b2629ffbe57a5054f46286be120c5428c21166f76dd7fca1ee19ceb1649b65bff9401438686bb5636ce1e87f
-  data.tar.gz: 3eaee048aa5a41b3e1b669575645c538c10ff1faac65f4423c8473d2825198c8718fef3ceff12f91209759ee572b2f5e99d42467cb60d95782fb929fc27048d3
+  metadata.gz: cafe8835843afd7873891d6a8c85ba294b8cb846a63641a273844aa50801071d77a92a6e1391e82b9921b199163ab87f9864885ba94f1efaf5a241448a9c0143
+  data.tar.gz: 3787c83078142822c4d7ff198abbcd5a148061612079877ed8f4e4a3b828a4addb9484c4eb36beb417f30c570c336e1a708d7d9a3735342b3553f1d18e69fb8a

data/ChangeLog.md

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

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] }
 

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: digest-crc
-version: 0.5.0
+version: 0.5.1
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.
 description:
   Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
@@ -9,6 +9,13 @@ license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: https://github.com/postmodern/digest-crc#readme
+
+metadata:
+  documentation_uri: https://rubydoc.info/gems/digest-crc
+  source_code_uri: https://github.com/postmodern/digest-crc
+  bug_tracker_uri: https://github.com/postmodern/digest-crc/issues
+  changelog_uri: https://github.com/postmodern/digest-crc/blob/master/ChangeLog.md
+
 has_yard: true
 
 development_dependencies:

data/lib/digest/crc15.rb

@@ -28,7 +28,7 @@ module Digest
       0x7c41, 0x39d8, 0x32ea, 0x7773, 0x248e, 0x6117, 0x6a25, 0x2fbc, 0x0846, 0x4ddf, 0x46ed, 0x0374, 0x5089, 0x1510, 0x1e22, 0x5bbb,
       0x0af8, 0x4f61, 0x4453, 0x01ca, 0x5237, 0x17ae, 0x1c9c, 0x5905, 0x7eff, 0x3b66, 0x3054, 0x75cd, 0x2630, 0x63a9, 0x689b, 0x2d02,
       0x276f, 0x62f6, 0x69c4, 0x2c5d, 0x7fa0, 0x3a39, 0x310b, 0x7492, 0x5368, 0x16f1, 0x1dc3, 0x585a, 0x0ba7, 0x4e3e, 0x450c, 0x0095
-    ]
+    ].freeze
 
     #
     # Packs the CRC15 checksum.

data/lib/digest/crc16_genibus.rb

@@ -8,6 +8,12 @@ module Digest
   #
   class CRC16Genibus < CRC16
 
+    INIT_XOR = 0xffff
+
+    INIT_CRC = 0x0000 ^ INIT_XOR
+
+    XOR_MASK = 0xffff
+
     # Generated by `./pycrc.py --algorithm=table-driven --model=crc-16 --generate=c`
     TABLE = [
       0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
@@ -42,7 +48,7 @@ module Digest
       0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
       0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
       0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
-    ]
+    ].freeze
 
     #
     # Updates the CRC16 Genibus checksum.

data/lib/digest/crc16_kermit.rb

@@ -42,7 +42,7 @@ module Digest
       0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9,
       0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
       0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
-    ]
+    ].freeze
 
     #
     # Updates the CRC16 Kermit checksum.

data/lib/digest/crc16_x_25.rb

@@ -12,6 +12,7 @@ module Digest
 
     XOR_MASK = 0xffff
 
+    # Generated by `./pycrc.py --algorithm=table-driven --model=x-25 --generate=c`
     TABLE = [
       0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf,
       0x8c48, 0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7,
@@ -45,7 +46,7 @@ module Digest
       0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9,
       0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
       0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
-    ]
+    ].freeze
     
   end
 end

data/lib/digest/crc32_bzip2.rb

@@ -6,6 +6,7 @@ module Digest
   #
   class CRC32BZip2 < CRC32
 
+    # Generated by `./pycrc.py --algorithm=table-driven --model=crc-32-bzip2 --generate=c`
     TABLE = [
       0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9, 0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,
       0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, 0x2b4bcb61, 0x350c9b64, 0x31cd86d3, 0x3c8ea00a, 0x384fbdbd,
@@ -39,7 +40,7 @@ module Digest
       0xe3a1cbc1, 0xe760d676, 0xea23f0af, 0xeee2ed18, 0xf0a5bd1d, 0xf464a0aa, 0xf9278673, 0xfde69bc4,
       0x89b8fd09, 0x8d79e0be, 0x803ac667, 0x84fbdbd0, 0x9abc8bd5, 0x9e7d9662, 0x933eb0bb, 0x97ffad0c,
       0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668, 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
-    ]
+    ].freeze
 
     #
     # Updates the CRC32 BZip2 checksum.

data/lib/digest/crc32_posix.rb

@@ -41,7 +41,7 @@ module Digest
     0xe3a1cbc1, 0xe760d676, 0xea23f0af, 0xeee2ed18, 0xf0a5bd1d, 0xf464a0aa, 0xf9278673, 0xfde69bc4,
     0x89b8fd09, 0x8d79e0be, 0x803ac667, 0x84fbdbd0, 0x9abc8bd5, 0x9e7d9662, 0x933eb0bb, 0x97ffad0c,
     0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668, 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
-    ]
+    ].freeze
 
     #
     # Updates the CRC32 POSIX checksum.

data/lib/digest/crc32_xfer.rb

@@ -1,12 +1,16 @@
 require 'digest/crc32'
 
 module Digest
+  #
+  # Implements the CRC32 XFER algorithm.
+  #
   class CRC32XFER < CRC32
 
     INIT_CRC = 0x00000000
 
     XOR_MASK = 0x00000000
 
+    # Generated by `./pycrc.py --algorithm=table-driven --model=xfer --generate=c`
     TABLE = [
       0x00000000, 0x000000af, 0x0000015e, 0x000001f1, 0x000002bc, 0x00000213, 0x000003e2, 0x0000034d,
       0x00000578, 0x000005d7, 0x00000426, 0x00000489, 0x000007c4, 0x0000076b, 0x0000069a, 0x00000635,
@@ -40,8 +44,14 @@ module Digest
       0x00006cd8, 0x00006c77, 0x00006d86, 0x00006d29, 0x00006e64, 0x00006ecb, 0x00006f3a, 0x00006f95,
       0x00006350, 0x000063ff, 0x0000620e, 0x000062a1, 0x000061ec, 0x00006143, 0x000060b2, 0x0000601d,
       0x00006628, 0x00006687, 0x00006776, 0x000067d9, 0x00006494, 0x0000643b, 0x000065ca, 0x00006565
-    ]
+    ].freeze
 
+    #
+    # Updates the CRC32 XFER checksum.
+    #
+    # @param [String] data
+    #   The data to update the checksum with.
+    #
     def update(data)
       data.each_byte do |b|
         @crc = (@table[((@crc >> 24) ^ b) & 0xff] ^ (@crc << 8)) & 0xffffffff

data/lib/digest/crc64_jones.rb

@@ -78,7 +78,7 @@ module Digest
       0x0df7adabd7a6e2d6, 0x772fdd63e7936baf, 0xf8474c3bb7cdf024, 0x829f3cf387f8795d,
       0x66e7a46c27f3aa2c, 0x1c3fd4a417c62355, 0x935745fc4798b8de, 0xe98f353477ad31a7,
       0xa6df411fbfb21ca3, 0xdc0731d78f8795da, 0x536fa08fdfd90e51, 0x29b7d047efec8728
-    ]
+    ].freeze
 
   end
 end

data/lib/digest/crc64_xz.rb

@@ -80,7 +80,7 @@ module Digest
       0x50a65c93309e7c0b, 0xe388102d33392364, 0xa4226ac498dedc50, 0x170c267a9b79833f,
       0xdcd7181e300f9e5e, 0x6ff954a033a8c131, 0x28532e49984f3e05, 0x9b7d62f79be8616a,
       0xa707db9acf80c06d, 0x14299724cc279f02, 0x5383edcd67c06036, 0xe0ada17364673f59
-    ]
+    ].freeze
 
   end
 end

data/spec/crc16_genibus_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 require 'crc_examples'
-require 'digest/crc16_modbus'
+require 'digest/crc16_genibus'
 
-describe Digest::CRC16Modbus do
+describe Digest::CRC16Genibus do
   let(:string)   { '1234567890' }
-  let(:expected) { 'c20a' }
+  let(:expected) { 'cde7' }
 
   it_should_behave_like "CRC"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digest-crc
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ files:
 - spec/crc16_zmodem_spec.rb
 - spec/crc1_spec.rb
 - spec/crc24_spec.rb
-- spec/crc32_bzip_spec.rb
+- spec/crc32_bzip2_spec.rb
 - spec/crc32_jam_spec.rb
 - spec/crc32_mpeg_spec.rb
 - spec/crc32_posix_spec.rb
@@ -106,7 +106,11 @@ files:
 homepage: https://github.com/postmodern/digest-crc#readme
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://rubydoc.info/gems/digest-crc
+  source_code_uri: https://github.com/postmodern/digest-crc
+  bug_tracker_uri: https://github.com/postmodern/digest-crc/issues
+  changelog_uri: https://github.com/postmodern/digest-crc/blob/master/ChangeLog.md
 post_install_message: 
 rdoc_options: []
 require_paths: