latinum 1.5.0 → 1.6.0

data/lib/latinum/resource.rb

@@ -23,46 +23,84 @@
 require 'bigdecimal'
 require 'bigdecimal/util'
 
+require_relative 'error'
+
 module Latinum
-	class DifferentResourceNameError < ArgumentError
-		def initialize
-			super "Cannot operate on different currencies!"
-		end
-	end
-	
-	# A fixed unit in a given named resource
+	# A Resource represents a fixed amount of a named currency or material.
 	class Resource
-		include Comparable
+		# Parse a string representation of a resource.
+		# @parameter string [String] e.g "5 NZD".
+		# @returns [Resource] The Resource that represents the parsed string.
+		def self.parse(string, default_name: nil)
+			amount, name = string.split(/\s+/, 2)
+			
+			self.new(amount, name || default_name)
+		end
 		
-		attr :amount
-		attr :name
+		# Load a string representation of a resource.
+		# @parameter string [String | Nil] e.g. "5 NZD" or nil.
+		# @returns [Resource | Nil] The Resource that represents the parsed string.
+		def self.load(string)
+			if string
+				# Remove any whitespaces
+				string = string.strip
+				
+				parse(string) unless string.empty?
+			end
+		end
+		
+		# Dump a string representatino of a resource.
+		# @parameter resource [Resource] The resource to dump.
+		# @returns [String | Nil] A string that represents the {Resource}.
+		def self.dump(resource)
+			resource.to_s if resource
+		end
+		
+		include Comparable
 		
 		def initialize(amount, name)
 			@amount = amount.to_d
 			@name = name
 		end
 		
-		# By default, we can only add and subtract if the name is the same
+		# The amount of the resource.
+		# @attribute [BigDecimal]
+		attr :amount
+		
+		# The name of the resource.
+		# @attribute [String]
+		attr :name
+		
+		# Add two resources. Must have the same name.
+		# @returns [Resource] A resource with the added amount.
 		def + other
 			raise DifferentResourceNameError if @name != other.name
 			
 			self.class.new(@amount + other.amount, @name)
 		end
 		
+		# Subtract two resources. Must have the same name.
+		# @returns [Resource] A resource with the subtracted amount.
 		def - other
 			raise DifferentResourceNameError if @name != other.name
 			
 			self.class.new(@amount - other.amount, @name)
 		end
 		
+		# Invert the amount of the resource.
+		# @returns [Resource] A resource with the negated amount.
 		def -@
 			self.class.new(-@amount, @name)
 		end
 		
+		# Multiplies the resource by a given factor.
+		# @returns [Resource] A resource with the updated amount.
 		def * factor
 			self.class.new(@amount * factor, @name)
 		end
 		
+		# Divides the resource by a given factor.
+		# @returns [Resource] A resource with the updated amount.
 		def / factor
 			if factor.is_a? self.class
 				raise DifferentResourceNameError if @name != factor.name
@@ -73,6 +111,10 @@ module Latinum
 			end
 		end
 		
+		# Compute a new resource using the given exchange rate for the specified name.
+		# @parameter rate [Numeric] The exchange rate to use.
+		# @parameter name [String] The name of the new resource.
+		# @parameter precision [Integer | Nil] The number of decimal places to round to.
 		def exchange(rate, name, precision = nil)
 			return self if @name == name
 			
@@ -83,20 +125,28 @@ module Latinum
 			self.class.new(exchanged_amount, name)
 		end
 		
+		# A human readable string representation of the resource amount and name.
+		# @returns [String] e.g. "5 NZD".
 		def to_s
 			"#{@amount.to_s('F')} #{@name}"
 		end
 		
+		# A human readable string representation of the resource amount.
+		# @returns [String] e.g. "5.00".
+		def to_digits
+			@amount.to_s('F')
+		end
+		
 		def inspect
 			"#<#{self.class.name} #{self.to_s.dump}>"
 		end
 		
-		# Compare with another resource or a Numeric value.
+		# Compare with another {Resource} or a Numeric value.
 		def <=> other
 			if other.is_a? self.class
 				result = @amount <=> other.amount
 				return result unless result == 0
-
+				
 				result = @name <=> other.name
 				return result
 			elsif other.is_a? Numeric
@@ -109,30 +159,11 @@ module Latinum
 		end
 		
 		def eql? other
-			self.class.eql? other.class and @name.eql? other.name and @amount.eql? other.amount
-		end
-		
-		class << self
-			def parse(string, default_name: nil)
-				amount, name = string.split(/\s+/, 2)
-				
-				self.new(amount, name || default_name)
-			end
-			
-			def load(string)
-				if string
-					# Remove any whitespaces
-					string = string.strip
-					
-					parse(string) unless string.empty?
-				end
-			end
-			
-			def dump(resource)
-				resource.to_s if resource
-			end
+			self.class.eql?(other.class) and @name.eql?(other.name) and @amount.eql?(other.amount)
 		end
 		
+		# Whether the amount of the resource is zero.
+		# @returns [Boolean]
 		def zero?
 			@amount.zero?
 		end

data/lib/latinum/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Latinum
-	VERSION = "1.5.0"
+	VERSION = "1.6.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: latinum
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-01 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,65 +39,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.4'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- latinum.gemspec
 - lib/latinum.rb
 - lib/latinum/bank.rb
 - lib/latinum/collection.rb
 - lib/latinum/currencies/global.rb
+- lib/latinum/error.rb
 - lib/latinum/formatters.rb
 - lib/latinum/resource.rb
 - lib/latinum/version.rb
-- spec/latinum/bank_spec.rb
-- spec/latinum/collection_spec.rb
-- spec/latinum/comparison_spec.rb
-- spec/latinum/formatters_spec.rb
-- spec/latinum/integrals_spec.rb
-- spec/latinum/resource_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/ioquatix/latinum
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -113,15 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: Latinum is a simple gem for managing resource computations, including money
-  and minerals.
-test_files:
-- spec/latinum/bank_spec.rb
-- spec/latinum/collection_spec.rb
-- spec/latinum/comparison_spec.rb
-- spec/latinum/formatters_spec.rb
-- spec/latinum/integrals_spec.rb
-- spec/latinum/resource_spec.rb
-- spec/spec_helper.rb
+summary: Provides immutable resource and money computations.
+test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.6
-      os: osx
-    - rvm: 2.6
-      env: COVERAGE=BriefSummary,Coveralls
-    - rvm: 2.7
-    - rvm: truffleruby
-    - rvm: jruby-head
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec

data/README.md

@@ -1,276 +0,0 @@
-# Latinum
-
-Latinum is a library for resource and currency calculations. It provides immutable `Resource` objects for dealing with quantities of named resources with an arbitrary number of decimal places, and `Bank` objects for converting resources and formatting them for output. Latinum doesn't include any global state by default and thus is ideal for integration with other frameworks/libraries.
-
-[![Build Status](https://travis-ci.com/ioquatix/latinum.svg?branch=master)](https://travis-ci.com/ioquatix/latinum)
-[![Code Climate](https://codeclimate.com/github/ioquatix/latinum.svg)](https://codeclimate.com/github/ioquatix/latinum)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/latinum/badge.svg)](https://coveralls.io/r/ioquatix/latinum)
-
-## Motivation
-
-I was originally planning on using the [Money gem](https://github.com/RubyMoney/money), but it's [dependency on global state](https://github.com/RubyMoney/money/blob/39b617cca8f02c885cc8246e0aab3e9dc5f90e15/lib/money/currency.rb#L19-L21) makes it hard to use if you want to deal with money as an immutable value type.
-
-Additionally, I wanted to support BitCoin, Japanese Yen, etc. The money gem was heavily biased towards decimal currency. It had (~2012) [fields like `dollars` and `cents`](https://github.com/RubyMoney/money/issues/197) which don't really make sense and don't really align with the real world. These days they have fixed parts of the API, but it's a bit of a mess now, supporting both decimal and non-decimal values.
-
-Another problem I had at the time was the [concept of zero](https://github.com/RubyMoney/money/issues/195). It should be possible to have an additive (e.g. 0) and multiplicative identity (e.g. 1) do the right thing. In fact, in Latinum, you can multiply `Latinum::Resource` instances by a scalar and get a useful result (e.g. for computing discounts).
-
-Finally, because of the above problem, it was not obvious at the time how to sum up a collection of money instances correctly. In fact, this is still a problem and a separate gem, based on the `Latinum::Collection` concept, [was made](https://github.com/lulalala/money-collection). However, this all fits together in a rather haphazard way.
-
-Latinum addresses all these issues. It has an immutable value type `Latinum::Resource` which has a robust definition: A value (e.g. 5.0025) and a resource name (USD). The semantics of resources are well defined without the need for "Currency" state like the symbol, how many decimal places, etc. So, it suits well for serialization into a database, and for formatting to the user, there is `Latinum::Bank` which gives you the choice of how you decide to format things or exchange them, whether you want to round something off, etc.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-	gem 'latinum'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install latinum
-
-## Usage
-
-Latinum has several core concepts:
-
-- A `Resource` represents an immutable value with a specific face name (e.g. `'USD'`).
-- A `Resource` can only be combined with resources with the same face name.
-- A `Bank` is responsible for managing currencies and formatting options.
-- A `Bank` can exchange currencies explicitly with a given set of exchange rates.
-- A `Collection` is responsible for adding currencies together and is completely deterministic.
-
-### Resources and Collections
-
-To create a new resource, use a string for accuracy:
-
-	> ten = Latinum::Resource.new("10.00", "NZD")
-	=> 10.0 NZD
-	> ten.amount == "10.00".to_d
-	=> true
-
-You can add resources of different values but with the same name:
-
-	> ten + ten
-	=> 20.0 NZD
-
-But, you can't add resources of different names together:
-
-	> twenty = Latinum::Resource.new("20.00", "AUD")
-	=> 20.0 AUD
-	> ten + twenty
-	DifferentResourceNameError: Cannot operate on different currencies!
-
-To add multiple currencies together, use a collection:
-
-	> collection = Latinum::Collection.new
-	> collection << [ten, twenty]
-	> collection.collect(&:to_s)
-	=> [10.0 NZD, 20.0 AUD]
-
-#### Calculating Totals
-
-The `Latinum::Collection` is the correct way to sum up a list of transactions or other items with an
-associated `Latinum::Resource`. Here is an example:
-
-	<table class="listing transactions" data-model="Transaction">
-		<thead>
-			<tr>
-				<th class="name">Name</th>
-				<th class="date">Date</th>
-				<th class="price">Price</th>
-				<th class="quantity">Quantity</th>
-				<th class="subtotal">Sub-total</th>
-				<th class="tax_rate">Tax</th>
-				<th class="total">Total</th>
-			</tr>
-		</thead>
-		<tbody>
-			<?r 
-				currencies = Set.new
-				
-				summary = {
-					:subtotal => Latinum::Collection.new(currencies),
-					:tax => Latinum::Collection.new(currencies),
-					:total => Latinum::Collection.new(currencies)
-				}
-				
-				invoice.transactions.each do |transaction|
-					subtotal = transaction.subtotal
-					summary[:subtotal] << subtotal
-					summary[:tax] << subtotal * transaction.tax_rate.to_d
-					summary[:total] << transaction.total
-				
-			?>
-			<tr data-id="#{transaction.id}" data-rev="#{transaction.rev}">
-				<th class="name">#{f.text transaction.name}</th>
-				<td class="date">#{f.text transaction.date}</td>
-				<td class="price">#{f.text transaction.price}</td>
-				<td class="quantity">#{f.quantity transaction}</td>
-				<td class="subtotal">#{f.text subtotal}</td>
-				<td class="tax_rate">#{f.tax transaction}</td>
-				<td class="total">#{f.text transaction.total}</td>
-			</tr>
-			<?r end ?>
-		</tbody>
-		<tfoot>
-			<?r currencies.each do |currency| ?>
-			<tr>
-				<td colspan="5">#{currency} Summary:</td>
-				<td class="subtotal">#{f.text summary[:subtotal][currency]}</td>
-				<td class="tax_rate">#{f.text summary[:tax][currency]}</td>
-				<td class="total">#{f.text summary[:total][currency]}</td>
-				<td></td>
-			</tr>
-			<?r end ?>
-		</tfoot>
-	</table>
-
-### Banks and Exchange Rates
-
-The bank is responsible for formatting and exchange rates:
-
-	require 'latinum/bank'
-	require 'latinum/currencies/global'
-	
-	> bank = Latinum::Bank.new(Latinum::Currencies::Global)
-	> bank << Latinum::ExchangeRate.new("NZD", "AUD", "0.5")
-	
-	> nzd = Latinum::Resource.new("10", "NZD")
-	=> 10.0 NZD
-	> aud = bank.exchange nzd, "AUD"
-	=> 5.0 AUD
-
-Formatting an amount is typically required for presentation to the end user:
-
-	> bank.format(nzd)
-	=> "$10.00 NZD"
-	
-	> bank.format(aud, name: nil)
-	=> "$5.00"
-
-The bank can also be used to parse currency, which will depend on the priority of currencies if a symbol that matches multiple currencies is supplied:
-
-	> bank.parse("$5")
-	=> 5.0 USD
-	
-	> bank.parse("€5")
-	=> 5.0 EUR
-
-Currency codes take priority over symbols if specified:
-
-	> bank.parse("€5 NZD")
-	=> 5.0 NZD
-
-### Conversion To and From Integers
-
-For storage in traditional databases, you may prefer to use integers. Based on the precision of the currency, you can store integer representations:
-
-	> resource = Latinum::Resource.new("1.12345678", "BTC")
-	
-	> 112345678 == bank.to_integral(resource)
-	true
-	
-	> resource == bank.from_integral(112345678, "BTC")
-	true
-
-As BitCoin has 8 decimal places, it requires an integer representation with at least 10^8.
-
-### ActiveRecord Serialization
-
-Latinum can be easily used in a [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord) model simply by declaring a serialized data-type for a string or text column, e.g.
-
-	class Transaction < ActiveRecord::Base
-		serialize :total, Latinum::Resource
-	end
-
-It can be used like so:
-
-	> transaction = Transaction.new(:total => "10 NZD")
-	> transaction.total * 2
-	=> "20.0 NZD"
-
-To format the output, use a `Latinum::Bank`, e.g. assuming the bank is set up correctly:
-
-	> bank.format(transaction.total)
-	=> "$20.00 NZD"
-	
-	> bank.format(transaction.total, name: nil)
-	=> "$20.00"
-	
-	> bank.format(transaction.total, symbol: nil)
-	=> "20.00 NZD"
-
-### Relaxo Serialization
-
-Latinum is natively supported by [Relaxo](https://github.com/ioquatix/relaxo) (CouchDB) and as such can be used in [Relaxo models](https://github.com/ioquatix/relaxo-model) easily.
-
-	require 'latinum'
-	require 'relaxo/model'
-	require 'relaxo/model/properties/latinum'
-	
-	class Transaction
-		include Relaxo::Model
-
-		property :name
-		property :price, Attribute[Latinum::Resource]
-	end
-	
-	db = Relaxo.connect('test')
-	db.create!
-	
-	t = Transaction.create(db, price: Latinum::Resource.load("50 NZD"))
-	
-	t.price
-	# => <Latinum::Resource "50.0 NZD">
-	
-	# Save and reload from database server:
-	t.save
-	t = Transaction.fetch(db, t.id)
-	
-	t.price
-	# => <Latinum::Resource "50.0 NZD">
-
-It gets stored in the database like so:
-
-	{
-		"_id": "740f4728fc9a571d826688db2f004771",
-		"_rev": "1-45a29c63311cfa0d5a765707184b2b3b",
-		"type": "transaction",
-		"price": [
-			"50.0",
-			"NZD"
-		]
-	}
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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.