money-collection 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31d48e73a143672af436d2128462573a8f9b7d70
+  data.tar.gz: 2c8528a4f6163392762d25ddea387eb6649d860a
+SHA512:
+  metadata.gz: 9027fda3114e23db23061ab4a88d31e071a89d690a11c4de994c0c8b6517d6a41f5e28aa1620dff27285be12aac433612e95871ff3609d6bc457aeb82d358603
+  data.tar.gz: 85632bb6ae43b0eac67779762a35909c1d00894ba67c51cb727413f78f977538d3349d1af189c1094e5f2822c55390dfefe098bf2f0dd3b34eedf5bdb3bb3313

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in money-collection.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 lulalala
+
+MIT License
+
+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.md

@@ -0,0 +1,56 @@
+# Money::Collection
+
+Calculating sum/min/max on a bunch of Money objects, with __accuracy__ and __efficiency__.
+
+This is achieved by minimizing number of currency conversions and object creations.
+
+For large collections, sum/min/max can perform up to 4 times as fast. For small collections (n<10), it can perform at least 2 times as fast.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'money-collection'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install money-collection
+
+## Usage
+
+Here is the demo of the Money::Collection library:
+
+```ruby
+require 'money'
+require 'money/collection'
+
+c = Money::Collection.new( [money1, money2] )
+c << money3
+c.concat [money4, money5]
+
+c.sum
+c.sum('TWD') # returns sum in TWD currency.
+c.max
+c.min
+```
+
+For more, please check the API documentation.
+
+## Contributing
+
+The followings areas can use some of your expertise:
+
+* Benchmarking, including comparison between commits.
+* Accuracy improvement
+* Optimization
+
+## License
+
+MIT License (See LICENSE.txt)
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end

data/benchmark/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end

data/benchmark/max.rb

@@ -0,0 +1,47 @@
+require_relative 'helper'
+require 'benchmark'
+require 'money'
+require 'money/collection'
+
+Money.add_rate(:usd, :twd, 30.4071518)
+Money.add_rate(:twd, :usd, 0.032887)
+
+def generate_samples(size, possible_currencies = [:usd])
+  size.times.map do
+    Money.new(Random.rand(100000), possible_currencies.sample)
+  end
+end
+
+benchmarking_sizes = [1,2,5,10,50,100,200,400,600,800,1000]
+
+puts 'Single currency'
+
+samples = generate_samples(benchmarking_sizes.max)
+# rehearsal
+100.times{ Money::Collection.new(samples).sum }
+Benchmark.bm do |x|
+  benchmarking_sizes.each do |size|
+    x.report "sum #{size} items" do
+      sliced_samples = samples.first(size)
+      10000.times do
+        Money::Collection.new(sliced_samples).max
+      end
+    end
+  end
+end
+
+puts 'Multiple currencies'
+
+samples = generate_samples(benchmarking_sizes.max, [:usd, :twd])
+# rehearsal
+100.times{ Money::Collection.new(samples).sum }
+Benchmark.bm do |x|
+  benchmarking_sizes.each do |size|
+    x.report "sum #{size} items" do
+      sliced_samples = samples.first(size)
+      10000.times do
+        Money::Collection.new(sliced_samples).max
+      end
+    end
+  end
+end

data/benchmark/sum.rb

@@ -0,0 +1,47 @@
+require_relative 'helper'
+require 'benchmark'
+require 'money'
+require 'money/collection'
+
+Money.add_rate(:usd, :twd, 30.4071518)
+Money.add_rate(:twd, :usd, 0.032887)
+
+def generate_samples(size, possible_currencies = [:usd])
+  size.times.map do
+    Money.new(Random.rand(100000), possible_currencies.sample)
+  end
+end
+
+benchmarking_sizes = [1,2,5,10,50,100,200,400,600,800,1000]
+
+puts 'Single currency'
+
+samples = generate_samples(benchmarking_sizes.max)
+# rehearsal
+100.times{ Money::Collection.new(samples).sum }
+Benchmark.bm do |x|
+  benchmarking_sizes.each do |size|
+    x.report "sum #{size} items" do
+      sliced_samples = samples.first(size)
+      10000.times do
+        Money::Collection.new(sliced_samples).sum
+      end
+    end
+  end
+end
+
+puts 'Multiple currencies'
+
+samples = generate_samples(benchmarking_sizes.max, [:usd, :twd])
+# rehearsal
+100.times{ Money::Collection.new(samples).sum }
+Benchmark.bm do |x|
+  benchmarking_sizes.each do |size|
+    x.report "sum #{size} items" do
+      sliced_samples = samples.first(size)
+      10000.times do
+        Money::Collection.new(sliced_samples).sum
+      end
+    end
+  end
+end

data/lib/money/collection.rb

@@ -0,0 +1,125 @@
+require "money/collection/version"
+
+class Money
+  class Collection
+    include Enumerable
+
+    # @parma array [#to_a] collection of Money objects
+    def initialize(array = nil)
+      @collection = array.to_a.dup
+      @group_by_currency = @collection.group_by(&:currency)
+    end
+
+    # Sums up Money objects in collection.
+    # @param target_currency [Currency, String, Symbol] - currency of the returning money object.
+    # @return [Money] sum of Money collection.
+    def sum(target_currency = nil)
+      if @collection.empty?
+        return Money.new(0, target_currency)
+      end
+
+      if @group_by_currency.size == 1
+        sum = self.class.sum_single_currency(@collection)
+      else
+        sums_per_currency = @group_by_currency.values.map{|moneys|
+          self.class.sum_single_currency(moneys)
+        }
+
+        # If target_currency is specified, and is in collection,
+        # move it to the front so it has precedence over other currencies.
+        if target_currency
+          target_currency = self.class.convert_to_currency_object(target_currency)
+          if index = sums_per_currency.find_index{|money| money.currency == target_currency}
+            money = sums_per_currency.delete_at(index)
+            sums_per_currency.unshift money
+          end
+        end
+
+        sum = self.class.sum_basic(sums_per_currency)
+      end
+
+      if target_currency.nil?
+        return sum
+      else
+        return sum.exchange_to(target_currency)
+      end
+    end
+
+    def max
+      @group_by_currency.values.map{|moneys|
+        moneys.max_by{|money| money.fractional}
+      }.max
+    end
+
+    def min
+      @group_by_currency.values.map{|moneys|
+        moneys.min_by{|money| money.fractional}
+      }.min
+    end
+
+  #### delegations
+
+    def each
+      if block_given?
+        @collection.each{|x| yield(x)}
+        return self
+      else
+        return @collection.each
+      end
+    end
+
+    def <<(obj)
+      @collection << obj
+      if @group_by_currency[obj.currency].nil?
+        @group_by_currency[obj.currency] = [obj]
+      else
+        @group_by_currency[obj.currency] << obj
+      end
+      self
+    end
+
+    def concat(other_ary)
+      @collection.concat(other_ary)
+
+      other_ary.group_by(&:currency).each do |currency, ary|
+        if @group_by_currency[currency].nil?
+          @group_by_currency[currency] = ary
+        else
+          @group_by_currency[currency].concat(ary)
+        end
+      end
+      self
+    end
+
+    def size
+      @collection.size
+    end
+
+  private
+
+    # Sums up Money objects using built-in :+ method.
+    # @param moneys [Enumerable<Money>] list of Moneys.
+    # @return [Money] sum of Money collection.
+    def self.sum_basic(moneys)
+      moneys.reduce{|total, money| total + money }
+    end
+
+    # Sums up Money objects of the same currency.
+    # Number of object creation is minimized.
+    # @param moneys [Enumerable<Money>] list of Moneys. There is no validation so caller must ensure all Moneys belong to the same currency.
+    # @return [Money] sum of Money collection.
+    def self.sum_single_currency(moneys)
+      total_fractional = moneys.reduce(0){|fractional, money| fractional += money.fractional }
+      Money.new(total_fractional, moneys[0].currency)
+    end
+
+    def self.convert_to_currency_object(currency)
+      case currency
+      when String, Symbol
+        ::Money::Currency.new(currency)
+      when ::Money::Currency
+        currency
+      end
+    end
+  end
+end

data/lib/money/collection/version.rb

@@ -0,0 +1,5 @@
+class Money
+  class Collection
+    VERSION = "0.0.1"
+  end
+end

data/money-collection.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'money/collection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "money-collection"
+  spec.version       = Money::Collection::VERSION
+  spec.authors       = ["lulalala"]
+  spec.email         = ["mark@goodlife.tw"]
+  spec.summary       = %q{Optimized operation on collection of Money objects}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/lulalala/money-collection"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "money", "~> 6.3"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'minitest/spec'
+require 'minitest/autorun'
+

data/spec/money/collection_spec.rb

@@ -0,0 +1,211 @@
+require 'helper'
+require 'money'
+require 'money/collection'
+
+describe Money::Collection do
+  before do
+    foo = {
+      :iso_code        => "FOO",
+      :subunit_to_unit => 100,
+    }
+    Money::Currency.register(foo)
+
+    Money.add_rate("FOO", "USD", 0.5)
+    Money.add_rate("USD", "FOO", 2)
+  end
+
+  it 'has version' do
+    Money::Collection.const_get('VERSION').wont_be_empty
+  end
+
+  describe '#sum' do
+
+    it 'sums with no element' do
+      c = Money::Collection.new
+      c.sum.must_equal Money.new(0)
+    end
+
+    it 'sums with single element' do
+      c = Money::Collection.new
+      c << Money.new(10,:usd)
+      c.sum.must_equal Money.new(10,:usd)
+    end
+
+    it 'sums same currency' do
+      ary = [
+        Money.new(10,:usd),
+        Money.new(20,:usd),
+        Money.new(30,:usd),
+      ]
+
+      c = Money::Collection.new(ary)
+
+      c.sum.must_equal Money.new(60,:usd)
+    end
+
+    it 'sums different currencies' do
+      ary = [
+        Money.new(100,:usd),
+        Money.new(10,:foo),
+      ]
+
+      c = Money::Collection.new(ary)
+
+      c.sum.must_equal normal_sum(ary)
+    end
+
+    it 'sums correctly, avoiding rounding down error' do
+      ary = [
+        Money.new(10,:usd),
+        Money.new(1,:foo),
+        Money.new(1,:foo),
+      ]
+
+      c = Money::Collection.new(ary)
+
+      c.sum.must_equal Money.new(11,:usd)
+    end
+
+    it 'sums correctly, avoiding rounding twice if possible' do
+      ary = [
+        Money.new(10,:usd),
+        Money.new(1,:foo),
+      ]
+
+      c = Money::Collection.new(ary)
+
+      c.sum(:foo).must_equal Money.new(21,:foo)
+    end
+
+    it 'returns sum in the specified currency' do
+      ary = [
+        Money.new(10,:usd),
+        Money.new(2,:foo),
+      ]
+
+      c = Money::Collection.new(ary)
+
+      c.sum('foo').must_equal Money.new(22,:foo)
+      c.sum('usd').must_equal Money.new(11,:usd)
+    end
+
+    it 'returns sum large number of Money' do
+      10.times do
+        # force first bunch to be FOO, the a bunch of USD,
+        # so there won't be currency conversion error even for native sum method
+        ary = 1000.times.map do
+          Money.new(Random.rand(100000), :foo)
+        end
+        ary.concat(
+          1000.times.map do
+            Money.new(Random.rand(100000), :usd)
+          end
+        )
+
+        c = Money::Collection.new(ary)
+        c.sum('foo').must_equal normal_sum(ary)
+      end
+    end
+  end
+
+  describe '#min' do
+    it 'returns accurate smallest Money object' do
+      ary = [
+        Money.new(30,:foo),
+        Money.new(1,:usd),
+        Money.new(3,:foo),
+      ]
+
+      c = Money::Collection.new(ary)
+      c.min.must_equal Money.new(1,:usd)
+    end
+    it 'returns smallest Money objects (from many items)' do
+      ary = 1000.times.map do
+        Money.new(Random.rand(100000) + 10, :foo)
+      end
+      c = Money::Collection.new(ary)
+      min = Money.new(1, :usd)
+      c << min
+      c.min.must_equal min
+    end
+  end
+
+  describe '#max' do
+    it 'returns accurate biggest Money object' do
+      ary = [
+        Money.new(30,:foo),
+        Money.new(1,:usd),
+        Money.new(3,:foo),
+      ]
+
+      c = Money::Collection.new(ary)
+      c.max.must_equal Money.new(30,:foo)
+    end
+    it 'returns biggest Money objects (from many items)' do
+      ary = 1000.times.map do
+        Money.new(Random.rand(100000), :foo)
+      end
+      c = Money::Collection.new(ary)
+      max = Money.new(100001, :usd)
+      c << max
+      c.max.must_equal max
+    end
+  end
+
+  describe '#concat' do
+    it 'concats Money objects to collection' do
+      ary = [
+        Money.new(10,:usd),
+        Money.new(2,:foo),
+      ]
+
+      c = Money::Collection.new
+      c.concat ary
+
+      c.size.must_equal 2
+      c.sum('foo').must_equal Money.new(22,:foo)
+    end
+    it 'concats Money objects to collection multiple times' do
+      ary = [
+        Money.new(10,:usd),
+        Money.new(2,:foo),
+      ]
+
+      c = Money::Collection.new
+      c.concat ary
+      c.concat ary
+
+      c.size.must_equal 4
+      c.sum('foo').must_equal Money.new(44,:foo)
+    end
+  end
+
+  describe '#<<' do
+    it 'concats Money object to collection multiple times' do
+      c = Money::Collection.new
+      c << Money.new(10,:usd)
+      c << Money.new(10,:foo)
+      c << Money.new(10,:usd)
+
+      c.sum.must_equal Money.new(25,:usd)
+    end
+  end
+
+  describe 'no side effect' do
+    it 'does not change original array that is passed in the initialize method' do
+      m1 = Money.new(10,:usd)
+      ary = [m1]
+
+      c = Money::Collection.new(ary)
+      c << Money.new(1,:usd)
+
+      ary.size.must_equal 1
+      ary[0].must_equal m1
+    end
+  end
+end
+
+# Adds up array of Money one by one and returns the sum.
+def normal_sum(array)
+  array.reduce{|total, money| total + money }
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: money-collection
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- lulalala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Optimized operation on collection of Money objects
+email:
+- mark@goodlife.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/helper.rb
+- benchmark/max.rb
+- benchmark/sum.rb
+- lib/money/collection.rb
+- lib/money/collection/version.rb
+- money-collection.gemspec
+- spec/helper.rb
+- spec/money/collection_spec.rb
+homepage: https://github.com/lulalala/money-collection
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Optimized operation on collection of Money objects
+test_files:
+- spec/helper.rb
+- spec/money/collection_spec.rb
+has_rdoc: