rpg-tools 0.1.0

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.project
+**.tmp_*
+Gemfile.lock
+.idea
+.project
+.document
+.settings/
+rdoc/
+doc/
+.yardoc/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx
+  - ree
+

data/.yardopts

@@ -0,0 +1,3 @@
+lib/**/*.rb
+app/**/*.rb
+app/models/tools/*.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+     
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eduardo Casanova Cuesta
+
+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.textile

@@ -0,0 +1,28 @@
+h1. RPG Tools 
+
+#TODO
+
+h2. Installation
+
+Add to your Gemfile:
+<pre><code>
+  gem 'rpg_tools'
+</code></pre>
+Then run:
+<pre><code>
+  bundle update
+</code></pre>
+
+h2. Using RPG Tools. API
+
+#TODO
+
+h2. License
+
+Copyright (c) 2011 Eduardo Casanova Cuesta
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+begin
+  require 'bundler/setup'
+  require 'bundler'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Fuzion RPG"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'app/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks

data/app/models/tools/check_roll.rb

@@ -0,0 +1,82 @@
+class Tools::CheckRoll
+
+  attr_accessor :throw, :threshold, :rolling_chances, :greater_than_threshold, :equal_than_threshold
+  attr_reader :result
+  def initialize throw, threshold, rolling_chances=1, greater_than_threshold=true, equal_than_threshold=true
+    @throw = throw
+    @threshold = threshold
+    @rolling_chances = rolling_chances
+    @greater_than_threshold = greater_than_threshold
+    @equal_than_threshold = equal_than_threshold
+  end
+
+  #[true/false,best_rolled]
+  def roll
+    return @result if @result
+    best_rolled = 0
+    @rolling_chances.times do
+      rolled_throw = @throw.roll 1,true #Detailed throw
+      best_rolled = rolled_throw if rolled_throw[0] > best_rolled[0]
+    end
+    @result = [compare(best_rolled[0], @threshold),best_rolled]    
+    result
+  end
+
+  def reroll
+    @result = nil
+    roll
+  end
+
+  def is_successful?
+    roll if @result.blank?
+    return @result[0]
+  end  
+  
+  def result
+    [@result[0],@result[1][0]]
+  end
+  
+  def detailed_result
+    @result
+  end
+
+  def to_s
+    string = "#{@throw.to_s} #{I18n.t('rpg_tools.check_roll.must_be')} #{comparatives_text} #{@threshold}."
+    if @result
+      string << " #{I18n.t('rpg_tools.check_roll.already_checked')}" 
+      string << " #{@result[0] ? I18n.t('rpg_tools.check_roll.success') : I18n.t('rpg_tools.check_roll.failure')}"
+      string << " (#{@result[1][0]})."
+    end
+    string
+  end
+
+  private
+
+  def compare rolled_throw, threshold
+    gtt = @greater_than_threshold
+    ett = @equal_than_threshold
+    if gtt and ett
+    return rolled_throw >= threshold
+    elsif gtt and !ett
+    return rolled_throw > threshold
+    elsif !gtt and !ett
+    return rolled_throw < threshold
+    elsif !gtt and ett
+    return rolled_throw <= threshold
+    end
+  end
+  
+  def comparatives_text
+    gtt = @greater_than_threshold
+    ett = @equal_than_threshold
+    if gtt and ett
+    return I18n.t 'rpg_tools.check_roll.greater_and_equal'
+    elsif gtt and !ett
+    return I18n.t 'rpg_tools.check_roll.greater'
+    elsif !gtt and !ett
+    return I18n.t 'rpg_tools.check_roll.less'
+    elsif !gtt and ett
+    return I18n.t 'rpg_tools.check_roll.less_and_equal'
+    end
+  end
+end

data/app/models/tools/die.rb

@@ -0,0 +1,35 @@
+class Tools::Die
+  attr_accessor :sides
+  
+  def initialize sides=20
+    @sides = sides
+  end
+  
+  # Rolls the die and returns result as +Fixnum+ if rolls==1 or as +Array+ of +Fixnum+
+  # if rolls>1.
+  def roll rolls=1
+    return simple_roll if rolls==1
+    results = Array.new
+    rolls.times do 
+      results << simple_roll
+    end
+    return results
+  end
+  
+  # Returns the die as a string with the format Dx, where x is the number of sides. Example "D6", "D20", "D100", etc.
+  def to_s
+    return "D#{@sides}"
+  end
+  
+  # Return true if the dice are equal, i.e. they have the same number of sides.
+  def eql? die
+    return false if die==nil or die.sides!=@sides
+    return true
+  end
+  
+  private 
+  
+  def simple_roll
+    1 + rand(sides)
+  end
+end

data/app/models/tools/throw.rb

@@ -0,0 +1,71 @@
+class Tools::Throw
+  attr_accessor :dice, :offset
+  
+  def initialize dice, offset=0
+    @dice = dice.sort_by{|die| die.sides}
+    @offset = offset
+  end
+  
+  # Rolls the dice, add the offset and returns result as +Fixnum+ if rolls==1 or as 
+  # +Array+ of +Fixnum+ if rolls>1.
+  def roll rolls=1, detailed=false
+    return simple_roll if rolls==1 and !detailed
+    return detailed_roll if rolls==1 and detailed
+    results = Array.new
+    rolls.times do 
+      results << simple_roll if !detailed
+      results << detailed_roll if detailed
+    end
+    return results
+  end  
+  
+  # Returns the dice as a string with the format aDx,bDy,cDz+n, where a,b,c are the number of dice,
+  # x,y,z are the number of sides and n the offset. Example "D6,D20,D100+8", etc.
+  def to_s
+    throw_dice_number = Array.new
+    throw_dice = Array.new
+    temp_dice = dice.sort_by{|die| die.sides}    
+    last_die = nil
+    temp_dice.each do |temp_die|
+      if !temp_die.eql? last_die
+        last_die = temp_die
+        throw_dice << temp_die
+        throw_dice_number << temp_dice.count{|die| die.eql? temp_die}
+      end
+    end
+    throw_string = ""
+    throw_dice.each_index do |i|
+      throw_string << "," if i>0
+      throw_string << throw_dice_number[i].to_s + throw_dice[i].to_s
+    end
+    throw_string << "+" if @offset>0
+    throw_string << "#{@offset}" if @offset!=0
+    return throw_string
+  end
+  
+  private 
+  
+  def simple_roll
+    total = 0
+    dice.each do |die|
+      total+= die.roll
+    end
+    total += offset
+    return total
+  end
+  
+  def detailed_roll
+    results = Array.new
+    total = 0
+    dice.each do |die|
+      roll = die.roll
+      total+= roll
+      results << roll
+    end
+    total += offset
+    detailed_throw = Array.new
+    detailed_throw[0] = total
+    detailed_throw[1] = results
+    return detailed_throw
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  rpg_tools:
+    check_roll:
+      already_checked: "Has already been rolled with"
+      failure: "failure"
+      greater: "greater than"
+      greater_and_equal: "greater or equal to"
+      less: "less than"
+      less_and_equal: "less or equal to"
+      must_be: "must be"
+      success: "succes"

data/lib/generators/rpg_tools/install_generator.rb

@@ -0,0 +1,21 @@
+class RPG_Tools::InstallGenerator < Rails::Generators::Base #:nodoc:
+  include Rails::Generators::Migration
+  
+  source_root File.expand_path('../templates', __FILE__)
+  
+  require 'rails/generators/active_record'
+  
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+  
+  def create_initializer_file
+    template 'initializer.rb', 'config/initializers/rpg_tools.rb'
+  end
+  
+  def create_migration_file
+    require 'rake'
+    Rails.application.load_tasks
+    Rake::Task['rpg_tools_engine:install:migrations'].invoke
+  end
+end

data/lib/generators/rpg_tools/templates/initializer.rb

@@ -0,0 +1,3 @@
+RPG_Tools.setup do |config|
+
+end

data/lib/rpg_tools.rb

@@ -0,0 +1,11 @@
+module FuzionRPG 
+   class << self
+    def setup
+      yield self
+    end
+   end
+   
+end
+# reopen ActiveRecord and include all the above to make
+# them available to all our models if they want it
+require 'rpg_tools/engine' 

data/lib/rpg_tools/engine.rb

@@ -0,0 +1,11 @@
+module RPG_Tools
+  class Engine < Rails::Engine
+=begin    
+    initializer "rpg_tools.models.*whatever*" do
+      ActiveSupport.on_load(:active_record) do
+        include RPG_Tools::Models::Whatever
+      end
+    end
+=end
+  end
+end

data/rpg_tools.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+	s.name = "rpg-tools"
+	s.version = "0.1.0"
+	s.authors = ["Eduardo Casanova Cuesta"]
+	s.summary = "Some tools useful when creating a RPG: Die, Throw and CheckRoll."
+	s.description = "Some tools useful when creating a RPG: Die, Throw and CheckRoll."
+	s.email = "ecasanovac@gmail.com"
+	s.homepage = "https://github.com/roendal/rpg-tools"
+	s.files = `git ls-files`.split("\n")
+
+	# Gem dependencies
+	#
+  s.add_runtime_dependency('rails', '~> 3.0.0')
+	
+	# Development Gem dependencies
+	#
+	# Testing database
+	s.add_development_dependency('sqlite3-ruby')
+	# Debugging
+	if RUBY_VERSION < '1.9'
+		s.add_development_dependency('ruby-debug', '~> 0.10.3')
+	end
+	# Specs
+	s.add_development_dependency('rspec-rails', '~> 2.6.1')
+	# Fixtures
+	s.add_development_dependency('factory_girl', '~> 1.3.2')
+	# Integration testing
+	s.add_development_dependency('capybara', '~> 1.0.1')
+end
+

data/spec/dummy/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rpg_tools', :path => '../../../rpg_tools'
+
+gem 'mysql', '2.8.1'
+

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>