rollr 0.0.6 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 107c19f3d3fb4c489bf0cd139aa3b7220407a929
+  data.tar.gz: 4c39c86ddcc4c4741d6f69754ca8a812bd2f5d20
+SHA512:
+  metadata.gz: d233a5b67b864749d0a5bdf4a7ad2b39c23e7d2a5306310f5250cfc15a88e5a4886df36b0d634adea26d19477dddbc0c03ee4384486b58c6336ce7d695b468a8
+  data.tar.gz: 927817bb49c9b13c649b08dc65eef1ec046999051155831698a3388e6593363f325178a837d335121b859a49a5334d89d2b12b0e6548da60094d9ae375e1dbe0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alxjrvs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rollr.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Alex Jarvis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Jarvis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+# Rollr
+
+Rollr is a gem that simulates rolling dice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rollr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rollr
+
+## How to Get Rolling
+
+```
+$ gem install rollr
+$ irb
+> require 'rollr'
+#=> true
+```
+
+### The `Die` Class
+
+`Rollr` lets you make `Die`, and these `die` can have any number of sides.
+
+```
+> d6 = Rollr::Die.new(6)
+```
+
+When you roll a `Die`, you get a `RollResult`. 
+
+```
+> d6.roll
+#=> <Rollr::RollResult #hash total: 3, rolls: [3], number_of_dice: 1, die_sides: 6>
+> d6.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 6>
+```
+
+You can roll multiple dice of the same kind by passing a number to the `roll` argument with the `number` keyword argument. 
+
+```
+> d6.roll(number: 3)
+#=> <Rollr::RollResult #hash total: 9, rolls: [3, 5, 1], number_of_dice: 3, die_sides: 6>
+```
+
+### `RollResult`s
+```
+> result = d6.roll(number: 3)
+#=> <Rollr::RollResult #hash total: 14, rolls: [2, 6, 6], number_of_dice: 3, die_sides: 6>
+```
+
+The `RollResult` has few helpful things to report about your roll. 
+
+The `#total` method represents the sum total of the dice that were rolled: 
+
+```
+> result.total
+#=> 14
+```
+
+The `#rolls` array, which reports the individual results of any dice rolled: 
+
+```
+> result.rolls
+#=> [2, 6, 6]
+```
+
+`#number_of_dice` tells you how many dice were rolled this time: 
+
+```
+result.number_of_dice
+#=> 3 
+```
+
+`#die_sides` reports the number of sides on the dice rolled in this result:
+
+```
+result.die_sides
+#=> 6
+```
+
+### Dice Constants
+
+Rollr comes pre-packaged with several shortcuts for popular Die sizes:
+
+```
+#D20
+> result = Rollr::D20.roll
+#=> <Rollr::RollResult #hash total: 18, rolls: [18], number_of_dice: 1, die_sides: 20>
+
+#D12
+> result = Rollr::D12.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+
+#D10
+> result = Rollr::D10.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+
+#D8
+> result = Rollr::D8.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+
+#D6
+> result = Rollr::D6.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+
+#D4
+> result = Rollr::D4.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+
+#D3
+> result = Rollr::D3.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+
+#D2
+> result = Rollr::D2.roll
+#=> <Rollr::RollResult #hash total: 6, rolls: [6], number_of_dice: 1, die_sides: 12>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alxjrvs/rollr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rollr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rollr/die.rb

@@ -0,0 +1,28 @@
+require 'securerandom'
+
+module Rollr
+  class Die
+    attr_accessor :sides, :rolls
+
+    def initialize(sides)
+      @sides = sides
+    end 
+
+    def roll(number: 1)
+      Rollr::RollResult.new(
+        rolls: array_of_rolls(number),
+        sides: sides
+      )
+    end 
+
+    private
+
+    def single_roll
+      SecureRandom.random_number(sides)
+    end
+
+    def array_of_rolls(number)
+      (1..number).map { single_roll }
+    end
+  end 
+end

data/lib/rollr/roll_result.rb

@@ -0,0 +1,22 @@
+module Rollr
+  class RollResult
+    attr_accessor :rolls
+
+    def initialize(sides:, rolls:)
+      @sides = sides
+      @rolls = rolls
+    end 
+
+    def die_sides
+      @sides
+    end
+
+    def total
+      @_total ||= rolls.inject(:+)
+    end
+
+    def number_of_dice
+      @_number_of_dice ||= rolls.count
+    end
+  end 
+end

data/lib/rollr/version.rb

@@ -0,0 +1,3 @@
+module Rollr
+  VERSION = "1.0.1"
+end

data/lib/rollr.rb

@@ -1,93 +1,10 @@
-# Rollr Simulates rolling dice of different size.
-#
-# In its most recent version, it also supports a kind of primitive logging,
-# which can track the rolls made to the die over time, as well as the individual
-# results of rolls within a pool of rolls (so, for instance, if you rolled 20
-# 6 six sided die, you could see the result of each individual roll of each
-# die.
-#
-# @author Alex Jarvis
-
-require 'rubygems'
+require "rollr/version"
+require "rollr/die"
+require "rollr/roll_result"
 
 module Rollr
 
-
-  # Represents a single instance of a die
-  #
-  class Die
-
-
-    # @attribute sides [Integer] The number of sides the die has
-    #
-    attr_accessor :sides, :rolls
-
-    # New instance of Die
-    #
-    # @param [Integer] sides
-    # @return [Object] Die object
-    #
-    def initialize(sides)
-      @sides = sides
-      @rolls = []
-    end #initialize
-
-    # Roll a new die. This creates a DiceRoll Object, and adds it to the array of rolls from this Die. 
-    # Then, return the total of that Roll.
-    #
-    # @param [Integer] count
-    # @return [Integer] The result of the rolls, by way of a DiceRoll object.
-    #
-    def roll(count=1)
-      individual_rolls = (1..count).map { |d| rand(self.sides) + 1 }
-      @rolls << DiceRoll.new(individual_rolls, self.sides, count)
-      @rolls.last.total
-    end #roll
-
-    # Roll a new die. This creates a DiceRoll Object, and adds it to the array of rolls from this Die. 
-    # Then, drop the lowest number of die rolls equal to the second argument
-    # Then, return the total of that Roll.
-    #
-    # @param [Integer] count
-    # @param [Integer] drop_die
-    # @return [Integer] The result of the rolls, by way of a DiceRoll object.
-    #
-    def roll_drop_lowest(count=1, drop_die = 0)
-      individual_rolls = (1..count).map { |d| rand(self.sides) + 1 }.sort.drop(drop_die)
-      @rolls << DiceRoll.new(individual_rolls, self.sides, count)
-      @rolls.last.total
-    end #roll_drop_lowest
-  end #Die
-
-  #DiceRoll is a class that holds information regarding a single instance of a rolled die.
-  #
-  class DiceRoll
-
-    # @attribute each_side [Array] the individual result of a single roll of a die.
-    # @attribute total [Integer] the combined total of the individual rolls
-    # @attribute dice_sides [Integer] the number of sides the rolled die had
-    # @attribute number_of_dice [Integer] the number of dice rolled.
-    # 
-    attr_accessor :each_die, :total, :dice_sides, :number_of_dice
-
-
-    # New instance of DiceRoll
-    #
-    # @param [Array] individual
-    # @param [Integer] sides
-    # @param [Integer] number
-    # @return [Object] Die object
-    #
-    def initialize(individual, sides, number)
-      @each_die = individual
-      @dice_sides = sides
-      @number_of_dice = number
-      @total = individual.inject(0) { |total, d| total += d }
-    end #initialize
-
-  end #DiceRoll
-  #Die Constants
-
+  D2 = Die.new(2)
   D3 = Die.new(3)
   D4 = Die.new(4)
   D6 = Die.new(6)
@@ -96,6 +13,4 @@ module Rollr
   D12 = Die.new(12)
   D20 = Die.new(20)
 
-end #Rollr
-
-
+end

data/rollr.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rollr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rollr"
+  spec.version       = Rollr::VERSION
+  spec.authors       = ["Alex Jarvis"]
+  spec.email         = ["alxjrvs@gmail.com"]
+  spec.summary       = %q{Random Numbers, With Style.}
+  spec.description   = %q{Rollr is a Gem that provides a more familiar interface for generating random numbers - Rolling Dice. Using Rollr, developers can generate psuedorandom numbers securely and succinctly.}
+  spec.homepage      = "http://www.github.com/alxjrvs/rollr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

metadata

@@ -1,48 +1,120 @@
 --- !ruby/object:Gem::Specification
 name: rollr
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Alex Jarvis
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
-dependencies: []
-description: Rollr is a Gem that provides useful functions to simulate the Rolling
-  of Dice... because we weren't social enough as is.
-email: alxjrvs@gmail.com
-executables:
-- rollr
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: Rollr is a Gem that provides a more familiar interface for generating
+  random numbers - Rolling Dice. Using Rollr, developers can generate psuedorandom
+  numbers securely and succinctly.
+email:
+- alxjrvs@gmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rollr.rb
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
 - bin/rollr
-homepage: https://github.com/alxjrvs/Rollr
-licenses: []
+- bin/setup
+- lib/rollr.rb
+- lib/rollr/die.rb
+- lib/rollr/roll_result.rb
+- lib/rollr/version.rb
+- rollr.gemspec
+homepage: http://www.github.com/alxjrvs/rollr
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
-summary: ! 'Rollr: Rand() for the Rest of Us'
+specification_version: 4
+summary: Random Numbers, With Style.
 test_files: []