games_dice 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ccf1c8256d9cfa52fa5e99b06c0d0a32288ebdbf54e0e7d0d9f194e4fa21be8
-  data.tar.gz: 0b0935a31996519bcd74a8b9fe865911bc5d5d1d68a288c46a2d9450588ecefa
+  metadata.gz: b413f80b11ad9ca9e552ffcf86f24d4405f8750bff01f231e4f0ab20be1963de
+  data.tar.gz: 9eae95cf6218d6ad7d047077d5541dd471707059f5ed325098d1031012ae4bcf
 SHA512:
-  metadata.gz: ea6550cb8a23fd28d311ce1b9227e3a9d8b20cfc6ac57459f157e138be850fc543e2e0b17e3dbcee3a6c0ea070c1d126b2b467c1fcb927f13da77acad33dcdbf
-  data.tar.gz: bb9b6efd51537a01de7ab325546431852ab96d1aa28042776481345e20e0ed60c64d9185b2161bc00e15d63aa0c8c859f33541cb34374fae736a3fa32a1fe3de
+  metadata.gz: 7394cf91a9a1c911340fcb3c8edee3ef7adb303172b5106eb0a3956e05be141be2ab874046b4cb99d8ec2f3d7208dc2f6428b10c5d8b12c2c72b3cb6f73af3d0
+  data.tar.gz: 9d8c8bd1337c26aa4c3203a62e359af2b180f21bf46831b8929f6f234d60f1e00a26e01f5822b13769c6f30a41b538b6dce20e8df35a3767909428bdb366b8a1

data/.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - maintenance
   pull_request:
   schedule:
     - cron: '0 6 8 * *'
@@ -25,7 +26,15 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - run: bundle exec rake compile spec
+      - run: bundle exec rake
+      - name: Upload Ruby coverage report
+        if: always()
+        uses: actions/upload-artifact@v6
+        with:
+          name: ruby-coverage-${{ matrix.ruby }}
+          path: coverage/ruby
+          retention-days: 14
+          if-no-files-found: warn
 
   rubocop:
     name: RuboCop (Ruby ${{ matrix.ruby }})
@@ -41,6 +50,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - run: bundle exec rubocop
+      - run: bundle exec ncs-rubocop-conf-audit
 
   audit:
     name: Dependency audit

data/.gitignore

@@ -4,7 +4,6 @@
 *.bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -1,53 +1,18 @@
+inherit_gem:
+  ncs_rubocop_conf:
+    - config/base.yml
+    - config/rake.yml
+    - config/rspec.yml
+    - config/native_extension.yml
+
 plugins:
   - rubocop-performance
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.3
-  NewCops: enable
-  SuggestExtensions: false
-
-Layout/LineLength:
-  Max: 120
-  
-Metrics/BlockLength:
-  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
+inherit_mode:
+  merge:
+    - Exclude
 
-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:
+# RuboCop rationale: Local agent guidance and ad-hoc probes are not repository source.
+AllCops:
   Exclude:
-    - spec/probability_spec.rb
+    - 'docs/agent/**/*'

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # GamesDice Changelog
 
+## 0.6.0 ( 14 October 2026 )
+
+* Fix native repetition termination, keeper allocation leaks, and exception cleanup. Validate
+  finite probabilities and check integer endpoints and distribution spans before allocation.
+* Fix bounds with negative multipliers, reject nonpositive keeper counts, and make explanations
+  reflect weighted results and the actual mapped keepers.
+* Bound aggregate probability truncation error by `1e-10` before floating-point roundoff, use
+  cheap exact shortcuts, and raise `GamesDice::ProbabilityLimitError` for unsupported work.
+  Bounds return safe enclosing intervals when cheaply provable, otherwise they also raise.
+* Cache combined probabilities and invalidate derived state when exposed recipe arrays or
+  mapping labels change. Previous results and explanations clear until the next roll.
+* Clarify that shorthand replacement rerolls use the existing default limit of 1000.
+* **Breaking serialization change:** remove the legacy `Probabilities._load` protocol and support
+  paired Marshal dump/load round trips. Previously serialized probabilities, including those
+  cached in dice, may no longer load. Recompute from recipes, or export hashes with the previous
+  version and reconstruct using `Probabilities.from_h`.
+* Standardise development linting on `ncs_rubocop_conf` v0.2.0 with its base, Rake, RSpec, and native-extension profiles.
+* Refactor the test suite to meet the shared policy without reducing its assertions or coverage.
+
 ## 0.5.0 ( 22 July 2026 )
 
  * Add support and CI coverage for Ruby 4.0.

data/Gemfile

@@ -6,12 +6,14 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bundler-audit', '~> 0.9', require: false
+gem 'ncs_rubocop_conf',
+    github: 'neilslater/ncs_rubocop_conf',
+    tag: 'v0.2.1',
+    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 'simplecov', '~> 0.22.0', require: false
 gem 'yard', '~> 0.9'

data/README.md

@@ -24,7 +24,7 @@ gem as-is, and add them as features within your project code.
 
 ## Supported Ruby Versions
 
-GamesDice 0.4.2 supports MRI Ruby 3.3 and 3.4. It uses a native extension and does not support JRuby.
+GamesDice 0.6.0 supports MRI Ruby 3.3, 3.4, and 4.0. It uses a native extension and does not support JRuby.
 
 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.
@@ -132,7 +132,8 @@ Returns a GamesDice::Probabilities object that describes the probability distrib
 Note that some distributions, involving keeping a number best or worst results, can take
 significant time to calculate. If the theoretical distribution would contain a large number
 of very low probabilities due to a possibility of large numbers re-rolls, then the
-calculations cut short, typically approximating to the nearest 1.0e-10.
+calculation may omit unfinished branches within the aggregate `1e-10` truncation bound described below,
+or raise `GamesDice::ProbabilityLimitError` when its limits prevent that guarantee.
 
 ### GamesDice::Probabilities instance methods
 
@@ -166,7 +167,19 @@ Returns the probability of a result equal to the integer n.
     probabilities.p_eql( 3 )  # => 0.004629629629
     probabilities.p_eql( 2 )  # => 0.0
 
-Probabilities below 1e-10 due to requiring long sequences of re-rolls will calculate as 0.0
+Very unlikely sequences of rerolls may be left out to keep calculation time reasonable.
+This changes the probability of any result, or range of results, by at most `1e-10`
+(one in ten billion), in addition to normal floating-point rounding. This limit applies
+to all the dice together, including when keeping only the highest or lowest rolls.
+
+GamesDice limits the amount of work spent calculating probabilities. If it cannot achieve
+the accuracy described above within those limits, it raises `GamesDice::ProbabilityLimitError`.
+These calculation limits do not change how the dice are rolled.
+
+For complex dice, `dice.min` and `dice.max` may describe a wider range than can actually
+be rolled. Every roll will fall within that range, but its endpoints may not be possible
+results. These methods also raise `GamesDice::ProbabilityLimitError` if they cannot find
+suitable bounds within the calculation limits.
 
 #### probabilities.p_gt( n )
 
@@ -200,7 +213,34 @@ Returns the probability of a result less than the integer n.
 
 Returns the mean result, weighted by the probability of each value.
 
-    probabilities.expected  # => 10.5 (rounded to nearest 1e-9)
+    probabilities.expected  # => 10.5 (mean of the returned distribution)
+
+If very unlikely reroll sequences were left out, this mean is also an approximation.
+Rare but unusually high or low results can affect the mean more than their small
+probabilities might suggest, so the `1e-10` accuracy limit for probabilities does
+not apply to the mean.
+
+## Changing dice rules
+
+You can change existing dice by editing their bunches, multipliers, reroll rules or mapping
+rules. GamesDice recalculates affected probabilities and minimum/maximum values when next
+needed. Previous results and explanations are cleared until you roll again.
+
+Each entry in `dice.bunches` has a matching entry in `dice.bunch_multipliers`. If you add,
+remove or reorder bunches, make the corresponding change to their multipliers before
+using the dice.
+
+If you supply custom rule callbacks, keep their behavior unchanged while the rules are
+in use. Replace the rule object when changing its behavior, and do not change dice rules
+from inside a callback.
+
+## Saving and loading dice
+
+Breaking change in 0.6.0: legacy serialized `GamesDice::Probabilities` objects requiring the old
+`_load` protocol are no longer supported. This also affects serialized dice containing such
+cached probabilities. New objects support Marshal dump/load round trips. Recompute persisted
+distributions from their recipes, or export hashes using the previous version and reconstruct
+with `Probabilities.from_h`. Only deserialize trusted data.
 
 ## String Dice Descriptions
 
@@ -257,7 +297,8 @@ The simple form specifies a low value that will automatically trigger a re-roll
     1d6r1
 
 When rolled, this die will score from 1 to 6. If it rolls a 1, it will roll again automatically
-and use that result instead.
+and use that result instead, repeating while it rolls 1, up to the default limit of 1000 rerolls.
+Use `1d6r:1,replace,1.` for exactly one replacement attempt.
 
 The full version of this modifier, allows you to specify from 1 to 3 parameters:
 

data/Rakefile

@@ -11,7 +11,7 @@ require 'yard'
 
 desc 'GamesDice unit tests'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/*_spec.rb'
+  t.pattern = 'spec/**/*_spec.rb'
   t.verbose = false
 end
 
@@ -28,7 +28,14 @@ Rake::ExtensionTask.new do |ext|
   ext.gem_spec = gemspec
 end
 
-task default: %i[compile spec]
+namespace :docs do
+  desc 'Check Ruby API documentation for YARD warnings and undocumented objects'
+  task :check do
+    ruby 'script/check_documentation.rb'
+  end
+end
+
+task default: %i[compile spec docs:check]
 
 rebuild_and_test_native = lambda do |mode, test: true|
   tasks = %w[clobber compile]
@@ -46,7 +53,6 @@ rebuild_and_test_native = lambda do |mode, test: true|
 end
 
 # 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
@@ -94,8 +100,10 @@ namespace :c do
 
     rebuild_and_test_native.call('sanitize', test: false)
 
+    # MRI owns its threads' alternate signal stacks; ASan must not unmap them on thread exit.
+    # See https://bugs.ruby-lang.org/issues/20256 (also applies when preloading ASan into stock Ruby).
     sh(
-      { 'ASAN_OPTIONS' => 'detect_leaks=0', 'LD_PRELOAD' => libasan },
+      { 'ASAN_OPTIONS' => 'detect_leaks=0:use_sigaltstack=0', 'LD_PRELOAD' => libasan },
       RbConfig.ruby,
       '-S',
       'bundle',
@@ -105,4 +113,3 @@ namespace :c do
     )
   end
 end
-# rubocop:enable Metrics/BlockLength

data/ext/games_dice/extconf.rb

@@ -6,7 +6,6 @@ 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.
@@ -31,6 +30,4 @@ when 'sanitize'
 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')