hazard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65a691e41f930731beb08c8ab724fa4c613eb6bb
+  data.tar.gz: addd13767874083872e367ae5b9ab985ee7cd51c
+SHA512:
+  metadata.gz: bd6ee65ff8de7cab884886f3c2f34489656df0ec68d9ab18d29607294d5e15f74ca3b2a0a9fbd50d46cff6bbdbc4622df521b920e33aba0c065a5c3ea950ae18
+  data.tar.gz: 72d985ba1fa458bbfc691834c391b0e88bebe8e8b4cba8c6b12425bab4660c42c317405a653d2820dea836d91b7b9f0f2d915f9e4799763b0b15458c33b86fd0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea
+
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zuger.cedric@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hazard.gemspec
+gemspec
+
+gem 'mocha', group: 'test'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Zuger Cédric
+
+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,119 @@
+# Hazard
+
+Hazard is a very simple dices library for ruby (see [usage](##usage) ).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hazard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hazard
+    
+If needed :
+
+    $ require 'hazard'  
+
+## Usage
+
+Roll a simple dice
+
+    >> Hazard.d<n>        # where n is an number
+    => Roll a n-sided dice
+
+Examples : 
+
+    >> Hazard.d6
+    => 2
+    
+    Hazard.d8
+    => 4
+     
+    Hazard.d42
+    => 38
+     
+    
+Roll multiple dices
+
+    >> Hazard.r<m>d<n>    # where m and n are numbers
+    => Roll m n-sided dices and return the sum
+
+Examples : 
+   
+    Hazard.r2d6
+     => 4
+     
+    Hazard.r4d8
+     => 12
+     
+    Hazard.r48d42
+     => 356
+         
+         
+Roll dices but get the detail
+
+    >> Hazard.s<m>d<n>    # where m and n are numbers
+    => Roll m n-sided dices and return a RolledDices object
+
+Examples : 
+         
+    >> Hazard.s2d6.rolls
+    => [1, 6]     
+          
+    >> Hazard.s2d6.result
+    => 7
+    
+    # Under the hood
+    >> Hazard.s2d6
+    => #<RolledDices:0x007f62e55a0010 @rolls=[1, 6], @result=7>
+    
+Some real cases
+         
+    # Assuming you are playing DD Next
+    
+    # You may want to roll 2 d20 dices with advantage (take the greatest)
+    # This will rolls 2 d20, get the rolls and get the best of them
+    
+    >> Hazard.s2d20.rolls.max 
+    => 19
+    
+    # Obviously a disadvantage is
+    
+    >> Hazard.s2d20.rolls.min
+    => 13
+    
+    # Maybe you want to roll with an advantage and make the check (because you are as lazy as me)
+    
+    >> Hazard.s2d20.rolls.max > 12
+    => true or false
+    
+    # Should you have the Elemental Adept feat, which mean that you treat all 1 as 2
+    # If you cast a fireball, this will do the trick : 
+    
+    >> Hazard.s6d6.rolls.map{ |d| d == 1 ? 2 : d }.reduce(:+)
+    => 13
+                    
+    
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/czuger/hazard. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/hazard.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hazard/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'hazard'
+  spec.version       = Hazard::VERSION
+  spec.authors       = ['ced']
+  spec.email         = ['zuger.cedric@gmail.com']
+
+  spec.summary       = 'Dices library for ruby'
+  spec.description   = 'A very simple dices library for ruby'
+  spec.homepage      = 'https://github.com/czuger/hazard'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/).reject{ |e| e =~ /bin/ }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+end

data/lib/hazard/version.rb

@@ -0,0 +1,3 @@
+module Hazard
+  VERSION = '1.0.0'
+end

data/lib/hazard.rb

@@ -0,0 +1,50 @@
+class RolledDices
+  attr_reader :result, :rolls
+  def initialize( rolls )
+    @rolls = rolls
+    @result = rolls.reduce(:+)
+  end
+  # Required for tests
+  def ==( rolled_dices )
+    @rolls == rolled_dices.rolls && @result == rolled_dices.result
+  end
+end
+
+class Hazard
+
+  def self.method_missing( method_name )
+
+    # Transform the method_name to string
+    method_name = method_name.to_s
+
+    # If first character is 's'
+    if method_name[0] == 's'
+      method_name = method_name[1..-1]
+      # Then we will return a splitted result
+      splitted_result = true
+    end
+
+    # Parse the method name to get how many dices and what size of dices was required
+    dices_match = method_name.to_s.match( /(\d*)d(\d+)/ )
+    # Raise an error if match fail
+    raise "Method mising : #{method_name}" unless dices_match
+
+    # Get the dices amount
+    dices_amount = dices_match[1].to_i
+    # If no amount is given then the amount is 1
+    dices_amount = 1 if dices_amount == 0
+    # Get the type of dices
+    dice_type = dices_match[2].to_i
+
+    # Rolls the dices
+    rolls = (1..dices_amount).map{ Kernel.rand( 1..dice_type ) }
+
+    # Unless splitted_result was requested, return the sum of the rolled dices
+    return rolls.reduce(:+) unless splitted_result
+
+    # Return a RolledDices otherwise
+    RolledDices.new( rolls )
+
+  end
+
+end

data/test/hazard_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class HazardTest < Minitest::Test
+
+  def test_dices
+    Kernel.stubs( :rand ).returns( 6 )
+
+    assert_equal 6, Hazard.d6
+
+    assert_equal 12, Hazard.r2d6
+    assert_equal 12, Hazard._2d6
+
+    assert_equal RolledDices.new( [ 6, 6 ] ), Hazard.s2d6
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hazard'
+
+require 'minitest/autorun'
+require 'mocha/mini_test'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hazard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ced
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A very simple dices library for ruby
+email:
+- zuger.cedric@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hazard.gemspec
+- lib/hazard.rb
+- lib/hazard/version.rb
+- test/hazard_test.rb
+- test/test_helper.rb
+homepage: https://github.com/czuger/hazard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Dices library for ruby
+test_files:
+- test/hazard_test.rb
+- test/test_helper.rb