para_dice 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e84f99eb4b926c858463cb3e1f5d38795aa83a42
+  data.tar.gz: 397c26eec927b3da43e367c705483c986f614e46
+SHA512:
+  metadata.gz: f442d38d1210ab0b9f87db37def9f475e620d944c5eb7bbce849487ac4e1d2468d34a097a93ee7a9f8610faaeed30eb1429a5ccda648619aabd9ff0b87d7280a
+  data.tar.gz: 16c1d751f0ddf24bd9cedbd555fc450917ed4c5daeb7c60c33adcf14a6b74e76c16cd737b60af3dc93824f31bdaebcc9df50bab57ef34d7d708986ae8abce6c2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/.pullreview.yml

@@ -0,0 +1,77 @@
+---
+rules:
+  ignore:
+#  - add_db_index
+#  - add_underscores_to_large_numeric
+#  - always_else_in_case
+#  - ambiguous_first_argument
+#  - assigned_but_unused_variable
+#  - assignment_in_conditional
+  - avoid_copy_paste
+#  - avoid_empty_rescue_block
+#  - avoid_global_variable
+#  - avoid_similar_code
+#  - avoid_singleton_variable
+#  - avoid_using_curly_braces_for_multi-line_blocks
+#  - check_return_value_of_save
+#  - don_t_use_parentheses_around_the_condition
+#  - extra_blank_line_detected
+#  - extra_blank_line_detected_at_body_beginning
+#  - extra_blank_line_detected_at_body_end
+#  - favor_if_unless_for_single_line
+#  - improve_coverage_of_class
+#  - improve_coverage_of_method
+#  - improve_coverage_of_project
+#  - indent_when_as_deep_as_case
+#  - missing_class_documentation
+#  - missing_method_documentation
+#  - naming_convention_for_class
+#  - naming_convention_for_method
+#  - naming_convention_for_module
+#  - no_for_loop
+#  - no_instance_variable_in_partial
+#  - no_params_in_view
+#  - no_session_in_view
+#  - omit_parentheses_when_no_args
+#  - prefer_accolades_over_doend_for_single-line_blocks
+#  - prefer_map_over_collect
+#  - prefer_reduce_over_inject
+#  - prefer_ruby_19_new_hash_syntax
+#  - prefer_ruby_19_new_lambda_syntax
+#  - prefer_single_quoted_strings
+#  - reduce_number_of_params
+#  - refactor_complex_class
+#  - refactor_complex_method
+#  - remove_trailing_whitespace
+#  - restrict_auto_generated_routes
+#  - shadowing_outer_local_variable
+#  - simplify_call_to_render
+#  - simplify_call_to_render_partial
+#  - space_between_curly_brace_and_pipe_missing
+#  - space_inside_closing_curly_brace_missing
+#  - space_inside_opening_curly_brace_missing
+#  - space_inside_parentheses_detected
+#  - space_inside_square_brackets_detected
+#  - space_missing_after_colon
+#  - space_missing_after_comma
+#  - space_missing_after_hash_sign
+#  - space_missing_after_semicolon
+#  - space_missing_inside_closing_curly_brace
+#  - space_missing_inside_opening_curly_brace
+#  - space_missing_to_left_of_parentheses
+#  - star_interpreted_as_argument_prefix
+#  - surrounding_space_missing_for_accolade
+#  - surrounding_space_missing_for_addition
+#  - surrounding_space_missing_for_arrow
+#  - surrounding_space_missing_for_assign
+#  - surrounding_space_missing_for_divide
+#  - surrounding_space_missing_for_equality
+#  - surrounding_space_missing_for_greater_than
+#  - surrounding_space_missing_for_incr
+#  - surrounding_space_missing_for_minus
+#  - surrounding_space_missing_for_multiplication
+#  - surrounding_space_missing_for_not_equal
+#  - surrounding_space_missing_for_t_square
+  - use_a_logger
+#  - use_def_with_parentheses_when_there_are_arguments
+#  - uses_spaces_instead_of_tabs

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+before_install:
+- gem uninstall bundler
+- gem install bundler --version '1.7.6'
+rvm:
+- 2.1
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+group :test do
+  gem "codeclimate-test-reporter", '~>0.4.1', require: nil
+  gem 'pullreview-coverage', require: false
+end
+
+gem 'tty', '~>0.1.0', group: :development
+# Specify your gem's dependencies in para_dixe.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,27 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec,
+      all_after_pass: true,
+      all_on_start: true,
+      run_all: { cmd: 'bundle exec rspec  --color'},
+      cmd: 'bundle exec rspec --format Fuubar --color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+  watch(%r{^data/(.+)\.yml}) {"spec"}
+end
+
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Scott M Parrish
+
+MIT License
+
+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,51 @@
+# ParaDice
+
+[![Build Status](https://travis-ci.org/anithri/para_dice.svg?branch=master)](https://travis-ci.org/anithri/para_dice)
+[![Code Climate](https://codeclimate.com/github/anithri/para_dice/badges/gpa.svg)](https://codeclimate.com/github/anithri/para_dice)
+[![Test Coverage](https://codeclimate.com/github/anithri/para_dice/badges/coverage.svg)](https://codeclimate.com/github/anithri/para_dice)
+[![Dependency Status](https://gemnasium.com/anithri/para_dice.svg)](https://gemnasium.com/anithri/para_dice)
+[![PullReview stats](https://www.pullreview.com/github/anithri/para_dice/badges/master.svg?)](https://www.pullreview.com/github/anithri/para_dice/reviews/master)
+
+An extensible dice gem.
+
+## Introduction
+ParaDice is a ruby library that provides customizable dice and results of rolling one or more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'para_dice'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install para_dice
+
+
+## Usage
+
+```ruby
+require para_dice
+
+# Use a set of polyhedral dice
+bag = ParaDice::GenerateDiceBag.poly
+#   Get a dice cup to roll 3 d6 in this case
+cup = bag.take_cup([:d6, :d6, :d6])
+cup.roll! # [4, 2, 4]
+result = cup.roll # ParaDice::Results::Sum object
+result.raw # [4,2,
+
+```
+## Contributing
+
+1. Fork it ( https://github.com/anithri/para_dice/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,10 @@
+require "bundler/gem_tasks"
+require 'rake/version_task'
+require 'rspec/core/rake_task'
+
+Rake::VersionTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec
+

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/bin/dice_tests.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'gotham_dice'
+require 'tty'
+
+# number of times to test
+ITERATIONS = 10_000
+
+# all dice faces for gotham_dice
+HEADERS    = ['pow', 'move', 'clue', 'totals']
+
+bag = GothamDice.get
+cup = bag.get_cup('combat', 'combat', 'detect', 'detect', 'move', 'move')
+
+table = TTY::Table.new(header: HEADERS)
+# totals = Hash.new{|h,k| h[k] = []}
+totals = Hash.new(0)
+
+ITERATIONS.times do
+  r = cup.roll
+  r['totals'] = r.values.reduce(:+)
+  HEADERS.each do |h|
+    totals[h] += r[h]
+  end
+end
+puts totals.inspect
+table << totals.values.map { |e| e * 1.0 / ITERATIONS }
+puts table.render width: 120, resize: true

data/data/face_types.yml

@@ -0,0 +1,27 @@
+---
+#name are unique
+#redefining the same name will result in original being lost.
+:move:
+  :name: move
+  :val: move
+:pow:
+  :name: pow
+  :val: pow
+:clue:
+  :name: clue
+  :val: clue
+:blank:
+  :name: blank
+  :val: blank
+:batman:
+  :name: batman
+  :val: batman
+:times2:
+  :name: Plus 1
+  :val: :plus_1
+:plus3:
+  :name: Plus 3
+  :val: :plus_3
+:joker:
+  :name: joker
+  :val: joker

data/data/gotham_dice.yml

@@ -0,0 +1,55 @@
+---
+:combat:
+  :name: Combat
+  :faces:
+  - pow_pow_pow
+  - pow_pow
+  - pow
+  - clue
+  - clue_clue
+  - blank
+:detect:
+  :name: Detect
+  :faces:
+  - clue_clue_clue
+  - clue_clue
+  - clue
+  - move
+  - move_move
+  - blank
+:move:
+  :name: Move
+  :faces:
+  - move_move_move
+  - move_move
+  - move
+  - pow
+  - pow_pow
+  - blank
+:hero:
+  :name: Hero
+  :faces:
+  - move
+  - clue
+  - pow
+  - plus1
+  - plus3
+  - batman
+:crime:
+  :name: Crime
+  :faces:
+  - antipow
+  - antipow
+  - anticlue
+  - anticlue
+  - antimove
+  - antimove
+:villain:
+  :name: Villain
+  :faces:
+  - antipow
+  - anticlue
+  - antimove
+  - antiplus_1
+  - antiplus_3
+  - joker

data/data/specs/not_really_yaml.yml

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Scott M Parrish
+
+MIT License
+
+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/data/specs/simple_array.yml

@@ -0,0 +1,7 @@
+---
+- Batgirl
+- Robin
+- Nightwing
+- Huntress
+- Red Robin
+- Batwoman

data/data/specs/simple_hash.yml

@@ -0,0 +1,4 @@
+---
+a: 1
+b: 2
+c: 3

data/data/star_wars_dice.yml

@@ -0,0 +1,87 @@
+---
+:boost:
+  :name: boost
+  :faces:
+  - blank
+  - blank
+  - success
+  - advantage
+  - advantage_advantage
+  - success_advantage
+:setback:
+  :name: setback
+  :faces:
+  - blank
+  - blank
+  - failure
+  - failure
+  - threat
+  - threat
+:ability:
+  :name: ability
+  :faces:
+  - blank
+  - success
+  - success
+  - success_success
+  - advantage
+  - advantage
+  - success_advantage
+  - advantage_advantage
+:difficulty:
+  :name: difficulty
+  :faces:
+  - blank
+  - failure
+  - failure_failure
+  - threat
+  - threat
+  - threat
+  - threat_threat
+  - failure_threat
+:proficincy:
+  :name: proficincy
+  :faces:
+  - blank
+  - success
+  - success
+  - success_success
+  - success_success
+  - advantage
+  - success_advantage
+  - success_advantage
+  - success_advantage
+  - advantage_advantage
+  - advantage_advantage
+  - triumph_success
+:challenge:
+  :name: challenge
+  :faces:
+  - blank
+  - failure
+  - failure
+  - failure_failure
+  - failure_failure
+  - threat
+  - threat
+  - failure_threat
+  - failute_threat
+  - threat_threat
+  - threat_threat
+  - despair_failure
+:force:
+  :name: force
+  :faces:
+  - dark
+  - dark
+  - dark
+  - dark
+  - dark
+  - dark
+  - dark_dark
+  - light
+  - light
+  - light_light
+  - light_light
+  - light_light
+

data/lib/gotham_dice.rb

@@ -0,0 +1,44 @@
+require 'para_dice/string_die'
+require 'para_dice/bag'
+require 'para_dice/results/cancel_opposing'
+require 'para_dice/results/split_faces'
+require 'para_dice/results/hash'
+require 'yaml'
+
+# Another example of creating a custom set of dice
+class GothamDice < ParaDice::Bag
+  # path to yml file
+  DATA_FILE_NAME  = 'data/gotham_dice.yml'
+
+  # which faces are considered opposing, and thus cancel out in CancelOpposing
+  #   readers
+  OPPOSING        = [
+      ['blank', 'blank'],
+      ['pow', 'antipow'],
+      ['clue', 'anticlue'],
+      ['move', 'antimove'],
+  ]
+  # The Readers to use in order, in this case, use '_' to split face names
+  #   (allowing single faces with multiple results), then cancel all of the
+  #   opposing results, then present the results as a frequency hash
+  DEFAULT_READERS = [
+      ParaDice::Results::SplitFaces.new('_'),
+      ParaDice::Results::CancelOpposing.new(OPPOSING),
+      ParaDice::Results::Hash
+  ]
+
+  # @!attribute dice
+  #   @return [Hash<String,Paradise::StringDie]
+  attribute :dice, Hash[String => ParaDice::StringDie]
+
+  # @!attribute default_readers
+  #   @return [Array<#resolve>], defaults to DEFAULT_READERS
+  attribute :default_readers, Array, default: ->(*a) { DEFAULT_READERS }
+
+  # simple way to get a bag of dice with optional rng
+  # @return [GothamDice]
+  def self.get(rng = nil)
+    hash = YAML.load_file(DATA_FILE_NAME)
+    self.new(name: 'Gotham Dice', dice: hash, rng: rng)
+  end
+end

data/lib/para_dice/bag.rb

@@ -0,0 +1,44 @@
+require 'virtus'
+require 'para_dice/die'
+require 'para_dice/cup'
+module ParaDice
+  # Class to provide a convienent container for and roller of dice
+  class Bag
+    # Is a virtus.model
+    include Virtus.model
+
+    # @!attribute name
+    #   @return [String] default: 'Dice Bag'
+    attribute :name, String, default: 'Dice Bag'
+    # @!attribute dice
+    #   @return [Hash<String,Die>] default: {}
+    attribute :dice, Hash[String => Die], default: ->(*a) { {} }
+    # @!attribute default_readers
+    #   @return [Array<#resolve>] default: []
+    attribute :default_readers, Array, default: ->(*a) { [] }
+    # @!attribute rng
+    #   @return [Random] default: Random.new
+    attribute :rng, Random, default: ->(*a) { Random.new }
+
+    # add a die to the bag
+    # @param [Die]
+    def add_die(die)
+      dice[die.name] = die
+    end
+
+    # get an array of dice from an array of dice names
+    # @param(*dice_names) array of dice names.
+    def get_dice(*dice_names)
+      dice_names.flatten.map { |die_name| dice[die_name.to_s] }
+    end
+
+    # given an array of dice_names, create a Cup using them and default_readers
+    # @param(*dice_names) array of dice names.
+    def get_cup(*dice_names)
+      Cup.new(dice:    get_dice(*dice_names),
+              rng:     rng,
+              readers: default_readers
+      )
+    end
+  end
+end

data/lib/para_dice/cup.rb

@@ -0,0 +1,19 @@
+require 'para_dice/die'
+module ParaDice
+  class Cup
+    # Includes Virtus.model
+    include Virtus.model
+
+    attribute :dice, Array[ParaDice::Die], default: []
+    attribute :rng, Random, default: ->(c, a) { Random.new }
+    attribute :readers, Array, default: []
+
+    def roll(roll_rng = rng)
+      readers.reduce(roll!(roll_rng)) { |faces, reader| reader.resolve(faces) }
+    end
+
+    def roll!(roll_rng = rng)
+      dice.map { |d| d.roll(roll_rng) }
+    end
+  end
+end

data/lib/para_dice/die.rb

@@ -0,0 +1,64 @@
+require 'virtus'
+
+module ParaDice
+  # @abstract  A module meant to be the basis of a custom Die object with
+  #   behaviour included from this die.
+  # @see GothamDice
+  # @see StarWarsDice
+  module Die
+    ERROR_MSG = ': Must be implemented in your Die class or included in a faces module.'
+
+    # @!method initialize(params = {})
+    #   @see Virtus for details
+    #   creates new Die object and populates it's attributes with values from params.
+    #     this list may not be comprehensive.  Check modules you include for other
+    #     options.
+    #   @param [Hash] params
+    #     @option params [String] :name
+    #     @option params [Random] :rng
+    #     @option params [String] :description
+
+    include Virtus.module
+
+    # @!attribute [rw] name
+    #   @return [String] required
+    # @!attribute [rw] rng
+    #   @return [Random] default Random.new
+    # @!attribute [rw] description
+    #   @return [String] default ''
+    attribute :name, String, default: :quit_if_no_name
+    attribute :rng, Random, default: ->(*args) { Random.new() }
+    attribute :description, String, default: ''
+
+    # for overloading and calling super on to allow more complex arrangements of
+    #   face and dice behavior modules
+    # @param [Random] roll_rng
+    # @return [Object] random face from die
+    def roll(roll_rng = rng)
+      random_face(roll_rng)
+    end
+
+    # @abstract Implement in Include-able Module  and override {#face_count} to implement
+    #   a custom Threadable class.
+    def face_count
+      raise NotImplementedError.new ('face_count' + ERROR_MSG)
+    end
+
+    # @abstract Implement in Include-able Module  and override {#face_count} to implement
+    #   a custom Threadable class.
+    def random_face(this_rng = rng)
+      raise NotImplementedError.new ('random_face' + ERROR_MSG)
+    end
+
+    # @abstract Implement in Include-able Module  and override {#face_count} to implement
+    #   a custom Threadable class.
+    def faces
+      raise NotImplementedError.new ('faces' + ERROR_MSG)
+    end
+
+    private
+    def quit_if_no_name
+      raise ArgumentError.new('no :name entry found in initialization hash')
+    end
+  end
+end

data/lib/para_dice/faces/arrayed.rb

@@ -0,0 +1,34 @@
+require 'para_dice/die'
+module ParaDice
+  module Faces
+    # a module to be included into a ParaDice::Die or similar object.
+    # Uses an Array object to provide faces, and provides count and
+    # random_face methods
+    # @note, these are strings, but the pattern could easily be symbols, numbers,
+    # json objects, etc.  the only difference would be in how you
+    module Arrayed
+      include ParaDice::Die
+
+      # @!attribute faces
+      #   @return Array<String>
+      attribute :faces, Array[String], default: :quit_if_no_faces
+
+      # returns size of array
+      # @return [Fixnum]
+      def face_count
+        faces.size
+      end
+
+      # returns a random face from faces using rng
+      # @return [String]
+      def random_face(r = rng)
+        faces.sample(random: r)
+      end
+
+      private
+      def quit_if_no_faces
+        raise ArgumentError.new('no :faces entry found in initialization hash')
+      end
+    end
+  end
+end