picklive-currency 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in picklive-currency.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    picklive-currency (0.0.1)
+      actionpack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.0)
+    activemodel (3.1.2)
+      activesupport (= 3.1.2)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.2)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.1)
+      guard (>= 0.8.4)
+    hike (1.2.1)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sprockets (2.1.1)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  picklive-currency!
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end
+
+

data/README.md

@@ -0,0 +1,52 @@
+# picklive-currency
+
+Classes for representing amounts of money or virtual money.
+
+Currently it has GBP and Chips currencies built in.
+
+## Examples
+
+```ruby
+# The amount can be given in as the usual value or the integer value:
+GBP[5.20] == GBP.new(520) # => true
+
+# They are comparable:
+GBP[3.10] > GBP[3.09] # => true
+GBP[3.10] > GBP[3.10] # => false
+
+# You can compare with an integer value
+GBP[3.10] > 309 # => true
+
+# Equality check is more strict:
+GBP[3.10] == 310 # => false
+
+# Objects are instances of Picklive::Currency::Base
+GBP[3.10].is_a? Picklive::Currency::Base # => true
+
+GBP[3.10].to_s # => "£3.10"
+Chips[100].to_s # => "100 Chips"
+
+Chips[100].class.real? # => false
+Chips[100].class.virtual? # => true
+GBP[3.10].class.real? # => true
+
+class Transaction
+  attr_accessor :amount_in_pennies
+  attr_accessor :currency_code
+  include Picklive::Currency::ModelMethods
+  include Picklive::Currency::Converters
+  currency_field :amount
+end
+
+t = Transaction.new
+t.amount_in_pennies = 310
+t.currency_code = 'GBP'
+
+t.amount # => <GBP:3.1>
+t.amount_in_currency # => <GBP:3.1>
+
+t.amount = Chips[100]
+t.amount_in_pennies # => 100
+t.currency_code # => "chips"
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/picklive-currency.rb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+
+require 'picklive/currency'

data/lib/picklive/currency.rb

@@ -0,0 +1,243 @@
+# -*- encoding : utf-8 -*-
+
+require 'action_view'
+
+module Picklive
+  module Currency
+
+    def self.[](code)
+      puts "WARN: Currency code #{code.inspect} is DEPRECATED" if code == 'chip'
+      return GBP if code == 'GBP'
+      return Chips if code == 'chips' || code == 'chip'
+      raise ArgumentError.new("unknown currency code: #{code.inspect}")
+    end
+
+    def self.all            ; [GBP, Chips] ; end
+    def self.cash_codes     ; 'GBP'       ; end
+    def self.virtual_codes  ; 'chips'      ; end
+
+    # To create a currency object:
+    #
+    #   GBP.new(1000) # -> <GBP:10.0>
+    #   GBP[10]       # -> <GBP:10.0>
+    #   GBP['10.00']  # -> <GBP:10.0>
+    #   Chips[1000]   # -> <Chips:1000>
+    class Base
+      def self.fake?              ; not real? ; end
+      def self.cash?              ; real?     ; end
+      def self.virtual?           ; !cash?    ; end
+      def self.html_symbol        ; symbol    ; end
+
+      attr_accessor :integer_amount
+      private :integer_amount=
+
+      def initialize integer_amount
+        self.integer_amount = integer_amount.to_i
+      end
+
+      def self.[](human_value)
+        v = human_value.to_f
+        new((v * self.precision).round)
+      end
+
+      def amount
+        if self.class.precision == 1
+          integer_amount
+        else
+          integer_amount / self.class.precision.to_f
+        end
+      end
+      alias_method :to_decimal, :amount
+
+      def +(other); same_type!(other); self.class.new(integer_amount + num_from(other)); end
+      def -(other); same_type!(other); self.class.new(integer_amount - num_from(other)); end
+      def *(multiplier); self.class.new(integer_amount * multiplier); end
+      def /(divider); self.*(1/divider.to_f); end
+      def -@; self.class.new(-integer_amount); end
+      def abs; self.class.new(integer_amount.abs); end
+
+      include Comparable
+      def <=>(other); same_type!(other); self.integer_amount <=> num_from(other); end
+      def ==(other)
+        if other.is_a?(self.class)
+          self.integer_amount == other.integer_amount
+        else
+          self.integer_amount == 0 && (other.respond_to?(:to_i) && other.to_i == 0)
+        end
+      end
+      def eql?(other); self == other; end
+
+      def same_type!(other)
+        unless other.is_a?(Fixnum) || other.is_a?(Float)
+          unless other.is_a?(Picklive::Currency::Base)
+            raise "Not a currency: #{other.inspect}"
+          end
+          if self.class.code != other.class.code
+            raise ArgumentError.new("Different currencies: #{self.class.code} vs #{other.class.code}")
+          end
+        end
+      end
+
+      def num_from(other)
+        other.respond_to?(:integer_amount) ? other.integer_amount : other
+      end
+
+      def to_i;  integer_amount;       end
+      def to_f;  integer_amount.to_f;  end
+      def inspect; "<#{self.class.code}:#{amount}>"; end
+
+      def for_sentence
+        to_s(:short => true)
+      end
+    end
+
+
+    class GBP < Base
+      def self.precision    ; 100    ; end
+      def self.code         ; 'GBP'  ; end
+      def self.real?        ; true   ; end
+      def self.symbol       ; '£'    ; end
+      def self.html_symbol  ; '&pound;' ; end
+
+      include ActionView::Helpers::NumberHelper
+
+      def to_s options = {}
+        s = number_to_currency(amount, :unit => '£')
+        if options[:short]
+          if amount < 1.0
+            s = "#{integer_amount}p"
+          else
+            s = s.gsub(/\.0+$/, '')
+          end
+        end
+        s
+      end
+    end
+
+
+    class Chips < Base
+      def self.precision    ; 1       ; end
+      def self.code         ; 'chips' ; end
+      def self.real?        ; false   ; end
+      def self.symbol       ; ''      ; end
+
+      include ActionView::Helpers::TextHelper
+
+      def to_s
+        pluralize(amount, "Chip")
+      end
+    end
+
+
+    # It provides scopes for models that have a `currency_code` method.
+    module ModelMethods
+
+      def self.included(base)
+        if defined?(ActiveRecord::Base) && base.superclass == ActiveRecord::Base
+          base.class_eval do
+            scope :cash_only,    where(:currency_code => Picklive::Currency.cash_codes)
+            scope :virtual_only, where(:currency_code => Picklive::Currency.virtual_codes)
+          end
+        end
+      end
+
+      def currency
+        Picklive::Currency[currency_code]
+      end
+
+      def amount_in_currency
+        currency.new(amount_in_pennies)
+      end
+    end
+
+    # Provides setters and getters for `something_in_currency`, alias: `something`
+    # Mix it into classes that have `something_in_pennies` setter/getter and call:
+    #   cuurrency_field :something
+    module Converters
+      def self.included(base)
+        base.instance_eval do
+          def currency_field(*fields)
+            self.class_eval do
+
+              fields.each do |field|
+                define_method "#{field}_in_currency" do
+                  pennies = self.send("#{field}_in_pennies")
+                  currency.new(pennies) unless pennies.nil?
+                end
+
+                define_method "#{field}_in_currency=" do |amount_in_currency|
+                  if ! amount_in_currency.is_a?(Picklive::Currency::Base)
+                    amount_in_currency = Picklive::Currency::GBP.new((amount_in_currency.to_f * Picklive::Currency::GBP.precision).round)
+                  end
+                  if self.respond_to?("currency_code=")
+                    self.currency_code = amount_in_currency.class.code
+                  end
+                  self.send("#{field}_in_pennies=", amount_in_currency.integer_amount)
+                end
+
+                alias_method :"#{field}",  :"#{field}_in_currency"
+                alias_method :"#{field}=", :"#{field}_in_currency="
+
+              end
+            end
+          end
+
+          def currency_fields(*fields)
+            currency_field(*fields)
+          end
+        end
+      end
+    end
+
+  end
+end
+
+GBP = Picklive::Currency::GBP
+Chips = Picklive::Currency::Chips
+
+class Fixnum
+  def percent
+    self.to_f / 100
+  end
+
+  def pounds
+    (self * 100).pennies
+  end
+  alias_method :pound, :pounds
+
+  def pennies
+    Picklive::Currency::GBP.new(self)
+  end
+  alias_method :pence, :pennies
+
+  def to_pounds
+    self / 100.0
+  end
+
+  def to_pennies
+    self * 100
+  end
+
+  def chips
+    Picklive::Currency::Chips.new(self)
+  end
+end
+
+class Float
+  def pounds
+    (self * 100).round.pennies
+  end
+  alias_method :pound, :pounds
+
+  def to_pennies
+    (self * 100).round
+  end
+end
+
+class String
+  def pounds
+    to_f.pounds
+  end
+  alias_method :pound, :pounds
+end
+

data/lib/picklive/currency/autoload.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+module Picklive
+  autoload :Currency, 'picklive/currency'
+end

data/picklive-currency.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'picklive/currency/autoload'
+
+Gem::Specification.new do |s|
+  s.name        = "picklive-currency"
+  s.version     = "1.0.0"
+  s.authors     = ["Levente Bagi"]
+  s.email       = ["levente@picklive.com"]
+  s.homepage    = "https://tech.picklive.com"
+  s.summary     = %q{Picklive Currency}
+  s.description = %q{Currency classes that can represent GBP or Chips}
+
+  s.rubyforge_project = "picklive-currency"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "actionpack"
+  s.add_development_dependency "rspec"
+
+end

data/spec/picklive/currency_spec.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+
+require 'picklive/currency'
+
+describe Picklive::Currency do
+
+  it "knows about GBP" do
+    Picklive::Currency['GBP'].should == GBP
+  end
+
+  it "knows about chips" do
+    Picklive::Currency['chips'].should == Chips
+  end
+
+  describe "currency 0 value" do
+    it "is equal to 0 as integer" do
+      (GBP.new(0) == 0).should be_true
+    end
+  end
+
+  describe "currency nonzero value" do
+    it "is not equal to the integer value" do
+      (GBP.new(100) == 100).should be_false
+    end
+  end
+
+  it "can be created in to different ways, which create equal objects" do
+    GBP[5.20].should == GBP.new(520)
+  end
+
+  it "is comparable with same type" do
+    (GBP[3.10] > GBP[3.09]).should be_true
+    (GBP[3.10] > GBP[3.10]).should be_false
+  end
+
+  it "is not comparable with a different type" do
+    expect { GBP[3.10] > Chips[309] }.to raise_error
+  end
+
+  it "is comparable to an integer, except for equality" do
+    (GBP[3.10] > 309).should be_true
+    (GBP[3.10] > 310).should be_false
+    (GBP[3.10] == 310).should be_false
+    (GBP[3.10] != 310).should be_true
+  end
+
+  it "has a format that can be included in sentences" do
+    "Give me #{GBP[5].for_sentence}".should == "Give me £5"
+    "Give me #{GBP[0.1].for_sentence}".should == "Give me 10p"
+  end
+end
+
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: picklive-currency
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Levente Bagi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Currency classes that can represent GBP or Chips
+email: 
+- levente@picklive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/picklive-currency.rb
+- lib/picklive/currency.rb
+- lib/picklive/currency/autoload.rb
+- picklive-currency.gemspec
+- spec/picklive/currency_spec.rb
+homepage: https://tech.picklive.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: picklive-currency
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Picklive Currency
+test_files: 
+- spec/picklive/currency_spec.rb