nerd_dice 0.2.0 → 0.3.0

data/lib/nerd_dice/sets_randomization_technique.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NerdDice
+  # The NerdDice::SetsRandomizationTechnique is a module mixin that can be included
+  # in classes. It provides an attribute reader and writer for randomization_technique
+  # and checks against the NerdDice::RANDOMIZATION_TECHNIQUES constant to make sure the
+  # input provided is valid
+  module SetsRandomizationTechnique
+    attr_reader :randomization_technique
+
+    def randomization_technique=(new_value)
+      unless RANDOMIZATION_TECHNIQUES.include?(new_value) || new_value.nil?
+        raise NerdDice::Error, "randomization_technique must be one of #{NerdDice::RANDOMIZATION_TECHNIQUES.join(', ')}"
+      end
+
+      @randomization_technique = new_value
+    end
+  end
+end

data/lib/nerd_dice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NerdDice
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

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

@@ -46,8 +46,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "securerandom", "~> 0.1", ">= 0.1.0"
 
   # Development Dependencies
-  spec.add_development_dependency "rubocop", "~> 1.8", ">= 1.8.1"
-  spec.add_development_dependency "rubocop-performance", "~> 1.9", ">= 1.9.1"
-  spec.add_development_dependency "rubocop-rake", "~> 0.5", ">= 0.5.1"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.1", ">= 2.1.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.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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Duchemin
@@ -35,7 +35,7 @@ cert_chain:
   WQ4faXJSevxT+x9TgyUNJINPkz/KqreClzdL83cwxPzFFQto7zF6zMCsj0slqJjW
   EQ==
   -----END CERTIFICATE-----
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: securerandom
@@ -57,86 +57,114 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.5
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: |2
       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
@@ -148,14 +176,15 @@ email:
 executables:
 - console
 - generate_checksums
+- nerd_dice_benchmark
 - setup
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - BURN_THE_CONTRIBUTOR_COVENANT_WITH_FIRE.md
 - CHANGELOG.md
 - Gemfile
@@ -166,14 +195,29 @@ files:
 - UNLICENSE.txt
 - bin/console
 - bin/generate_checksums
+- bin/nerd_dice_benchmark
 - bin/setup
 - certs/msducheminjr.pem
 - checksum/nerd_dice-0.1.0.gem.sha256
 - checksum/nerd_dice-0.1.0.gem.sha512
 - checksum/nerd_dice-0.1.1.gem.sha256
 - checksum/nerd_dice-0.1.1.gem.sha512
+- 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
@@ -203,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem for rolling polyhedral dice.

metadata.gz.sig

@@ -1,4 +1,3 @@
-K�B�p���:�
�'�	�9��~��"�Y!W-��0��Fvj ~���UyyN�|=&�w��h��z�,�H)�+
-��S�y`�/4��O?1:
-�cR
-�`�#�;���t���W�Q��[�!�cN������U�jf'�Q�	QJ���Ƿt��p�ڝu0ռ[�Rj�"���vOY���m��!�n6�9�PV�k��ԗJG/|�ѓk�VN��꿫_�+
+C����w
+�g4���]�T۞~����s�����ul�!�
�o��D���#����`t��r��r̋8l��������M]�Tu���M���X�Ʌe/���ϧ9��.�>�G��B��'��R����۽/r"wa�����P��p�0���pd޼�v�,�N�_㼨�����krd��PT������͋)V�c�"#RG�З{��|�nP	9�X�s�p�i���>�?^�6LXQ�.4 
�O�ء6怳�`ݣ�D.����ڠ|�S��:a�P��j���"��1ȩF�*V7��
+�-�w�r���[�5�7��,�4���_��}�SJ:

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4