test/acts_as_gold_test.rb @@ -1,32 +1,45 @@ h1. acts_as_gold -Written by "Ariejan de Vroom":mailto:ariejan@ariejan.net. +Acts_as_gold extends ActiveRecord models to use a single integer column to store money in the form of Gold, Silver and Copper. This money system can be found in many games, including World of Warcraft. + +Written by "Ariejan de Vroom":mailto:ariejan@ariejan.net Copyright 2008 Ariejan de Vroom -h2. Download +h2. Download and installation + +You can install acts_as_gold either as a Ruby on Rails plugin or a Ruby Gem. It's recommended you use the Ruby Gem to get easier updates later on. + +h3. Plugin installation + +Simply install the plugin: + +<pre>./script/plugin install git://github.com/ariejan/acts_as_gold.git</pre> -Github: "Page":http://github.com/ariejan/acts_as_gold/tree/master "Clone":git://github.com/ariejan/acts_as_gold.git +h3. Gem installation -Gem: <pre>gem install ariejan-acts_as_gold --source http://gems.github.com</pre> +Just install the gem: -Note: if you install acts_as_gold using the gem from Github, you'll need this -in your environment.rb if you want to use Rails 2.1's dependency manager: +<pre>gem install ariejan-acts_as_gold --source http://gems.github.com</pre> -config.gem "ariejan-acts_as_gold", +Add the following to your environment.rb if you want to use Rails 2.1's dependency manager (which is highly recommended): + +<pre><code>config.gem "ariejan-acts_as_gold", :lib => "acts_as_gold", - :source => "http://gems.github.com" + :source => "http://gems.github.com"</code></pre> h2. Enabling acts_as_gold -<pre><code># This will use player.money to store the current amount of money. -class Player < ActiveRecord::Base - acts_as_gold -end +This will use player.money to store the current amount of money. + +<pre><code>class Player < ActiveRecord::Base + acts_as_gold # Uses the +money+ attribute from Player +end</code></pre> + +You may also specify a different column for storing money, for example +pennies+ -# You may also specify a different columnt for storing money -class Player < ActiveRecord::Base - acts_as_gold :current_value +<pre><code>class Player < ActiveRecord::Base + acts_as_gold :column => :pennies # Uses the +pennies+ attribute from Player end</code></pre> h2. Using acts_as_gold README.textile @@ -1,24 +1,23 @@ Gem::Specification.new do |s| s.name = %q{acts_as_gold} - s.version = "1.0.1" + s.version = "1.0.2" s.specification_version = 2 if s.respond_to? :specification_version= s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Ariejan de Vroom"] + s.homepage = %q{http://ariejan.net} s.date = %q{2008-08-13} s.description = %q{acts_as_gold allows you to extend a model with money in the form of Gold, Silver and Copper, as seen in World of Warcraft} s.email = %q{ariejan@ariejan.net} s.extra_rdoc_files = ["README.textile"] - s.files = ["Changelog", "LICENSE", "Rakefile", "README.textile", "lib/acts_as_gold.rb", "lib/active_record/acts/gold.rb"] + s.files = ["Changelog", "LICENSE", "Rakefile", "README.textile", "lib/acts_as_gold.rb", "test/acts_as_gold_test.rb"] s.has_rdoc = true s.rdoc_options = ["--line-numbers", "--inline-source", "--main", "README.textile"] s.require_paths = ["lib"] s.rubygems_version = %q{1.0.1} s.summary = %q{acts_as_gold extends a model with Gold, Silver and Copper money.} - - # s.test_files = ["test/attribute_proxy_test.rb", "test/factory_test.rb", "test/integration_test.rb", "test/sequence_test.rb"] - s.test_files = [] + s.test_files = ["test/acts_as_gold_test.rb"] s.add_dependency(%q<activerecord>, [">= 1.0"]) end \ No newline at end of file acts_as_gold.gemspec @@ -1,3 +1,3 @@ $:.unshift "#{File.dirname(__FILE__)}/lib" -require 'active_record/acts/gold' -ActiveRecord::Base.class_eval { include ActiveRecord::Acts::Gold } \ No newline at end of file +require 'acts_as_gold' +ActiveRecord::Base.class_eval { include ActsAsGold } \ No newline at end of file init.rb @@ -1 +1,133 @@ -require 'active_record/acts/gold' \ No newline at end of file +module ActsAsGold + # Thrown when trying to spend more than you have. + class NotEnoughMoneyError < StandardError + end + + def self.included(base) + base.extend(ClassMethods) + end + + # This +acts_as+ extension provides the capabilities for splitting a given interger column into + # three separte coin values: Copper, Silver and Gold. + # + # A simple example: a Charachter has money ( t.integer :money, :limit => 20) + # + # class Character < ActiveRecord::Base + # acts_as_gold # Uses the money attributes + # acts_as_gold :column => :pennies # Uses the pennies attributes + # end + # + # character.money = 57503 + # character.gold = 5 + # character.silver = 75 + # character.copper = 3 + # + # character.money += 2.gold + 10.copper + # character.gold = 7 + # character.copper = 13 + # character.money = 77513 + # + # Copper and Silver have a maximum of 99. E.g. 100 copper => 1 silver and 100 silver => 1 Gold. + # The maximum amount of money depends on the integer type used in the database: + # + # signed int(11) 2,147,483,647 => 214,748 Gold, 36 Silver, 47 Copper + # signed int(20) 9,223,372,036,854,775,807 => 922,337,203,685,477 Gold, ++8 Silver, 07 Copper + # + module ClassMethods + # Configuration options are: + # + # * +column+ - specifies the column name to use for keeping the money integer (default: +money+) + def acts_as_gold(options = {}) + configuration = { :column => "money" } + configuration.update(options) if options.is_a?(Hash) + + class_eval <<-EOV + include ActsAsGold::InstanceMethods + + def money_column + '#{configuration[:column]}' + end + + EOV + end + end + + # Allow Fixnum and Bignum to easily convert to Gold, Silver or Copper. + # This allows for things like: + # + # character.money = 2.gold + 45.silver + 50.copper + module IntegerExtensions + # 1.gold => 10000 + def gold + self * 10000 + end + + # 1.silver => 100 + def silver + self * 100 + end + + # Dummy, 1.copper => ! + def copper + self + end + end + + # All the methods available to records that have the acts_as_gold method enabled. + module InstanceMethods + # Earn money. + # + # Either enter a total money value, or sum it up with gold and def silver. To earn + # 1 Gold, 95 silver and 0 copper you can do the following: + # + # character.earn(19500) + # character.earn(1.gold + 95.silver) + # + # This return true if the amount was added successfully + def earn(amount) + update_attribute(:money, money + amount) + end + + # Spend money + # + # You can specify money the same way as with earning money. + # + # We return true if the money was spend successfully. + # + # This will raise a 'ActiveRecord::Acts::Gold::NotEnoughMoneyError' when there's not enough money + def spend(amount) + if money >= amount + update_attribute(:money, money - amount) + else + raise ActsAsGold::NotEnoughMoneyError + end + end + + # Return the amount of Gold + def gold + split_copper.first.divmod(100).first + end + + def silver + split_copper.first.divmod(100).last + end + + def copper + split_copper.last + end + + private + + def split_copper + self.send(money_column).divmod(100) + end + end +end + +class Fixnum + include ActsAsGold::IntegerExtensions +end + +class Bignum + include ActsAsGold::IntegerExtensions +end \ No newline at end of file lib/acts_as_gold.rb lib/active_record/acts/gold.rb uninstall.rb ef267b4526e6a54cff2ba902c858956e00d5d289 Ariejan de Vroom ariejan@ariejan.net http://github.com/ariejan/acts_as_gold/commit/7a3422044316134c7b0a5a7406e1ffdca5719bee 7a3422044316134c7b0a5a7406e1ffdca5719bee 2008-08-13T04:18:21-07:00 2008-08-13T04:18:21-07:00 [1.0.2] Added tests, some minor bugfixes. 0b4627e072387023662904a40b6cd2bde9ad74d0 Ariejan de Vroom ariejan@ariejan.net