craps 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4eb406436a8952507d3545298b78b1b63a9401f9
4
+ data.tar.gz: 6b50e49f09e68c710b7054626c9787430c536342
5
+ SHA512:
6
+ metadata.gz: f57fd3480480cbbcf5b7263ad6b82409683071ac3ab0d5b49ff17b1cd246e917cbf23cb47fe504f6b10c0f47a3e8ace4df7aa55ac3d91066db3e41438d7628fe
7
+ data.tar.gz: c86a1642155e71e77fd63d2a10b5b680d87df06fbdf7521bea781241896741d7dc9504e6556ad13bf8ef305b3d6ecd77e3392d83addf7d6250761d76a6339b1b
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --require spec_helper
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in craps.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Ole Henrik Skogstrøm
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # Craps
2
+
3
+ TODO: Write a gem description
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'craps'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install craps
18
+
19
+ ## Basic Usage
20
+
21
+ Instantiate a new six sided die with:
22
+ ```
23
+ dice = Dice.new(6)
24
+ ```
25
+
26
+ Alternatively use the subclass:
27
+ ```
28
+ die = D6.new
29
+ ```
30
+
31
+ Throw a single die with:
32
+ ```dice.roll```
33
+
34
+ Throw multiple dice with:
35
+ ```dice.roll(2)```
36
+
37
+ ## Probability
38
+
39
+ To get the probability of throwing equal to or above a certain number on a die you can use the `higher_or_equal_to` method.
40
+ ```
41
+ # On a 6 sided dice it is 33.3% chance to get 5 or above:
42
+ dice.higher_or_equal_to(4)
43
+ # returns 0.33333333333333326
44
+ ```
45
+
46
+ You can also do the oposite. Calculate the chanse to get equal to or bellow a certain number:
47
+ ```
48
+ # On a 6 sided dice it is 83.33333% chance to get 5 or bellow:
49
+ dice.lower_or_equal_to(4)
50
+ # returns 0.8333333333333334
51
+ ```
52
+
53
+
54
+ ## Contributing
55
+
56
+ 1. Fork it
57
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
58
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
59
+ 4. Push to the branch (`git push origin my-new-feature`)
60
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/craps.gemspec ADDED
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'craps/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "craps"
8
+ spec.version = Craps::VERSION
9
+ spec.authors = ["Ole Henrik Skogstrøm"]
10
+ spec.email = ["oleskogstrom@gmail.com"]
11
+ spec.description = %q{This gem gives you a basic dice simulator along with some probability caltucations.}
12
+ spec.summary = %q{Basic dice roller. Also gives basic probability calculations.}
13
+ spec.homepage = "https://github.com/ohenrik/craps"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.3"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "rspec"
24
+ end
data/lib/craps/dice.rb ADDED
@@ -0,0 +1,75 @@
1
+ module Craps
2
+
3
+ class Dice
4
+
5
+ attr_reader :sides
6
+ attr_reader :last_result
7
+
8
+ def initialize(sides)
9
+ @sides = sides
10
+ end
11
+
12
+ #Check how many dices that have been thrown in total
13
+ @@dices_thrown = 0
14
+ def self.dices_thrown
15
+ @@dices_thrown
16
+ end
17
+
18
+ # Throw one or many times
19
+ def roll(throw_times=1)
20
+ result_array = []
21
+ throw_times.times do |n|
22
+ result_array[n] = rand(1..@sides)
23
+ @@dices_thrown += 1
24
+ end
25
+ # Both remember the result and return it.
26
+ @last_result = result_array
27
+ end
28
+
29
+
30
+ # Some statistical helpers
31
+ # Check what the probability is of getting equalt to or more than a given result.
32
+ def base_prob
33
+ return (1/@sides)
34
+ end
35
+
36
+ def higher_or_equal_to(numb)
37
+ if valid_integer(numb)
38
+ # Here we need to add 1/6 to get the correct result of "more than or equal"
39
+ 1 - (numb.to_f/@sides.to_f) + (1.0/6.0)
40
+ end
41
+ end
42
+
43
+ # Same as above but lower or equal
44
+ def lower_or_equal_to(numb)
45
+ if valid_integer(numb)
46
+ (numb.to_f/@sides.to_f)
47
+ end
48
+ end
49
+
50
+ def valid_integer(numb)
51
+ if numb.is_a? Integer
52
+ if @sides < numb
53
+ puts "Imposible: You cannot roll a higher number than the dice sides or bellow 1"
54
+ false
55
+ elsif @sides >= numb && numb > 0
56
+ true
57
+ end
58
+ else
59
+ puts "You did not enter an integer"
60
+ false
61
+ end
62
+ end
63
+
64
+ end
65
+
66
+ # A standard D6 dice for easier access
67
+ class D6 < Dice
68
+
69
+ def initialize
70
+ @sides = 6
71
+ end
72
+
73
+ end
74
+
75
+ end
@@ -0,0 +1,3 @@
1
+ module Craps
2
+ VERSION = "0.0.1"
3
+ end
data/lib/craps.rb ADDED
@@ -0,0 +1,6 @@
1
+ require "craps/version"
2
+ require "craps/dice"
3
+
4
+ module Craps
5
+
6
+ end
@@ -0,0 +1,19 @@
1
+ require "spec_helper"
2
+
3
+ module Craps
4
+ describe Dice do
5
+ describe "#roll" do
6
+ let(:roll) { Craps::D6.new.roll(6) }
7
+
8
+ it "returns an integer" do
9
+ expect(roll).to be_a(Array)
10
+ end
11
+
12
+ it "Is the correct lenght" do
13
+ expect(roll.size).to eq(6)
14
+ end
15
+
16
+ end
17
+ end
18
+
19
+ end
@@ -0,0 +1,90 @@
1
+ require "craps"
2
+ # This file was generated by the `rspec --init` command. Conventionally, all
3
+ # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
4
+ # The generated `.rspec` file contains `--require spec_helper` which will cause this
5
+ # file to always be loaded, without a need to explicitly require it in any files.
6
+ #
7
+ # Given that it is always loaded, you are encouraged to keep this file as
8
+ # light-weight as possible. Requiring heavyweight dependencies from this file
9
+ # will add to the boot time of your test suite on EVERY test run, even for an
10
+ # individual file that may not need all of that loaded. Instead, consider making
11
+ # a separate helper file that requires the additional dependencies and performs
12
+ # the additional setup, and require it from the spec files that actually need it.
13
+ #
14
+ # The `.rspec` file also contains a few flags that are not defaults but that
15
+ # users commonly want.
16
+ #
17
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
18
+ RSpec.configure do |config|
19
+ # rspec-expectations config goes here. You can use an alternate
20
+ # assertion/expectation library such as wrong or the stdlib/minitest
21
+ # assertions if you prefer.
22
+ config.expect_with :rspec do |expectations|
23
+ # This option will default to `true` in RSpec 4. It makes the `description`
24
+ # and `failure_message` of custom matchers include text for helper methods
25
+ # defined using `chain`, e.g.:
26
+ # be_bigger_than(2).and_smaller_than(4).description
27
+ # # => "be bigger than 2 and smaller than 4"
28
+ # ...rather than:
29
+ # # => "be bigger than 2"
30
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
31
+ end
32
+
33
+ # rspec-mocks config goes here. You can use an alternate test double
34
+ # library (such as bogus or mocha) by changing the `mock_with` option here.
35
+ config.mock_with :rspec do |mocks|
36
+ # Prevents you from mocking or stubbing a method that does not exist on
37
+ # a real object. This is generally recommended, and will default to
38
+ # `true` in RSpec 4.
39
+ mocks.verify_partial_doubles = true
40
+ end
41
+
42
+ # The settings below are suggested to provide a good initial experience
43
+ # with RSpec, but feel free to customize to your heart's content.
44
+ =begin
45
+ # These two settings work together to allow you to limit a spec run
46
+ # to individual examples or groups you care about by tagging them with
47
+ # `:focus` metadata. When nothing is tagged with `:focus`, all examples
48
+ # get run.
49
+ config.filter_run :focus
50
+ config.run_all_when_everything_filtered = true
51
+
52
+ # Limits the available syntax to the non-monkey patched syntax that is recommended.
53
+ # For more details, see:
54
+ # - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
55
+ # - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
56
+ # - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
57
+ config.disable_monkey_patching!
58
+
59
+ # This setting enables warnings. It's recommended, but in some cases may
60
+ # be too noisy due to issues in dependencies.
61
+ config.warnings = true
62
+
63
+ # Many RSpec users commonly either run the entire suite or an individual
64
+ # file, and it's useful to allow more verbose output when running an
65
+ # individual spec file.
66
+ if config.files_to_run.one?
67
+ # Use the documentation formatter for detailed output,
68
+ # unless a formatter has already been configured
69
+ # (e.g. via a command-line flag).
70
+ config.default_formatter = 'doc'
71
+ end
72
+
73
+ # Print the 10 slowest examples and example groups at the
74
+ # end of the spec run, to help surface which specs are running
75
+ # particularly slow.
76
+ config.profile_examples = 10
77
+
78
+ # Run specs in random order to surface order dependencies. If you find an
79
+ # order dependency and want to debug it, you can fix the order by providing
80
+ # the seed, which is printed after each run.
81
+ # --seed 1234
82
+ config.order = :random
83
+
84
+ # Seed global randomization in this process using the `--seed` CLI option.
85
+ # Setting this allows you to use `--seed` to deterministically reproduce
86
+ # test failures related to randomization by passing the same `--seed` value
87
+ # as the one that triggered the failure.
88
+ Kernel.srand config.seed
89
+ =end
90
+ end
metadata ADDED
@@ -0,0 +1,101 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: craps
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Ole Henrik Skogstrøm
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-11-02 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.3'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: This gem gives you a basic dice simulator along with some probability
56
+ caltucations.
57
+ email:
58
+ - oleskogstrom@gmail.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - .gitignore
64
+ - .rspec
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - craps.gemspec
70
+ - lib/craps.rb
71
+ - lib/craps/dice.rb
72
+ - lib/craps/version.rb
73
+ - spec/craps/dice_spec.rb
74
+ - spec/spec_helper.rb
75
+ homepage: https://github.com/ohenrik/craps
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - '>='
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - '>='
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.2.0
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Basic dice roller. Also gives basic probability calculations.
99
+ test_files:
100
+ - spec/craps/dice_spec.rb
101
+ - spec/spec_helper.rb