polyhedral 0.0.1

data/README

@@ -0,0 +1,23 @@
+== What
+Ye classic polyhedral dice program, complete with personalization.
+
+== How
+require 'rubygems'
+require 'polyhedral'
+
+== Install
+To construct a Ruby gem, just type:
+
+  rake gem
+
+To install it, type:
+
+  sudo gem install polyhedral-0.0.1.gem
+
+== Notes
+I haven't tested this code with YARV, so YMMV.
+
+== Contribute
+The source is availble at github: git://github.com/yesmar/polyhedral.git. Feel
+free to clone it and implement your own awesome ideas. You can also send your
+patches by email to yesmar[at]speakeasy[dot]net.

data/lib/polyhedral.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# polyhedram.rb
+# yesmar@speakeasy.net
+
+module Polyhedral
+  Polyhedral::NAME = 'polyhedral'
+  Polyhedral::VERSION = '0.0.1'
+  Polyhedral::COPYRIGHT = 'Copyright (c) 2008 Ramsey Dow'
+  def self.copyright() Polyhedral::COPYRIGHT end
+  def self.version() Polyhedral::VERSION end
+  def self.libdir() File.expand_path(__FILE__).gsub(%r/\.rb$/, '') end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)+'/polyhedral')
+
+require 'die'
+
+# TODO: bad developer, no unit tests
+# TODO: need to finish developing example programs
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/polyhedral/die.rb

@@ -0,0 +1,313 @@
+#!/usr/bin/env ruby
+
+# die.rb
+# yesmar@speakeasy.net
+
+module Polyhedral
+  class Die
+    attr_reader :sides, :material, :color
+    attr_accessor :name
+
+    DEFAULT_SIDES = 6
+    DEFAULT_TIMES = 1
+
+    # initialize Die instance
+    def initialize(sides=DEFAULT_SIDES, name=nil, material=nil, color=nil,
+      seed=nil
+    )
+      raise ArgumentError, 'nil sides' if sides.nil?
+      raise ArgumentError, 'invalid sides class' if !sides.is_a?(Integer)
+      if !name.nil?
+        raise ArgumentError, 'nil name' if name.nil?
+        raise ArgumentError, 'invalid name' if name.class != String
+        raise ArgumentError, 'empty name' if name.empty?
+      end
+      if !material.nil?
+        raise ArgumentError, 'nil material' if material.nil?
+        raise ArgumentError, 'invalid material' if material.class != String
+        raise ArgumentError, 'empty material' if material.empty?
+      end
+      if !color.nil?
+        raise ArgumentError, 'nil color' if color.nil?
+        raise ArgumentError, 'invalid color' if color.class != String
+        raise ArgumentError, 'empty color' if color.empty?
+      end
+      if !seed.nil?
+        raise ArgumentError, 'invalid seed class' if !seed.is_a?(Integer)
+      end
+
+      @sides = sides
+      @seed = seed
+
+      if !@seed.nil?
+        srand(@seed)
+      else
+        srand
+      end
+
+      @count = 0
+      @frequency = Array.new(@sides, 0)
+
+      @name = name
+      @material = material
+      @color = color
+
+      nil
+    end
+
+    # dump instance state to specified output stream
+    def dump(stream=STDOUT, indent=0)
+      raise ArgumentError, 'nil stream' if stream.nil?
+      raise ArgumentError, 'invalid stream class' if stream.class != IO
+      raise ArgumentError, 'nil indent' if indent.nil?
+      raise ArgumentError, 'invalid indent class' if !indent.is_a?(Integer)
+      raise ArgumentError, 'indent range error' if indent < 0
+
+      # instance
+      indent.times { stream << ' ' }
+      stream << "#{self.class}<id=#{self.object_id}>:\n"
+
+      indent += 2
+
+      # sides
+      indent.times { stream << ' ' }
+      stream << "sides: #{@sides}\n"
+
+      # seed
+      indent.times { stream << ' ' }
+      stream << "seed: #{@seed ? @seed : 'nil'}\n"
+
+      # count
+      indent.times { stream << ' ' }
+      stream << "count: #{@count}\n"
+
+      # frequency
+      indent.times { stream << ' ' }
+      stream << "frequency<id=#{@frequency.object_id}>:\n"
+      (indent-1).times { stream << ' ' }
+      @frequency.each { |f| stream << " #{f}" }
+      stream << "\n"
+
+      # name
+      indent.times { stream << ' ' }
+      stream << "name: #{@name ? @name : 'nil'}\n"
+
+      # material
+      indent.times { stream << ' ' }
+      stream << "material: #{@material ? @material : 'nil'}\n"
+
+      # color
+      indent.times { stream << ' ' }
+      stream << "color: #{@color ? @color : 'nil'}\n"
+
+      nil
+    end
+
+    # throw die n times (applying modifier as appropriate)
+    def throw(quantity=DEFAULT_TIMES, modifier=0)
+      raise ArgumentError, 'nil quantity' if quantity.nil?
+      raise ArgumentError, 'invalid quantity class' if !quantity.is_a?(Integer)
+      raise ArgumentError, 'invalid quantity value' if quantity < 1
+      raise ArgumentError, 'nil modifier' if modifier.nil?
+      raise ArgumentError, 'invalid modifier class' if !modifier.is_a?(Integer)
+
+      score = 0
+
+      # update throw count
+      @count += quantity
+
+      quantity.times do
+        result = rand(@sides) + 1
+        score += result
+
+        # update frequency count
+        @frequency[result-1] += 1
+      end
+
+      score+modifier
+    end
+
+    # emit Die instance as Integer
+    def to_i
+      @sides
+    end
+
+    # emit Die instance as String
+    def to_s
+      "d#{sides}"
+    end
+
+    # return description of the Die instance
+    def inspect
+      desc = []
+
+      desc << "#{@name} is " if !@name.nil? && !@name.empty?
+      desc << 'a'
+      desc << " #{@color}" if !@color.nil? && !@color.empty?
+      desc << " #{@material}" if !@material.nil? && !@material.empty?
+      desc << " #{self}"
+
+      desc << " (#{@count} throw"
+      if @count != 1
+        desc << 's)'
+      else
+        desc << ')'
+      end
+
+      desc.join
+    end
+
+    # dump frequency graph to specified output stream
+    def frequency(stream=STDOUT)
+      raise ArgumentError, 'nil stream' if stream.nil?
+      raise ArgumentError, 'invalid stream class' if stream.class != IO
+
+      num = max_frequency
+      min = min_frequency
+      min -= 1 if min > 0
+
+      stream << "Throws  Frequency Graph"
+      stream << " for #{@name}" if !@name.nil? && !@name.empty?
+      stream << "\n\n"
+
+      while num > min do
+        printf(stream, "%6d", num)
+
+        @frequency.each do |f|
+          if f >= num
+            stream << '  *'
+          else
+            stream << '   '
+          end
+        end
+
+        stream << "\n"
+        num -= 1
+      end
+
+      stream << "\n      "
+      @frequency.length.times do |f|
+        n = f+1
+        if n.to_s.length >= 2
+          stream << ' '
+        else
+          stream << '  '
+        end
+        stream << n
+      end
+      stream << "\n"
+
+      nil
+    end
+
+    # return array of historically lowest scoring side(s)
+    def lowest
+      min_f = 1000000
+      low_side = @sides-1
+
+      @sides.times do |s|
+        if @frequency[s] < min_f
+          min_f = @frequency[s]
+          low_side = s
+        end
+      end
+
+      low_set = Array.new
+      low_set << low_side+1
+
+      @sides.times do |s|
+        next if s == low_side
+        low_set << s+1 if @frequency[s] == @frequency[low_side]
+      end
+
+      low_set
+    end
+
+    # return array of historically highest scoring side(s)
+    def highest
+      max_f = 0
+      high_side = 0
+
+      @sides.times do |s|
+        if @frequency[s] > max_f
+          max_f = @frequency[s]
+          high_side = s
+        end
+      end
+
+      high_set = Array.new
+      high_set << high_side+1
+
+      @sides.times do |s|
+        next if s == high_side
+        high_set << s+1 if @frequency[s] == @frequency[high_side]
+      end
+
+      high_set
+    end
+
+    # store Die instance to disk
+    def to_file(pathname)
+      # validate arguments
+      raise ArgumentError, 'nil pathname' if pathname.nil?
+      raise ArgumentError, 'invalid pathname class' if pathname.class != String
+      raise ArgumentError, 'empty pathname' if pathname.empty?
+
+      begin
+        f = File.open(pathname, 'w')
+        Marshal.dump(self, f)
+      rescue Exception => e
+        return false
+      ensure
+        f.close
+      end
+
+      return true
+    end
+
+    # load Die instance from disk
+    def Die.from_file(pathname)
+      # validate arguments
+      raise ArgumentError, 'nil pathname' if pathname.nil?
+      raise ArgumentError, 'invalid pathname class' if pathname.class != String
+      raise ArgumentError, 'empty pathname' if pathname.empty?
+
+      begin
+        f = File.open(pathname, 'r')
+        object = Marshal.load(f)
+      rescue Exception => e
+        return nil
+      ensure
+        f.close unless f.nil?
+      end
+
+      return object
+    end
+
+    private
+
+    # return minimum frequency
+    def min_frequency
+      min_f = 1000000
+      @frequency.each { |f| min_f = f if f < min_f }
+      min_f
+    end
+
+    # return maximum frequency
+    def max_frequency
+      max_f = 0
+      @frequency.each { |f| max_f = f if f > max_f }
+      max_f
+    end
+
+    @sides
+    @seed
+    @count
+    @frequency
+    @name
+    @material
+    @color
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: polyhedral
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ramsey Dow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-27 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: yesmar @nospam@ speakeasy.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/polyhedral.rb
+- lib/polyhedral/die.rb
+- README
+has_rdoc: true
+homepage: http://polyhedral.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: http://rubyforge.org/projects/polyhedral/
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Ye classic polyhedral dice
+test_files: []
+