digest-crc 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f6be5490751ab763c1fdd99f95a2e4ae0a22a073969623f14170159cb55c5b0
-  data.tar.gz: 7f152d312932b784ce074ce9d463bf07dd2bccf5035d9b1bc98dd8c804daa377
+  metadata.gz: 2d9232bc15248414404921523bad56602e83532f5d8d783c1f90bcbaaec045cd
+  data.tar.gz: 0e33fbe550c55afb0c56a9dce895f584a0eacc2d2957d00008b72338effcd03b
 SHA512:
-  metadata.gz: 0e9e53d3fc14577e50276ea0f13b663bf62fcafbc2a063491e076bdec99d467f0c57ad0d0cb5b794af1dbadc6794db4070cb6d956b13f4525c5c30af3dea618b
-  data.tar.gz: '07198de582c8e350def1763a6c2593ad8a42065c675826c278e3326e81d1a1960b613879a7df017727e12cdc4a4ffc36c15350108a3f6d87076e1f28e4d81afe'
+  metadata.gz: f6d6969231e3e6f5ffe90d97627f7e39e318713355009d2848d89e289aeae873a452865d4e34be9871fcc8d4d7725f369ab11dde24c45135ec610519b52c76a6
+  data.tar.gz: 562a7d60009f5ec9fe29ca8aa6555bed1607d7659b2903e3f2efcfb9f12e331e22e0ed370056c7f6d03f8443c282c2659b2192e259880510913c803380edaa5a

data/.github/workflows/integration.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    tags: [ 'v0.*' ]
+  pull_request:
+    paths: [ 'ext/**' ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    name: Integration Testing
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Docker
+        uses: docker-practice/actions-setup-docker@master
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run integration tests
+        run: bundle exec rake spec:integration

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - jruby
+    name: OS ${{ matrix.os }} / Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake spec

data/.gitignore

@@ -8,3 +8,4 @@ pkg
 /ext/digest/crc*/extconf.h
 /ext/digest/crc*/*.o
 /ext/digest/crc*/*.so
+/spec/integration/docker/digest-crc.gem

data/ChangeLog.md

@@ -1,3 +1,13 @@
+### 0.6.2 / 2020-12-03
+
+* Lower the rake dependency to `~> 12.0` for ruby 2.6.
+* Fixed a bug in `ext/digest/Rakefile` which prevented digest-crc from being
+  installed on systems where C extensions could not be successfully compiled.
+  * Rake's `ruby` method, which in turn calls rake's `sh` method, raises
+    a `RuntimeError` exception when the ruby command fails, causing rake to
+    exit with an error code. Instead, rescue any `RuntimeError` exceptions and
+    fail gracefully.
+
 ### 0.6.1 / 2020-07-02
 
 * Fix installation issues under bundler by adding rake as an explicit dependency

data/README.md

@@ -54,6 +54,24 @@ module.
 gem install digest-crc
 ```
 
+**Note:** to enable the C extensions ensure that you are using CRuby and have
+a C compiler (`gcc` or `clang`) and `make` installed, _before_ installing
+digest-crc.
+
+* Debian / Ubuntu:
+
+      $ sudo apt install gcc make
+
+* RedHat / Fedora:
+
+      $ sudo dnf install gcc make
+
+* Alpine Linux:
+
+      $ apk add build-base
+
+* macOS: install XCode
+
 ## Examples
 
 Calculate a CRC32:
@@ -157,7 +175,7 @@ end
     Digest::CRC64XZ#update  3.019690   0.000000   3.019690 (  3.040971)
 
 ### C extensions (ruby 2.7.1)
-o
+
     $ bundle exec rake build:c_exts
     ...
     $ bundle exec ./benchmarks.rb

data/Rakefile

@@ -23,19 +23,32 @@ CLEAN.include('ext/digest/crc*/Makefile')
 CLEAN.include('ext/digest/crc*/*.o')
 CLEAN.include('ext/digest/crc*/*.so')
 
+file 'spec/integration/docker/digest-crc.gem' do |t|
+  sh "gem build -o #{t.name} digest-crc.gemspec"
+end
+
 require 'rspec/core/rake_task'
 namespace :spec do
-  RSpec::Core::RakeTask.new(:pure)
+  RSpec::Core::RakeTask.new(:pure) do |t|
+    t.exclude_pattern = 'spec/integration/*_spec.rb'
+  end
   task :pure => :clean
 
   if RUBY_ENGINE == 'ruby'
-    RSpec::Core::RakeTask.new(:c_exts)
+    RSpec::Core::RakeTask.new(:c_exts) do |t|
+      t.exclude_pattern = 'spec/integration/*_spec.rb'
+    end
     task :c_exts => 'build:c_exts'
   end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/*_spec.rb'
+  end
 end
 
 task :spec => 'spec:pure'
 task :spec => 'spec:c_exts' if RUBY_ENGINE == 'ruby'
+
 task :test => :spec
 task :default => :spec
 

data/ext/digest/Rakefile

@@ -13,14 +13,6 @@ rescue LoadError
   fail_gracefully "mkmf is not installed"
 end
 
-MAKE = $make # set by mkmf
-       
-def make(target=nil)
-  if target then sh(MAKE,target)
-  else           sh(MAKE)
-  end
-end
-
 CRCS  = Dir['crc*']
 DLEXT = MakeMakefile::CONFIG['DLEXT']
 
@@ -29,7 +21,9 @@ CRCS.each do |crc|
 
   file "#{crc}/Makefile" => "#{crc}/extconf.rb" do
     Dir.chdir(crc) do
-      unless ruby('-S', 'extconf.rb')
+      begin
+        ruby '-S', 'extconf.rb'
+      rescue
         fail_gracefully "extconf.rb failed"
       end
     end
@@ -39,9 +33,10 @@ CRCS.each do |crc|
 
   file "#{crc}/#{crc_ext_lib}" => "#{crc}/Makefile" do
     Dir.chdir(crc) do
-      make 'clean'
-
-      unless make
+      begin
+        sh 'make', 'clean'
+        sh 'make'
+      rescue
         fail_gracefully "Unable to build C extensions"
       end
     end

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: digest-crc
-version: 0.6.1
+version: 0.6.2
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.
 description:
   Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
@@ -21,8 +21,8 @@ extensions:
 
 has_yard: true
 
+dependencies:
+  rake: ~> 12.0
+
 development_dependencies:
   bundler: ~> 2.0
-
-dependencies:
-  rake: ~> 13.0

data/lib/digest/crc16_qt.rb

@@ -6,5 +6,6 @@ module Digest
   #
   # @note Is exactly the same as the CRC16 X-25 algorithm.
   #
-  CRC16QT = CRC16X25
+  class CRC16QT < CRC16X25
+  end
 end

data/spec/crc16_qt_spec.rb

@@ -5,6 +5,6 @@ describe "Digest::CRC16QT" do
   subject { Digest::CRC16QT }
 
   it "should be an alias to Digest::CRC16X25" do
-    expect(subject).to be(Digest::CRC16X25)
+    expect(subject).to be < Digest::CRC16X25
   end
 end

data/spec/integration/docker/Dockerfile.base

@@ -0,0 +1,9 @@
+ARG RUBY_VERSION=2.7.0
+FROM ruby:${RUBY_VERSION}-slim
+
+RUN apt-get update -y -qq
+RUN apt-get install -y -qq bash
+
+COPY ./digest-crc.gem .
+
+ENTRYPOINT gem install ./digest-crc.gem

data/spec/integration/docker/Dockerfile.with-gcc

@@ -0,0 +1,3 @@
+FROM test-digest-crc-base
+
+RUN apt-get install -y -qq gcc

data/spec/integration/docker/Dockerfile.with-gcc-and-make

@@ -0,0 +1,3 @@
+FROM test-digest-crc-with-gcc
+
+RUN apt-get install -y -qq make

data/spec/integration/install_spec.rb

@@ -0,0 +1,59 @@
+require 'rspec'
+
+describe "installing digest-crc" do
+  ROOT_DIR   = File.expand_path('../../..',__FILE__)
+  DOCKER_DIR = File.expand_path('../docker', __FILE__)
+
+  IMAGES = %w[
+    test-digest-crc-base
+    test-digest-crc-with-gcc
+    test-digest-crc-with-gcc-and-make
+  ]
+
+  before(:all) do
+    puts ">>> Building digest-crc gem ..."
+    Dir.chdir(ROOT_DIR) do
+      system 'gem', 'build',
+             '-o', File.join(DOCKER_DIR,'digest-crc.gem'),
+             'digest-crc.gemspec'
+    end
+
+    IMAGES.each do |image|
+      suffix = image.sub('test-digest-crc-','')
+
+      puts ">>> Building #{image} docker image ..."
+      Dir.chdir(DOCKER_DIR) do
+        system "docker build -t #{image} --file Dockerfile.#{suffix} ."
+      end
+    end
+  end
+
+  context "when installing into a slim environment" do
+    let(:image) { 'test-digest-crc-base' }
+
+    it "should successfully install digest-crc" do
+      expect(system("docker run #{image}")).to be(true)
+    end
+  end
+
+  context "when gcc is installed" do
+    let(:image) { 'test-digest-crc-with-gcc' }
+
+    it "should successfully install digest-crc" do
+      expect(system("docker run #{image}")).to be(true)
+    end
+  end
+
+  context "when gcc and make are installed" do
+    let(:image) { 'test-digest-crc-with-gcc-and-make' }
+
+    it "should successfully install digest-crc" do
+      expect(system("docker run #{image}")).to be(true)
+    end
+  end
+
+  after(:all) do
+    puts ">>> Removing test-digest-crc docker images ..."
+    system "docker image rm -f #{IMAGES.reverse.join(' ')}"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digest-crc
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -49,9 +49,10 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".github/workflows/integration.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - ChangeLog.md
 - Gemfile
@@ -223,6 +224,10 @@ files:
 - spec/crc8_spec.rb
 - spec/crc_examples.rb
 - spec/crc_spec.rb
+- spec/integration/docker/Dockerfile.base
+- spec/integration/docker/Dockerfile.with-gcc
+- spec/integration/docker/Dockerfile.with-gcc-and-make
+- spec/integration/install_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/postmodern/digest-crc#readme
 licenses:
@@ -248,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.

data/.travis.yml

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