nerd_dice 0.1.0 → 0.4.0

data/lib/nerd_dice/dice_set.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module NerdDice
+  # The NerdDice::DiceSet class allows you to instantiate and roll a set of dice by specifying
+  # the number of sides, the number of dice (with a default of 1) and other options. As part of
+  # initialization the DiceSet will initialize and roll the Die objects specified by the
+  # DiceSet.new method. The parameters align with the NerdDice.total_dice method and
+  # NerdDice::DiceSet.new(6, 3, bonus: 5).total would be equivalent to
+  # NerdDice.total_dice(6, 3, bonus: 5)
+  #
+  # Usage:
+  #   Instantiate a d20:
+  #   <tt>dice = NerdDice::DiceSet.new(20)
+  #       dice.total # between 1 and 20
+  #   </tt>
+  #
+  #   Instantiate 3d6 + 5:
+  #   <tt>dice = NerdDice::DiceSet.new(6, 3, bonus: 5)
+  #       dice.total # between 8 and 23
+  #   </tt>
+  #
+  #   You can also specify options that will cascade to the member dice when instantiating
+  #   <tt>NerdDice::DiceSet.new(6, 3, randomization_technique: :randomized,
+  #                        foreground_color: "#FF0000",
+  #                        background_color: "#FFFFFF"
+  #                        damage_type: "necrotic"))
+  #   </tt>
+  class DiceSet
+    include Enumerable
+    include SetsRandomizationTechnique
+
+    attr_reader :number_of_sides, :number_of_dice, :dice, :bonus
+    attr_accessor :background_color, :foreground_color, :damage_type
+
+    # required to implement Enumerable uses the @dice collection
+    def each(&block)
+      @dice.each(&block)
+    end
+
+    # not included by default in Enumerable: allows [] directly on the DiceSet object
+    def [](index)
+      @dice[index]
+    end
+
+    # not included by default in Enumerable: adds length property directly to the DiceSet object
+    def length
+      @dice.length
+    end
+
+    # sorts the @dice collection in place
+    def sort!
+      @dice.sort!
+    end
+
+    # reverses the @dice collection in place
+    def reverse!
+      @dice.reverse!
+    end
+
+    # re-rolls each Die in the collection and sets its is_included_in_total property back to true
+    def reroll_all!
+      @dice.map do |die|
+        die.roll
+        die.is_included_in_total = true
+      end
+    end
+
+    # resets is_included_in_total property back to true for each Die in the collection
+    def include_all_dice!
+      @dice.map { |die| die.is_included_in_total = true }
+    end
+
+    ###################################
+    # highest instance method
+    # (aliased as with_advantage)
+    ###################################
+    # Arguments:
+    #   number_to_take (Integer default: nil) =>  the number dice to take
+    #
+    # Notes:
+    # * If the method is called with a nil value it will take all but one of the dice
+    # * If the method is called on a DiceSet with one Die, the lone Die will remain included
+    # * The method will raise an ArgumentError if you try to take more dice than the DiceSet contains
+    # * Even though this method doesn't have a bang at the end, it does call other bang methods
+    #
+    # Return (NerdDice::DiceSet) => Returns the instance the method was called on with
+    # die objects that have is_included_in_total property modified as true for the highest(n)
+    # dice and false for the remaining dice.
+    def highest(number_to_take = nil)
+      include_all_dice!
+      number_to_take = check_low_high_argument!(number_to_take)
+      get_default_to_take if number_to_take.nil?
+      @dice.sort.reverse.each_with_index do |die, index|
+        die.is_included_in_total = false if index >= number_to_take
+      end
+      self
+    end
+
+    alias with_advantage highest
+
+    ###################################
+    # lowest instance method
+    # (aliased as with_disadvantage)
+    ###################################
+    # Arguments and Notes are the same as for the highest method documented above
+    #
+    # Return (NerdDice::DiceSet) => Returns the instance the method was called on with
+    # die objects that have is_included_in_total property modified as true for the lowest(n)
+    # dice and false for the remaining dice.
+    def lowest(number_to_take = nil)
+      include_all_dice!
+      number_to_take = check_low_high_argument!(number_to_take)
+      get_default_to_take if number_to_take.nil?
+      @dice.sort.each_with_index do |die, index|
+        die.is_included_in_total = false if index >= number_to_take
+      end
+      self
+    end
+
+    alias with_disadvantage lowest
+
+    # custom attribute writer that ensures the argument is an Integer duck-type and calls to_i
+    def bonus=(new_value)
+      @bonus = new_value.to_i
+    rescue NoMethodError
+      raise ArgumentError, "Bonus must be a value that responds to :to_i"
+    end
+
+    ###################################
+    # total method
+    ###################################
+    # Return (Integer) => Returns the sum of the values on the Die objects in the collection
+    # where is_included_in_total is set to true and then adds the value of the bonus
+    # attribute (which may be negative)
+    def total
+      @dice.select(&:included_in_total?).sum(&:value) + @bonus
+    end
+
+    private
+
+      def initialize(number_of_sides, number_of_dice = 1, **opts)
+        @number_of_sides = number_of_sides
+        @number_of_dice = number_of_dice
+        parse_options(opts)
+        @dice = []
+        @number_of_dice.times { @dice << Die.new(@number_of_sides, **opts) }
+      end
+
+      def parse_options(opts)
+        self.randomization_technique = opts[:randomization_technique]
+        @background_color = opts[:background_color] || NerdDice.configuration.die_background_color
+        @foreground_color = opts[:foreground_color] || NerdDice.configuration.die_foreground_color
+        @damage_type = opts[:damage_type]
+        self.bonus = opts[:bonus]
+      end
+
+      # validates the argument input to the highest and lowest methods
+      # sets a default value if number_to_take is nil
+      def check_low_high_argument!(number_to_take)
+        number_to_take ||= number_of_dice == 1 ? 1 : number_of_dice - 1
+        raise ArgumentError, "Argument cannot exceed number of dice" if number_to_take > number_of_dice
+
+        number_to_take
+      end
+  end
+end

data/lib/nerd_dice/die.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module NerdDice
+  # The NerdDice::Die class allows you to instantiate and roll a die by specifying
+  # the number of sides with other options. As part of initialization the die will
+  # be rolled and have a value
+  #
+  # Usage:
+  #   Instantiate a d20:
+  #   <tt>die = NerdDice::Die.new(20)
+  #       die.value # between 1 and 20
+  #   </tt>
+  #
+  #   You can also specify options when instantiating
+  #   <tt>NerdDice::Die.new(12, randomization_technique: :randomized,
+  #                        foreground_color: "#FF0000",
+  #                        background_color: "#FFFFFF",
+  #                        damage_type: "necrotic"))
+  #   </tt>
+  class Die
+    include Comparable
+    include SetsRandomizationTechnique
+
+    attr_reader :number_of_sides, :value
+    attr_accessor :background_color, :foreground_color, :damage_type, :is_included_in_total
+
+    # comparison operator override using value: required to implement Comparable
+    def <=>(other)
+      value <=> other.value
+    end
+
+    # rolls the die, setting the value to the new roll and returning that value
+    def roll
+      @value = NerdDice.execute_die_roll(@number_of_sides, @randomization_technique)
+    end
+
+    alias included_in_total? is_included_in_total
+
+    private
+
+      def initialize(number_of_sides, **opts)
+        @number_of_sides = number_of_sides
+        self.randomization_technique = opts[:randomization_technique]
+        @background_color = opts[:background_color] || NerdDice.configuration.die_background_color
+        @foreground_color = opts[:foreground_color] || NerdDice.configuration.die_foreground_color
+        @damage_type = opts[:damage_type]
+        @is_included_in_total = true
+        roll
+      end
+  end
+end

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.1.0"
+  VERSION = "0.4.0"
 end

data/lib/nerd_dice.rb

@@ -1,47 +1,29 @@
 # frozen_string_literal: true
 
 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"
+require "nerd_dice/convenience_methods"
 # 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
 # specified number of dice such as rolling 4d6 and dropping the lowest for
 # 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
 
-  ############################
-  # 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 self.total_dice(number_of_sides, number_of_dice = 1, opts = {})
-    total = 0
-    number_of_dice.times do
-      total += rand(number_of_sides) + 1
-    end
-    total += opts[:bonus] if opts[:bonus].is_a?(Integer)
-    total
-  end
+  RANDOMIZATION_TECHNIQUES = %i[securerandom random_rand random_object randomized].freeze
+  ABILITY_SCORE_KEYS = %i[ability_score_array_size ability_score_number_of_sides ability_score_dice_rolled
+                          ability_score_dice_kept].freeze
+
+  extend ConvenienceMethods
 end

data/nerd_dice.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/statelesscode/nerd_dice"
-  spec.metadata["changelog_uri"] = "https://github.com/statelesscode/nerd_dice/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/statelesscode/nerd_dice/blob/master/CHANGELOG.md"
   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["documentation_uri"] = "https://github.com/statelesscode/nerd_dice/README.md"
+  spec.metadata["github_repo"] = "https://github.com/statelesscode/nerd_dice"
 
   # 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.
@@ -40,11 +40,16 @@ Gem::Specification.new do |spec|
 
   # Certs and signing
   spec.cert_chain  = ["certs/msducheminjr.pem"]
-  spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $PROGRAM_NAME.match?(/gem\z/)
+  spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $PROGRAM_NAME.end_with?("gem")
 
   # Dependencies
-  spec.add_development_dependency "rubocop", "~> 1.5", ">= 1.5.2"
-  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.0", ">= 2.0.1"
+  spec.add_dependency "securerandom", "~> 0.1", ">= 0.1.1"
+
+  # Development Dependencies
+  spec.add_development_dependency "coveralls_reborn", "~> 0.23.0"
+  spec.add_development_dependency "rubocop", "~> 1.22", ">= 1.22.2"
+  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.5", ">= 2.5.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.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Duchemin
@@ -35,88 +35,136 @@ cert_chain:
   WQ4faXJSevxT+x9TgyUNJINPkz/KqreClzdL83cwxPzFFQto7zF6zMCsj0slqJjW
   EQ==
   -----END CERTIFICATE-----
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.22'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.22.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.22'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.22.2
 - !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.0'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.5.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
@@ -127,14 +175,16 @@ email:
 - statelesscode@gmail.com
 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
@@ -144,8 +194,33 @@ files:
 - Rakefile
 - 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
+- checksum/nerd_dice-0.3.0.gem.sha256
+- checksum/nerd_dice-0.3.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/convenience_methods.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
@@ -156,9 +231,10 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/statelesscode/nerd_dice
   source_code_uri: https://github.com/statelesscode/nerd_dice
-  changelog_uri: https://github.com/statelesscode/nerd_dice/CHANGELOG.md
+  changelog_uri: https://github.com/statelesscode/nerd_dice/blob/master/CHANGELOG.md
   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
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -174,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem for rolling polyhedral dice.

data/.travis.yml

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