randomevent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6155df4b607a596457e2e9fa7236aacb9266cde4
+  data.tar.gz: 2141bde33c24e95967e952e72ab6003bbd23f79c
+SHA512:
+  metadata.gz: 547f343ea0d6b03b9e67a5e06dea3668a5841e7b453a31ab5cf09cd96b98d584c28c0c0bf2eea40df9c71a471736ecd51f312bc7a2a723bf60191f9170a601f6
+  data.tar.gz: 7e228e419e526a3acd49de84290c6c356090bc42a0aeea056380c78b3744bf820889d8be0494da9892c3f2be457930e191e0ee30f83aafda5cd6ea05d041d252

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Reed
+
+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,36 @@
+# Randomevent
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'randomevent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install randomevent
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/randomevent/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "randomevent"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/randomevent/version.rb

@@ -0,0 +1,3 @@
+module Randomevent
+  VERSION = "0.1.0"
+end

data/lib/randomevent.rb

@@ -0,0 +1,69 @@
+require "randomevent/version"
+
+#
+# RandomEvent - a DSL class to make it easy to execute random events
+#
+# Use the chance method inside the constructor to add an chance 'path'
+# the probabilty passed in should be between 0 and 1. You can also pass
+# :else. This will be executed if no other blocks are hit
+#
+# Example:
+#
+#   # half of the time it will output hello, 25% of the time goodbye
+#   # and 25 % of the time the default will be executed
+#	RandomEvent.new do |r|
+#		r.chance 0.5 do
+#			puts 'hello'
+#		end
+#
+#		r.chance 0.25 do
+#			puts 'goodbye'
+#		end
+#
+#		r.chance :else do
+#			puts '-'
+#		end
+#	end
+#
+#
+class RandomEvent
+	def initialize
+		@paths = []
+		@else_block = nil
+
+		# run the DSL
+		yield self
+		self.execute
+	end
+
+	def chance(prob, &block)
+		if prob == :else
+			@else_block = block
+		elsif prob.kind_of? Numeric
+			@paths.push({:p => prob, :block => block})
+		end
+	end
+
+	def execute
+		sum_prob = 0
+		v = rand()
+
+		# get the sum of the hash, and make sure the probabilites add up
+		total_p = @paths.map {|path| path[:p] }.inject(0, :+)
+		raise 'total probability is > 1.0' if total_p > 1
+
+		@paths.each do |path|
+			sum_prob += path[:p]
+
+			if v < sum_prob
+				path[:block].call
+				return
+			end
+		end
+
+		# we didn't hit anything... call the else block if we have
+		# one
+		@else_block.call if !@else_block.nil?
+
+	end
+end

data/randomevent.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'randomevent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "randomevent"
+  spec.version       = Randomevent::VERSION
+  spec.authors       = ["Nathan Reed"]
+  spec.email         = ["reednj@gmail.com"]
+
+  spec.summary       = %q{A Gem to execute a block from a set based on a certain probability}
+  spec.homepage      = "http://github.com/reednj/randomevent"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/test/randomevent_test.rb

@@ -0,0 +1,91 @@
+
+require 'randomevent'
+require 'minitest/autorun'
+
+class RandomEventTest < Minitest::Test
+
+	def test_default_event
+		was_run = false
+
+		RandomEvent.new do |r|
+			r.chance :else do
+				was_run = true
+			end
+		end
+
+		assert was_run, 'default block not executed'
+	end
+
+	def test_single_event
+		was_run = false
+
+		RandomEvent.new do |r|
+			r.chance 0.5 do
+				was_run = true
+			end
+			r.chance 0.5 do
+				was_run = true
+			end
+		end
+
+		assert was_run, 'block not executed'
+	end
+
+	def test_zero_prob
+		was_run = false
+
+		RandomEvent.new do |r|
+			r.chance 0.0 do
+				was_run = true
+			end
+		end
+
+		assert !was_run, 'block with zero probablity executed'
+	end
+
+	def test_many_runs
+		default_chance = 1.0/100.0
+		runs_required = 10000
+		expected = (default_chance*runs_required) 
+		
+		exec_count = 0
+		else_count = 0
+
+		# ok this test is a bit non-deterministic, because we don't know
+		# exactly how many times the events will be triggered, but we can be
+		# pretty confident it is going to fall within some sort of range, so
+		# we will run assertions against that
+		(0...runs_required).each do
+
+			RandomEvent.new do |r|
+				r.chance default_chance do
+					exec_count += 1
+				end
+
+				r.chance :else do
+					else_count += 1
+				end
+			end
+		end
+
+		assert exec_count > expected * 0.5, "#{exec_count} executions - expected around #{expected}"
+		assert exec_count < expected * 2.0, "#{exec_count} executions - expected around #{expected}"
+		assert exec_count + else_count == runs_required, "totals runs should equal #{runs_required}, got #{exec_count + else_count}"
+	end
+
+	def test_prob_more_than_1
+		# here the probablity of the events adds up to more than
+		# 1 - this should throw an error
+		assert_raises RuntimeError do 
+			RandomEvent.new do |r|
+				r.chance 0.8 do
+					was_run = true
+				end
+				r.chance 0.5 do
+					was_run = true
+				end
+			end
+		end
+	end
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: randomevent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Reed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- reednj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/randomevent.rb
+- lib/randomevent/version.rb
+- randomevent.gemspec
+- test/randomevent_test.rb
+homepage: http://github.com/reednj/randomevent
+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.5
+signing_key: 
+specification_version: 4
+summary: A Gem to execute a block from a set based on a certain probability
+test_files:
+- test/randomevent_test.rb