ariejan-acts_as_gold 1.0.1

data/Changelog

@@ -0,0 +1,3 @@
+2008-08-13
+
+[ariejan] Initial release of the acts_as_gold plugin and gem.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ariejan de Vroom
+
+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,74 @@
+h1. acts_as_gold
+
+Written by "Ariejan de Vroom":mailto:ariejan@ariejan.net.
+
+Copyright 2008 Ariejan de Vroom
+
+h2. Download
+
+Github: "Page":http://github.com/ariejan/acts_as_gold/tree/master "Clone":git://github.com/ariejan/acts_as_gold.git
+
+Gem: <pre>gem install ariejan-acts_as_gold --source http://gems.github.com</pre>
+
+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:
+
+config.gem "ariejan-acts_as_gold",
+           :lib    => "acts_as_gold",
+           :source => "http://gems.github.com"
+
+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
+
+# You may also specify a different columnt for storing money
+class Player < ActiveRecord::Base
+  acts_as_gold :current_value
+end</code></pre>
+
+h2. Using acts_as_gold
+
+Acts_as_gold adds two things. If you make a model act as gold, you'll get three bonus methods: +gold+, +silver+ and +copper+. 
+
+You can have a maximum of 99 copper and 99 silver. 99 copper becomes 1 silver and 99 silver becomes 1 gold. The amount of gold is limited by the integer type you use.
+
+214,748 Gold, 36 Silver, 47 Copper for a default :integer column (int(11))
+922,337,203,685,477 Gold, 58 Silver, 07 Copper for a bigint (int(20)). 
+
+<pre><code>player.money = 3005075
+player.gold => 300
+player.silver => 50
+player.copper => 75</code></pre>
+
+A sample migration to add the money column to your model:
+
+<pre><code>add_column :players, :money, :integer, :limit => 20, :default => 15000</code></pre>
+
+This migration allows up to approximately 922,377 billion gold and gives the player 1 gold and 50 silver by default. 
+
+h2. Earning and spending
+
+It's really easy to earn and spend money.
+
+Earning money is no problem. You may want want to set a limit to the maximum amount of money you can have to avoid interger overflows. 
+
+<pre><code>player.earn(2.gold + 25.silver)</code></pre>
+
+Spending is also easy. This method return true if the money was spend successfully. It will raise a NotEnoughMoneyError if there's not enough money to be spend. 
+
+<pre><code>player.spend(10.silver + 3.copper)</code></pre>
+
+h2. Fixnum and Bignum extensions
+
+As een in the previous examples, you can use several helper methods on Fixnum and Bignum to convert them to correct money values. You can use these throughout your application:
+
+<pre><code>25.gold
+33.silver
+78.copper</code></pre>
+
+h2. More Information
+
+"Ariejan.net":http://ariejan.net

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_gold plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_gold plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsGold'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/active_record/acts/gold.rb

@@ -0,0 +1,132 @@
+module ActiveRecord  
+  module Acts #:nodoc:
+    module Gold #:nodoc:
+      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 :money
+      #   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, 58 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 ActiveRecord::Acts::Gold::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 HotChocolate::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
+  end
+end
+
+class Fixnum
+  include ActiveRecord::Acts::Gold::IntegerExtensions
+end
+
+class Bignum
+  include ActiveRecord::Acts::Gold::IntegerExtensions
+end

data/lib/acts_as_gold.rb

@@ -0,0 +1 @@
+require 'active_record/acts/gold'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: ariejan-acts_as_gold
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ariejan de Vroom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: 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
+email: ariejan@ariejan.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- Changelog
+- LICENSE
+- Rakefile
+- README.textile
+- lib/acts_as_gold.rb
+- lib/active_record/acts/gold.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.textile
+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: acts_as_gold extends a model with Gold, Silver and Copper money.
+test_files: []
+