games_dice 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1046747fdad80e794bb7883aaaade1a14e737a39641b6e85e7c179e96a3375
-  data.tar.gz: 54b1c1aa41b58b53e8a72ad59f835de932fde926a038626a0df165605677300c
+  metadata.gz: 1ccf1c8256d9cfa52fa5e99b06c0d0a32288ebdbf54e0e7d0d9f194e4fa21be8
+  data.tar.gz: 0b0935a31996519bcd74a8b9fe865911bc5d5d1d68a288c46a2d9450588ecefa
 SHA512:
-  metadata.gz: 60e56aa2b32a4550ae6334c372ad1a9b0a07820c8a58ae4ce07c0ae3d5721ff91b8422d3d2d52b690e387738d3ee5bb6a7c05bed2d40145b776ef9a9d6295c0c
-  data.tar.gz: 7a0e7c3759def3b6f482e4242ae23b770c50876fc26f5464bca4e77b91cbf64596c901c4eb9cc69e9eee351d63fa8978426ceae7125eb34aa7c3e0856a0a8e1e
+  metadata.gz: ea6550cb8a23fd28d311ce1b9227e3a9d8b20cfc6ac57459f157e138be850fc543e2e0b17e3dbcee3a6c0ea070c1d126b2b467c1fcb927f13da77acad33dcdbf
+  data.tar.gz: bb9b6efd51537a01de7ab325546431852ab96d1aa28042776481345e20e0ed60c64d9185b2161bc00e15d63aa0c8c859f33541cb34374fae736a3fa32a1fe3de

data/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  schedule:
+    - cron: '0 6 8 * *'
+
+permissions:
+  contents: read
+
+jobs:
+  rspec:
+    name: RSpec (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.3', '3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake compile spec
+
+  rubocop:
+    name: RuboCop (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.3', '3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rubocop
+
+  audit:
+    name: Dependency audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - run: bundle exec bundle-audit check --update
+
+  native-quality:
+    name: C ${{ matrix.check }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        check: [lint, coverage, sanitize]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install C coverage tools
+        if: matrix.check == 'coverage'
+        run: sudo apt-get update && sudo apt-get install -y gcovr
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Show Ruby extension compiler
+        run: |
+          ruby -rrbconfig -e 'puts RbConfig::CONFIG.fetch("CC")'
+          gcc --version
+      - name: Run native quality check
+        run: bundle exec rake c:${{ matrix.check }}
+      - name: Add C coverage summary to job summary
+        if: matrix.check == 'coverage' && always()
+        run: |
+          if test -f coverage/c/summary.txt; then
+            cat coverage/c/summary.txt >> "$GITHUB_STEP_SUMMARY"
+          fi
+      - name: Upload C coverage report
+        if: matrix.check == 'coverage' && always()
+        uses: actions/upload-artifact@v6
+        with:
+          name: c-coverage
+          path: coverage/c
+          retention-days: 14
+          if-no-files-found: warn

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.rubocop.yml

@@ -1,15 +1,53 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.6.0
+  TargetRubyVersion: 3.3
   NewCops: enable
+  SuggestExtensions: false
 
 Layout/LineLength:
   Max: 120
   
 Metrics/BlockLength:
-  IgnoredMethods:
+  AllowedMethods:
     - context
     - describe
     - shared_examples
     - define
-  
 
+RSpec/ExampleLength:
+  Max: 25
+
+RSpec/MultipleExpectations:
+  Max: 21
+
+RSpec/NestedGroups:
+  Max: 4
+
+# This project keeps specs flat so they are easy to run individually.
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Exclude:
+    - spec/complex_die_spec.rb
+
+RSpec/MultipleDescribes:
+  Exclude:
+    - spec/readme_spec.rb
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/readme_spec.rb
+
+# Probabilities implements #each without mixing in Enumerable; these specs
+# intentionally collect yielded pairs manually.
+Style/MapIntoArray:
+  Exclude:
+    - spec/probability_spec.rb

data/.yardopts

@@ -1,5 +1,5 @@
 lib/**/*.rb
---exclude ext
+ext/**/*.c
 --no-private
 -
 README.md

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # GamesDice Changelog
 
+## 0.5.0 ( 22 July 2026 )
+
+ * Add support and CI coverage for Ruby 4.0.
+ * Add dependency auditing and native extension lint, sanitizer, and coverage checks to CI.
+ * Modernise native probability object memory management using Ruby's typed data API.
+ * Expand probability specifications to cover native extension edge cases.
+
+## 0.4.2 ( 19 July 2026 )
+
+ * Require MRI Ruby 3.3 or later and test against Ruby 3.3 and 3.4.
+ * Update development and runtime dependencies.
+ * Replace Travis CI with GitHub Actions.
+ * Modernise the RSpec suite and RuboCop configuration.
+ * Correct and clarify README documentation.
+
+## 0.4.1
+
+ * Tidy up documentation and address some Rubocop offences.
+
 ## 0.4.0 ( 19 September 2021 )
 
  * Dropping support for older Ruby versions (< 2.6)

data/Gemfile

@@ -4,3 +4,14 @@ source 'https://rubygems.org'
 
 # Dependencies are in games_dice.gemspec
 gemspec
+
+gem 'bundler-audit', '~> 0.9', require: false
+gem 'rake', '~> 13.2'
+gem 'rake-compiler', '~> 1.2'
+gem 'redcarpet', '~> 3.6'
+gem 'rspec', '~> 3.13'
+gem 'rubocop', '~> 1.75', require: false
+gem 'rubocop-performance', '~> 1.25', require: false
+gem 'rubocop-rake', '~> 0.7', require: false
+gem 'rubocop-rspec', '~> 3.6', require: false
+gem 'yard', '~> 0.9'

data/README.md

@@ -1,10 +1,4 @@
 # GamesDice
-[![Gem Version](https://badge.fury.io/rb/games_dice.png)](http://badge.fury.io/rb/games_dice)
-[![Build Status](https://travis-ci.org/neilslater/games_dice.png?branch=master)](http://travis-ci.org/neilslater/games_dice)
-[![Coverage Status](https://coveralls.io/repos/neilslater/games_dice/badge.png?branch=master)](https://coveralls.io/r/neilslater/games_dice?branch=master)
-[![Inline docs](http://inch-ci.org/github/neilslater/games_dice.png?branch=master)](http://inch-ci.org/github/neilslater/games_dice)
-[![Code Climate](https://codeclimate.com/github/neilslater/games_dice.png)](https://codeclimate.com/github/neilslater/games_dice)
-[![Dependency Status](https://gemnasium.com/neilslater/games_dice.png)](https://gemnasium.com/neilslater/games_dice)
 
 A library for simulating dice. Use it to construct dice-rolling systems used in role-playing and board games.
 
@@ -30,11 +24,10 @@ gem as-is, and add them as features within your project code.
 
 ## Supported Ruby Versions
 
-GamesDice is tested routinely on MRI Rubies 1.9.3, 2.0.0, 2.1.0, 2.1.1 and JRuby, and the
-"build passing" badge is based on those tests.
+GamesDice 0.4.2 supports MRI Ruby 3.3 and 3.4. It uses a native extension and does not support JRuby.
 
-It *should* also work in versions from 1.8.7, in Ruby Enterprise and in Rubinius, but it
-is not tested routinely on those Rubies.
+GamesDice 0.4.0 and 0.4.1 support MRI Ruby 2.6 and later. Versions before 0.4.0 also provide a
+pure-Ruby implementation of the probability calculations and can be used with JRuby.
 
 ## Installation
 
@@ -50,21 +43,6 @@ Or install it yourself as:
 
     $ gem install games_dice
 
-When installed, GamesDice will attempt to install Ruby native extensions in C, for speeding up probabilities
-calculations. However, all the features are available in pure Ruby, and the gem should fall back to that
-automatically on installation if your system does not support C native extensions. You can verify which
-is being installed by installing the gem in verbose mode:
-
-    $ gem install games_dice --verbose
-
-You can also verify which version you are using in Ruby by calling the class method:
-
-    GamesDice::Probabilities.implemented_in
-
-which will return either *:ruby* or *:c*. Other than this method, and a speed difference between
-implementations, there should be no other difference. If you find one, then it will be considered
-as a bug.
-
 ## Usage
 
     require 'games_dice'
@@ -88,8 +66,8 @@ Converts a string such as '3d6+6' into a GamesDice::Dice object
 
 Parameters:
 
- * dice_description is a string such as '3d6' or '2d4-1'. See String Dice Descriptions below for possibilities.
- * prng is optional, if provided it should be an object that has a method 'rand( integer )' that works like Ruby's built-in rand method
+ * `dice_description` is a string such as `3d6` or `2d4-1`. See String Dice Descriptions below for possibilities.
+ * `prng` is optional. If provided, it must respond to `rand(integer)` in the same way as Ruby's built-in `rand` method.
 
 Returns a GamesDice::Dice object.
 
@@ -215,12 +193,12 @@ Returns the probability of a result less than or equal to the integer n.
 
 Returns the probability of a result less than the integer n.
 
-    probabilities.p_lt( 17 )  # => 0.9953703703703
+    probabilities.p_lt( 17 )  # => 0.9814814814814
     probabilities.p_lt( 3 )   # => 0.0
 
 #### probabilities.expected
 
-Returns the mean result, weighted by probabality of each value.
+Returns the mean result, weighted by the probability of each value.
 
     probabilities.expected  # => 10.5 (rounded to nearest 1e-9)
 
@@ -254,7 +232,7 @@ A die modifier can also be a single letter plus an integer value, e.g.
 
     1d6r1
 
-You can add comma-seperated parameters to a modifier by using a ":" (colon) character after the
+You can add comma-separated parameters to a modifier by using a ":" (colon) character after the
 modifier letter, and a "." (full stop) to signify the end of the parameters. What parameters are
 accepted, and what they mean, depends on the modifier:
 
@@ -272,7 +250,7 @@ are all equivalent.
 #### Rerolls
 
 You can specify that dice rolling certain values should be re-rolled, and how that re-roll should be
-interpretted.
+interpreted.
 
 The simple form specifies a low value that will automatically trigger a re-roll and replace:
 
@@ -287,7 +265,7 @@ The full version of this modifier, allows you to specify from 1 to 3 parameters:
 
 Where:
 
- * VALUE_COMPARISON is one of >, >=, == (default), <= < plus an integer to set conditions on when the reroll should occur
+ * VALUE_COMPARISON is one of `>`, `>=`, `==` (default), `<=`, or `<`, plus an integer that determines when the reroll occurs
  * REROLL_TYPE is one of
   * replace (default) - use the new value in place of existing value for the die
   * add - add result of reroll to running total, and ignore any subtract rules
@@ -319,7 +297,7 @@ The full version of this modifier, allows you to specify from 1 to 3 parameters:
 
 Where:
 
- * VALUE_COMPARISON is one of >, >= (default), ==, <= < plus an integer to set conditions on when the map should occur
+ * VALUE_COMPARISON is one of `>`, `>=` (default), `==`, `<=`, or `<`, plus an integer that determines when the map occurs
  * MAP_VALUE is an integer that will be used in place of a result from a die, default value is 1
   * maps are tested in order that they are declared, and first one that matches is applied
   * when at least one map has been defined, all unmapped values default to 0

data/Rakefile

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'fileutils'
+require 'open3'
+require 'rbconfig'
 require 'rspec/core/rake_task'
 require 'rake/extensiontask'
+require 'shellwords'
 require 'yard'
 
-def can_compile_extensions
-  return false if RUBY_DESCRIPTION =~ /jruby/
-
-  true
-end
-
 desc 'GamesDice unit tests'
-RSpec::Core::RakeTask.new(:test) do |t|
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/*_spec.rb'
   t.verbose = false
 end
@@ -30,14 +28,81 @@ Rake::ExtensionTask.new do |ext|
   ext.gem_spec = gemspec
 end
 
-task :delete_compiled_ext do |_t|
-  `rm lib/games_dice/games_dice.*`
+task default: %i[compile spec]
+
+rebuild_and_test_native = lambda do |mode, test: true|
+  tasks = %w[clobber compile]
+  tasks << 'spec' if test
+
+  sh(
+    { 'GAMES_DICE_NATIVE_MODE' => mode },
+    RbConfig.ruby,
+    '-S',
+    'bundle',
+    'exec',
+    'rake',
+    *tasks
+  )
 end
 
-task pure_test: %i[delete_compiled_ext test]
+# Native quality orchestration is kept together so each task shares the same rebuild contract.
+# rubocop:disable Metrics/BlockLength
+namespace :c do
+  desc 'Compile the C extension with strict warnings'
+  task :lint do
+    rebuild_and_test_native.call('lint', test: false)
+  end
+
+  desc 'Measure C coverage using the full Ruby spec suite'
+  task :coverage do
+    cc = RbConfig::CONFIG.fetch('CC')
+    compiler_version = Open3.capture2e(*Shellwords.split(cc), '--version').first
+
+    unless compiler_version.match?(/gcc/i) && !compiler_version.match?(/clang/i)
+      abort "c:coverage requires a GCC Ruby build (current compiler: #{cc})"
+    end
+
+    abort 'c:coverage requires gcovr on PATH' unless system('gcovr', '--version', out: File::NULL)
+
+    rebuild_and_test_native.call('coverage')
+
+    FileUtils.mkdir_p('coverage/c')
+    sh(
+      'gcovr',
+      '--root', '.',
+      '--filter', 'ext/games_dice/',
+      '--html-details', 'coverage/c/index.html',
+      '--xml', 'coverage/c/cobertura.xml',
+      '--txt', 'coverage/c/summary.txt',
+      '--print-summary'
+    )
+  end
+
+  desc 'Run the Ruby specs with ASan and UBSan'
+  task :sanitize do
+    abort 'c:sanitize requires Linux' unless RUBY_PLATFORM.include?('linux')
+
+    cc = RbConfig::CONFIG.fetch('CC')
+    compiler_version = Open3.capture2e(*Shellwords.split(cc), '--version').first
+
+    unless compiler_version.match?(/gcc/i) && !compiler_version.match?(/clang/i)
+      abort "c:sanitize requires a GCC Ruby build (current compiler: #{cc})"
+    end
+
+    libasan = Open3.capture2e(*Shellwords.split(cc), '-print-file-name=libasan.so').first.strip
+    abort 'c:sanitize could not locate the GCC ASan runtime' if libasan.empty? || libasan == 'libasan.so'
+
+    rebuild_and_test_native.call('sanitize', test: false)
 
-if can_compile_extensions
-  task default: %i[compile test]
-else
-  task default: [:test]
+    sh(
+      { 'ASAN_OPTIONS' => 'detect_leaks=0', 'LD_PRELOAD' => libasan },
+      RbConfig.ruby,
+      '-S',
+      'bundle',
+      'exec',
+      'rake',
+      'spec'
+    )
+  end
 end
+# rubocop:enable Metrics/BlockLength

data/ext/games_dice/extconf.rb

@@ -3,5 +3,34 @@
 # ext/games_dice/extconf.rb
 
 require 'mkmf'
+require 'rbconfig'
+
+# mkmf exposes compiler and linker flags through these globals.
+# rubocop:disable Style/GlobalVars
+case ENV.fetch('GAMES_DICE_NATIVE_MODE', 'release')
+when 'release'
+  # Use Ruby's normal extension build flags.
+when 'lint'
+  $CFLAGS << ' -std=gnu2x -O0 -g'
+  $CFLAGS << ' -Wall -Wextra -Wpedantic -Wformat=2 -Werror'
+
+  cc = RbConfig::CONFIG.fetch('CC')
+  host_os = RbConfig::CONFIG.fetch('host_os')
+  if cc.include?('clang') || host_os.include?('darwin')
+    # Ruby callback signatures legitimately leave some parameters unused, and
+    # Ruby 4 headers use standard attributes that Clang treats as C23 syntax.
+    $CFLAGS << ' -Wno-strict-prototypes -Wno-unused-parameter -Wno-c23-extensions'
+  end
+when 'coverage'
+  $CFLAGS << ' -O0 -g --coverage'
+  $LDFLAGS << ' --coverage'
+when 'sanitize'
+  $CFLAGS << ' -O1 -g -fsanitize=address,undefined'
+  $CFLAGS << ' -fno-omit-frame-pointer'
+  $LDFLAGS << ' -fsanitize=address,undefined'
+else
+  abort "Unknown GAMES_DICE_NATIVE_MODE: #{ENV.fetch('GAMES_DICE_NATIVE_MODE', nil)}"
+end
+# rubocop:enable Style/GlobalVars
 
 create_makefile('games_dice/games_dice')

data/ext/games_dice/games_dice.c

@@ -6,7 +6,7 @@
 // To hold the module object
 VALUE GamesDice = Qnil;
 
-void Init_games_dice() {
+void Init_games_dice(void) {
   GamesDice = rb_define_module("GamesDice");
-  init_probabilities_class( GamesDice );
+  init_probabilities_class();
 }