hazard 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +119 -0
- data/Rakefile +10 -0
- data/hazard.gemspec +31 -0
- data/lib/hazard/version.rb +3 -0
- data/lib/hazard.rb +50 -0
- data/test/hazard_test.rb +16 -0
- data/test/test_helper.rb +5 -0
- metadata +100 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 65a691e41f930731beb08c8ab724fa4c613eb6bb
|
4
|
+
data.tar.gz: addd13767874083872e367ae5b9ab985ee7cd51c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: bd6ee65ff8de7cab884886f3c2f34489656df0ec68d9ab18d29607294d5e15f74ca3b2a0a9fbd50d46cff6bbdbc4622df521b920e33aba0c065a5c3ea950ae18
|
7
|
+
data.tar.gz: 72d985ba1fa458bbfc691834c391b0e88bebe8e8b4cba8c6b12425bab4660c42c317405a653d2820dea836d91b7b9f0f2d915f9e4799763b0b15458c33b86fd0
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at zuger.cedric@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2016 Zuger Cédric
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
# Hazard
|
2
|
+
|
3
|
+
Hazard is a very simple dices library for ruby (see [usage](##usage) ).
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'hazard'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install hazard
|
20
|
+
|
21
|
+
If needed :
|
22
|
+
|
23
|
+
$ require 'hazard'
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
Roll a simple dice
|
28
|
+
|
29
|
+
>> Hazard.d<n> # where n is an number
|
30
|
+
=> Roll a n-sided dice
|
31
|
+
|
32
|
+
Examples :
|
33
|
+
|
34
|
+
>> Hazard.d6
|
35
|
+
=> 2
|
36
|
+
|
37
|
+
Hazard.d8
|
38
|
+
=> 4
|
39
|
+
|
40
|
+
Hazard.d42
|
41
|
+
=> 38
|
42
|
+
|
43
|
+
|
44
|
+
Roll multiple dices
|
45
|
+
|
46
|
+
>> Hazard.r<m>d<n> # where m and n are numbers
|
47
|
+
=> Roll m n-sided dices and return the sum
|
48
|
+
|
49
|
+
Examples :
|
50
|
+
|
51
|
+
Hazard.r2d6
|
52
|
+
=> 4
|
53
|
+
|
54
|
+
Hazard.r4d8
|
55
|
+
=> 12
|
56
|
+
|
57
|
+
Hazard.r48d42
|
58
|
+
=> 356
|
59
|
+
|
60
|
+
|
61
|
+
Roll dices but get the detail
|
62
|
+
|
63
|
+
>> Hazard.s<m>d<n> # where m and n are numbers
|
64
|
+
=> Roll m n-sided dices and return a RolledDices object
|
65
|
+
|
66
|
+
Examples :
|
67
|
+
|
68
|
+
>> Hazard.s2d6.rolls
|
69
|
+
=> [1, 6]
|
70
|
+
|
71
|
+
>> Hazard.s2d6.result
|
72
|
+
=> 7
|
73
|
+
|
74
|
+
# Under the hood
|
75
|
+
>> Hazard.s2d6
|
76
|
+
=> #<RolledDices:0x007f62e55a0010 @rolls=[1, 6], @result=7>
|
77
|
+
|
78
|
+
Some real cases
|
79
|
+
|
80
|
+
# Assuming you are playing DD Next
|
81
|
+
|
82
|
+
# You may want to roll 2 d20 dices with advantage (take the greatest)
|
83
|
+
# This will rolls 2 d20, get the rolls and get the best of them
|
84
|
+
|
85
|
+
>> Hazard.s2d20.rolls.max
|
86
|
+
=> 19
|
87
|
+
|
88
|
+
# Obviously a disadvantage is
|
89
|
+
|
90
|
+
>> Hazard.s2d20.rolls.min
|
91
|
+
=> 13
|
92
|
+
|
93
|
+
# Maybe you want to roll with an advantage and make the check (because you are as lazy as me)
|
94
|
+
|
95
|
+
>> Hazard.s2d20.rolls.max > 12
|
96
|
+
=> true or false
|
97
|
+
|
98
|
+
# Should you have the Elemental Adept feat, which mean that you treat all 1 as 2
|
99
|
+
# If you cast a fireball, this will do the trick :
|
100
|
+
|
101
|
+
>> Hazard.s6d6.rolls.map{ |d| d == 1 ? 2 : d }.reduce(:+)
|
102
|
+
=> 13
|
103
|
+
|
104
|
+
|
105
|
+
## Development
|
106
|
+
|
107
|
+
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.
|
108
|
+
|
109
|
+
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).
|
110
|
+
|
111
|
+
## Contributing
|
112
|
+
|
113
|
+
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.
|
114
|
+
|
115
|
+
|
116
|
+
## License
|
117
|
+
|
118
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
119
|
+
|
data/Rakefile
ADDED
data/hazard.gemspec
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'hazard/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
|
8
|
+
spec.name = 'hazard'
|
9
|
+
spec.version = Hazard::VERSION
|
10
|
+
spec.authors = ['ced']
|
11
|
+
spec.email = ['zuger.cedric@gmail.com']
|
12
|
+
|
13
|
+
spec.summary = 'Dices library for ruby'
|
14
|
+
spec.description = 'A very simple dices library for ruby'
|
15
|
+
spec.homepage = 'https://github.com/czuger/hazard'
|
16
|
+
spec.license = 'MIT'
|
17
|
+
|
18
|
+
spec.files = `git ls-files`.split($/).reject{ |e| e =~ /bin/ }
|
19
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
20
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
21
|
+
spec.require_paths = ['lib']
|
22
|
+
|
23
|
+
spec.bindir = 'exe'
|
24
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
25
|
+
spec.require_paths = ['lib']
|
26
|
+
|
27
|
+
spec.add_development_dependency 'bundler', '~> 1.13'
|
28
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
29
|
+
spec.add_development_dependency 'minitest', '~> 5.0'
|
30
|
+
|
31
|
+
end
|
data/lib/hazard.rb
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
class RolledDices
|
2
|
+
attr_reader :result, :rolls
|
3
|
+
def initialize( rolls )
|
4
|
+
@rolls = rolls
|
5
|
+
@result = rolls.reduce(:+)
|
6
|
+
end
|
7
|
+
# Required for tests
|
8
|
+
def ==( rolled_dices )
|
9
|
+
@rolls == rolled_dices.rolls && @result == rolled_dices.result
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
class Hazard
|
14
|
+
|
15
|
+
def self.method_missing( method_name )
|
16
|
+
|
17
|
+
# Transform the method_name to string
|
18
|
+
method_name = method_name.to_s
|
19
|
+
|
20
|
+
# If first character is 's'
|
21
|
+
if method_name[0] == 's'
|
22
|
+
method_name = method_name[1..-1]
|
23
|
+
# Then we will return a splitted result
|
24
|
+
splitted_result = true
|
25
|
+
end
|
26
|
+
|
27
|
+
# Parse the method name to get how many dices and what size of dices was required
|
28
|
+
dices_match = method_name.to_s.match( /(\d*)d(\d+)/ )
|
29
|
+
# Raise an error if match fail
|
30
|
+
raise "Method mising : #{method_name}" unless dices_match
|
31
|
+
|
32
|
+
# Get the dices amount
|
33
|
+
dices_amount = dices_match[1].to_i
|
34
|
+
# If no amount is given then the amount is 1
|
35
|
+
dices_amount = 1 if dices_amount == 0
|
36
|
+
# Get the type of dices
|
37
|
+
dice_type = dices_match[2].to_i
|
38
|
+
|
39
|
+
# Rolls the dices
|
40
|
+
rolls = (1..dices_amount).map{ Kernel.rand( 1..dice_type ) }
|
41
|
+
|
42
|
+
# Unless splitted_result was requested, return the sum of the rolled dices
|
43
|
+
return rolls.reduce(:+) unless splitted_result
|
44
|
+
|
45
|
+
# Return a RolledDices otherwise
|
46
|
+
RolledDices.new( rolls )
|
47
|
+
|
48
|
+
end
|
49
|
+
|
50
|
+
end
|
data/test/hazard_test.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
class HazardTest < Minitest::Test
|
4
|
+
|
5
|
+
def test_dices
|
6
|
+
Kernel.stubs( :rand ).returns( 6 )
|
7
|
+
|
8
|
+
assert_equal 6, Hazard.d6
|
9
|
+
|
10
|
+
assert_equal 12, Hazard.r2d6
|
11
|
+
assert_equal 12, Hazard._2d6
|
12
|
+
|
13
|
+
assert_equal RolledDices.new( [ 6, 6 ] ), Hazard.s2d6
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
data/test/test_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,100 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: hazard
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- ced
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-11-19 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.13'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.13'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ~>
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ~>
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: minitest
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ~>
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '5.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ~>
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '5.0'
|
55
|
+
description: A very simple dices library for ruby
|
56
|
+
email:
|
57
|
+
- zuger.cedric@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- .gitignore
|
63
|
+
- .travis.yml
|
64
|
+
- CODE_OF_CONDUCT.md
|
65
|
+
- Gemfile
|
66
|
+
- LICENSE.txt
|
67
|
+
- README.md
|
68
|
+
- Rakefile
|
69
|
+
- hazard.gemspec
|
70
|
+
- lib/hazard.rb
|
71
|
+
- lib/hazard/version.rb
|
72
|
+
- test/hazard_test.rb
|
73
|
+
- test/test_helper.rb
|
74
|
+
homepage: https://github.com/czuger/hazard
|
75
|
+
licenses:
|
76
|
+
- MIT
|
77
|
+
metadata: {}
|
78
|
+
post_install_message:
|
79
|
+
rdoc_options: []
|
80
|
+
require_paths:
|
81
|
+
- lib
|
82
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - '>='
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - '>='
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
requirements: []
|
93
|
+
rubyforge_project:
|
94
|
+
rubygems_version: 2.4.8
|
95
|
+
signing_key:
|
96
|
+
specification_version: 4
|
97
|
+
summary: Dices library for ruby
|
98
|
+
test_files:
|
99
|
+
- test/hazard_test.rb
|
100
|
+
- test/test_helper.rb
|