dicey 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 530103d6f251d8f7c0b8400bde5b70c7c92bc6f79c6638aa99e0900f2af2129b
-  data.tar.gz: 943e0dd4655eb14c1e8b67bbbdf53deadec26856a864bfa5cb25b7f7d0b624e6
+  metadata.gz: c11673348152c65cc6b6bb0b50a3bdf6b515479b6df9e1885c26d1e89e826dd4
+  data.tar.gz: 722bcec16c95bd5fbd9774aa382b3d074c2c2898fbef1308ecce9f988f2e2f55
 SHA512:
-  metadata.gz: 747b729c073e357d7f4016d40df42a1669d166c1056e91dcf4ad07308a92f6a09c9cc2e058bbf595930766e8319197be529daa5041b280bbb6c98ab1b0f1538f
-  data.tar.gz: c2cf10206752a9d0fff536b5d1e13291520d2af4355d468f51288d8f922de3c94dfca3cfefc20d6536c5aa957ec8d7e178724a7bdfabf544aaede4ab49cda8aa
+  metadata.gz: 536a1274842408a7daeb543382ffd799fbf500020a9bde67f050ce2c3ce0e95e3dd9b0b94034f115af78f0c4d95ad7eef88910271b0db131b6433ad8303b2500
+  data.tar.gz: 5a67e9950f0fb8b82b156dcd001623a9029a1fd666e08f6570095648ef4e57e582699ca1ffcb85d1ec9e746adb8dd1f27ad1b36630f5682629a2d5ff57272ac4

data/README.md

@@ -70,17 +70,7 @@ gem install dicey
 
 Or, if using Bundler, add it to your `Gemfile`:
 ```rb
-gem "dicey", "~> 0.16"
-```
-
-(Optional) If intending to work with non-numeric dice, install **vector_number** too:
-```sh
-gem install vector_number
-```
-
-or add it to your `Gemfile`:
-```rb
-gem "vector_number"
+gem "dicey", "~> 0.17"
 ```
 
 > [!TIP]
@@ -92,10 +82,8 @@ gem "vector_number"
 ### Requirements
 
 **Dicey** is tested to work on CRuby 3.0+, latest JRuby and TruffleRuby. Compatible implementations should work too.
+- `vector_number` is a dependency, used for non-numeric dice, but technically not required.
 - JSON and YAML formatting require `json` and `yaml`.
-- Non-numeric dice require gem `vector_number` to be installed.
-
-Otherwise, there are no direct dependencies.
 
 ## Usage: CLI (command line)
 
@@ -262,13 +250,11 @@ You are a wizard and you have a spellbook with an elemental vortex spell that de
 ```sh
 $ dicey 3d❄️,🔥,⚡️,🌪,🌲 -m r
 # (❄️,🔥,⚡️,🌪,🌲)+(❄️,🔥,⚡️,🌪,🌲)+(❄️,🔥,⚡️,🌪,🌲)
-roll => 1⋅🌪 + 1⋅🌲 + 1⋅⚡️
+roll => 1⋅"🌪" + 1⋅"🌲" + 1⋅"⚡️"
 ```
 
 Wind, wood and lightning in equal proportion it is! Your enemies will tremble!
 
-Regrettably, it is not possible to use elemental dice without installing **vector_number** gem first.
-
 ### All ways to define dice
 
 There are four *main* ways to define dice:
@@ -334,18 +320,16 @@ It is easy enough to create numeric dice or dice with distinct symbols. However,
 
 For example, a game may have a die which can roll 1-3 💚 or a ♥️. You could just use completely different strings for the different numbers of hearts, but they would not be summable (what if you need to roll two such dice and add them together?). In this case, you can directly use `VectorNumber` to create summable strings:
 ```rb
-# Using Symbols is not required, but they look nicer in output.
-# `DieFoundry` uses Symbols for this reason.
-heal = VectorNumber[:"💚"]
-regen = VectorNumber[:"♥️"]
+heal = VectorNumber["💚"]
+regen = VectorNumber["♥️"]
 die = Dicey::AbstractDie.new([heal, heal * 2, heal * 3, regen])
-  # => #<Dicey::AbstractDie:0x00007f4a7c95efe8 @current_side_index=0, @sides_list=[(1⋅💚), (2⋅💚), (3⋅💚), (1⋅♥️)], @sides_num=4>
+  # => #<Dicey::AbstractDie:0x00007f4a7c95efe8 @current_side_index=0, @sides_list=[(1⋅"💚"), (2⋅"💚"), (3⋅"💚"), (1⋅"♥️")], @sides_num=4>
 ```
 
 Now such dice can easily be rolled together and results summed:
 ```rb
 die.roll + die.roll
-  # => (5⋅💚)
+  # => (5⋅"💚")
 ```
 
 ### Rolling
@@ -394,7 +378,7 @@ die.roll
 Distribution calculators live in `Dicey::DistributionCalculators` module. There are three main calculators currently.
 - `Dicey::DistributionCalculators::PolynomialConvolution` is the recommended calculator, able to handle all `Dicey::RegularDie` and other integer dice.
 - `Dicey::DistributionCalculators::MultinomialCoefficients` is specialized for repeated numeric dice. However, it is currently limited to dice with arithmetic sequences (this includes regular dice, however).
-- `Dicey::DistributionCalculators::Iterative` is the most generic, able to work with *abstract* dice. It needs gem "**vector_number**" to be installed and available to work with non-numeric dice.
+- `Dicey::DistributionCalculators::Iterative` is the most generic, able to work with *abstract* dice.
 
 Additionally, there are three special calculators.
 - `Dicey::DistributionCalculators::Binomial` is a fast calculator for collections of equal two-sided dice, like coins, including *abstract* dice.
@@ -517,7 +501,7 @@ This algorithm is based on raising a univariate polynomial to a power and using
 
 This is a specialized alogorithm for coin-like dice of any kind. It is significantly faster than general algorithms.
 
-- Limitations: only *equal* two-sided dice are allowed, **vector_number** allows non-numeric values.
+- Limitations: only *equal* two-sided dice are allowed.
 - Example: `dicey 500d2`
 - Complexity: **O(n<sup>2</sup>)**
 - Running time examples:
@@ -528,7 +512,7 @@ This is a specialized alogorithm for coin-like dice of any kind. It is significa
 
 At last, there is an iterative algorithm which goes through every possible dice roll and adds results together. Whil being inefficient, it has the largest input space, allowing to work with completely nonsensical dice, including complex numbers and altogether non-numeric values.
 
-- Limitations: without **vector_number** all values must be numbers, otherwise almost any values are viable.
+- Limitations: practically all values are viable.
 - Example: `dicey 5 1,0.1,2 A,B,C`
 - Complexity: **O(n<sup>2</sup>⋅m<sup>2</sup>)**
 - Running time examples:

data/lib/dicey/cli/blender.rb

@@ -7,6 +7,7 @@ require_relative "options"
 require_relative "calculator_runner"
 require_relative "calculator_test_runner"
 require_relative "roller"
+require_relative "verbose_printer"
 
 Dir["formatters/*.rb", base: __dir__].each { require_relative _1 }
 
@@ -46,7 +47,13 @@ module Dicey
       def call(argv = ARGV)
         options, arguments = get_options_and_arguments(argv)
         require_optional_libraries(options)
-        return_value = RUNNERS[options.delete(:mode)].call(arguments, **options)
+
+        verbose_printer = VerbosePrinter.new(options[:verbosity])
+        verbose_printer.print("Selected mode: #{options[:mode]}")
+
+        return_value =
+          RUNNERS[options.delete(:mode)]
+          .call(arguments, **options, verbose_printer: verbose_printer)
         print return_value if return_value.is_a?(String)
         !!return_value
       end

data/lib/dicey/cli/calculator_runner.rb

@@ -13,15 +13,17 @@ module Dicey
       # @param arguments [Array<String>] die definitions
       # @param format [#call] formatter for output
       # @param result [Symbol] result type selector
+      # @param verbose_printer [VerbosePrinter]
       # @return [String]
       # @raise [DiceyError]
-      def call(arguments, format:, result:, **)
+      def call(arguments, format:, result:, verbose_printer: nil, **)
         raise DiceyError, "no dice!" if arguments.empty?
 
         dice = arguments.flat_map { |definition| die_foundry.cast(definition) }
         calculator = DistributionCalculators::AutoSelector.call(dice)
         raise DiceyError, "no calculator could handle these dice!" unless calculator
 
+        verbose_printer&.print("Using calculator: #{calculator.class}")
         distribution = calculator.call(dice, result_type: result)
 
         format.call(distribution, AbstractDie.describe(dice))

data/lib/dicey/cli/calculator_test_runner.rb

@@ -72,8 +72,11 @@ module Dicey
       #
       # @param report_style [Symbol] one of: +:full+, +:quiet+;
       #   +:quiet+ style does not output any text
+      # @param verbose_printer [VerbosePrinter]
       # @return [Boolean] whether there are no failing tests
-      def call(*, report_style:, **)
+      def call(*, report_style:, verbose_printer: nil, **)
+        verbose_printer&.print("Available calculators:")
+        verbose_printer&.print(AVAILABLE_CALCULATORS.map { "  - #{_1.class}" }.join("\n"))
         results = TEST_DATA.to_h { |test| run_test(test) }
         output_report(results, report_style)
         results.values.none? do |test_result|

data/lib/dicey/cli/options.rb

@@ -88,9 +88,9 @@ module Dicey
           puts @parser.ver
           exit
         end
-        @parser.on_tail("-v", "(Deprecated) Show program version and exit.") do
+        @parser.on_tail("-v", "--verbose", "Enable verbose output.") do
           puts @parser.ver
-          exit
+          @options[:verbosity] = 1
         end
       end
 

data/lib/dicey/cli/roller.rb

@@ -4,7 +4,6 @@ require_relative "../die_foundry"
 
 require_relative "../mixins/rational_to_integer"
 require_relative "../mixins/vectorize_dice"
-require_relative "../mixins/warn_about_vector_number"
 
 module Dicey
   module CLI
@@ -14,7 +13,6 @@ module Dicey
     class Roller
       include Mixins::RationalToInteger
       include Mixins::VectorizeDice
-      include Mixins::WarnAboutVectorNumber
 
       # @param arguments [Array<String>] die definitions
       # @param format [#call] formatter for output
@@ -28,7 +26,6 @@ module Dicey
 
         format.call({ "roll" => rational_to_integer(result) }, AbstractDie.describe(dice))
       rescue TypeError
-        warn_about_vector_number
         raise DiceyError, "can not roll dice with non-numeric sides!"
       end
 

data/lib/dicey/cli/verbose_printer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dicey
+  module CLI
+    # Prints verbose output to the given IO object.
+    class VerbosePrinter
+      def initialize(verbosity, io = $stdout)
+        @verbosity = verbosity || 0
+        @io = io
+      end
+
+      # Prints the given message to the IO object if the verbosity level
+      # is greater than or equal to the minimum verbosity level.
+      #
+      # @param message [String]
+      # @param min_verbosity [Integer]
+      def print(message, min_verbosity = 1)
+        @io.puts message if @verbosity >= min_verbosity
+      end
+    end
+  end
+end

data/lib/dicey/die_foundry.rb

@@ -47,8 +47,8 @@ module Dicey
     # - list of decimal numbers (like "0.5,0.2,0.8" or "(2.0,)"), which produces a {NumericDie},
     #   but uses +Rational+ for values to maintain precise results;
     # - list of strings, possibly mixed with numbers (like "0.5,asdf" or "(👑,♠️,♥️,♣️,♦️,⚓️)"),
-    #   which produces an {AbstractDie} with strings converted to Symbols
-    #   and numbers treated the same as in previous cases.
+    #   which produces an {AbstractDie} with numbers treated the same as in previous cases,
+    #   and other or quoted values treated as Strings.
     #
     # Any die definition can be prefixed with a count, like "2D6" or "1d1,3,5" to create an array.
     # A plain "d" without an explicit count is ignored instead, creating a single die.
@@ -100,7 +100,7 @@ module Dicey
         when /\A#{FRACTION}\z/o
           rational_to_integer(Rational(side))
         else
-          side.match(STRING)[:side].to_sym
+          side.match(STRING)[:side]
         end
       end
       build_dice(AbstractDie, definition[:count], sides)

data/lib/dicey/distribution_calculators/empirical.rb

@@ -3,7 +3,6 @@
 require_relative "base_calculator"
 
 require_relative "../mixins/vectorize_dice"
-require_relative "../mixins/warn_about_vector_number"
 
 module Dicey
   module DistributionCalculators
@@ -15,13 +14,12 @@ module Dicey
     # Does a number of rolls and calculates approximate probabilities from that.
     # Even if weights are requested, results are non-integer.
     #
-    # If dice include non-numeric sides, gem +vector_number+ has to be installed.
+    # If dice include non-numeric sides, gem +vector_number+ has to be available.
     #
     # *Options:*
     # - *rolls* (Integer) (_defaults_ _to:_ _N_) — number of rolls to perform
     class Empirical < BaseCalculator
       include Mixins::VectorizeDice
-      include Mixins::WarnAboutVectorNumber
 
       # Default number of rolls to perform.
       N = 10_000
@@ -29,11 +27,7 @@ module Dicey
       private
 
       def validate(dice)
-        if defined?(VectorNumber) || dice.all?(NumericDie)
-          true
-        else
-          warn_about_vector_number
-        end
+        !!defined?(VectorNumber) || dice.all?(NumericDie)
       end
 
       def calculate_heuristic(dice_count, sides_count)

data/lib/dicey/distribution_calculators/iterative.rb

@@ -3,26 +3,20 @@
 require_relative "base_calculator"
 
 require_relative "../mixins/vectorize_dice"
-require_relative "../mixins/warn_about_vector_number"
 
 module Dicey
   module DistributionCalculators
     # Calculator for a collection of {AbstractDie} which goes through
     # every possible combination of dice (somewhat slow).
     #
-    # If dice include non-numeric sides, gem +vector_number+ has to be installed.
+    # If dice include non-numeric sides, gem +vector_number+ has to be available.
     class Iterative < BaseCalculator
       include Mixins::VectorizeDice
-      include Mixins::WarnAboutVectorNumber
 
       private
 
       def validate(dice)
-        if defined?(VectorNumber) || dice.all?(NumericDie)
-          true
-        else
-          warn_about_vector_number
-        end
+        !!defined?(VectorNumber) || dice.all?(NumericDie)
       end
 
       def calculate_heuristic(dice_count, sides_count)

data/lib/dicey/distribution_properties_calculator.rb

@@ -3,6 +3,8 @@
 require_relative "mixins/rational_to_integer"
 
 module Dicey
+  # @note This class is considered experimental. It may be changed at any point.
+  #
   # Calculates distribution properties,
   # also known as descriptive statistics when applied to a population sample.
   #

data/lib/dicey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dicey
-  VERSION = "0.17.1"
+  VERSION = "0.18.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dicey
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Alexander Bulancov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vector_number
@@ -17,13 +16,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.3
-  type: :development
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: |
   Dicey provides a CLI executable and a Ruby API for fast calculation of
   distribution of weights or probabilities of dice rolls,
@@ -33,7 +38,6 @@ description: |
   It can also be used to roll dice. While not the primary focus,
   rolling is well supported, including ability to seed random source
   for reproducible results.
-email:
 executables:
 - dicey
 - dicey-to-gnuplot
@@ -59,6 +63,7 @@ files:
 - lib/dicey/cli/formatters/yaml_formatter.rb
 - lib/dicey/cli/options.rb
 - lib/dicey/cli/roller.rb
+- lib/dicey/cli/verbose_printer.rb
 - lib/dicey/die_foundry.rb
 - lib/dicey/distribution_calculators/auto_selector.rb
 - lib/dicey/distribution_calculators/base_calculator.rb
@@ -72,7 +77,6 @@ files:
 - lib/dicey/mixins/missing_math.rb
 - lib/dicey/mixins/rational_to_integer.rb
 - lib/dicey/mixins/vectorize_dice.rb
-- lib/dicey/mixins/warn_about_vector_number.rb
 - lib/dicey/numeric_die.rb
 - lib/dicey/regular_die.rb
 - lib/dicey/version.rb
@@ -82,11 +86,10 @@ licenses:
 metadata:
   homepage_uri: https://github.com/trinistr/dicey
   bug_tracker_uri: https://github.com/trinistr/dicey/issues
-  documentation_uri: https://rubydoc.info/gems/dicey/0.17.1
-  source_code_uri: https://github.com/trinistr/dicey/tree/v0.17.1
-  changelog_uri: https://github.com/trinistr/dicey/blob/v0.17.1/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/dicey/0.18.0
+  source_code_uri: https://github.com/trinistr/dicey/tree/v0.18.0
+  changelog_uri: https://github.com/trinistr/dicey/blob/v0.18.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -103,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Dice roll weights/probabilities distribution calculator. Also rolls dice.
 test_files: []

data/lib/dicey/mixins/warn_about_vector_number.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Dicey
-  module Mixins
-    # @api private
-    # Mix-in for warning about missing VectorNumber gem.
-    module WarnAboutVectorNumber
-      private
-
-      def warn_about_vector_number
-        warn <<~TEXT
-          Dice with non-numeric sides need gem "vector_number" to be present and available.
-          If this is intended, please install the gem.
-        TEXT
-        false
-      end
-    end
-  end
-end