crc 0.3.1.1 → 0.4

data/lib/crc/_utils.rb

@@ -0,0 +1,114 @@
+class CRC
+  #
+  # Utilities.
+  #
+  module Utils
+    extend self
+
+    def bitreflect_reference(num, bitsize)
+      n = 0
+      bitsize.times { n <<= 1; n |= (num & 0x01); num >>= 1 }
+      n
+    end
+
+    def bitreflect(num, bitsize)
+      case
+      when bitsize > 128
+        bitreflect_reference(num, bitsize)
+      when bitsize > 64
+        bitreflect128(num) >> (128 - bitsize)
+      when bitsize > 32
+        bitreflect64(num) >> (64 - bitsize)
+      when bitsize > 16
+        bitreflect32(num) >> (32 - bitsize)
+      when bitsize > 8
+        bitreflect16(num) >> (16 - bitsize)
+      else
+        bitreflect8(num) >> (8 - bitsize)
+      end
+    end
+
+    def build_table(bitsize, polynomial, unfreeze = false, slice: 16)
+      bitmask = ~(~0 << bitsize)
+      table = []
+      Aux.slide_to_head(bitsize, 0, bitmask & polynomial, bitmask) do |xx, poly, csh, head, carries, pad|
+        table << (t = [])
+        256.times do |b|
+          b <<= csh
+          8.times { b = (b[head] == 0) ? (b << 1) : (((carries & b) << 1) ^ poly) }
+          t << b
+        end
+        t.freeze unless unfreeze
+
+        carries8 = carries >> 7
+        (1...slice).step do
+          tt = table[-1]
+          table << (t = [])
+          256.times do |b|
+            t << (table[0][tt[b] >> csh] ^ ((carries8 & tt[b]) << 8))
+          end
+          t.freeze unless unfreeze
+        end
+        0
+      end
+      table.freeze unless unfreeze
+      table
+    end
+
+    def build_reflect_table(bitsize, polynomial, unfreeze = false, slice: 16)
+      polynomial = bitreflect(polynomial, bitsize)
+      table = []
+
+      table << (t = [])
+      256.times do |b|
+        8.times { b = (b[0] == 0) ? (b >> 1) : ((b >> 1) ^ polynomial) }
+        t << b
+      end
+      t.freeze unless unfreeze
+
+      (1...slice).step do
+        tt = table[-1]
+        table << (t = [])
+        256.times do |b|
+          t << (table[0][tt[b] & 0xff] ^ (tt[b] >> 8))
+        end
+        t.freeze unless unfreeze
+      end
+
+      table.freeze unless unfreeze
+      table
+    end
+
+    def export_table(table, bitsize, linewidth, indentsize = 2)
+      bitsize0 = bitsize.to_i
+      indent = " " * indentsize.to_i
+      case
+      when bitsize0 > 64 || bitsize0 < 1
+        raise "invalid bitsize (expected to 1..64, but given #{bitsize})"
+      when bitsize0 > 32
+        packformat = "Q>"
+        hexwidth = 16
+      when bitsize0 > 16
+        packformat = "N"
+        hexwidth = 8
+      when bitsize0 > 8
+        packformat = "n"
+        hexwidth = 4
+      else # when bitsize0 > 0
+        packformat = "C"
+        hexwidth = 2
+      end
+      table = table.to_a.pack("#{packformat}*").unpack("H*")[0]
+      table.gsub!(/(?<=\w)(?=\w{#{hexwidth}}{#{linewidth}}+$)/, "\n")
+      table.gsub!(/(?<=\w)(?=\w{#{hexwidth}}+$)/, " ")
+      table.gsub!(/(?<=\w)(?=\s|$)/, ",")
+      table.gsub!(/(?:(?<=^)|(?<=\s))(?=\w)/, "0x")
+      table.gsub!(/^/, "#{indent}  ")
+      <<-EOS
+#{indent}TABLE = [
+#{table}
+#{indent}].freeze
+      EOS
+    end
+  end
+end

data/lib/crc/acrc.rb

@@ -3,17 +3,17 @@
 require_relative "../crc"
 
 class CRC
-  module ModuleClass
+  using CRC::Extensions
+
+  module Calcurator
     #
     # call-seq:
-    #   acrc(crc, rest_seq = nil, target_crc = 0) -> byte string as arc-code
+    #   acrc(pre, post = nil, targetcrc = 0) -> byte string as arc-code
     #
     # 目的となる crc になるように、指定された crc に続くバイト列を逆算します。
     #
     # 出力されるバイト列は、crc のビット数を表現できるバイト数となります。
     #
-    # 現在のところ、reflect-input/output 限定となっています。
-    #
     # * crc32("123456789????") の結果が 0 となるような、???? の部分を逆算する
     #
     #     seq = "123456789"
@@ -31,75 +31,20 @@ class CRC
     #
     #     seq1 = "123456789"
     #     seq2 = "ABCDEFG"
-    #     target_crc = 0x12345678
-    #     seq = seq1 + CRC::CRC32.acrc(seq1, seq2, target_crc) + seq2
+    #     targetcrc = 0x12345678
+    #     seq = seq1 + CRC::CRC32.acrc(seq1, seq2, targetcrc) + seq2
     #     p CRC::CRC32[seq] # => #<CRC::CRC32:12345678>
     #
-    def acrc(crc, rest_seq = nil, target_crc = 0)
-      raise NotImplementedError, "crc polynomial is not odd" unless polynomial.odd?
-      raise NotImplementedError, "crc module is not reflect input and output" unless reflect_input? && reflect_output?
-
-      bitsize = self.bitsize
-      poly = CRC.bitreflect(polynomial, bitsize)
-      target_crc = target_crc.to_i
-      target_crc ^= xor_output
-
-      if rest_seq
-        rest_seq.bytesize.downto(1) do |i|
-          target_crc = Aux.acrc_loop_reflect(target_crc, rest_seq.getbyte(i - 1), poly, bitsize, 0xff, 8)
-        end
-      end
-
-      bytes = (bitsize + 7) / 8
-      bits = bytes * 8
-
-      case crc
-      when Numeric
-        state = bitmask & crc ^ xor_output
-      when CRC
-        raise "different crc module (given %p(%p), expect %p)" % [crc, crc.class, self] unless variant?(crc)
-        state = crc.state
-      else
-        state = new(crc).state
-      end
-
-      if bits > bitsize
-        # ビット数が 8 の境界にない場合、その隙間分を埋める。
-        # 現在の実装では、最終結果のバイト列における最終バイト値の
-        # 上位ビットが 0 であるようにしている。
-        pad = bits - bitsize
-        target_crc = Aux.acrc_loop_reflect(target_crc, 0, poly, bitsize, 0xff, pad)
-      end
-
-      target_crc = Aux.acrc_loop_reflect(target_crc, state, poly, bitsize, bitmask, bitsize)
-
-      bytes.times.reduce("") { |a, *| a << (target_crc & 0xff).chr(Encoding::BINARY); target_crc >>= 8; a }
-    end
-  end
-
-  module Aux
-    def self.acrc_loop_reflect(target_crc, state, poly, crcbits, bitmask, bits)
-      head = bits - 1
-      bitmask1 = bitmask >> 1
-      crchead = crcbits - 1
-
-      #puts "target_crc=0b%016b, state=0b%016b, reversed-polynomial=0b%016b" % [target_crc, state, poly]
-      bits.times do |i|
-        if target_crc[crchead] == 0
-          target_crc <<= 1
-        else
-          target_crc ^= poly
-          target_crc <<= 1
-          target_crc |= 0x01
-        end
-
-        target_crc ^= state[head]
-        #puts "    0_%016b ^ %d" % [target_crc, state[head]]
-        state = (state & bitmask1) << 1
-      end
-      #puts "target_crc=0b%016b" % target_crc
-
-      target_crc
+    def acrc(pre, post = nil, targetcrc = 0)
+      pre = pre.convert_internal_state_for(self)
+      laststate = targetcrc.convert_target_state_for(self)
+      state = unshiftbytes(post, laststate)
+      bytesize = (bitsize + 7) / 8
+      pre <<= (bytesize * 8 - bitsize) unless reflect_input?
+      bytes = pre.splitbytes("".b, bytesize, reflect_input?)
+      state = unshiftbytes(bytes, state)
+      state <<= (bytesize * 8 - bitsize) unless reflect_input?
+      state.splitbytes("".b, bytesize, reflect_input?)
     end
   end
 end

data/lib/crc/codegen.rb

@@ -854,7 +854,7 @@ end
         raise ArgumentError, "out of algorithm code (given #{algorithm})"
       end
       (<<-EOS).gsub!(/^(?!$)/, " ").gsub!(/^/) { line_prefix }.chomp!
-A CRC generator for #{crcname}.
+A CRC calculator for #{crcname}.
 
 This code is auto generated by <https://rubygems.org/gems/crc>.
 

data/lib/crc/version.rb

@@ -1,5 +1,5 @@
 #!ruby
 
 class CRC
-  VERSION = "0.3.1.1"
+  VERSION = "0.4"
 end

data/test/common.rb

@@ -0,0 +1,23 @@
+#!ruby
+
+require "test-unit"
+require "crc"
+require "optparse"
+
+alltest = false
+opt = OptionParser.new(nil, 12, " ")
+opt.instance_eval do
+  on("--all", "test all crc modules") { alltest = true }
+  order!
+end
+
+if alltest
+  $testmodules = CRC::MODULE_TABLE.values.uniq
+else
+  $testmodules = %w(
+      CRC-32 CRC-32-POSIX CRC-64 CRC-64-ECMA
+      CRC-3-ROHC CRC-5-USB CRC-7-ROHC CRC-7-UMTS CRC-8-CCITT CRC-8-MAXIM
+      CRC-15 CRC-16 CRC-16-XMODEM CRC-24-OPENPGP CRC-24-BLE CRC-31-PHILIPS
+  ).map { |e| CRC[e] }
+end
+

data/test/self_check.rb

@@ -0,0 +1,31 @@
+require "crc"
+
+$stderr.puts "#{__FILE__}:#{__LINE__}: SELF CHECK for CRC modules (#{File.basename($".grep(/_(?:byruby|turbo)/)[0]||"")})\n"
+
+class CRC
+  MODULE_TABLE.values.uniq.each do |crc|
+    check = crc::CHECK
+    checked = crc.crc("123456789")
+    case check
+    when nil
+      $stderr.puts "| %20s(\"123456789\" * 1) = %16X (check only)\n" % [crc.name, checked]
+    when checked
+      ;
+    else
+      $stderr.puts "| %20s(\"123456789\" * 1) = %16X (expect to %X)\n" % [crc.name, checked, check]
+    end
+
+    check = 9.times.reduce(crc.new) { |a, x| a + crc.new(crc::CHECK, 9) }
+    checked = crc["123456789" * 9]
+    case check
+    when nil
+      $stderr.puts "| %20s(\"123456789\" * 9) = %16X (check only)\n" % [crc.name, checked]
+    when checked
+      ;
+    else
+      $stderr.puts "| %20s(\"123456789\" * 9) = %16X (expect to %X)\n" % [crc.name, checked, check]
+    end
+  end
+end
+
+$stderr.puts "#{__FILE__}:#{__LINE__}: DONE SELF CHECK\n"

data/test/test_block.rb

@@ -0,0 +1,28 @@
+#!ruby
+
+require "test-unit"
+require "crc"
+require_relative "common"
+
+class TestCRC < Test::Unit::TestCase
+  $testmodules.each do |crc|
+    next unless crc.const_defined?(:CHECK) && crc::CHECK
+    class_eval(<<-"EOS", __FILE__, __LINE__ + 1)
+      def test_block_#{crc.to_s.slice(/\w+$/)}
+        assert_equal(#{crc}::CHECK, #{crc}.crc("123456789"))
+      end
+
+      def test_stream_#{crc.to_s.slice(/\w+$/)}
+        s = #{crc}.new
+        s << "123456789"
+        assert_equal(#{crc}::CHECK, s.crc)
+      end
+
+      def test_stream2_#{crc.to_s.slice(/\w+$/)}
+        s = #{crc}.new
+        "123456789".each_char { |ch| s << ch }
+        assert_equal(#{crc}::CHECK, s.crc)
+      end
+    EOS
+  end
+end

data/test/test_magic.rb

@@ -0,0 +1,25 @@
+#!ruby
+
+require "test-unit"
+require "crc"
+require_relative "common"
+
+class TestCRCMagic < Test::Unit::TestCase
+  $testmodules.each do |crc|
+    next unless crc.const_defined?(:CHECK) && crc::CHECK
+    name = crc.to_s.slice(/\w+$/)
+    class_eval(<<-"TESTCODE", __FILE__, __LINE__ + 1)
+      def test_magic_#{name}
+        assert_equal #{crc}.magic, #{crc}.hexdigest(#{crc}.magicdigest(""))
+        assert_equal #{crc}.magic, #{crc}.hexdigest("A" + #{crc}.magicdigest("A"))
+        assert_equal #{crc}.magic, #{crc}.hexdigest("A" * 100 + #{crc}.magicdigest("A" * 100))
+      end
+
+      def test_magicnumber_#{name}
+        assert_equal #{crc}.magicnumber, #{crc}.crc(#{crc}.magicdigest(""))
+        assert_equal #{crc}.magicnumber, #{crc}.crc("A" + #{crc}.magicdigest("A"))
+        assert_equal #{crc}.magicnumber, #{crc}.crc("A" * 100 + #{crc}.magicdigest("A" * 100))
+      end
+    TESTCODE
+  end
+end

metadata

@@ -1,34 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: crc
 version: !ruby/object:Gem::Version
-  version: 0.3.1.1
+  version: '0.4'
 platform: ruby
 authors:
 - dearblue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
 description: |
-  Pure ruby implemented general CRC (Cyclic Redundancy Check) generator.
+  Pure ruby implemented general CRC (Cyclic Redundancy Check) calcurator.
   Customization is posible for 1 to 64 bit width, any polynomials, and with/without bit reflection input/output.
   If you need more speed, please use crc-turbo.
-email: dearblue@users.osdn.me
+email: dearblue@users.noreply.github.com
 executables:
 - rbcrc
 extensions: []
@@ -37,9 +37,15 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 - lib/crc.rb
+- lib/crc/_aux.rb
 - lib/crc/_byruby.rb
 - lib/crc/_combine.rb
+- lib/crc/_extensions.rb
+- lib/crc/_file.rb
+- lib/crc/_magic.rb
 - lib/crc/_modules.rb
+- lib/crc/_shift.rb
+- lib/crc/_utils.rb
 - lib/crc/acrc.rb
 - lib/crc/codegen.rb
 - lib/crc/finder.rb
@@ -53,14 +59,24 @@ files:
 - bin/rbcrc
 - gemstub.rb
 - lib/crc.rb
+- lib/crc/_aux.rb
 - lib/crc/_byruby.rb
 - lib/crc/_combine.rb
+- lib/crc/_extensions.rb
+- lib/crc/_file.rb
+- lib/crc/_magic.rb
 - lib/crc/_modules.rb
+- lib/crc/_shift.rb
+- lib/crc/_utils.rb
 - lib/crc/acrc.rb
 - lib/crc/codegen.rb
 - lib/crc/finder.rb
 - lib/crc/version.rb
-homepage: https://osdn.jp/projects/rutsubo/
+- test/common.rb
+- test/self_check.rb
+- test/test_block.rb
+- test/test_magic.rb
+homepage: https://github.com/dearblue/ruby-crc-turbo
 licenses:
 - BSD-2-Clause
 - Zlib
@@ -78,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -86,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: general CRC generator
+summary: general CRC calcurator
 test_files: []