randsum 1.0.0

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+after_script: bundle exec codeclimate-test-reporter
+

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,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in randsum.gemspec
+gemspec
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end

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,181 @@
+# Randsum
+
+[![Build Status](https://travis-ci.org/RANDSUM/randsum.svg?branch=master)](https://travis-ci.org/RANDSUM/randsum)[![Code Climate](https://codeclimate.com/github/RANDSUM/randsum/badges/gpa.svg)](https://codeclimate.com/github/RANDSUM/randsum) [![Test Coverage](https://codeclimate.com/github/RANDSUM/randsum/badges/coverage.svg)](https://codeclimate.com/github/RANDSUM/randsum/coverage) [![Issue Count](https://codeclimate.com/github/RANDSUM/randsum/badges/issue_count.svg)](https://codeclimate.com/github/RANDSUM/randsum)
+all hail the rectangles
+## Finally, a way to roll specific quantities of particular sides of dice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'randsum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install randsum
+
+## How to Get Rolling
+
+```
+$ gem install randsum
+$ irb
+> require 'randsum'
+#=> true
+```
+
+### The `Die` Class
+
+`Randsum` lets you make `Die`, which sounds like an existential baby stringing together its first downer of a sentence.
+
+A `Die` represents something more commonly referred to in the plural - Dice. Each `Die` takes an argument in its initializer, representing the number of sides of the die you want to make.
+
+```
+> d6 = Randsum::Die.new(6)
+```
+
+Once you've created this new random number object, you can use `.roll` to generate a random number from 1 to the size of the die.
+
+```
+> d6.roll
+#=> You rolled 1 d6, and got a 5. (Rolls: [5])
+```
+
+...aw, go ahead. Roll it a few more times. I won't blame you.
+
+```
+> d6.roll
+#=> You rolled 1 d6, and got a 6. (Rolls: [6])
+
+> d6.roll
+#=> You rolled 1 d6, and got a 3. (Rolls: [3])
+```
+
+That's pretty neat, right?
+
+`Randsum` comes pre-packaged with several shortcuts for popular Die sizes:
+
+```
+#D20
+> Randsum::D20.roll
+#=> You rolled 1 d20, and got a 20. (Rolls: [20])
+
+#D12
+> Randsum::D12.roll
+#=> You rolled 1 d12, and got a 2. (Rolls: [2])
+
+#D2-6, D8, and D10!
+```
+
+### Rolling Multiple Dice
+
+`Die#roll` also takes an optional argument that represents how many bones you want to roll. Check it:
+
+```
+> Randsum::D6.roll(2)
+#=> You rolled 2 d6, and got a 2. (Rolls: [1, 1])
+```
+
+Snakeyes. Rough.
+
+
+### Making use of the rolls: the `RollReport`
+
+`Die#roll` returns a `RollReport` object, which can teach you a lot about your rolls (but not, tragically, how to roll better.)
+
+```
+> report = Randsum::D20.roll 5
+#=> You rolled 5 d20, and got a 61. (Rolls: [20, 16, 9, 14, 1])
+```
+
+The `#total` method represents the sum total of the dice that were rolled:
+
+```
+> report.total
+#=> 61
+```
+
+The `#rolls` array, which reports the individual results of any dice rolled:
+
+```
+> report.rolls
+#=> [20, 17, 9, 14,1]
+```
+
+`#quantity` tells you how many dice were rolled this time:
+
+```
+> report.quantity
+#=> 5
+```
+
+`#sides` reports the number of sides on the dice rolled in this result:
+
+```
+> report.sides
+#=> 20
+```
+
+And if you don't like that roll (hey we get it) you can use `#die` to get another of the same die to roll again!
+
+```
+> report.die.roll
+#=> You rolled 1 D20, and got 17. (Rolls: [17])
+```
+
+#### Manipulating `RollReport`s
+
+Roll results can be further manipulated after their original creation. To facilitate popular use-cases for Dice rolling, `RollReport`s also include public `#drop_lowest` and `#drop_highest`, and `#drop` methods.
+
+`#drop_lowest` returns a new `RollReport` without the lowest numerical die roll.
+
+```
+> report = Randsum::D6.roll 4
+#=> You rolled 4 d6, and got 11. (Rolls: [3, 2, 2, 4])
+
+> new_report = report.drop_lowest
+#=>  You rolled 3 d6, and got 9. (Rolls: [4, 3, 2])
+```
+
+Similarly, `#drop_highest` will remove the highest number in the `rolls` array.
+
+```
+> new_result = report.drop_highest
+#=> You rolled 3 d6, and got 7. (Rolls: [2, 2, 3])
+```
+
+Both `#drop_lowest` and `#drop_highest` can also take an optional integer argument.
+
+```
+> result.drop_highest(2)
+#=> You rolled 2 d6, and got 4. (Rolls: [2, 2])
+```
+
+### WHY IS THIS SO COMPLICATED
+
+`Die#simple_roll` will just give you a random number, but where's the fun in that?
+
+### Why build this?
+[Rollr](http://github.com/alxjrvs/rollr) was one of the first things I ever built. I think it's funny, and I'm not sure why.
+
+I recently had the privilege of attending Sandi Metz' POODNyc workshop, which involved a continual practice of refactoring the same "simple" problem over and over again.  I liked revisitng Rollr through the years, and Randsum reflects an attempt to use small refactoring techniques to continue to mull over the "simple" problem of random numbers.
+
+## 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/randsum. 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 "randsum"
+
+# 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/randsum

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'randsum'
+
+  a = ARGV[1]
+
+if ARGV[1].include? "d"
+  a = ARGV[1].split(%r[d])[1].to_i
+else
+ puts "Wrong Usage. Proper Usage: randsum [Integer] d[integer]"
+end
+ puts Randsum::Die.new(a.to_i).roll(ARGV[0].to_i)
+

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/randsum/die.rb

@@ -0,0 +1,37 @@
+require 'securerandom'
+
+module Randsum
+  class Die
+    ZERO_INDEX_FIXER = 1
+    attr_accessor :sides, :randomizer
+
+    def initialize(sides, randomizer: SecureRandom)
+      @sides = sides
+      @randomizer = randomizer
+    end
+
+    def roll(quantity = 1)
+      Randsum::RollReport.new(
+        roll_for(quantity)
+      )
+    end
+
+    def to_s
+      "d#{sides}"
+    end
+
+    def simple_roll
+      randomizer.random_number(sides).to_i + ZERO_INDEX_FIXER
+    end
+
+    private
+
+    def roll_for(quantity)
+        Randsum::Roll.new(
+          quantity: quantity,
+          die: self
+        )
+    end
+
+  end
+end

data/lib/randsum/filters/droppers/dropper.rb

@@ -0,0 +1,23 @@
+module Randsum
+  class Dropper < Filter
+
+    def self.dropper_for(quantity:,extremity:, rolls:)
+      Object.const_get(
+        "Randsum::#{extremity.to_s.gsub("est","").capitalize}Dropper"
+      ).new(quantity: quantity, rolls: rolls)
+    end
+
+    def filter
+      ordered.first(remainder)
+    end
+
+    def ordered
+      raise NotImplementedError
+    end
+
+    def remainder
+      rolls.length - quantity
+    end
+
+  end
+end

data/lib/randsum/filters/droppers/high_dropper.rb

@@ -0,0 +1,7 @@
+module Randsum
+  class HighDropper < Dropper
+    def ordered
+      rolls.sort { |a, b| a <=> b }
+    end
+  end
+end

data/lib/randsum/filters/droppers/low_dropper.rb

@@ -0,0 +1,7 @@
+module Randsum
+  class LowDropper < Dropper
+    def ordered
+      rolls.sort { |a, b| b <=> a }
+    end
+  end
+end

data/lib/randsum/filters/filter.rb

@@ -0,0 +1,14 @@
+module Randsum
+  class Filter
+    attr_reader :quantity, :rolls
+
+    def initialize(quantity:, rolls:)
+      @quantity = quantity
+      @rolls = rolls
+    end
+
+    def filter
+      raise NotImplementedError
+    end
+  end
+end

data/lib/randsum/metadata.rb

@@ -0,0 +1,6 @@
+module Randsum
+  SUMMARY = "RNaaOOP"
+  DESCRIPTION = "Don't you hate it when you have to generate specific quantities of random numbers from a particular range while writing ruby?  Look no further. "
+  HOMEPAGE = "https://api.randsum.io"
+  LICENSE = "MIT"
+end

data/lib/randsum/roll.rb

@@ -0,0 +1,39 @@
+module Randsum
+  class Roll
+    attr_reader :die, :quantity, :sides, :result
+
+    def initialize(die:, quantity:, result: nil)
+      @die = die
+      @quantity = quantity
+      @sides = die.sides
+      @result = result || roll!
+    end
+
+    def to_s
+      "Rolls: #{result}"
+    end
+
+    def drop(quantity:,extremity:)
+      return new_roll_with(
+      result: Dropper.dropper_for(
+          quantity: quantity,
+          extremity: extremity,
+          rolls: result
+        ).filter
+      )
+    end
+
+    private
+    def new_roll_with(result: nil)
+      return Roll.new(
+        die: die,
+        quantity: quantity,
+        result: result
+      )
+    end
+
+    def roll!
+      (1..quantity).map { die.simple_roll }
+    end
+  end
+end

data/lib/randsum/roll_report.rb

@@ -0,0 +1,61 @@
+module Randsum
+  class RollReport
+
+    def initialize(roll)
+      @roll = roll
+    end
+
+    def inspect
+      to_s
+    end
+
+    def to_s
+      "You rolled #{quantity} #{die}, and got #{total}. (#{roll})"
+    end
+
+    def to_i
+      total
+    end
+
+    def sides
+      die.sides
+    end
+
+    def die
+      roll.die
+    end
+
+    def rolls
+      @_rolls ||= roll.result
+    end
+
+    def total
+      @_total ||= rolls.inject(:+)
+    end
+
+    def quantity
+      @_quantity ||= rolls.count
+    end
+
+    def drop(quantity:, extremity:)
+      return RollReport.new(
+        roll.drop(quantity: quantity, extremity: extremity)
+      )
+    end
+
+    def drop_lowest(quantity = 1)
+      return RollReport.new(
+        roll.drop(quantity: quantity, extremity: :lowest)
+      )
+    end
+
+    def drop_highest(quantity = 1)
+      return RollReport.new(
+        roll.drop(quantity: quantity, extremity: :highest)
+      )
+    end
+
+    private
+    attr_reader :roll
+  end
+end

data/lib/randsum/version.rb

@@ -0,0 +1,3 @@
+module Randsum
+  VERSION = "1.0.0"
+end

data/lib/randsum.rb

@@ -0,0 +1,21 @@
+require "randsum/version"
+require "randsum/filters/filter"
+require "randsum/filters/droppers/dropper"
+require "randsum/filters/droppers/high_dropper"
+require "randsum/filters/droppers/low_dropper"
+require "randsum/roll"
+require "randsum/die"
+require "randsum/roll_report"
+
+module Randsum
+
+  D2 = Die.new(2)
+  D3 = Die.new(3)
+  D4 = Die.new(4)
+  D6 = Die.new(6)
+  D8 = Die.new(8)
+  D10= Die.new(10)
+  D12 = Die.new(12)
+  D20 = Die.new(20)
+
+end

data/randsum.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'randsum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "randsum"
+  spec.version       = Randsum::VERSION
+  spec.authors       = ["Alex Jarvis"]
+  spec.email         = ["alxjrvs@gmail.com"]
+  spec.summary       = %q{Random Numbers, With Style.}
+  spec.description   = %q{Randsum is a Gem that provides a more familiar interface for generating random numbers - Rolling Dice. Using Randsum, developers can generate psuedorandom numbers securely and succinctly.}
+  spec.homepage      = "http://www.github.com/alxjrvs/randsum"
+  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