nerd_dice 0.2.1 → 0.3.0

data/lib/nerd_dice.rb

@@ -2,6 +2,10 @@
 
 require "nerd_dice/version"
 require "nerd_dice/configuration"
+require "nerd_dice/sets_randomization_technique"
+require "nerd_dice/die"
+require "nerd_dice/dice_set"
+require "nerd_dice/class_methods"
 require "securerandom"
 # Nerd dice allows you to roll polyhedral dice and add bonuses as you would in
 # a tabletop roleplaying game. You can choose to roll multiple dice and keep a
@@ -9,168 +13,14 @@ require "securerandom"
 # ability scores or rolling with advantage and disadvantage if those mechanics
 # exist in your game.
 #
-# Usage:
-#   Right now there is only a single class method :total_dice
+# This module is broken down into multiple source files:
+#   The class_methods file has all of the module_level methods called by NerdDice.method_name
 #
-#   If you wanted to roll a single d4, you would execute:
-#   <tt>NerdDice.total_dice(4)</tt>
-#
-#   If you wanted to roll 3d6, you would execute
-#   <tt>NerdDice.total_dice(6, 3)</tt>
-#
-#   If you wanted to roll a d20 and add 5 to the value, you would execute
-#   <tt>NerdDice.total_dice(20, 1, { bonus: 5 })</tt>
-#
-#   The bonus in the options hash must be an Integer or it will be ignored
+# See the README for overall usage for the module
 module NerdDice
   class Error < StandardError; end
 
   RANDOMIZATION_TECHNIQUES = %i[securerandom random_rand random_object randomized].freeze
-
-  class << self
-    attr_reader :count_since_last_refresh
-
-    ############################
-    # configure class method
-    ############################
-    # Arguments: None
-    # Expects and yields to a block where configuration is specified.
-    # See README and NerdDice::Configuration class for config options
-    # Return (NerdDice::Configuration) the Configuration object tied to the
-    #   @configuration class instance variable
-    def configure
-      yield configuration
-      configuration
-    end
-
-    ############################
-    # configuration class method
-    ############################
-    # Arguments: None
-    # Provides the lazy-loaded class instance variable @configuration
-    # Return (NerdDice::Configuration) the Configuration object tied to the
-    #   @configuration class instance variable
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    ############################
-    # total_dice class method
-    ############################
-    # Arguments:
-    #   number_of_sides (Integer) =>  the number of sides of the dice to roll
-    #   number_of_dice (Integer, DEFAULT: 1) => the quantity to roll of the type
-    #     of die specified in the number_of_sides argument.
-    #   options (Hash, DEFAULT: {}) any additional options you wish to include
-    #     :bonus (Integer) => The total bonus (positive integer) or penalty
-    #       (negative integer) to modify the total by. Is added to the total of
-    #       all dice after they are totaled, not to each die rolled
-    #
-    # Return (Integer) => Total of the dice rolled, plus modifier if applicable
-    def total_dice(number_of_sides, number_of_dice = 1, **opts)
-      total = 0
-      number_of_dice.times do
-        total += execute_die_roll(number_of_sides, opts[:randomization_technique])
-      end
-      begin
-        total += opts[:bonus].to_i
-      rescue NoMethodError
-        raise ArgumentError, "Bonus must be a value that responds to :to_i"
-      end
-      total
-    end
-
-    ############################
-    # execute_die_roll class method
-    ############################
-    # Arguments:
-    #   number_of_sides (Integer) =>  the number of sides of the die to roll
-    #   using_generator (Symbol) => must be one of the symbols in
-    #     RANDOMIZATION_TECHNIQUES or nil
-    #
-    # Return (Integer) => Value of the single die rolled
-    def execute_die_roll(number_of_sides, using_generator = nil)
-      @count_since_last_refresh ||= 0
-      gen = get_number_generator(using_generator)
-      result = gen.rand(number_of_sides) + 1
-      increment_and_evalutate_refresh_seed
-      result
-    end
-
-    ############################
-    # refresh_seed! class method
-    ############################
-    # Options: (none required)
-    #   randomization_technique (Symbol) => must be one of the symbols in
-    #     RANDOMIZATION_TECHNIQUES if specified
-    #   random_rand_seed (Integer) => Seed to set for Random
-    #   random_object_seed (Integer) => Seed to set for new Random object
-    # Return (Hash or nil) => Previous values of generator seeds that were refreshed
-    def refresh_seed!(**opts)
-      technique, random_rand_new_seed, random_object_new_seed = parse_refresh_options(opts)
-      @count_since_last_refresh = 0
-      return nil if technique == :securerandom
-
-      reset_appropriate_seeds!(technique, random_rand_new_seed, random_object_new_seed)
-    end
-
-    private
-
-      def get_number_generator(using_generator = nil)
-        using_generator ||= configuration.randomization_technique
-        case using_generator
-        when :securerandom then SecureRandom
-        when :random_rand then Random
-        when :random_object then @random_object ||= Random.new
-        when :randomized then random_generator
-        else raise ArgumentError, "Unrecognized generator. Must be one of #{RANDOMIZATION_TECHNIQUES.join(', ')}"
-        end
-      end
-
-      def random_generator
-        gen = RANDOMIZATION_TECHNIQUES.reject { |el| el == :randomized }.sample
-        get_number_generator(gen)
-      end
-
-      def refresh_random_rand_seed!(new_seed)
-        new_seed ? Random.srand(new_seed) : Random.srand
-      end
-
-      def refresh_random_object_seed!(new_seed)
-        old_seed = @random_object&.seed
-        @random_object = new_seed ? Random.new(new_seed) : Random.new
-        old_seed
-      end
-
-      def parse_refresh_options(opts)
-        [
-          opts[:randomization_technique] || configuration.randomization_technique,
-          opts[:random_rand_seed],
-          opts[:random_object_seed]
-        ]
-      end
-
-      # rubocop:disable Metrics/MethodLength
-      def reset_appropriate_seeds!(technique, random_rand_new_seed, random_object_new_seed)
-        return_hash = {}
-        case technique
-        when :random_rand
-          return_hash[:random_rand_prior_seed] = refresh_random_rand_seed!(random_rand_new_seed)
-        when :random_object
-          return_hash[:random_object_prior_seed] = refresh_random_object_seed!(random_object_new_seed)
-        when :randomized
-          return_hash[:random_rand_prior_seed] = refresh_random_rand_seed!(random_rand_new_seed)
-          return_hash[:random_object_prior_seed] = refresh_random_object_seed!(random_object_new_seed)
-        end
-        return_hash
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def increment_and_evalutate_refresh_seed
-        @count_since_last_refresh += 1
-        return unless configuration.refresh_seed_interval
-
-        refresh_seed! if @count_since_last_refresh >= configuration.refresh_seed_interval
-      end
-  end
+  ABILITY_SCORE_KEYS = %i[ability_score_array_size ability_score_number_of_sides ability_score_dice_rolled
+                          ability_score_dice_kept].freeze
 end

data/nerd_dice.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.metadata["bug_tracker_uri"] = "https://github.com/statelesscode/nerd_dice/issues"
   spec.metadata["documentation_uri"] = "https://github.com/statelesscode/nerd_dice/README.md"
   spec.metadata["github_repo"] = "https://github.com/statelesscode/nerd_dice"
-  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -44,13 +43,13 @@ Gem::Specification.new do |spec|
   spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $PROGRAM_NAME.end_with?("gem")
 
   # Dependencies
-  spec.add_dependency "securerandom", "~> 0.2", ">= 0.2.2"
+  spec.add_dependency "securerandom", "~> 0.1", ">= 0.1.0"
 
   # Development Dependencies
-  spec.add_development_dependency "coveralls_reborn", "~> 0.27.0"
-  spec.add_development_dependency "rubocop", "~> 1.46", ">= 1.46.0"
-  spec.add_development_dependency "rubocop-performance", "~> 1.16", ">= 1.16.0"
+  spec.add_development_dependency "coveralls_reborn", "~> 0.22.0"
+  spec.add_development_dependency "rubocop", "~> 1.20", ">= 1.20.0"
+  spec.add_development_dependency "rubocop-performance", "~> 1.11", ">= 1.11.5"
   spec.add_development_dependency "rubocop-rake", "~> 0.6", ">= 0.6.0"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.18", ">= 2.18.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.4", ">= 2.4.0"
   spec.add_development_dependency "simplecov-lcov", "~> 0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nerd_dice
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Duchemin
@@ -10,33 +10,32 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEhTCCAu2gAwIBAgIBATANBgkqhkiG9w0BAQsFADBEMRYwFAYDVQQDDA1zdGF0
-  ZWxlc3Njb2RlMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
-  FgNjb20wHhcNMjMwMjIzMjMyMTQwWhcNMjQwMjIzMjMyMTQwWjBEMRYwFAYDVQQD
-  DA1zdGF0ZWxlc3Njb2RlMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJ
-  k/IsZAEZFgNjb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCxVzHS
-  gYszan//tjTSO0z59UO1rUiT5G0//iyhiaYIiuwxhYFbfD+wOCou4M18pQtEb4qx
-  o67tPfGimBAVak6fGfo8fo1ByHiKCvx3jgOjxNifT9pRFlBSr6ZvyXeu7zA0ddLr
-  slw92DNqeRlZXqB0mxDtpKWONGc1XhAqEjEP3VL7g7x0xPQShcpXg/OyRPR5vyv8
-  66pXdFrXYZGrySfIB6ZOWFV6wGBj603rPdXOeYVeks6hKvw3wb4G1s7tvwTA5MWI
-  otw6Mp9TaMdms9zTc5A3N58pueKfBJfwkICkdAGJDWC6sIXECoaTDRqVK96RSH/1
-  8tEPDoFYpJDOa5byX1j7srwO0B6WOtPxix7gW1wBbEp7eWSQf1k3k9XEh32SRsPq
-  NJObRfhkzoa9p1tPkVP3nasDTK5gtisolwhb7Vimeup54yKfT/THv2iNEnGTvK1P
-  sV4vC8nch88lBI1mIecmSh/mwED4Mb1dNtcyuB/+XnSI8vIzXJKAAKaT0eMCAwEA
-  AaOBgTB/MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRP42hSa0JV
-  QGDSobiGTYyfM570hjAiBgNVHREEGzAZgRdzdGF0ZWxlc3Njb2RlQGdtYWlsLmNv
-  bTAiBgNVHRIEGzAZgRdzdGF0ZWxlc3Njb2RlQGdtYWlsLmNvbTANBgkqhkiG9w0B
-  AQsFAAOCAYEANtaR6OV7p1IJOsvVgGQzVg88NIOeXrfOaEDUPb6eg4JMOSL0Cvvl
-  2F7lB/ykbQcO4Oe7NucuavC7ClyG3c/V5eQ5TtPNWkMbVN9ESVR8wk5SjhiI8L35
-  MBxJ6YU27eyDmazQJ7eCYcRJkuyWt3KcqgsEh7JyNnKcJ/3rgf1QW0IyJiGsXM1I
-  SssQ/t7Ia2tVMrVMsvs834v9FRpVbO3dHdCO4t7zQBIADVcj4NqCDV10D6aji/Aa
-  35YJHwlkhuZH6AYC45QHt9dW0/OLmbFwoJqW7syrso2PParyMr4YcJwucXViRiL7
-  l5aVpYdz/RTqdB92Mmud5Hj5zkuEE4CHBh8L8AJC5kZu/YUXXDtuECSMVhg5O84h
-  QsdcuygyVASmw2aliMAFXfIBDYelduG0XwjdOREN3q4SDTKP+pfBxx6OdD1RfsYF
-  /9HhtVbKLq34iQftF4oIH66bYDEyG5y4CLKQ8Nq0WDWq50OcaP9KpDiS21BC43SW
-  t+NX7PDOWx4k
+  MIIETTCCArWgAwIBAgIBATANBgkqhkiG9w0BAQsFADAoMSYwJAYDVQQDDB1zdGF0
+  ZWxlc3Njb2RlL0RDPWdtYWlsL0RDPWNvbTAeFw0yMDEyMDYyMzQ1NTZaFw0yMTEy
+  MDYyMzQ1NTZaMCgxJjAkBgNVBAMMHXN0YXRlbGVzc2NvZGUvREM9Z21haWwvREM9
+  Y29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAyHIMJi0o3bwBZsx5
+  TQ35XByFsdDRsro3T+0NY7EAILtOiU04o9C2NPOp/RQE7BXQgMjGebwp6bT6QvzN
+  6noV4jPL7Fi5pWw08QygG7f+73YUBb+8d8o+3xGrC+UO5h1PZEtVcZwUWUG18QBE
+  fbDinQT6P4IDQoZwhfrPCB+aBfUyQp4Ok7oD7MEWqsq9SjrSxqxfk4+oZdXUySe7
+  Vi5vnzVQ5uFf56NHwWnNKCzJzmH84mBO5MzHaQpHNzKGJPoUmzLU5RBlCH6YXqBG
+  KhXTMUDBWKJmJ3RDry/FpGgJLKu4wzFRYjXla6IjeKozWGuPNNJ+2mesXKhsX7bo
+  vVCzRxPEupbEg/0FkJiWpiGlSPOdd6oJiwX8E6rlEeV605xrbOQewkbovHkYTMtG
+  +NH+u08x0z4Oj71kmDLwuj812uS0mtrCg2VhiYO0ZCQ4XrwBsBfK+/MtMlR+o6sG
+  /zvz/vHVJKaLTQxRp5oGo4QH6HfbOnwzTkXdZnt5AlN31ErJAgMBAAGjgYEwfzAJ
+  BgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUC7seYydsGO6O1qT4nVVD
+  G/LkiHYwIgYDVR0RBBswGYEXc3RhdGVsZXNzY29kZUBnbWFpbC5jb20wIgYDVR0S
+  BBswGYEXc3RhdGVsZXNzY29kZUBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQADggGB
+  ADPRFRB1cjqdcE2O0jtqiDRmrR62uEYBiUbkRPVhyoEp/cK0TVhAs9mGWAyCWu0M
+  LewUeqNTUvQ9MgvagcKcnxa2RTjdrP3nGnwpStMr9bm3ArNJEzvWEs0Eusk9y73x
+  fjy0qH2pw5WPfWcKYlDehMXqOP+a4udYsz0YSNiI8qEfkDCSqTJN11d5kSjVjwGB
+  xkauxDT68j1JZRjPmQl3dl+DCgxkoziWX2mFTPLfGg5vZ0t6gmhdUtLvJtNIo0IX
+  477E5UjmE1+rULQp/fsH6n5+H+t2eCED41ST+gkKbaQBUfIuUaCmdHz9sJaIIBw2
+  6ordFa1nrLV4w5Uf6qYFnWVhIWX4GToyZSPO2s0DPYp3PWFJ4VtzKa2vp1TR5ZEA
+  dkij2eQ9M8bzWWmW+A7RNaI0CzLl967bKGBSaMVCsZGBarggWD8UwJnBhTuOPZGR
+  WQ4faXJSevxT+x9TgyUNJINPkz/KqreClzdL83cwxPzFFQto7zF6zMCsj0slqJjW
+  EQ==
   -----END CERTIFICATE-----
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: securerandom
@@ -44,74 +43,74 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.46'
+        version: '1.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.46.0
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.46'
+        version: '1.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.46.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.11.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.11.5
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -138,20 +137,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +205,19 @@ files:
 - checksum/nerd_dice-0.2.0.gem.sha256
 - checksum/nerd_dice-0.2.0.gem.sha512
 - lib/nerd_dice.rb
+- lib/nerd_dice/class_methods.rb
+- lib/nerd_dice/class_methods/configure.rb
+- lib/nerd_dice/class_methods/execute_die_roll.rb
+- lib/nerd_dice/class_methods/harvest_totals.rb
+- lib/nerd_dice/class_methods/refresh_seed.rb
+- lib/nerd_dice/class_methods/roll_ability_scores.rb
+- lib/nerd_dice/class_methods/roll_dice.rb
+- lib/nerd_dice/class_methods/total_ability_scores.rb
+- lib/nerd_dice/class_methods/total_dice.rb
 - lib/nerd_dice/configuration.rb
+- lib/nerd_dice/dice_set.rb
+- lib/nerd_dice/die.rb
+- lib/nerd_dice/sets_randomization_technique.rb
 - lib/nerd_dice/version.rb
 - nerd_dice.gemspec
 homepage: https://github.com/statelesscode/nerd_dice
@@ -221,7 +232,6 @@ metadata:
   bug_tracker_uri: https://github.com/statelesscode/nerd_dice/issues
   documentation_uri: https://github.com/statelesscode/nerd_dice/README.md
   github_repo: https://github.com/statelesscode/nerd_dice
-  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -237,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem for rolling polyhedral dice.