crcs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 715a18e23f830edb25d180f89c2e3dd42826a799
+  data.tar.gz: 117c739f0113b25e7fc016e0989cef568b4090ca
+SHA512:
+  metadata.gz: 214a0ba671a70b6d275cf0dbe2516c254ddb28a053205980de7f98ad75abb3d0d7d800da59a68fcea3eb94eef893f385fdf91c14ecc7674521f52a1424b68d82
+  data.tar.gz: c20a504b9d6bc31ccf631ba03ea697af6a5068d51276e70932569a4fbdca169eb221df034a67bd5910082578255ef8ecb6506ead03b9058668ad5259e9295084

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,70 @@
+# Crcs
+
+This gem provides C extension for calculating CRC32 digests. It's based on
+table-driven slice-by-8 CRC32 algorithm.
+
+## Installation
+
+Nothing special. Simply run
+
+```
+gem install crcs
+```
+
+or add folowing line to your Gemfile
+
+```ruby
+gem 'crcs'
+```
+
+## Using
+
+This gem integrates to Ruby Digest module. This way you can easily use
+all methods that this module provides. Just use `Digest::CRC32` class after
+requiring gem into your code. For example:
+
+```ruby
+# Generate hexdigest for sample string
+Digest::CRC32.hexdigest('Your data')
+# or
+crc32 = Digest::CRC32.new
+crc32 << 'Data'
+crc32 << 'More data'
+crc32.hexdigest
+
+# Generate file digest
+Digest::CRC32.file('filename.txt').hexdigest
+```
+
+## Performance
+
+Let's compare this gem with few others:
+* [crc32](https://github.com/tdobrovolskij/crc32) which provides C extension with
+the same algorithm but without all that fancy Digest module staff. It has only one method
+`calculate`. So you should care about previous crc32 digests and data length by yourself
+* Standard zlib ruby implementation
+* [digest-crc](https://github.com/postmodern/digest-crc) which is pure Ruby
+implementation of few CRC-algorithms
+
+### Benchmarking method
+
+First of all we will create a string with random data provided by `SecureRandom.random_bytes`.
+I choosed variable with 5 megabytes of random bytes
+Next let's create digest for that string 1000 times by each of gems.
+
+*All benchmarks performed on MacBook Pro 15 mid 2015 with 2,2 GHz Intel Core i7*
+
+### Results
+
+```
+                           user      system     total       real
+crcs                    12.660000   0.030000  12.690000 ( 12.709954)
+tdobrovolskij/crc32      3.550000   0.010000   3.560000 (  3.574127)
+zlib                     0.470000   0.000000   0.470000 (  0.471863)
+postmodern/digest-crc  947.670000   1.330000 949.000000 (950.414528)
+```
+For some reasons my gem is terribly slower than crc32 and zlib libraries. I think
+it's caused by overhead of creating digest objects and other things that happening inside
+of that module. Maybe I should extract my code to separate class and try again?
+Fortunately, as you can see, my gem isn't so bad comparing with pure ruby implementation.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('crc32') do |ext|
+  ext.ext_dir = 'ext/digest/crc32'
+  ext.lib_dir = 'lib/digest'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(spec: :compile)
+
+task default: :spec

data/crcs.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'digest/crc32/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'crcs'
+  spec.version       = Digest::CRC32::VERSION
+  spec.authors       = ['Nikolay Norkin']
+  spec.email         = ['n.e.norkin@gmail.com']
+
+  spec.summary       = 'CRC32 implementation for Ruby'
+  spec.description   = 'This gem contains C extension for calculating CRC32'
+  spec.homepage      = 'https://github.com/duderman/crcs'
+  spec.licenses      = ['MIT']
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|benchmark)}) }
+  spec.extensions    = ['ext/digest/crc32/extconf.rb']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler', '~> 0.9'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/ext/digest/crc32/crc32.c

@@ -0,0 +1,150 @@
+#include "digest.h"
+#include "crc32.h"
+
+static const unsigned long crc_table[256] = {
+    0x00000000, 0x77073096, 0xee0e612c, 0x990951ba,
+    0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
+    0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
+    0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91,
+    0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
+    0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
+    0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec,
+    0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5,
+    0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
+    0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
+    0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940,
+    0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
+    0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116,
+    0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f,
+    0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
+    0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d,
+    0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a,
+    0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
+    0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818,
+    0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
+    0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
+    0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457,
+    0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c,
+    0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
+    0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
+    0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb,
+    0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
+    0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9,
+    0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086,
+    0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
+    0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4,
+    0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad,
+    0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
+    0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683,
+    0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
+    0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
+    0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe,
+    0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7,
+    0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
+    0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
+    0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252,
+    0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
+    0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60,
+    0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79,
+    0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
+    0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f,
+    0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04,
+    0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
+    0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a,
+    0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
+    0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
+    0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21,
+    0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e,
+    0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
+    0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
+    0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45,
+    0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
+    0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db,
+    0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0,
+    0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
+    0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6,
+    0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf,
+    0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
+    0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
+};
+
+int
+CRC32_Init(CRC32_CTX *pms)
+{
+    pms->count[0] = pms->count[1] = 0;
+    pms->state[0] = 0xFFFFFFFF;
+
+    return 1;
+}
+
+void
+CRC32_Update(CRC32_CTX *pms, const uint8_t *data, size_t nbytes)
+{
+    register uint32_t crc = pms->state[0];
+    register const uint8_t *p = data;
+    uint32_t nbits = (uint32_t)(nbytes << 3);
+    uint32_t tbl_idx;
+
+    if (nbytes <= 0)
+      return;
+
+    /* Update the message length. */
+    pms->count[1] += nbytes >> 29;
+    pms->count[0] += nbits;
+    if (pms->count[0] < nbits)
+      pms->count[1]++;
+
+    /* Update */
+    while (nbytes--) {
+        tbl_idx = (crc ^ *p) & 0xff;
+        crc = (crc_table[tbl_idx] ^ (crc >> 8)) & 0xffffffff;
+
+        p++;
+    }
+    crc &= 0xffffffff;
+
+    pms->state[0] = crc;
+}
+
+int
+CRC32_Finish(CRC32_CTX *pms, uint8_t *digest)
+{
+  register uint32_t crc = pms->state[0] ^ 0xFFFFFFFF;
+  register int i;
+
+  for (i = 3; i >= 0; i--)
+    {
+      digest[i] = (uint8_t)(crc & 0xFF);
+      crc = crc >> 8;
+    }
+
+  return 1;
+}
+
+static const rb_digest_metadata_t crc32 = {
+    RUBY_DIGEST_API_VERSION,
+    CRC32_DIGEST_LENGTH,
+    CRC32_BLOCK_LENGTH,
+    sizeof(CRC32_CTX),
+    (rb_digest_hash_init_func_t)CRC32_Init,
+    (rb_digest_hash_update_func_t)CRC32_Update,
+    (rb_digest_hash_finish_func_t)CRC32_Finish,
+};
+
+void
+Init_crc32(void)
+{
+    VALUE mDigest, cDigest_Base, cDigest_CRC32;
+
+    rb_require("digest.so");
+
+    mDigest = rb_path2class("Digest");
+    cDigest_Base = rb_path2class("Digest::Base");
+
+    cDigest_CRC32 = rb_define_class_under(mDigest, "CRC32", cDigest_Base);
+
+    rb_cvar_set(cDigest_CRC32, rb_intern("metadata"),
+        Data_Wrap_Struct(rb_cObject, 0, 0, &crc32));
+}
+
+

data/ext/digest/crc32/crc32.h

@@ -0,0 +1,25 @@
+#ifndef CRC32_INCLUDED
+#  define CRC32_INCLUDED
+
+#include "defs.h"
+
+typedef struct crc32_state_s {
+    uint32_t count[2];	/* message length in bits, lsw first */
+    uint32_t state[1];	/* digest buffer */
+} CRC32_CTX;
+
+#ifdef RUBY
+#define CRC32_Init	rb_Digest_CRC32_Init
+#define CRC32_Update	rb_Digest_CRC32_Update
+#define CRC32_Finish	rb_Digest_CRC32_Finish
+#endif
+
+int	CRC32_Init _((CRC32_CTX *pms));
+void CRC32_Update _((CRC32_CTX *pms, const uint8_t *data, size_t nbytes));
+int	CRC32_Finish _((CRC32_CTX *pms, uint8_t *digest));
+
+#define CRC32_BLOCK_LENGTH 64
+#define CRC32_DIGEST_LENGTH 4
+#define CRC32_DIGEST_STRING_LENGTH	(CRC32_DIGEST_LENGTH * 2 + 1)
+
+#endif /* CRC32_INCLUDED */

data/ext/digest/crc32/defs.h

@@ -0,0 +1,33 @@
+#ifndef DEFS_H
+#define DEFS_H
+
+#include "ruby.h"
+#include <sys/types.h>
+
+#if defined(HAVE_SYS_CDEFS_H)
+# include <sys/cdefs.h>
+#endif
+#if !defined(__BEGIN_DECLS)
+# define __BEGIN_DECLS
+# define __END_DECLS
+#endif
+
+#if defined(HAVE_INTTYPES_H)
+# include <inttypes.h>
+#else
+  typedef unsigned char uint8_t;
+  typedef unsigned int  uint32_t;
+# if SIZEOF_LONG == 8
+  typedef unsigned long uint64_t;
+# elif defined(__GNUC__)
+  typedef unsigned long long uint64_t;
+# elif defined(_MSC_VER)
+  typedef unsigned _int64 uint64_t;
+# elif defined(__BORLANDC__)
+  typedef unsigned __int64 uint64_t;
+# else
+#  define NO_UINT64_T
+# endif
+#endif
+
+#endif /* DEFS_H */

data/ext/digest/crc32/digest.h

@@ -0,0 +1,35 @@
+#include "ruby.h"
+
+#define RUBY_DIGEST_API_VERSION 3
+
+typedef int (*rb_digest_hash_init_func_t)(void *);
+typedef void (*rb_digest_hash_update_func_t)(void *, unsigned char *, size_t);
+typedef int (*rb_digest_hash_finish_func_t)(void *, unsigned char *);
+
+typedef struct {
+    int api_version;
+    size_t digest_len;
+    size_t block_len;
+    size_t ctx_size;
+    rb_digest_hash_init_func_t init_func;
+    rb_digest_hash_update_func_t update_func;
+    rb_digest_hash_finish_func_t finish_func;
+} rb_digest_metadata_t;
+
+#define DEFINE_UPDATE_FUNC_FOR_UINT(name) \
+void \
+rb_digest_##name##_update(void *ctx, unsigned char *ptr, size_t size) \
+{ \
+    const unsigned int stride = 16384; \
+ \
+    for (; size > stride; size -= stride, ptr += stride) { \
+  name##_Update(ctx, ptr, stride); \
+    } \
+    if (size > 0) name##_Update(ctx, ptr, size); \
+}
+
+#define DEFINE_FINISH_FUNC_FROM_FINAL(name) \
+int \
+rb_digest_##name##_finish(void *ctx, unsigned char *ptr) \
+{ \
+    return name##_Final(ptr, ctx); \

data/ext/digest/crc32/extconf.rb

@@ -0,0 +1,11 @@
+require 'mkmf'
+
+$defs << "-DHAVE_CONFIG_H"
+$INCFLAGS << " -I$(srcdir)/.. -I$(hdrdir)/ruby"
+
+$objs = [ "crc32.#{$OBJEXT}" ]
+
+have_header('inttypes.h')
+have_header('ruby/digest.h')
+
+create_makefile('digest/crc32')

data/lib/crcs.rb

@@ -0,0 +1,3 @@
+require 'digest/crc32.so'
+
+require 'digest/crc32/version'

data/lib/digest/crc32/version.rb

@@ -0,0 +1 @@
+Digest::CRC32::VERSION = '0.1.0'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: crcs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikolay Norkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem contains C extension for calculating CRC32
+email:
+- n.e.norkin@gmail.com
+executables: []
+extensions:
+- ext/digest/crc32/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- crcs.gemspec
+- ext/digest/crc32/crc32.c
+- ext/digest/crc32/crc32.h
+- ext/digest/crc32/defs.h
+- ext/digest/crc32/digest.h
+- ext/digest/crc32/extconf.rb
+- lib/crcs.rb
+- lib/digest/crc32/version.rb
+homepage: https://github.com/duderman/crcs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: CRC32 implementation for Ruby
+test_files: []