money-convert 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c91b3c56e242f88c5617a8bb9cbac70df38e2106f2dbf88f7133bdf9c21c7f2e
-  data.tar.gz: afde2ee3bb80f2fc1ce580782416b7f0552e754b9316ab779ad3468eb0a0b0df
+  metadata.gz: 959345f9cce96a73647d6375e852d12329a1db3688518b36bfd26706b288ec87
+  data.tar.gz: 47feabe88d29ddb8ba9d06cb4008ee82b773e515b184f2471ddbdc29e24a77da
 SHA512:
-  metadata.gz: 4bb2ffa159e6bcc0100967a0a2f57149136ec966866d7b9cd6cd6317f15333675a9077c51e17f74554104c6b4d3f73aa4e4c396cf6059e9c0fbdefca4b74e678
-  data.tar.gz: c20cf866dd0a8816fc8b26ae80410560cff985f56e38500b9eceb38b2d4bf5ac26527ed8b22ffc594d3cf28eda062e5fce589bd915348bfcfa38888f59798849
+  metadata.gz: 1841871c04764b1a6aa43fa2ff5beac2dba0525336eea92825380eb207bd3ec0822d72571bbb9c55bf6015758d5fb4df87dbf6291cf5487693cef10e28687a9c
+  data.tar.gz: 919ab668e447e65ab758d6c03b41aee08a4cefff125508a5b7fbb0cb0218e32aa7f0a1b81c572d6d8ebd6b8a233023b1d194d943a034fde5c2a2331b4ee9c1ea

data/README.md

@@ -1,5 +1,7 @@
 # Money::Convert
 
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,14 +23,14 @@ Or install it yourself as:
 ```ruby
 # Configure the currency rates with respect to a base currency (here EUR):
  
-Money.conversion_rates('EUR', {
+MoneyConvert.conversion_rates('EUR', {
   'USD'     => 1.11,
   'Bitcoin' => 0.0047
 })
  
-# Instantiate money objects:
+# Instantiate money convert objects:
  
-fifty_eur = Money.new(50, 'EUR')
+fifty_eur = MoneyConvert.new(50, 'EUR')
  
 # Get amount and currency:
  
@@ -43,7 +45,7 @@ fifty_eur.convert_to('USD') # => 55.50 USD
  
 # Perform operations in different currencies:
  
-twenty_dollars = Money.new(20, 'USD')
+twenty_dollars = MoneyConvert.new(20, 'USD')
  
 # Arithmetics:
  
@@ -54,19 +56,19 @@ twenty_dollars * 3         # => 60 USD
  
 # Comparisons (also in different currencies):
  
-twenty_dollars == Money.new(20, 'USD') # => true
-twenty_dollars == Money.new(30, 'USD') # => false
+twenty_dollars == MoneyConvert.new(20, 'USD') # => true
+twenty_dollars == MoneyConvert.new(30, 'USD') # => false
  
 fifty_eur_in_usd = fifty_eur.convert_to('USD')
 fifty_eur_in_usd == fifty_eur          # => true
  
-twenty_dollars > Money.new(5, 'USD')   # => true
+twenty_dollars > MoneyConvert.new(5, 'USD')   # => true
 twenty_dollars < fifty_eur             # => true
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/money-convert. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/money-convert/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/varmad/money-convert. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/money-convert/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/lib/money-convert/money-convert.rb

@@ -1,5 +1,7 @@
-require_relative "conversion_rates"
+require_relative 'conversion_rates'
 
+# Class for converting money from one currency to another
+# and perform some arthimetic operations on two MoneyConvert objects.
 class MoneyConvert
   attr_accessor :amount, :currency, :base_currency, :to_currencies
 
@@ -12,6 +14,12 @@ class MoneyConvert
     "#{@amount} #{@currency}"
   end
 
+  # Returns class object with converted currency values
+  # For example:
+  #   fifty_eur = MoneyConvert.new(50, 'EUR')
+  #   fifty_eur_in_usd = fifty_eur.convert_to('USD')
+  #     =>   fifty_eur_in_usd.currency
+  #     =>   fifty_eur_in_usd.amount
   def convert_to(to_currency)
     return unless validate_currency(to_currency) && @@base_currency == currency
 
@@ -19,36 +27,47 @@ class MoneyConvert
     self.class.new(toal_amount, to_currency)
   end
 
-  def convert(to_currency)
-    (@amount.to_i * @@to_currencies.fetch(to_currency)).round(2)
-  end
-
-  def +(other)
-    return unless currency == @@base_currency
-
-    converted_amount = convert(other.currency)
-    converted_amount + amount.to_i
-  end
-
-  def -(other)
-    return unless currency == @@base_currency
-    
-    converted_amount = convert(other.currency)
-    converted_amount - amount.to_i
+  # Return sum of two MoneyConvert object, if +other+ object has different currency
+  # it will get converted into this object currency
+  # For Example:
+  #   MoneyConvert.new(50, 'EUR') + MoneyConvert.new(20, 'USD')
+  #   MoneyConvert.new(50, 'EUR') - MoneyConvert.new(20, 'USD')
+  #     => returns amount in EUR currency
+  %i[+, -].each do |method|
+    define_method(method) do |other|
+      return unless currency == @@base_currency
+      
+      converted_amount = convert(other.currency)
+      converted_amount - amount.to_i
+    end
   end
 
+  # Return division of two MoneyConvert object, if +other+ object has different currency
+  # it will get converted into this object currency
+  # For Example:
+  #   MoneyConvert.new(50, 'EUR') / MoneyConvert.new(20, 'USD')
+  #     => returns amount in EUR currency
   def /(other)
     return unless other.is_a?(Integer)
 
     amount.to_i / other
   end
 
+  # Return multiplication of two MoneyConvert object, if +other+ object has different currency
+  # it will get converted into this object currency
+  # For Example:
+  #   MoneyConvert.new(50, 'EUR') * MoneyConvert.new(20, 'USD')
+  #     => returns amount in EUR currency
   def *(other)
     return unless other.is_a?(Integer)
 
     amount.to_i * other
   end
 
+  # Return true if +other+ object and this object has same amount and currency
+  # For Example:
+  #   MoneyConvert.new(50, 'EUR') == MoneyConvert.new(50, 'EUR')
+  #     => returns boolean
   def ==(other)
     if amount == other.amount && currency == other.currency
       true
@@ -57,6 +76,11 @@ class MoneyConvert
     end
   end
 
+  # Return true if +other+ object amount is gtater than this object amount,
+  # and the currency should be same
+  # For Example:
+  #   MoneyConvert.new(50, 'EUR') > MoneyConvert.new(30, 'EUR')
+  #     => returns boolean
   def >(other)
     if amount > other.amount && currency == other.currency
       true
@@ -65,6 +89,11 @@ class MoneyConvert
     end
   end
 
+  # Return true if +other+ object amount is less than this object amount,
+  # and the currency should be same
+  # For Example:
+  #   MoneyConvert.new(20, 'EUR') < MoneyConvert.new(30, 'EUR')
+  #     => returns boolean
   def <(other)
     if amount < other.amount && currency == other.currency
       true
@@ -77,13 +106,22 @@ class MoneyConvert
     end
   end
 
-  def validate_currency(to_currency)
-    @@to_currencies&.keys&.include?(to_currency)
-  end
-
+  # Sets the +@@base_currency+ and +@@to_currencies+ class valiables
   def self.conversion_rates(base_currency, to_currencies)
     conversion_rates = MoneyConvert::ConversionRates.new(base_currency, to_currencies)
     @@base_currency = conversion_rates.base_currency
     @@to_currencies = conversion_rates.to_currencies
   end
+
+  private
+
+  # Returns converted currency
+  def convert(to_currency)
+    (@amount.to_i * @@to_currencies.fetch(to_currency, 1)).round(2)
+  end
+
+  # Checks wether the +to_currency+ is present in the given +@@to_curencies+ hash
+  def validate_currency(to_currency)
+    @@to_currencies&.keys&.include?(to_currency) || to_currency == @@base_currency
+  end
 end

data/lib/money-convert/version.rb

@@ -1,3 +1,3 @@
 class MoneyConvert
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-convert
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Srinivasa Varma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: