namelessjon-exalted 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jonathan Stott
+
+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

@@ -0,0 +1,10 @@
+exalted
+=======
+
+A collection of classes to make managing Exalted characters a little easier,
+especially dealing with all the stats.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Jonathan Stott. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rake'
+require 'rake/testtask'
+begin
+  gem('mislav-hanna')
+  require 'hanna/rdoctask'
+rescue
+  require 'rake/rdoctask'
+end
+require 'rcov/rcovtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "exalted"
+    s.summary = "Classes to help with Exalted"
+    s.email = "jonathan.stott@gmail.com"
+    s.homepage = "http://github.com/namelessjon/exalted"
+    s.description = "Classes to help with characters for Exalted, the RPG by WW."
+    s.authors = ["Jonathan Stott"]
+    s.add_dependency('extlib', '~> 0.9.9')
+    s.files = FileList["[A-Z]*", "{lib,test}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'exalted'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rcov::RcovTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :rcov

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+patch: 0
+major: 0
+minor: 1

data/lib/exalted/character.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/ruby
+# character.rb
+# Jonathan D. Stott <jonathan.stott@gmail.com>
+
+module Exalted
+
+  ATTRIBUTES = [
+    ['physical', %w{strength dexterity stamina}],
+    ['social', %w{charisma manipulation appearance}],
+    ['mental', %w{perception intelligence wits}]
+  ]
+
+  ABILITIES = {
+    'DB1e' => [
+          ['air', %w{linguistics lore occult thrown stealth} ],
+          ['earth', %w{awareness craft endurance martial_arts resistance}],
+          ['fire', %w{athletics dodge melee presence socialize}],
+          ['water', %w{brawl bureaucracy investigation larceny sail}],
+          ['wood', %w{archery medicine performance ride survival}]
+        ],
+    'DB2e' => [
+          ['air', %w{linguistics lore occult thrown stealth} ],
+          ['earth', %w{awareness craft integrity resistance war}],
+          ['fire', %w{athletics dodge melee presence socialize}],
+          ['water', %w{martial_arts bureaucracy investigation larceny sail}],
+          ['wood', %w{archery medicine performance ride survival}]
+        ],
+    'S1e' => [
+          ['dawn', %w{archery brawl martial_arts melee thrown}],
+          ['zenith', %w{endurance performance presence resistance survival }],
+          ['twilight', %w{craft investigation lore medicine occult}],
+          ['night', %w{athletics awareness dodge larceny stealth}],
+          ['eclipse', %w{bureaucracy linguistics ride sail socialize}]
+        ]
+
+  }
+
+  class Character
+    attr_reader :name, :caste, :type, :languages, :attributes, :abilities
+
+    # Creates a new Character
+    #
+    # This method expects a hash, with the following keys
+    #
+    # name:: The character's name
+    # caste:: The character's caste (optional, see also aspect)
+    # aspect:: The character's aspect (optional, see also caste)
+    # type:: The Exalted type.  Currently DB1e or DB2e or S1e
+    # languages:: The languages spoken by the character (Array)
+    # abilities:: A hash of 'ability => rating' pairs
+    # attributes:: A hash of 'attribute => rating' pairs
+    # favoured:: An array of the character's favoured abilities
+    def initialize(opts = {})
+      @opts = opts.to_mash
+
+
+      set_basics
+
+      set_attributes
+
+      set_abilities
+    end
+
+    protected
+
+    def set_basics
+      @name      = @opts[:name]
+      @caste     = @opts[:caste] || @opts[:aspect]
+      @type      = @opts[:type]
+      @languages = @opts[:languages] || []
+    end
+
+    # sets up the attributes for the character
+    def set_attributes
+      # save the raw stuff for ease of reference
+      @raw_attributes = @opts[:attributes]
+
+      # create a new attributes set
+      @attributes = StatBlock.new(:attributes, ATTRIBUTES)
+
+      # setup the attributes set.
+      @raw_attributes.each do |name, rating|
+        @attributes[name].rating = rating
+      end
+    end
+
+
+    # sets up the abilities used
+    def set_abilities
+      # save the raw stuff for ease of reference
+      @raw_abilities = @opts[:abilities]
+      @favoureds     = @opts[:favoured] || []
+      @specialities  = @opts[:specialities] || {}
+
+      # create a new attributes set
+      if ABILITIES[self.type]
+        @abilities = StatBlock.new(:abilities, ABILITIES[self.type])
+      else
+        raise ArgumentError, "I don't know about '#{self.type}' Exalted."
+      end
+
+      # setup the attributes set.
+      @raw_abilities.each do |name, rating|
+        @abilities[name].rating = rating
+      end
+
+      # setup the caste abilities
+      if @abilities[self.caste]
+        @abilities[self.caste].caste = true
+      end
+
+      # set favoureds!
+      @favoureds.each do |a|
+        @abilities[a].favoured = true
+      end
+
+      # Add specialities
+      @specialities.each do |ability, specs|
+        # want a flat array of specs.
+        specs = [specs].flatten
+        @abilities[ability].specialities = specs
+      end
+
+    end
+  end
+end

data/lib/exalted/stat.rb

@@ -0,0 +1,80 @@
+# A Stat object holds all the information about an Exalted stat.  This includes
+# the name, rating, whether it is favoured, or caste and any specialities it
+# might have.
+class Exalted::Stat
+  # the stat's name
+  attr_accessor :name
+
+  # the stat's rating
+  attr_accessor :rating
+
+  # specialities the stat has
+  attr_accessor :specialities
+
+  # set the favoured status
+  attr_writer :favoured
+
+  # set the caste status
+  attr_writer :caste
+
+
+  # Creates a new stat.
+  #
+  # Options include
+  # favoured:: sets the favoured status of the stat
+  # caste:: sets the caste status of the set
+  # specialities:: Adds specialities to the set
+  # specs:: see specialities
+  def initialize(name, rating = 0, opts={})
+    if Hash === rating
+      opts = rating
+      rating = 0
+    end
+
+    @name = name.downcase.to_sym
+    @rating = rating
+    @favoured = opts.delete(:favoured) || false
+    @caste = opts.delete(:caste) || false
+    specialities = opts.delete(:specialities) || opts.delete(:specs) || []
+    @specialities = specialities.sort
+  end
+
+  # Is the stat favoured?
+  def favoured?
+    (@favoured) ? true : false
+  end
+
+  # Is the stat a caste ability?
+  def caste?
+    (@caste) ? true : false
+  end
+
+  # :nodoc:
+  def eql?(o)
+    return false unless o.is_a?(Exalted::Stat)
+    return false unless self.rating == o.rating
+    return false unless self.favoured? == o.favoured?
+    return false unless self.caste? == o.caste?
+    return false unless self.specialities == o.specialities
+    return true if self.name.eql?(o.name)
+    false
+  end
+
+  def ==(o)
+    case o
+    when String
+      return true if self.name.to_s == o.downcase
+    when Symbol
+      return true if self.name == o
+    when Exalted::Stat
+      return self.eql?(o)
+    else
+      return false
+    end
+  end
+
+  # :nodoc:
+  def inspect
+    "#<Stat:#{@name}:#{rating}:#{@caste || @favoured}:#{@specialities.map {|s| "'#{s}'"}.join(",")}>"
+  end
+end

data/lib/exalted/stat_block.rb

@@ -0,0 +1,60 @@
+module Exalted
+  # A StatBlock holds several related StatSets, representing a character's
+  # Attributes or Abilities and similar groups of stats.
+  class StatBlock
+    include Enumerable
+
+    # the name of the statblock
+    attr_reader :name
+
+    # stat_sets in the block
+    attr_reader :stat_sets
+
+    # Create a new StatBlock
+    #
+    # The StatBlock is initialized with a name, e.g 'Attributes'
+    # and an array of tuples consisting of the arguments to a StatSet.new call
+    #   @stats = [
+    #     ['air', %w{linguistics lore occult thrown stealth}],
+    #     ...,
+    #     ['wood', %w{archery medicine performance ride survival}]
+    #   ]
+    #   @stat_block = StatBlock.new('abilities', @stats)
+    #
+    def initialize(name, stats)
+      @name = name
+      @stat_sets = []
+      stats.each do |name, abilities|
+        @stat_sets << StatSet.new(name, abilities)
+      end
+    end
+
+
+    def [](name)
+      # first, check for stat sets
+      stat_set = self.detect {|s| s == name }
+      if stat_set
+        return stat_set
+      else
+        @stat_sets.each do |stat_set|
+          if (stat_set.include?(name))
+            return stat_set[name]
+          end
+        end
+        nil
+      end
+    end
+
+    # yields each StatSet in turn to the block.
+    def each
+      @stat_sets.each { |ss| yield ss }
+    end
+
+    # yields each StatSet with stats with a non-zero rating inside to the block, in turn.
+    def each_rated
+      self.each do |ss|
+        yield ss if ss.detect { |s| s.rating > 0 }
+      end
+    end
+  end
+end

data/lib/exalted/stat_set.rb

@@ -0,0 +1,119 @@
+module Exalted
+  # A StatSet holds a group of related Stats, such as those comprising an
+  # caste or aspect ability grouping.  The Set has a name, and a record of the
+  # Stats within it.
+  #
+  #   # create a new stat set
+  #   @stat_set = StatSet.new('fire', %w{athletics dodge melee presence socialize})
+  #
+  #   # access the dodge stat
+  #   @stat_set['dodge']
+  #   # => #<Stat:dodge:0:false:>
+  #
+  class StatSet
+    include Enumerable
+
+    # name of the stat set, typically the caste or aspect.
+    attr_reader :name
+
+    # names of the stats in the set
+    attr_reader :stat_names
+
+    # the stats themselves
+    attr_reader :stats
+
+    # is this a set of caste abilities?
+    attr_reader :caste
+
+    def initialize(name, stats)
+      @name = name.to_sym
+      @stat_names = stats
+      @caste = false
+
+      create_stats
+    end
+
+    def inspect
+      "#<StatSet:#{name}:#{caste}:[#{stats.map {|s| s.inspect }.join(', ')}]>"
+    end
+
+    # hash style access to a Stat, based on the Stat's name.
+    def [](stat_name)
+      self.detect { |stat| stat == stat_name }
+    end
+
+    # yields each stat which has a non-zero rating in turn
+    def each
+      @stats.each do |stat|
+        yield stat
+      end
+    end
+
+    # yields only stats with a non-zero rating
+    def each_rated
+      self.each do |stat|
+        yield stat if stat.rating > 0
+      end
+    end
+
+    # assign caste status to all stats in the set at once.
+    def caste=(caste)
+      if @caste != caste
+        @stats.each do |stat|
+          stat.caste = caste
+        end
+        @caste = caste
+      end
+    end
+
+    # boolean accessor for if this is a caste stat set or no.
+    def caste?
+      (self.caste) ? true : false
+    end
+
+    # returns the number of stats in the set.
+    #
+    # If called as #size(false), only returns the number of stats with a non-zero
+    # rating
+    def size(all=true)
+      if all
+        @stats.size
+      else
+        @stats.find_all {|s| s.rating > 0 }.size
+      end
+    end
+
+    def ==(o)
+      case o
+      when String
+        return self.name.to_s == o
+      when Symbol
+        return self.name == o
+      when StatSet
+        return (self == o.name) && (self.stat_names == o.stat_names)
+      else
+        return false
+      end
+    end
+
+    def eql?(o)
+      return false unless o.is_a?(StatSet)
+      return false unless self.name.eql?(o.name)
+      return false unless self.stat_names.eql?(o.stat_names)
+      # detect for stats sharing the same name being not equal.
+      stats_not_eql = self.stat_names.detect { |n| !(self[n].eql?(o[n])) }
+      # if we have a stat that is not equal, we can return false
+      # otherwise, it appears we must return true!
+      return (stats_not_eql) ? false : true
+    end
+
+    protected
+
+    def create_stats
+      @stats = []
+      @stat_names.each do |name|
+        @stats << Stat.new(name)
+      end
+    end
+  end
+end

data/lib/exalted.rb

@@ -0,0 +1,10 @@
+gem('extlib', '~> 0.9.9')
+require 'extlib'
+
+module Exalted
+end
+
+require 'exalted/stat'
+require 'exalted/stat_set'
+require 'exalted/stat_block'
+require 'exalted/character'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: namelessjon-exalted
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonathan Stott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.9
+    version: 
+description: Classes to help with characters for Exalted, the RPG by WW
+email: jonathan.stott@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- VERSION.yml
+- Rakefile
+- lib/exalted
+- lib/exalted/stat_set.rb
+- lib/exalted/stat_block.rb
+- lib/exalted/stat.rb
+- lib/exalted/character.rb
+- lib/exalted.rb
+has_rdoc: false
+homepage: http://github.com/namelessjon/exalted
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Classes to help with Exalted
+test_files: []
+