dmorrill10-utils 0.0.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dustin Morrill
+
+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,25 @@
+# Dmorrill10::Utils
+
+Group of random Ruby mixin utility functions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dmorrill10-utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmorrill10-utils
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/dmorrill10-utils.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dmorrill10-utils/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dustin Morrill"]
+  gem.email         = ["morrill@ualberta.ca"]
+  gem.description   = %q{Group of random Ruby mixin utility functions.}
+  gem.summary       = %q{Group of random Ruby mixin utility functions.}
+  gem.homepage      = 'https://github.com/dmorrill10/dmorrill10-utils'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dmorrill10-utils"
+  gem.require_paths = ["lib"]
+  gem.version       = Dmorrill10::Utils::VERSION
+end

data/lib/dmorrill10-utils.rb

@@ -0,0 +1,11 @@
+require "dmorrill10-utils/version"
+
+require 'dmorrill10-utils/class'
+require 'dmorrill10-utils/enumerable'
+require 'dmorrill10-utils/integer'
+require 'dmorrill10-utils/string_form_manipulation'
+
+module Dmorrill10
+  module Utils
+  end
+end

data/lib/dmorrill10-utils/class.rb

@@ -0,0 +1,32 @@
+
+require File.expand_path('../string_form_manipulation', __FILE__)
+
+class Class
+  private
+
+  # @param [Array] names A list of exception names that the calling class would
+  #  like to define.
+  def exceptions(*names)
+    names.each do |name|
+      error_name = name.to_class_name
+      const_set(error_name, Class.new(RuntimeError))
+    end
+  end
+
+  def alias_new(alias_of_new)
+    alias_class_method alias_of_new, :new
+  end
+
+  # @param [#to_sym] alias_method A class method to alias the class method, +method_to_alias+.
+  # @param [#to_sym] method_to_alias A class method to be aliased by +alias_method+.
+  def alias_class_method(alias_method, method_to_alias)
+    singleton_class.alias_method_in_singleton_context alias_method.to_sym, method_to_alias.to_sym
+  end
+
+  # Must do this operation in singleton context
+  class << self
+    def alias_method_in_singleton_context(alias_method, method_to_alias)
+      alias_method alias_method, method_to_alias
+    end
+  end
+end

data/lib/dmorrill10-utils/enumerable.rb

@@ -0,0 +1,14 @@
+module Enumerable
+  # @return [Integer] Sum of the elements in this instance. All elements must
+  #  have a +to_i+ method, which converts the element into a form that may be
+  #  summed with an +Integer+.
+  def sum
+    flatten.inject(0){ |sum, element_amount| sum += element_amount.to_i }
+  end
+
+  # @return [Array] The array resulting from summing all elements in
+  #  this instance. All elements must have a +sum+ or +to_i+ method.
+  def mapped_sum
+    map { |element| if element.respond_to? :sum then element.sum else element.to_i end }
+  end
+end

data/lib/dmorrill10-utils/integer.rb

@@ -0,0 +1,69 @@
+
+require File.expand_path('../class', __FILE__)
+
+########### Table game specific ##########
+class Integer
+
+  exceptions :seat_out_of_bounds, :relative_position_out_of_bounds
+
+  # @param [Integer] seat The seat to which the relative position is desired.
+  # @param [Integer] number_of_players The number of players at the table.
+  # @return [Integer] The relative position of +self+ to +seat+, given the
+  #  number of players at the table, +number_of_players+, indexed such that
+  #  the seat immediately to the left of +seat+ has a +position_relative_to+ of
+  #  zero.
+  # @example <code>1.position_relative_to 0, 3</code> == 0
+  # @example <code>1.position_relative_to 1, 3</code> == 2
+  def position_relative_to(seat, number_of_players)
+    raise SeatOutOfBounds unless seat.seat_in_bounds?(number_of_players) &&
+      seat_in_bounds?(number_of_players)
+
+    adjusted_seat = if self > seat
+      self
+    else
+      self + number_of_players
+    end
+    adjusted_seat - seat - 1
+  end
+
+  # Inverse operation of +position_relative_to+.
+  # Given
+  #  <code>relative_position = seat.position_relative_to to_seat, number_of_players</code>
+  # then
+  #  <code>to_seat = seat.seat_from_relative_position relative_position, number_of_players</code>
+  #
+  # @param [Integer] relative_position_of_self_to_result The relative position
+  #  of seat +self+ to the seat that is returned by this function.
+  # @param [Integer] number_of_players The number of players at the table.
+  # @return [Integer] The seat to which the relative position,
+  #  +relative_position_of_self_to_result+, of +self+ was derived, given the
+  #  number of players at the table, +number_of_players+, indexed such that
+  #  the seat immediately to the left of +from_seat+ has a
+  #  +position_relative_to+ of zero.
+  # @example <code>1.seat_from_relative_position 0, 3</code> == 0
+  # @example <code>1.seat_from_relative_position 2, 3</code> == 1
+  def seat_from_relative_position(relative_position_of_self_to_result,
+                                  number_of_players)
+    raise SeatOutOfBounds unless seat_in_bounds?(number_of_players)
+
+    unless relative_position_of_self_to_result.seat_in_bounds?(number_of_players)
+      raise RelativePositionOutOfBounds
+    end
+
+    position_adjustment = relative_position_of_self_to_result + 1
+
+    to_seat = self + number_of_players - position_adjustment
+    if self > to_seat || !to_seat.seat_in_bounds?(number_of_players)
+      self - position_adjustment
+    else
+      to_seat
+    end
+  end
+
+  # @param [Integer] number_of_players The number of players at the table.
+  # @return [Bool] Reports whether or not +self+ represents an out of bounds
+  #  seat.
+  def seat_in_bounds?(number_of_players)
+    self < number_of_players && self >= 0
+  end
+end

data/lib/dmorrill10-utils/string_form_manipulation.rb

@@ -0,0 +1,17 @@
+module StringFormManipulation
+  # @return This string in camel-case class name form.
+  def to_camel_case
+    class_name = to_s.capitalize
+    class_name.gsub(/[_\s]+./) { |match| match = match[1,].capitalize }
+  end
+
+  alias_method :to_class_name, :to_camel_case
+end
+
+class String
+  include StringFormManipulation
+end
+
+class Symbol
+  include StringFormManipulation
+end

data/lib/dmorrill10-utils/version.rb

@@ -0,0 +1,5 @@
+module Dmorrill10
+  module Utils
+    VERSION = "0.0.2"
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: dmorrill10-utils
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Dustin Morrill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-17 00:00:00.000000000 Z
+dependencies: []
+description: Group of random Ruby mixin utility functions.
+email:
+- morrill@ualberta.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dmorrill10-utils.gemspec
+- lib/dmorrill10-utils.rb
+- lib/dmorrill10-utils/class.rb
+- lib/dmorrill10-utils/enumerable.rb
+- lib/dmorrill10-utils/integer.rb
+- lib/dmorrill10-utils/string_form_manipulation.rb
+- lib/dmorrill10-utils/version.rb
+homepage: https://github.com/dmorrill10/dmorrill10-utils
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Group of random Ruby mixin utility functions.
+test_files: []
+has_rdoc: