money-collection 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31d48e73a143672af436d2128462573a8f9b7d70
-  data.tar.gz: 2c8528a4f6163392762d25ddea387eb6649d860a
+SHA256:
+  metadata.gz: bd82171bc041fe8ea6511930392184765ce185882526cd01ed9a4b934b58a9e9
+  data.tar.gz: ad80e10f85340021bcffd3177d64bdd8dcdab5c583ec70ae1e1200bfe847910e
 SHA512:
-  metadata.gz: 9027fda3114e23db23061ab4a88d31e071a89d690a11c4de994c0c8b6517d6a41f5e28aa1620dff27285be12aac433612e95871ff3609d6bc457aeb82d358603
-  data.tar.gz: 85632bb6ae43b0eac67779762a35909c1d00894ba67c51cb727413f78f977538d3349d1af189c1094e5f2822c55390dfefe098bf2f0dd3b34eedf5bdb3bb3313
+  metadata.gz: 642b2e6aa39a0cdd4bbcb80f268471ea2cb92a514be40a7c306d86e5eff6b86736c4d487a9bdece2ad13505a5f8cf1ae6263c4187add56cbb08bc49ada2146db
+  data.tar.gz: 0c766984cd6b05b5116cce17d52e4e890e632b62a33dfdf4cd39ad44ff4567c8acf1d645cc6b738c861b59d799c448c4aca8ba7ab307f96bc758aa4e364f248d

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## Unreleased
+
+## 1.0.0
+
+- **Breaking change**: Update Money gem dependency to ~> 7.0. See the [Money 7.0 upgrading guide](https://github.com/RubyMoney/money/blob/main/UPGRADING-7.0.md)
+- **Breaking change**: Drop support for Ruby < 3.1
+
+## 0.1.0
+
+- Initial release
+- Add `Money::Collection` class for optimized sum/min/max operations on Money objects
+- Minimize currency conversions for accuracy and efficiency
+- Support enumerable operations with `#concat` and `#<<` methods

data/LICENSE

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

@@ -52,5 +52,5 @@ The followings areas can use some of your expertise:
 
 ## License
 
-MIT License (See LICENSE.txt)
+MIT License (See LICENSE)
 

data/lib/money/collection/version.rb

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

data/lib/money/collection.rb

@@ -20,29 +20,26 @@ class Money
 
       if @group_by_currency.size == 1
         sum = self.class.sum_single_currency(@collection)
+        if target_currency
+          sum = sum.exchange_to(target_currency)
+        end
       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.
+        # Convert to target_currency if specified
         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
+          target_currency = Money::Currency.wrap(target_currency)
+          sums_per_currency.map!{|s|
+            s.exchange_to(target_currency)
+          }
         end
 
         sum = self.class.sum_basic(sums_per_currency)
       end
 
-      if target_currency.nil?
-        return sum
-      else
-        return sum.exchange_to(target_currency)
-      end
+      sum
     end
 
     def max
@@ -112,14 +109,5 @@ class Money
       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/money-collection.gemspec

@@ -1,25 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'money/collection/version'
+require "money/collection/version"
+
+Gem::Specification.new do |s|
+  s.name        = "money-collection"
+  s.version     = Money::Collection::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["lulalala"]
+  s.email       = ["mark@goodlife.tw"]
+  s.homepage    = "https://github.com/RubyMoney/money-collection"
+  s.summary     = "Optimized operation on collection of Money objects"
+  s.description = "Optimized operation on collection of Money objects"
+  s.license     = "MIT"
 
-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"
+  s.add_dependency "money", "~> 7.0"
 
-  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"]
+  s.required_ruby_version = ">= 3.1"
 
-  spec.add_dependency "money", "~> 6.3"
+  s.files         = `git ls-files -z -- lib/* CHANGELOG.md LICENSE money-collection.gemspec README.md`.split("\x0")
+  s.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  if s.respond_to?(:metadata)
+    s.metadata["changelog_uri"] = "https://github.com/RubyMoney/money-collection/blob/main/CHANGELOG.md"
+    s.metadata["source_code_uri"] = "https://github.com/RubyMoney/money-collection/"
+    s.metadata["bug_tracker_uri"] = "https://github.com/RubyMoney/money-collection/issues"
+    s.metadata["rubygems_mfa_required"] = "true"
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: money-collection
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - lulalala
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -16,42 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '7.0'
   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'
+        version: '7.0'
 description: Optimized operation on collection of Money objects
 email:
 - mark@goodlife.tw
@@ -59,24 +30,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
+- CHANGELOG.md
+- LICENSE
 - 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
+homepage: https://github.com/RubyMoney/money-collection
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/RubyMoney/money-collection/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/RubyMoney/money-collection/
+  bug_tracker_uri: https://github.com/RubyMoney/money-collection/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -84,19 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 4.0.0
 specification_version: 4
 summary: Optimized operation on collection of Money objects
-test_files:
-- spec/helper.rb
-- spec/money/collection_spec.rb
-has_rdoc: 
+test_files: []

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-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/Rakefile

@@ -1,9 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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/spec/helper.rb

@@ -1,21 +0,0 @@
-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

@@ -1,211 +0,0 @@
-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