para_dice 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e84f99eb4b926c858463cb3e1f5d38795aa83a42
-  data.tar.gz: 397c26eec927b3da43e367c705483c986f614e46
+  metadata.gz: 2c52cca73b5eb7c28d3ed30e720952ac0a7f1e92
+  data.tar.gz: 6c35a7405db12a7eab68246f7fd253bdd05cde5b
 SHA512:
-  metadata.gz: f442d38d1210ab0b9f87db37def9f475e620d944c5eb7bbce849487ac4e1d2468d34a097a93ee7a9f8610faaeed30eb1429a5ccda648619aabd9ff0b87d7280a
-  data.tar.gz: 16c1d751f0ddf24bd9cedbd555fc450917ed4c5daeb7c60c33adcf14a6b74e76c16cd737b60af3dc93824f31bdaebcc9df50bab57ef34d7d708986ae8abce6c2
+  metadata.gz: debb2dfe10f76fca6d6c52df9572d3920983d5fda3b4a0acf985d931f54946dd11854007b014d71369d214cb7c3d4e758f9a4afb87cb363a1899d6cd89bd4717
+  data.tar.gz: 0b2e3a34767b2bd01dacf5bf530480210ed61859eb688824176b111759427dc58bf1bf52e76adf1d1cb5a6509d38b0f91e539e73c08e16ed8572d290d4c02292

data/.pullreview.yml

@@ -39,7 +39,7 @@ rules:
 #  - prefer_ruby_19_new_hash_syntax
 #  - prefer_ruby_19_new_lambda_syntax
 #  - prefer_single_quoted_strings
-#  - reduce_number_of_params
+  - reduce_number_of_params
 #  - refactor_complex_class
 #  - refactor_complex_method
 #  - remove_trailing_whitespace

data/.yardopts

@@ -0,0 +1 @@
+--plugin virtus

data/Gemfile

@@ -1,9 +1,7 @@
 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
+gem 'yard-virtus', '0.0.5', github: 'anithri/yard-virtus'
+
+# gem 'tty', '~>0.1.0', group: :development
+# Specify your gem's dependencies in para_dice.gemspec
 gemspec

data/README.md

@@ -1,15 +1,14 @@
-# ParaDice
+# ParaDice [![Gem Version](https://badge.fury.io/rb/para_dice.svg)](http://badge.fury.io/rb/para_dice)
 
 [![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)
+[![Inline docs](http://inch-ci.org/github/anithri/para_dice.svg?branch=master)](http://inch-ci.org/github/anithri/para_dice)
 
 An extensible dice gem.
 
 ## Introduction
-ParaDice is a ruby library that provides customizable dice and results of rolling one or more.
+ParaDice is a ruby library that provides a customizable dice system made of 4 component.  Dice, Bags, Cups, and Readers.  Dice is pretty obvious.  Cups are a group of dice ready to roll and read the result.  Bags are a container that keep track of dice and creates cups.  Finally the readers are used to take raw results and produce final results with.
 
 ## Installation
 
@@ -27,19 +26,23 @@ Or install it yourself as:
 
     $ gem install para_dice
 
-
 ## Usage
 
 ```ruby
-require para_dice
+require 'para_dice'
+
+# Create a simple die
+coin = ParaDice::StringDie.new(faces: ['heads','tails'], name: 'coin')
+coin.roll # => 'heads' or 'tails'
 
 # Use a set of polyhedral dice
-bag = ParaDice::GenerateDiceBag.poly
+bag = ParaDice::PolyBag.new
 #   Get a dice cup to roll 3 d6 in this case
 cup = bag.take_cup([:d6, :d6, :d6])
+# use roll to roll the dice and read the results
+cup.roll # 10
+#use roll! to roll the dice and return raw values
 cup.roll! # [4, 2, 4]
-result = cup.roll # ParaDice::Results::Sum object
-result.raw # [4,2,
 
 ```
 ## Contributing

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/lib/para_dice/bag.rb

@@ -12,10 +12,10 @@ module ParaDice
     attribute :name, String, default: 'Dice Bag'
     # @!attribute dice
     #   @return [Hash<String,Die>] default: {}
-    attribute :dice, Hash[String => Die], default: ->(*a) { {} }
+    attribute :dice, Hash[String => Die], default: {}
     # @!attribute default_readers
     #   @return [Array<#resolve>] default: []
-    attribute :default_readers, Array, default: ->(*a) { [] }
+    attribute :default_readers, Array, default: []
     # @!attribute rng
     #   @return [Random] default: Random.new
     attribute :rng, Random, default: ->(*a) { Random.new }

data/lib/para_dice/cup.rb

@@ -1,17 +1,33 @@
 require 'para_dice/die'
 module ParaDice
+  # A Cup hold a selection of dice and a selection of readers.  It's main purpose
+  #   is to provide a reusable component that you can call #roll on and get a
+  #   complex result from
   class Cup
     # Includes Virtus.model
     include Virtus.model
 
+    # @!attribute [rw] Dice
+    #   @return [Array<ParaDice::Die]
     attribute :dice, Array[ParaDice::Die], default: []
-    attribute :rng, Random, default: ->(c, a) { Random.new }
+
+    # @!attribute [rw] rng
+    #   @return [Random]
+    attribute :rng, Random, default: ->(*a) { Random.new }
+
+    # @!attribute [rw] readers
+    #   @return [Array<#resolvce>]
     attribute :readers, Array, default: []
 
+    # roll reach die in cup and call each reader in turn on the results, return
+    #   the result of the last reader
+    # @param [Random,#rand] roll_rng default: self.rng
     def roll(roll_rng = rng)
       readers.reduce(roll!(roll_rng)) { |faces, reader| reader.resolve(faces) }
     end
 
+    # roll each die in cup using roll_rng and return array of raw results from
+    # @param [Random,#rand] roll_rng default: self.rng
     def roll!(roll_rng = rng)
       dice.map { |d| d.roll(roll_rng) }
     end

data/lib/para_dice/die.rb

@@ -8,16 +8,17 @@ module ParaDice
   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
-
+    # @!scope class
+    #   @!method new(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
+    #     @return [Die]
     include Virtus.module
 
     # @!attribute [rw] name

data/lib/para_dice/faces/arrayed.rb

@@ -1,11 +1,12 @@
 require 'para_dice/die'
 module ParaDice
+  # container module to put Face modules in
   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
+    #   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
+    #   json objects, etc.  the only difference would be in how you
     module Arrayed
       include ParaDice::Die
 

data/lib/para_dice/faces/ranged.rb

@@ -1,9 +1,10 @@
 require 'virtus'
 module ParaDice
+  # container module to put Face modules in
   module Faces
     # a module to be included into a ParaDice::Die or similar object.
-    # Uses a Range object to provide a faces, and provides special count and
-    # random_face options
+    #   Uses a Range object to provide a faces, and provides special count and
+    #   random_face options
     module Ranged
       include Virtus.module
 

data/lib/para_dice/numbered_die.rb

@@ -6,6 +6,12 @@ module ParaDice
     include Die
     include Faces::Ranged
 
+    # @!method initialize(params = {})
+    #   initialize a new object, Inherited via Die from Virtus
+    #   @params [Hash] params hash containing all data for object
+    #     @option params params [String] :name
+
+    # given a maximum value, return a NumberedDie with max faces from 1..max
     def self.get(max)
       self.new(name: "d#{max}", range: 1..max)
     end

data/lib/para_dice/results/and_keep.rb

@@ -1,14 +1,18 @@
+#  part of the paradice gem
 module ParaDice
+  #  operators that must have a #resolve method that can be passed an array
   module Results
     # Results class to implement a roll 5 and keep 3 style of play
     class AndKeep
+      # default sort order.  passed to sort_by. defaults to a simple pass through
+      DEFAULT_SORT_BY = ->(obj) { obj }
+
       # @!attribute [rw] :default_keep
       #   @return [Fixnum] the default number of dice to keep
       # @!attribute [rw] :default_low_results
       #   @return [Boolean] keep dice off of the low end of the order. false by default
       # @!attribute [rw] :default_sort_by
       #   @return [Proc] the sort by block defaults to passing the object through to sort
-      DEFAULT_SORT_BY = ->(obj) { obj }
       attr_accessor :default_keep, :default_low_results, :default_sort_by
       # @param [Regex,String] default_keep
       def initialize(default_keep = nil)

data/lib/para_dice/utility.rb

@@ -1,13 +1,21 @@
 require 'facets/string/modulize'
-require 'hashie'
 
 module ParaDice
+  # provides utility methods used by other parts of ParaDice.
   module Utility
-    class IndifferentHash < Hash
-      include Hashie::Extensions::IndifferentAccess
-    end
-
-    # TODO ADD EXAMPLE
+    # Generate a Class or Module from a representation for the class.
+    # @example Get a module from
+    #   ParaDice::Utility.module_from(String) # => String
+    #   ParaDice::Utility.module_from('string') # => String
+    #   ParaDice::Utility.module_from('String') # => String
+    #   ParaDice::Utility.module_from('STRING') # => String
+    #   ParaDice::Utility.module_from(:string) # => String
+    #   ParaDice::Utility.module_from(:String) # => String
+    #   ParaDice::Utility.module_from('paradise/utility') # => Paradise::Utility
+    #   ParaDice::Utility.module_from('paradise__utility') # => Paradise::Utility
+    #   ParaDice::Utility.module_from('Paradise::Utility') # => Paradise::Utility
+    #   ParaDice::Utility.module_from('Utility', 'ParaDice') # => Paradise::Utility
+    #   ParaDice::Utility.module_from('Utility', ParaDice) # => Paradise::Utility
     # @param [Class,Module,#to_s] name
     # @param [Class, Module, #to_s] namespace
     # @return [false] if no name is found at top level or namespace
@@ -21,6 +29,9 @@ module ParaDice
 
     # to_summary creates a hash and populates it with uniq elements of the
     #   array, and the count of how many there are
+    # @example Make a summary from array
+    #   arr = [2,3,1,2,3,2,3]
+    #   ParaDice::Utility.to_summary(arr) # => { 1 => 1, 2 => 3, 3 => 3}
     # @param [Array] arr a list to summarize
     # @return [Hash]
     def self.to_summary(arr)
@@ -29,7 +40,9 @@ module ParaDice
 
     # from_summary creates an array and populates with a number of each key
     #   equal to the value for that key
-    # TODO ADD EXAMPLE
+    # @example Make an array from a Summary Hash
+    #   summary = {foo: 3, bar: 1, baz: 2}
+    #   ParaDice::Utility.from_summary(summary) # => [:foo,:foo,:foo,:bar,:baz,:baz]
     # @param [Hash<Object,Fixnum>] summary a hash to inflate a summary into an array
     # @return [Array<Object>]
     def self.from_summary(summary)

data/para_dice.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = File.read('VERSION')
   spec.authors       = ["Scott M Parrish"]
   spec.email         = ["anithri@gmail.com"]
-  spec.summary       = %q{Game Dev Toolbox.}
+  spec.summary = %q{Game Board Component - Dice.}
   spec.description   = %q{A Toolbox to help me build a board game.}
   spec.homepage      = ""
   spec.license       = "MIT"
@@ -19,16 +19,15 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'virtus', '~> 1.0.3'
   spec.add_runtime_dependency 'facets', '~> 2.9.3'
-  spec.add_runtime_dependency 'hashie', '~> 3.3.1'
 
   spec.add_development_dependency 'bundler', '~> 1.7.6'
   spec.add_development_dependency 'yard', '~> 0.8.7.6'
   spec.add_development_dependency 'rake', '~> 10.3.2'
   spec.add_development_dependency 'rspec', '~> 3.1.0'
-  spec.add_development_dependency 'guard-rspec', '~> 4.3.1'
-  spec.add_development_dependency 'guard-bundler', '~> 2.0.0'
   spec.add_development_dependency 'version', '~> 1.0.0'
   spec.add_development_dependency 'fuubar', '~> 2.0.0'
-  
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.1'
+  spec.add_development_dependency 'pullreview-coverage'
+
 end
 

data/spec/para_dice/cup_spec.rb

@@ -56,8 +56,8 @@ describe ParaDice::Cup do
     context 'with a hash_reader' do
       subject { cup.roll(rng) }
       let(:readers) { [ParaDice::Results::Hash] }
-      let(:cup) { described_class.new(dice: dice_list, readers: readers)
-      it { is_expected.to eq('baz' => 3, 'foo' => 1, 'bar' => 1) } }
+      let(:cup) { described_class.new(dice: dice_list, readers: readers) }
+      it { is_expected.to eq('baz' => 3, 'foo' => 1, 'bar' => 1) }
     end
     context 'with a cancel_opposing reader' do
       subject { cup.roll(rng) }

data/spec/para_dice/numbered_die_spec.rb

@@ -1,19 +1,11 @@
 require 'rspec'
 require 'para_dice/numbered_die'
 describe ParaDice::NumberedDie do
-
   describe '#get(max, offset = 0)' do
+    let(:arg) { 6 }
+    let(:faces) { [1, 2, 3, 4, 5, 6] }
     subject { described_class.get(arg) }
-
-    context 'only max' do
-      let(:arg) { 6 }
-
-      it { expect(subject.name).to eq 'd6' }
-      it do
-        is_expected.to have_attributes(name:        'd6',
-                                       description: '',
-                                       faces:       [1, 2, 3, 4, 5, 6])
-      end
-    end
+    it { is_expected.to be_a described_class }
+    it { is_expected.to have_attributes(name: 'd6', face_count: 6, faces: faces) }
   end
 end

data/spec/para_dice/results/array_spec.rb

@@ -4,5 +4,6 @@ require 'para_dice/results/array'
 
 describe ParaDice::Results::Array do
   let(:faces) { [:foo, :bar, :baz] }
-  subject { described_class.resolve(faces).should be faces }
+  subject { described_class.resolve(faces) }
+  it { is_expected.to eq(faces) }
 end

data/spec/para_dice_spec.rb

@@ -3,8 +3,7 @@ require 'rspec'
 require 'para_dice'
 
 describe ParaDice do
-  it 'let me have a 6 sided die', rewrite: true do
-    die = ParaDice.numbered_die(6)
-    expect(die).to be_a_kind_of ParaDice::Die
-  end
+  subject { ParaDice.numbered_die(6) }
+  it { is_expected.to be_a ParaDice::Die }
+  it { is_expected.to have_attributes name: 'd6' }
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'codeclimate-test-reporter'
 require 'pullreview/coverage_reporter'
-#CodeClimate::TestReporter.start
+# CodeClimate::TestReporter.start
 PullReview::CoverageReporter.start
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para_dice
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Scott M Parrish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.3
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: version
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.1
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -137,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: version
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: pullreview-coverage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 description: A Toolbox to help me build a board game.
 email:
 - anithri@gmail.com
@@ -176,6 +162,7 @@ files:
 - ".pullreview.yml"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -250,7 +237,7 @@ rubyforge_project:
 rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: Game Dev Toolbox.
+summary: Game Board Component - Dice.
 test_files:
 - spec/gotham_dice_spec.rb
 - spec/para_dice/bag_spec.rb