nerd_dice 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9829d6b43a9548f57a3c8ed8d9bb37955b7d78c3a96216b337184fc56271c6e7
-  data.tar.gz: 42143651b8e4feb48321f088de10adae1e2b16fcf5c945421017d81d8824e353
+  metadata.gz: 8f64389429514a7d0c2a8410b2e27575e5c11b316b50cee41b37c58d8f8af953
+  data.tar.gz: 4d2365e3ce8139d4675695dfe47edf9ef5d52b9cc873beb5c7c314b8955aaa33
 SHA512:
-  metadata.gz: 87fd79c32d6b160705ab428273553e4d805bdfdd537f5b9695425701f1db281e6cd557c3266fc49148b1567126c1ef741178d42be0a64e08750db773cc25edd8
-  data.tar.gz: 891670ff69791edb4c72008e112c4a11eb681bad56b1d914571466c94630ad4c1b3cafeb17811f1d75c81c7969e221e3b6b9ff5d2baf52521617008b7c9d8059
+  metadata.gz: d8bf0ea2c85e3aedf952d82d0f511463accedcad5122b14a7d6769a94100902887ca0e52cf85a6d8b69a75a6cd750858852ad71e34980e61624d39666bedff5b
+  data.tar.gz: ee2e8117b3071872a3d07353dabd4685c4a20e188591e80cbcb93609ba9f134ab22082ae01bee152c34c9cdd1a81a6a40aec2b1521d3e2a106d10f0c8fa313ae

data/.github/workflows/main.yml

@@ -0,0 +1,67 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Nerd Dice CI
+
+# Controls when the action will run.
+on: [push, pull_request]
+
+  # Allows you to run this workflow manually from the Actions tab
+  # workflow_dispatch:
+
+jobs:
+  test_rspec:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+    - name: Coveralls Parallel
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        flag-name: run-${{ matrix.test_number }}
+        parallel: true
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run rubocop
+      run: bundle exec rubocop --parallel
+
+  benchmark:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run benchmark script
+      run: bin/nerd_dice_benchmark
+
+  finish:
+    needs: test_rspec
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

data/.rubocop.yml

@@ -161,6 +161,14 @@ Layout/TrailingWhitespace:
 Style/RedundantPercentQ:
   Enabled: true
 
+# exclude spec from block length
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'nerd_dice.gemspec'
+
 Lint/ErbNewArguments:
   Enabled: true
 
@@ -305,3 +313,109 @@ Performance/StringInclude: # (new in 1.7)
 
 Performance/Sum: # (new in 1.8)
   Enabled: true
+
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+
+# Added 2021-08-14
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation: # (new in 1.18)
+  Enabled: true
+
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+
+Naming/InclusiveLanguage: # (new in 1.18)
+  Enabled: false
+
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+
+Performance/MapCompact: # (new in 1.11)
+  Enabled: true
+
+Performance/RedundantEqualityComparisonBlock: # (new in 1.10)
+  Enabled: true
+
+Performance/RedundantSplitRegexpArgument: # (new in 1.10)
+  Enabled: true
+
+RSpec/IdenticalEqualityAssertion: # (new in 2.4)
+  Enabled: true
+
+RSpec/Rails/AvoidSetupHook: # (new in 2.4)
+  Enabled: true
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true

data/CHANGELOG.md

@@ -1,8 +1,82 @@
 # Nerd Dice Changelog
 
 ## master \(unreleased\)
+### Added
+### Changed
+### Fixed
 
-## 0.1.0 \(2020-12-06\)
+## 0.4.0 \(2021-10-23\)
+### Added
+* Add `NerdDice::ConvenienceMethods` method_missing mixin module that allows for dynamic invocation of patterns in the method name that get converted into calls to `NerdDice.roll_dice` or `NerdDice.total_dice` along with allowing the advantage/disadvantage mechanic or bonuses to be parsed from the method name. Full documentation of the module can be found in the [Convenience Methods Mixin](README.md#convenience-methods-mixin) section of the README.
+* Add exensive specs to support the ConvenienceMethods module
+### Changed
+* Replace `Benchmark.bmbm` with `Benchmark.bm` in the nerd_dice_benchmark
+* Add convenience_methods to nerd_dice_benchmark
+* Extend `NerdDice::ConvenienceMethods` into top-level module as class methods
+### Fixed
+* Fix typos and horizontal scrolling in README
+* Fix CodeClimate Code Smell on harvest_totals
 
-### New Features
+## 0.3.0 \(2021-09-11\)
+### Added
+* Add new options to `NerdDice::Configuration`
+  - `ability_score_number_of_sides`
+  - `ability_score_dice_rolled`
+  - `ability_score_dice_kept`
+* Add `NerdDice.harvest_totals` method that takes in a collection and returns the results of calling `total` on each element
+* Add `NerdDice.roll_ability_scores` convenience method that returns an array of `DiceSet` objects based on options and/or configuration
+* Add `NerdDice.total_ability_scores` convenience method that returns an array of integers based on options and/or configuration
+* Add `NerdDice::Die` class that represents a single die object and mixes in the `Comparable` module
+* Add `NerdDice::DiceSet` class that represents a collection of `Die` objects and mixes in the `Enumerable` module
+* Add `NerdDice::SetsRandomizationTechnique` mixin module and include in the `DiceSet` and `Die` classes
+* Add `die_background_color` and `die_foreground_color` to `Configuration` class with defaults defined as constants
+* Add `NerdDice.roll_dice` method that behaves in a similar fashion to `total_dice` but returns a `DiceSet` object instead of an `Integer` and has additional optional arguments relating to the non-numeric attributes of the dice
+* Add `coveralls_reborn` to RSpec and GitHub actions
+* Add build badge to README
+* Add Code Climate maintainability integration and badge to README
+* Add `nerd_dice_benchmark` script to bin directory
+* Add GitHub Action CI build
+  - Run RSpec test suite, fail if specs fail, report coverage via Coveralls
+  - Run RuboCop and fail if violations
+  - Run benchmark suite and fail if outside of allowed ratios
+### Changed
+* Update RuboCop version and configuration
+* Break up the NerdDice source code file into several smaller files that are included by the module
+* Enforce that `NerdDice.configuration.ability_score_array_size` must be a positive duck-type integer
+### Fixed
+
+## 0.2.0 \(2021-01-28\)
+### Added
+* Add ability to configure with `NerdDice.configure` block or `NerdDice.configuration`
+  - Configure `randomization_technique` as `:random_rand`, `:securerandom`, `:random_object`, or `randomized`
+  - Configure `refresh_seed_interval` to allow a periodic refresh of the seed
+* Add `randomization_technique` option to `NerdDice.total_dice` method keyword arguments
+* Add a lower-level `execute_die_roll` method that allows you to roll a single die with a generator specified
+* Add ability to manually refresh or specify seed with `:refresh_seed!` method
+### Changed
+* Change `opts = {}` final argument to use keyword args `**opts` in the `NerdDice.total_dice` method. Now the method can be called as follows:
+```ruby
+# old
+NerdDice.total_dice(20, 1, {bonus: 5})
+NerdDice.total_dice(6, 3, {bonus: 1})
+
+# new
+NerdDice.total_dice(20, bonus: 5)
+NerdDice.total_dice(6, 3, bonus: 1)
+```
+* Call `:to_i` on bonus instead of using `:is_a?` and raise ArgumentError in the `NerdDice.total_dice` method if it doesn't respond to `:to_i`
+* Added `securerandom` as an explicit dependency due to Ruby 3.x change to bundled gem
+* `total_dice` no longer calls unqualified `.rand` which improves performance on all generators except for `:securerandom`
+### Fixed
+
+## 0.1.1 \(2020-12-12\)
+### Added
+### Changed
+### Fixed
+* Fix broken link to CHANGELOG in gemspec
+* Fix rubocop offenses from 0.1.0 and refactor specs
+
+## 0.1.0 \(2020-12-07\)
+
+### Added
 * Add NerdDice.total_dice class method with the ability to roll multiple polyhedral dice and add a bonus

data/Gemfile

@@ -5,5 +5,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in nerd_dice.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"

data/Gemfile.lock

@@ -1,66 +1,88 @@
 PATH
   remote: .
   specs:
-    nerd_dice (0.1.0)
+    nerd_dice (0.4.0)
+      securerandom (~> 0.1, >= 0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
+    coveralls_reborn (0.23.0)
+      simplecov (>= 0.18.1, < 0.22.0)
+      term-ansicolor (~> 1.6)
+      thor (>= 0.20.3, < 2.0)
+      tins (~> 1.16)
     diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (2.7.2.0)
+    docile (1.4.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (1.8.2)
-    rexml (3.2.3)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.5.2)
+    rspec-support (3.10.2)
+    rubocop (1.22.2)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.1)
-      rubocop (>= 0.90.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.0.1)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    securerandom (0.1.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.3)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls_reborn (~> 0.23.0)
   nerd_dice!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.5, >= 1.5.2)
-  rubocop-performance (~> 1.9, >= 1.9.1)
-  rubocop-rake (~> 0.5, >= 0.5.1)
-  rubocop-rspec (~> 2.0, >= 2.0.1)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.22, >= 1.22.2)
+  rubocop-performance (~> 1.11, >= 1.11.5)
+  rubocop-rake (~> 0.6, >= 0.6.0)
+  rubocop-rspec (~> 2.5, >= 2.5.0)
+  simplecov-lcov (~> 0.8.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.22