crc 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8e6fc81bbcef03f0e899ac1938b7535ddaa344a
-  data.tar.gz: 254fc51f632a763e49fd0d9483cb28c8265fbda3
+SHA256:
+  metadata.gz: 0b6f6d28a243bad0ffb9e82e9aee4209345b284cd82433783da10a2ebe60c049
+  data.tar.gz: e7c0aea67d734fc21567428df2d46047e2d8484d1f6147dbafcd4f9d280d8466
 SHA512:
-  metadata.gz: c2a19eac87f476a4a3fec5c1646d465d689a36ce5e04782a978d4acd8823823c130e4c26deaa19ac1d78881151c28641f2456f4a41b6c48d8ba21290af0a79e5
-  data.tar.gz: ea0a58a84d5dce2c66e2f3ca9a3f2374d249034c64b54f138aa1bc451ece1a1e31b3d7c69f62f1b5f22227bea2801b27b1a32ed51e7af62193892626eed45097
+  metadata.gz: '02249a8be40ac1ec6590841b217aec8f4cc0f5a5fddd1f563e573820bc50094320aed04b03ebcdcf93e0c4b85d19da8fe0973eaa6f3c586da3702a69ab6f7c08'
+  data.tar.gz: 9b5885a2b02026dc254953ce93024b5a8ac69e576698c6f4a8a42b0b93062bb5011d7c6478498c3bee6635b8a185b795f559591970f122ca81c6e68d7d32b2fb

data/HISTORY.ja.md

@@ -2,6 +2,14 @@ This document is written in Japanese.
 
 # crc for ruby の更新履歴
 
+## crc-0.4.2 (令和2年9月20日 日曜日)
+
+  * "CRC Module" は "CRC Model" とするべきなので修正
+  * 初期値の間違っていた CRC モデルがあったため修正
+  * "calcurator" は "calculator" の誤植なので修正 (thanks @stbnrivas [#2](https://github.com/dearblue/ruby-crc/pull/2))
+  * 間違ったリンクの修正 (thanks @simi [#1](https://github.com/dearblue/ruby-crc/pull/1))
+
+
 ## crc-0.4.1 (平成29年4月1日 土曜日)
 
   * rbcrc -lvv の表示に、ビット反転多項式、相反多項式、初期内部状態、ビット反転魔法数を追加

data/README.ja.md

@@ -0,0 +1,281 @@
+
+# crc - CRC calcurator for ruby
+
+これは Ruby 向けの汎用 CRC (巡回冗長検査; Cyclic Redundancy Check) 算出器です。
+
+“Slicing by 8” アルゴリズムを基にした“バイトオーダーフリーの Slicing by 16 アルゴリズム” を 100% Ruby で記述しています。
+
+CRC モデルとして CRC-32、CRC-32C、CRC-64-XZ、CRC-16、CRC-8-MAXIM、CRC-5-USB ほか多数が最初から組み込まれています。
+
+利用者は、1〜64のビット幅、任意の多項式、および入出力のビット反射の有無に関してカスタマイズが可能です。
+
+このライブラリは FreeBSD 10.3R amd64 上の zlib の `crc32()` よりも 85倍以上遅く、liblzma の `crc32()` よりも 120倍以上低速です。
+
+さらに速度が必要な場合は、[crc-turbo](https://rubygems.org/gems/crc-turbo) と併用してください。
+
+
+## API Guide
+
+この例は CRC-32 モデル (`CRC::CRC32` クラス) を使用しています。
+他の CRC モデルについては脳内変換して下さい。
+
+### 即時的算出
+
+  * `CRC.crc32(seq, init = CRC::CRC32.initial_crc) => crc-32 integer` (likely as `Zlib.crc32`)
+  * `CRC.crc32.crc(seq, init = CRC::CRC32.initial_crc) => crc-32 integer` (likely as `Zlib.crc32`)
+  * `CRC.crc32.digest(seq, init = CRC::CRC32.initial_crc) => crc-32 digest` (likely as `Digest::XXXX.digest`)
+  * `CRC.crc32.hexdigest(seq, init = CRC::CRC32.initial_crc) -> crc-32 hex-digest` (likely as `Digest::XXXX.hexdigest`)
+  * `CRC.crc32[seq, init = CRC::CRC32.initial_crc, current_length = 0] -> crc-32 calcurator`
+
+### 段階的算出 (ストリーミング)
+
+  * `CRC.crc32.new(init = 0, current_length = 0) => crc-32 calcurator`
+  * `CRC::CRC32#update(seq) => self` (likely as `Digest::XXXX.update`)
+  * `CRC::CRC32#finish => crc-32 integer` (likely as `Digest::XXXX.finish`)
+  * `CRC::CRC32#crc => crc-32 integer` (same as `CRC::CRC32#finish`)
+  * `CRC::CRC32#digest => crc-32 digest` (likely as `Digest::XXXX.digest`)
+  * `CRC::CRC32#hexdigest => crc-32 hex-digest` (likely as `Digest::XXXX.hexdigest`)
+
+#### 例
+
+``` ruby:ruby
+x = CRC.crc32.new     # => #<CRC::CRC32:00000000>
+x.update "123"        # => #<CRC::CRC32:884863D2>
+x.update "456789"     # => #<CRC::CRC32:CBF43926>
+x.crc                 # => 3421780262
+x.digest              # => "\xCB\xF49&"
+x.hexdigest           # => "CBF43926"
+```
+
+### CRC 値の結合
+
+  - `CRC.combine(crc1, crc2, len2) => combined crc integer` (likely as `Zlib.crc32_comibne`)
+  - `CRC#+(right_crc) => combined crc calcurator`
+
+`CRC.combine` は Mark Adler 氏による crccomb.c (<https://stackoverflow.com/questions/29915764/generic-crc-8-16-32-64-combine-implementation#29928573>) をそっくり~~パクった~~移植したものです。
+
+#### 例1
+
+``` ruby:ruby
+CRC.crc32.combine(CRC.crc32("123"), CRC.crc32("456789"), 6) # => 3421780262
+```
+
+#### 例2
+
+``` ruby:ruby
+CRC.crc32["123"] + CRC.crc32["456"] + CRC.crc32["789"] # => #<CRC::CRC32:CBF43926>
+```
+
+### 利用者定義 CRC モデルの生成
+
+  * `CRC.new(bitsize, poly, initial_crc = 0, refin = true, refout = true, xor_output = ~0) => new crc model class`
+
+#### 例
+
+``` ruby:ruby
+MyCRC32 = CRC.new(32, 0x04C11DB7)
+MyCRC32.class                     # => Class
+MyCRC32.hexdigest("123456789")    # => "CBF43926"
+MyCRC32["123456789"]              # => #<MyCRC32:CBF43926>
+```
+
+### 逆進 CRC 値の算出
+
+  - `CRC::XXX.acrc(pre, post = nil, want_crc = 0) => arc-crc byte string`
+
+#### 例
+
+``` ruby:ruby
+a = "12"
+c = "789"
+wantcrc = CRC.crc32("123456789")
+b = CRC.crc32.acrc(a, c, wantcrc)   # => "3456"
+CRC.crc32[a + b + c]                # => #<CRC::CRC32:CBF43926>
+```
+
+See CRC::Calcurate.acrc or below for more detail.
+
+
+## 組み込み CRC モデル
+
+```
+$ rbcrc -lq
+```
+
+CRC-1, CRC-3-ROHC, CRC-4-INTERLAKEN, CRC-4-ITU, CRC-5-EPC, CRC-5-ITU, CRC-5-USB, CRC-6-CDMA2000-A, CRC-6-CDMA2000-B, CRC-6-DARC, CRC-6-ITU, CRC-7, CRC-7-ROHC, CRC-7-UMTS, CRC-8-CCITT, CRC-8-MAXIM, CRC-8-DARC, CRC-8-SAE, CRC-8-WCDMA, CRC-8-CDMA2000, CRC-8-DVB-S2, CRC-8-EBU, CRC-8-I-CODE, CRC-8-ITU, CRC-8-LTE, CRC-8-ROHC, CRC-10, CRC-10-CDMA2000, CRC-11, CRC-11-UMTS, CRC-12-CDMA2000, CRC-12-DECT, CRC-12-UMTS, CRC-13-BBC, CRC-14-DARC, CRC-15, CRC-15-MPT1327, CRC-16, CRC-16-AUG-CCITT, CRC-16-CDMA2000, CRC-16-DECT-R, CRC-16-DECT-X, CRC-16-T10-DIF, CRC-16-DNP, CRC-16-BUYPASS, CRC-16-CCITT-FALSE, CRC-16-DDS-110, CRC-16-EN-13757, CRC-16-GENIBUS, CRC-16-LJ1200, CRC-16-MAXIM, CRC-16-MCRF4XX, CRC-16-RIELLO, CRC-16-TELEDISK, CRC-16-TMS37157, CRC-16-USB, CRC-16-A, CRC-16-KERMIT, CRC-16-MODBUS, CRC-16-X-25, CRC-16-XMODEM, CRC-24-Radix-64, CRC-24-OPENPGP, CRC-24-BLE, CRC-24-FLEXRAY-A, CRC-24-FLEXRAY-B, CRC-24-INTERLAKEN, CRC-24-LTE-A, CRC-24-LTE-B, CRC-30-CDMA, CRC-31-PHILIPS, CRC-32, CRC-32-BZIP2, CRC-32C, CRC-32D, CRC-32-MPEG-2, CRC-32-POSIX, CRC-32Q, CRC-32-JAMCRC, CRC-32-XFER, CRC-40-GSM, CRC-64-XZ, CRC-64-JONES, CRC-64-ECMA, CRC-64-WE, CRC-64-ISO
+
+
+## 環境変数
+
+### `RUBY_CRC_NOFAST`
+
+内部処理の実装を変更します。
+
+  - `RUBY_CRC_NOFAST=0`: 可能であれば "crc-turbo" を使います。ライブラリの読み込みが出来なければ、`RUBY_CRC_NOFAST=1` と同じ挙動になります。
+  - `RUBY_CRC_NOFAST=1`: Ruby で実装された“Slicing by 16”アルゴリズムの仕様を強制します。"crc-turbo" は使われません。
+  - `RUBY_CRC_NOFAST=2`: Dilip V. Sarwate 氏によるテーブルアルゴリズムに切り替えます。52% ほどに低速となります (CRC-32 の場合)。
+  - `RUBY_CRC_NOFAST=3`: ビット単位の計算アルゴリズムに切り替えます。`RUBY_CRC_NOFAST=1` と比較して 7% ほどに低速となります (CRC-32 の場合)。
+
+
+## Source code generator for the specific CRC calcurator (from crc-0.3.1)
+
+C・Ruby・javascript 向けの特化した CRC 算出器のソースコード生成機能があります。
+
+アルゴリズムは Ruby および javascript の場合は“Slicing by 16”に限定されます。
+
+Cの場合は、bit-by-bit, bit-by-bit-fast, halfbyte-table, standard-table, slicing-by-4, slicing-by-8, and slicing-by-16 を選択できます。
+
+```
+$ rbcrc --help
+usage: rbcrc [options] output-filename...
+ -m crcname   choose included crc name in library (``-l'' to print list)
+ -n crcname   declare function name or class name [DEFAULT is filename]
+ -s bitsize   declare crc bit size [REQUIRED for customized crc]
+ -p polynom   declare crc polynomial [REQUIRED for customized crc]
+ -c initcrc   declare initial crc (not internal state) [DEFAULT: 0]
+ -S initstate  declare initial state (internal state) [DEFAULT: unset]
+ -x xormask   declare xor bit mask for when output [DEFAULT: ~0]
+ -i           reflect input [DEFAULT]
+ -I           normal input (not reflect)
+ -o           reflect output [DEFAULT]
+ -O           normal output (not reflect)
+ -a algorithm  switch algorithm (see below) (C file type only)
+
+ -l           print crc names
+ -f           force overwrite
+ -v           increment verbosery level
+ -q           quiet mode (reset verbosery level to zero)
+
+About LICENSE for generated source code:
+  Generated code is under Creative Commons License Zero (CC0 / Public Domain).
+  See https://creativecommons.org/publicdomain/zero/1.0/
+
+Algorithms (C file type only):
+  bit-by-bit, bit-by-bit-fast, halfbyte-table, standard-table,
+  slicing-by-4, slicing-by-8, slicing-by-16, slicing-by-{2..999}
+
+Support export file types:
+  * .c for C (support C89, but required ``stdint.h'')
+  * .js for javascript (required ECMAScript 6th edition)
+  * .rb for ruby (for ruby-2.1+, jruby, and rubinius)
+                 (executable for ruby-1.8, ruby-1.9 and ruby-2.0)
+                 (executable for mruby and limitation bitsize by fixnum)
+
+examples:
+  * create crc-32 calcurator to c source (and header file)
+    $ rbcrc crc32.c
+
+  * create crc-32c calcurator to ruby source
+    $ rbcrc crc32c.rb
+
+  * create crc-30-cdma calcurator to javascript source
+    $ rbcrc crc30cdma.js
+
+  * create crc-32 calcurator to ``crc.c'', ``crc.rb'' and ``crc.js''
+    $ rbcrc -mcrc32 crc.c crc.rb crc.js
+
+  * create customized crc calcurator (as mycrc function) to ``mycrc.c''
+    $ rbcrc -s15 -p0x6789 -io -x~0 mycrc.c
+
+  * create customized crc calcurator (as MyCRC class) to ``mycrc_1.rb''
+    $ rbcrc -s39 -p0x987654321 -IO -x1 -nMyCRC mycrc_1.rb
+```
+
+- - - -
+
+また、このコマンドには各 CRC 仕様を YAML 形式で出力する機能もあります。
+
+``` text
+$ rbcrc -lvv
+...snip...
+"CRC-32":
+  bitsize:              32
+  polynomial:           0x04C11DB7  # 0xEDB88320 (bit reflected)
+  reversed reciprocal:  0x82608EDB  # 0xDB710641 (bit reflected)
+  reflect input:        true
+  reflect output:       true
+  initial crc:          0x00000000  # 0xFFFFFFFF (initial state)
+  xor output:           0xFFFFFFFF
+  magic number:         0x2144DF1C  # 0xDEBB20E3 (internal state)
+  another names:
+  - "CRC-32-ADCCP"
+  - "CRC-32-PKZIP"
+  - "PKZIP"
+...snip...
+```
+
+
+## CRC の逆算 (arc-crc)
+
+crc-0.4 にて、任意の CRC となるバイト列を逆算する機能が正式に追加されました。
+
+`require "crc/acrc"` にて、その機能が利用可能となります。
+
+名前の由来は、arc-sin などの C 関数である asin と同様に、arc-crc => acrc となっています。
+
+以下は使用例です。
+
+  * 文字列 "123456789????" を CRC32 した場合に 0 となるような、???? の部分を逆算する
+
+    ``` ruby:ruby
+    require "crc/acrc"
+
+    seq = "123456789"
+    seq << CRC.crc32.acrc(seq)
+    p CRC.crc32[seq] # => #<CRC::CRC32:00000000>
+    ```
+
+  * 文字列 "123456789????ABCDEFG" の、???? の部分を逆算する
+
+    ``` ruby:ruby
+    require "crc/acrc"
+
+    seq1 = "123456789"
+    seq2 = "ABCDEFG"
+    seq = seq1 + CRC.crc32.acrc(seq1, seq2) + seq2
+    p CRC.crc32[seq] # => #<CRC::CRC32:00000000>
+    ```
+
+  * 文字列 "123456789????ABCDEFG" を CRC32 した場合に 0x12345678 となるような、???? の部分を逆算する
+
+    ``` ruby:ruby
+    require "crc/acrc"
+
+    seq1 = "123456789"
+    seq2 = "ABCDEFG"
+    target_crc = 0x12345678
+    seq = seq1 + CRC.crc32.acrc(seq1, seq2, target_crc) + seq2
+    p CRC.crc32[seq] # => #<CRC::CRC32:12345678>
+    ```
+
+  * 独自仕様の CRC モジュールにも対応
+
+    ``` ruby:ruby
+    require "crc/acrc"
+
+    seq1 = "123456789"
+    seq2 = "ABCDEFG"
+    target_crc = 0x12345678
+    MyCRC = CRC.new(29, rand(1 << 29) | 1)
+    seq = seq1 + MyCRC.acrc(seq1, seq2, target_crc) + seq2
+    p MyCRC[seq] # => #<MyCRC:12345678>
+    ```
+
+
+## 諸元
+
+  - package name: crc
+  - author: dearblue (mailto:dearblue@users.noreply.github.com)
+  - report issue to: <https://github.com/dearblue/ruby-crc/issues>
+  - how to install: `gem install crc`
+  - version: 0.4.1
+  - production quality: TECHNICAL PREVIEW
+  - licensing:
+      - ***2 clause BSD License: MAIN LICENSE***
+      - zlib-style License: `lib/crc/_combine.rb`
+      - Creative Commons License Zero (CC0 / Public Domain): `lib/crc/_byruby.rb`, `lib/crc/_models.rb`
+  - dependency gems: none
+  - dependency external C libraries: none
+  - bundled external C libraries: none
+  - installed executable file:
+      - `rbcrc`: CRC calcuration source code generator for c, ruby and javascript

data/README.md

@@ -1,17 +1,17 @@
 
-# crc - CRC calcurator for ruby
+# crc - CRC calculator for ruby
 
-This is a general CRC (Cyclic Redundancy Check) calcurator for ruby.
+This is a generic CRC (Cyclic Redundancy Check) calculator for ruby.
 
 It is written by pure ruby with based on slice-by-eight algorithm (slice-by-16 algorithm with byte-order free).
 
-Included built-in CRC modules are CRC-32, CRC-32C, CRC-64-XZ, CRC-16, CRC-8-MAXIM, CRC-5-USB and many more.
+Included built-in CRC models are CRC-32, CRC-32C, CRC-64-XZ, CRC-16, CRC-8-MAXIM, CRC-5-USB and many more.
 
 Customization is posible for 1 to 64 bit width, any polynomials, and with/without bit reflection input/output.
 
 This library is slower than ×85+ of zlib/crc32, and slower than ×120+ of extlzma/crc32 on FreeBSD 10.3R amd64.
 
-If you need more speed, please use with [crc-turbo](https://rubygems/gems/crc-turbo).
+If you need more speed, please use with [crc-turbo](https://rubygems.org/gems/crc-turbo).
 
 
 ## Summary
@@ -20,34 +20,34 @@ If you need more speed, please use with [crc-turbo](https://rubygems/gems/crc-tu
   * author: dearblue (mailto:dearblue@users.noreply.github.com)
   * report issue to: <https://github.com/dearblue/ruby-crc/issues>
   * how to install: ``gem install crc``
-  * version: 0.4.1
+  * version: 0.4.2
   * production quality: TECHNICAL PREVIEW
   * licensing:
       * ***BSD-2-Clause : MAIN LICENSE***
       * zlib-style License : ``lib/crc/_combine.rb``
-      * Creative Commons License Zero (CC0 / Public Domain) : ``lib/crc/_byruby.rb``, ``lib/crc/_modules.rb``
+      * Creative Commons License Zero (CC0 / Public Domain) : ``lib/crc/_byruby.rb``, ``lib/crc/_models.rb``
   * dependency gems: none
   * dependency external C libraries: none
   * bundled external C libraries: none
   * installed executable file:
-      * rbcrc: CRC calcuration source code generator for c, ruby and javascript
+      * rbcrc: CRC calculation source code generator for c, ruby and javascript
 
 
 ## API Guide
 
-This examples are used CRC-32 module. Please see CRC for more details.
+This examples are used CRC-32 model. Please see CRC for more details.
 
-### Calcurate by direct
+### Calculate by direct
 
   * ``CRC.crc32(seq, init = CRC::CRC32.initial_crc) => crc-32 integer`` (likely as ``Zlib.crc32``)
   * ``CRC.crc32.crc(seq, init = CRC::CRC32.initial_crc) => crc-32 integer`` (likely as ``Zlib.crc32``)
   * ``CRC.crc32.digest(seq, init = CRC::CRC32.initial_crc) => crc-32 digest`` (likely as ``Digest::XXXX.digest``)
   * ``CRC.crc32.hexdigest(seq, init = CRC::CRC32.initial_crc) -> crc-32 hex-digest`` (likely as ``Digest::XXXX.hexdigest``)
-  * ``CRC.crc32[seq, init = CRC::CRC32.initial_crc, current_length = 0] -> crc-32 calcurator``
+  * ``CRC.crc32[seq, init = CRC::CRC32.initial_crc, current_length = 0] -> crc-32 calculator``
 
-### Calcurate by streaming
+### Calculate by streaming
 
-  * ``CRC.crc32.new(init = 0, current_length = 0) => crc-32 calcurator``
+  * ``CRC.crc32.new(init = 0, current_length = 0) => crc-32 calculator``
   * ``CRC::CRC32#update(seq) => self`` (likely as ``Digest::XXXX.update``)
   * ``CRC::CRC32#finish => crc-32 integer`` (likely as ``Digest::XXXX.finish``)
   * ``CRC::CRC32#crc => crc-32 integer`` (same as ``CRC::CRC32#finish``)
@@ -68,7 +68,7 @@ x.hexdigest           # => "CBF43926"
 ### Combine
 
   * ``CRC.combine(crc1, crc2, len2) => combined crc integer`` (likely as ``Zlib.crc32_comibne``)
-  * ``CRC#+(right_crc) => combined crc calcurator``
+  * ``CRC#+(right_crc) => combined crc calculator``
 
 Example-1 ::
 
@@ -82,9 +82,9 @@ Example-2 ::
 CRC.crc32["123"] + CRC.crc32["456"] + CRC.crc32["789"] # => #<CRC::CRC32:CBF43926>
 ```
 
-### Create customized crc module
+### Create customized crc model
 
-  * ``CRC.new(bitsize, poly, initial_crc = 0, refin = true, refout = true, xor_output = ~0) => new crc module class``
+  * ``CRC.new(bitsize, poly, initial_crc = 0, refin = true, refout = true, xor_output = ~0) => new crc model class``
 
 Example ::
 
@@ -95,7 +95,7 @@ MyCRC32.hexdigest("123456789")    # => "CBF43926"
 MyCRC32["123456789"]              # => #<MyCRC32:CBF43926>
 ```
 
-### Calcurate arc-crc
+### Calculate arc-crc
 
   * ``CRC::XXX.acrc(pre, post = nil, want_crc = 0) => arc-crc byte string``
 
@@ -109,10 +109,10 @@ b = CRC.crc32.acrc(a, c, wantcrc)   # => "3456"
 CRC.crc32[a + b + c]                # => #<CRC::CRC32:CBF43926>
 ```
 
-See CRC::Calcurate.acrc or below for more detail.
+See CRC::Calculate.acrc or below for more detail.
 
 
-## Built-in CRC modules
+## Built-in CRC models
 
 ```
 $ rbcrc -lq
@@ -134,9 +134,9 @@ CRC-1, CRC-3-ROHC, CRC-4-INTERLAKEN, CRC-4-ITU, CRC-5-EPC, CRC-5-ITU, CRC-5-USB,
 CRC.combine is ported from Mark Adler's crccomb.c in <https://stackoverflow.com/questions/29915764/generic-crc-8-16-32-64-combine-implementation#29928573>.
 
 
-## Source code generator for the specific CRC calcurator (from crc-0.3.1)
+## Source code generator for the specific CRC calculator (from crc-0.3.1)
 
-Add source code generator for the specific CRC calcurator to c, ruby, and javascript.
+Add source code generator for the specific CRC calculator to c, ruby, and javascript.
 
 Algorithm is slicing-by-16 only for ruby and javascript.
 
@@ -180,22 +180,22 @@ Support export file types:
                  (executable for mruby and limitation bitsize by fixnum)
 
 examples:
-  * create crc-32 calcurator to c source (and header file)
+  * create crc-32 calculator to c source (and header file)
     $ rbcrc crc32.c
 
-  * create crc-32c calcurator to ruby source
+  * create crc-32c calculator to ruby source
     $ rbcrc crc32c.rb
 
-  * create crc-30-cdma calcurator to javascript source
+  * create crc-30-cdma calculator to javascript source
     $ rbcrc crc30cdma.js
 
-  * create crc-32 calcurator to ``crc.c'', ``crc.rb'' and ``crc.js''
+  * create crc-32 calculator to ``crc.c'', ``crc.rb'' and ``crc.js''
     $ rbcrc -mcrc32 crc.c crc.rb crc.js
 
-  * create customized crc calcurator (as mycrc function) to ``mycrc.c''
+  * create customized crc calculator (as mycrc function) to ``mycrc.c''
     $ rbcrc -s15 -p0x6789 -io -x~0 mycrc.c
 
-  * create customized crc calcurator (as MyCRC class) to ``mycrc_1.rb''
+  * create customized crc calculator (as MyCRC class) to ``mycrc_1.rb''
     $ rbcrc -s39 -p0x987654321 -IO -x1 -nMyCRC mycrc_1.rb
 ```
 

data/bin/rbcrc

@@ -108,22 +108,22 @@ Support export file types:
                  (executable for mruby and limitation bitsize by fixnum)
 
 examples:
-  * create crc-32 calcurator to c source (and header file)
+  * create crc-32 calculator to c source (and header file)
     $ rbcrc crc32.c
 
-  * create crc-32c calcurator to ruby source
+  * create crc-32c calculator to ruby source
     $ rbcrc crc32c.rb
 
-  * create crc-30-cdma calcurator to javascript source
+  * create crc-30-cdma calculator to javascript source
     $ rbcrc crc30cdma.js
 
-  * create crc-32 calcurator to ``crc.c'', ``crc.rb'' and ``crc.js''
+  * create crc-32 calculator to ``crc.c'', ``crc.rb'' and ``crc.js''
     $ rbcrc -mcrc32 crc.c crc.rb crc.js
 
-  * create customized crc calcurator (as mycrc function) to ``mycrc.c''
+  * create customized crc calculator (as mycrc function) to ``mycrc.c''
     $ rbcrc -s15 -p0x6789 -io -x~0 mycrc.c
 
-  * create customized crc calcurator (as MyCRC class) to ``mycrc_1.rb''
+  * create customized crc calculator (as MyCRC class) to ``mycrc_1.rb''
     $ rbcrc -s39 -p0x987654321 -IO -x1 -nMyCRC mycrc_1.rb
   EOS
 

data/gemstub.rb

@@ -9,9 +9,9 @@ ver = $1
 GEMSTUB = Gem::Specification.new do |s|
   s.name = "crc"
   s.version = ver
-  s.summary = "general CRC calcurator"
+  s.summary = "generic CRC calculator"
   s.description = <<EOS
-Pure ruby implemented general CRC (Cyclic Redundancy Check) calcurator.
+Pure ruby implemented generic CRC (Cyclic Redundancy Check) calculator.
 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.
 EOS

data/lib/crc.rb

@@ -17,15 +17,15 @@ end
 require_relative "crc/version"
 
 #
-# This is a general CRC calcurator.
+# This is a generic CRC calculator.
 #
-# When you want to use CRC-32 module, there are following ways:
+# When you want to use CRC-32 model, there are following ways:
 #
-# 1. Calcurate CRC-32'd value at direct:
+# 1. Calculate CRC-32'd value at direct:
 #
 #     CRC.crc32("123456789") # => 3421780262
 #
-# 2. Calcurate CRC-32'd hex-digest at direct:
+# 2. Calculate CRC-32'd hex-digest at direct:
 #
 #     CRC::CRC32.hexdigest("123456789") # => "CBF43926"
 #
@@ -51,7 +51,7 @@ class CRC
 
   using Extensions
 
-  module Calcurator
+  module Calculator
     def [](seq, *args)
       c = new(*args)
       c.update(seq) if seq
@@ -157,20 +157,20 @@ class CRC
   #   initialize(initial_crc = nil, size = 0)
   #
   def initialize(initial_crc = nil, size = 0)
-    m = get_crc_module
+    m = get_crc_model
     @state = m.setup((initial_crc || m.initial_crc).to_i)
     @size = size.to_i
   end
 
   def reset(initial_crc = nil, size = 0)
-    m = get_crc_module
+    m = get_crc_model
     @state = m.setup((initial_crc || m.initial_crc).to_i)
     @size = size.to_i
     self
   end
 
   def update(seq)
-    @state = get_crc_module.update(seq, state)
+    @state = get_crc_model.update(seq, state)
     @size += seq.bytesize
     self
   end
@@ -178,15 +178,15 @@ class CRC
   alias << update
 
   def crc
-    get_crc_module.finish(state)
+    get_crc_model.finish(state)
   end
 
   def +(crc2)
-    m1 = get_crc_module
-    m2 = crc2.get_crc_module
+    m1 = get_crc_model
+    m2 = crc2.get_crc_model
     raise ArgumentError, "not a CRC instance (#{crc2.inspect})" unless m2
     unless m2.variant_for?(m1)
-      raise ArgumentError, "different CRC module (#{m1.inspect} and #{m2.inspect})"
+      raise ArgumentError, "different CRC model (#{m1.inspect} and #{m2.inspect})"
     end
     m1.new(m1.combine(crc, crc2.crc, crc2.size), size + crc2.size)
   end
@@ -214,66 +214,70 @@ class CRC
   end
 
   def digest
-    Aux.digest(crc, get_crc_module.bitsize)
+    Aux.digest(crc, get_crc_model.bitsize)
   end
 
   # return digest as internal state
   def digest!
-    Aux.digest(state, get_crc_module.bitsize)
+    Aux.digest(state, get_crc_model.bitsize)
   end
 
   def hexdigest
-    Aux.hexdigest(crc, get_crc_module.bitsize)
+    Aux.hexdigest(crc, get_crc_model.bitsize)
   end
 
   # return hex-digest as internal state
   def hexdigest!
-    Aux.hexdigest(state, get_crc_module.bitsize)
+    Aux.hexdigest(state, get_crc_model.bitsize)
   end
 
   alias to_str hexdigest
   alias to_s hexdigest
 
   def inspect
-    "\#<#{get_crc_module}:#{hexdigest}>"
+    "\#<#{get_crc_model}:#{hexdigest}>"
   end
 
   def pretty_inspect(q)
     q.text inspect
   end
 
-  MODULE_TABLE = {}
+  MODEL_TABLE = {}
 
   class << self
-    def lookup(modulename)
-      modulename1 = modulename.to_s.gsub(/[\W_]+/, "")
-      modulename1.downcase!
-      MODULE_TABLE[modulename1] or raise NameError, "modulename is not matched (for #{modulename})"
+    def lookup(modelname)
+      modelname1 = modelname.to_s.gsub(/[\W_]+/, "")
+      modelname1.downcase!
+      MODEL_TABLE[modelname1] or raise NameError, "modelname is not matched (for #{modelname})"
     end
 
     alias [] lookup
 
-    def crc(modulename, seq, crc = nil)
-      lookup(modulename).crc(seq, crc)
+    def crc(modelname, seq, crc = nil)
+      lookup(modelname).crc(seq, crc)
     end
 
-    def digest(modulename, seq, crc = nil)
-      lookup(modulename).digest(seq, crc)
+    def digest(modelname, seq, crc = nil)
+      lookup(modelname).digest(seq, crc)
     end
 
-    def hexdigest(modulename, seq, crc = nil)
-      lookup(modulename).hexdigest(seq, crc)
+    def hexdigest(modelname, seq, crc = nil)
+      lookup(modelname).hexdigest(seq, crc)
     end
   end
 
-  require_relative "crc/_modules"
+  # NOTE: "Calcurator" は typo ですが、後方互換のため一時的に残します。
+  # TODO: CRC::Calcurator はいずれ削除されます。
+  CRC::Calcurator = CRC::Calculator
+
+  require_relative "crc/_models"
   require_relative "crc/_combine"
   require_relative "crc/_shift"
   require_relative "crc/_magic"
   require_relative "crc/_file"
 
   #
-  # Create CRC module classes.
+  # Create CRC model classes.
   #
   LIST.each do |bitsize, polynomial, refin, refout, initial_crc, xor, check, *names|
     names.flatten!
@@ -284,10 +288,10 @@ class CRC
 
     names.each do |nm|
       nm1 = nm.downcase.gsub(/[\W_]+/, "")
-      if MODULE_TABLE.key?(nm1)
-        raise NameError, "collision crc-module name: #{nm} ({#{crc.to_str}} and {#{MODULE_TABLE[nm1].to_str}})"
+      if MODEL_TABLE.key?(nm1)
+        raise NameError, "collision crc-model name: #{nm} ({#{crc.to_str}} and {#{MODEL_TABLE[nm1].to_str}})"
       end
-      MODULE_TABLE[nm1] = crc
+      MODEL_TABLE[nm1] = crc
 
       name = nm.sub(/(?<=\bCRC)-(?=\d+)/, "").gsub(/[\W]+/, "_")
       const_set(name, crc)

data/lib/crc/_byruby.rb

@@ -9,7 +9,7 @@
 #
 # \* \* \* \* \* \* \* \*
 #
-# Pure ruby implemented general CRC calcurator.
+# Pure ruby implemented generic CRC calculator.
 # It's used slice-by-16 algorithm with byte-order free.
 # This is based on the Intel's slice-by-eight algorithm.
 #
@@ -27,8 +27,8 @@ class CRC
   class << self
     #
     # call-seq:
-    #   new(bitsize, polynomial, initial_crc = 0, reflect_input = true, reflect_output = true, xor_output = ~0, name = nil) -> new crc module class (CRC based class)
-    #   new(initial_crc = nil, size = 0) -> new crc calcurator (CRC instance)
+    #   new(bitsize, polynomial, initial_crc = 0, reflect_input = true, reflect_output = true, xor_output = ~0, name = nil) -> new crc model class (CRC based class)
+    #   new(initial_crc = nil, size = 0) -> new crc calculator (CRC instance)
     #
     def new(bitsize, polynomial, initial_crc = 0, reflect_input = true, reflect_output = true, xor_output = ~0, name = nil)
       bitsize = bitsize.to_i
@@ -56,7 +56,7 @@ class CRC
         # CRC クラスを普通に派生させた場合でも、CRC.new の基底メソッドが呼ばれるための細工
         define_singleton_method(:new, &Class.instance_method(:new).bind(self))
 
-        extend CRC::Calcurator
+        extend CRC::Calculator
       end
     end
 
@@ -254,7 +254,7 @@ class CRC
     end
   end
 
-  module Calcurator
+  module Calculator
     attr_reader :bitsize, :bitmask, :polynomial, :initial_crc,
                 :reflect_input, :reflect_output, :xor_output, :name
 

data/lib/crc/_extensions.rb

@@ -91,7 +91,7 @@ class CRC
     refine CRC do
       def convert_internal_state_for(crc)
         unless crc.variant?(self)
-          raise "not variant crc module (expect #{crc.to_s}, but self is #{inspect})"
+          raise "not variant crc model (expect #{crc.to_s}, but self is #{inspect})"
         end
 
         state
@@ -99,7 +99,7 @@ class CRC
 
       def convert_target_state_for(crc)
         unless crc.variant?(self)
-          raise "not variant crc module (expect #{crc.to_s}, but self is #{inspect})"
+          raise "not variant crc model (expect #{crc.to_s}, but self is #{inspect})"
         end
 
         state
@@ -168,12 +168,12 @@ class CRC
     end
 
     # refinements:
-    # * get_crc_module
+    # * get_crc_model
     # * variant_for?
     ;
 
     refine BasicObject do
-      def get_crc_module
+      def get_crc_model
         nil
       end
 
@@ -183,18 +183,18 @@ class CRC
     end
 
     refine CRC do
-      alias get_crc_module class
+      alias get_crc_model class
 
       def variant_for?(m)
-        get_crc_module.variant_for?(m)
+        get_crc_model.variant_for?(m)
       end
     end
 
     refine CRC.singleton_class do
-      alias get_crc_module itself
+      alias get_crc_model itself
 
       def variant_for?(m)
-        return false unless m = m.get_crc_module
+        return false unless m = m.get_crc_model
 
         if bitsize == m.bitsize &&
            polynomial == m.polynomial &&

data/lib/crc/_file.rb

@@ -7,7 +7,7 @@ class CRC
     self
   end
 
-  module Calcurator
+  module Calculator
     def file(path, *args)
       new(*args).file(path)
     end

data/lib/crc/_magic.rb

@@ -35,8 +35,8 @@ class CRC
 
     refine CRC do
       def to_magicdigest_for(m)
-        unless m.variant?(get_crc_module)
-          raise TypeError, "different crc type - #{get_crc_module.inspect} (expect #{m.inspect})", caller
+        unless m.variant?(get_crc_model)
+          raise TypeError, "different crc type - #{get_crc_model.inspect} (expect #{m.inspect})", caller
         end
 
         magicdigest
@@ -45,7 +45,7 @@ class CRC
 
     refine BasicObject do
       def to_magicdigest_for(m)
-        raise TypeError, "cant convert type - #{get_crc_module}", caller
+        raise TypeError, "cant convert type - #{get_crc_model}", caller
       end
     end
 
@@ -60,7 +60,7 @@ class CRC
 
   using CRC::Extensions
 
-  module Calcurator
+  module Calculator
     def magicnumber
       @magicnumber = crc(__cached_magic_code__)
       singleton_class.class_eval { attr_reader :magicnumber }
@@ -88,6 +88,6 @@ class CRC
   end
 
   def magicdigest
-    crc.to_magicdigest_for(get_crc_module)
+    crc.to_magicdigest_for(get_crc_model)
   end
 end

data/lib/crc/{_modules.rb → _models.rb}

@@ -78,11 +78,11 @@ class CRC
     [16,             0x6F63, false, false,          0,      0,             0xBDF4, "CRC-16-LJ1200"],
     [16,             0x8005,  true,  true,         ~0,     ~0,             0x44C2, "CRC-16-MAXIM"],
     [16,             0x1021,  true,  true,         ~0,      0,             0x6F91, "CRC-16-MCRF4XX"],
-    [16,             0x1021,  true,  true,     0xB2AA,      0,             0x63D0, "CRC-16-RIELLO"],
+    [16,             0x1021,  true,  true,     0x554D,      0,             0x63D0, "CRC-16-RIELLO"],
     [16,             0xA097, false, false,          0,      0,             0x0FB3, "CRC-16-TELEDISK"],
-    [16,             0x1021,  true,  true,     0x89EC,      0,             0x26B1, "CRC-16-TMS37157"],
+    [16,             0x1021,  true,  true,     0x3791,      0,             0x26B1, "CRC-16-TMS37157"],
     [16,             0x8005,  true,  true,          0,     ~0,             0xB4C8, "CRC-16-USB"],
-    [16,             0x1021,  true,  true,     0xC6C6,      0,             0xBF05, "CRC-16-A", "CRC-A", "CRC-16-ISO/IEC FCD 14443-3"],
+    [16,             0x1021,  true,  true,     0x6363,      0,             0xBF05, "CRC-16-A", "CRC-A", "CRC-16-ISO/IEC FCD 14443-3"],
     [16,             0x1021,  true,  true,          0,      0,             0x2189, "CRC-16-KERMIT", "KERMIT", "CRC-16-CCITT", "CRC-16-CCITT-TRUE", "CRC-CCITT"],
     [16,             0x8005,  true,  true,         ~0,      0,             0x4B37, "CRC-16-MODBUS", "MODBUS"],
     [16,             0x1021,  true,  true,          0,     ~0,             0x906E, "CRC-16-X-25", "X-25", "CRC-16-IBM-SDLC", "CRC-16-ISO-HDLC", "CRC-16-CRC-B", "CRC-B"],
@@ -92,7 +92,7 @@ class CRC
     #[24,         0x005D6DCB, false, false,          0,      0,                nil, "CRC-24"],
     [24,         0x00864CFB, false, false,          0,      0,         0x00CDE703, "CRC-24-Radix-64"],
     [24,         0x00864CFB, false, false, 0x00B704CE,      0,         0x0021CF02, "CRC-24-OPENPGP"],
-    [24,         0x0000065B,  true,  true, 0x00555555,      0,         0x00C25A56, "CRC-24-BLE"],
+    [24,         0x0000065B,  true,  true, 0x00AAAAAA,      0,         0x00C25A56, "CRC-24-BLE"],
     [24,         0x005D6DCB, false, false, 0x00FEDCBA,      0,         0x007979BD, "CRC-24-FLEXRAY-A"],
     [24,         0x005D6DCB, false, false, 0x00ABCDEF,      0,         0x001F23B8, "CRC-24-FLEXRAY-B"],
     [24,         0x00328B63, false, false,          0,     ~0,         0x00B4F3E6, "CRC-24-INTERLAKEN"],

data/lib/crc/_shift.rb

@@ -3,7 +3,7 @@ require_relative "_extensions"
 class CRC
   using Extensions
 
-  module Calcurator
+  module Calculator
     #
     # call-seq:
     #   shiftbits_by_bitbybit(bitset, state) -> state

data/lib/crc/acrc.rb

@@ -5,7 +5,7 @@ require_relative "../crc"
 class CRC
   using CRC::Extensions
 
-  module Calcurator
+  module Calculator
     #
     # call-seq:
     #   acrc(pre, post = nil, targetcrc = 0) -> byte string as arc-code

data/lib/crc/version.rb

@@ -1,5 +1,5 @@
 #!ruby
 
 class CRC
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/test/common.rb

@@ -7,14 +7,14 @@ require "optparse"
 alltest = false
 opt = OptionParser.new(nil, 12, " ")
 opt.instance_eval do
-  on("--all", "test all crc modules") { alltest = true }
+  on("--all", "test all crc models") { alltest = true }
   order!
 end
 
 if alltest
-  $testmodules = CRC::MODULE_TABLE.values.uniq
+  $testmodels = CRC::MODEL_TABLE.values.uniq
 else
-  $testmodules = %w(
+  $testmodels = %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

data/test/self_check.rb

@@ -1,9 +1,9 @@
 require "crc"
 
-$stderr.puts "#{__FILE__}:#{__LINE__}: SELF CHECK for CRC modules (#{File.basename($".grep(/_(?:byruby|turbo)/)[0]||"")})\n"
+$stderr.puts "#{__FILE__}:#{__LINE__}: SELF CHECK for CRC models (#{File.basename($".grep(/_(?:byruby|turbo)/)[0]||"")})\n"
 
 class CRC
-  MODULE_TABLE.values.uniq.each do |crc|
+  MODEL_TABLE.values.uniq.each do |crc|
     check = crc::CHECK
     checked = crc.crc("123456789")
     case check

data/test/test_arc.rb

@@ -7,7 +7,7 @@ require "crc/acrc"
 require "securerandom"
 
 class TestArcCRC < Test::Unit::TestCase
-  $testmodules.each do |crc|
+  $testmodels.each do |crc|
     class_eval(<<-"EOS", __FILE__, __LINE__ + 1)
       def test_arc_#{crc.to_s.slice(/\w+$/)}
         crc = #{crc}

data/test/test_block.rb

@@ -5,7 +5,7 @@ require "crc"
 require_relative "common"
 
 class TestCRC < Test::Unit::TestCase
-  $testmodules.each do |crc|
+  $testmodels.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+$/)}

data/test/test_magic.rb

@@ -5,7 +5,7 @@ require "crc"
 require_relative "common"
 
 class TestCRCMagic < Test::Unit::TestCase
-  $testmodules.each do |crc|
+  $testmodels.each do |crc|
     next unless crc.const_defined?(:CHECK) && crc::CHECK
     name = crc.to_s.slice(/\w+$/)
     class_eval(<<-"TESTCODE", __FILE__, __LINE__ + 1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crc
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - dearblue
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12'
 description: |
-  Pure ruby implemented general CRC (Cyclic Redundancy Check) calcurator.
+  Pure ruby implemented generic CRC (Cyclic Redundancy Check) calculator.
   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.noreply.github.com
@@ -36,6 +36,7 @@ extensions: []
 extra_rdoc_files:
 - HISTORY.ja.md
 - LICENSE
+- README.ja.md
 - README.md
 - lib/crc.rb
 - lib/crc/_aux.rb
@@ -44,7 +45,7 @@ extra_rdoc_files:
 - lib/crc/_extensions.rb
 - lib/crc/_file.rb
 - lib/crc/_magic.rb
-- lib/crc/_modules.rb
+- lib/crc/_models.rb
 - lib/crc/_shift.rb
 - lib/crc/_utils.rb
 - lib/crc/acrc.rb
@@ -54,6 +55,7 @@ extra_rdoc_files:
 files:
 - HISTORY.ja.md
 - LICENSE
+- README.ja.md
 - README.md
 - Rakefile
 - benchmark.rb
@@ -67,7 +69,7 @@ files:
 - lib/crc/_extensions.rb
 - lib/crc/_file.rb
 - lib/crc/_magic.rb
-- lib/crc/_modules.rb
+- lib/crc/_models.rb
 - lib/crc/_shift.rb
 - lib/crc/_utils.rb
 - lib/crc/acrc.rb
@@ -85,7 +87,7 @@ licenses:
 - Zlib
 - CC0-1.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset"
 - UTF-8
@@ -104,9 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
-summary: general CRC calcurator
+summary: generic CRC calculator
 test_files: []