Class: Vatcalc::ServiceElement

Inherits:
GNV
  • Object
show all
Defined in:
lib/vatcalc/service_element.rb

Instance Attribute Summary collapse

Attributes inherited from GNV

#currency, #source, #vector

Instance Method Summary collapse

Methods inherited from GNV

#*, #-@, #<=>, #coerce, #gross, #net, #to_gnv, #vat

Constructor Details

#initialize(amount, net: false, currency: nil, rates: {}) ⇒ ServiceElement

Initalizes a new Object of an ServiceElement Assumes that the amount is a gross value but you can pass a net value as well if you pass the option net: true

> b = ServiceElement.new 10.00, currency: “EUR”

b.net.to_f = 8.40

> b = ServiceElement.new 10.00, currency: “USD”

b.net.to_f = 9.35

> b = ServiceElement.new 10.00, currency: “USD”, net: true

> b.gross = 10.70

Parameters:

  • amount —

    [Money,Numeric]

  • options —

    [Hash]



21
22
23
24
25
26
 
# File 'lib/vatcalc/service_element.rb', line 21

def initialize(amount,net: false, currency: nil, rates: {})
  @net_service = net 
  #if an service element is initialized # =>  gross equals net
  super amount, amount, currency
  change_rates(rates)
end

Instance Attribute Details

#rates ⇒ Object (readonly)

Returns the value of attribute rates.



5
6
7
 
# File 'lib/vatcalc/service_element.rb', line 5

def rates
  @rates
end

#vat_splitted ⇒ Object (readonly)

Returns the value of attribute vat_splitted.



5
6
7
 
# File 'lib/vatcalc/service_element.rb', line 5

def vat_splitted
  @vat_splitted
end

Instance Method Details

#==(oth) ⇒ Object 



82
83
84
 
# File 'lib/vatcalc/service_element.rb', line 82

def ==(oth)
  oth.is_a?(ServiceElement) && oth.gross == gross && oth.net == net && (@vat_splitted == oth.vat_splitted)
end

#change_rates(new_rates) ⇒ Hash

Allocates net or gross by new vat_percentage rates and calculates the vat splitted by given rates

>

Examples:

=> {#<Vatcalc::VATPercentage vat_percentage:19%>=>#<Money fractional:64 currency:EUR>,
    #<Vatcalc::VATPercentage vat_percentage:7%>=>#<Money fractional:39 currency:EUR>}

Parameters:

  • rates (Hash)

Returns:

  • (Hash) 


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/vatcalc/service_element.rb', line 37

def change_rates(new_rates)
  if new_rates.is_a? Hash
    if !new_rates.empty?
      # Using basically the allocate function of the Money gem here.
      # EXPLANATION FROM MONEY GEM: 
      #
      # Allocates money between different parties without losing pennies.
      # After the mathematical split has been performed, leftover pennies will
      # be distributed round-robin amongst the parties. This means that parties
      # listed first will likely receive more pennies than ones that are listed later
      
      # @param [Array<Numeric>] splits [0.50, 0.25, 0.25] to give 50% of the cash to party1, 25% to party2, and 25% to party3.
      
      # @return [Array<Money>]
      
      # @example
      #   Money.new(5,   "USD").allocate([0.3, 0.7])         #=> [Money.new(2), Money.new(3)]
      #   Money.new(100, "USD").allocate([0.33, 0.33, 0.33]) #=> [Money.new(34), Money.new(33), Money.new(33)]
      #
      allocated = (@net_service ? net : gross).allocate(new_rates.values)
      # Init new vector after the allocate calculation
      # Comes from superclass GNV
      init_vector(0,0)
      @vat_splitted = {}
      new_rates.keys.zip(allocated).each do |vp,splitted|
        #creating a new base element
        b = BaseElement.new(splitted, net: @net_service,vat_percentage: vp, currency: @currency)
        @vector += b.vector
        @vat_splitted[b.vat_percentage] = b.vat 
      end
      @rates = new_rates
    else
      @vat_splitted = {}
    end
    @rates = new_rates
  else
    ArgumentError.new "Hash must be given not #{arg.class}"
  end
end

#hash ⇒ Object 



77
78
79
80
 
# File 'lib/vatcalc/service_element.rb', line 77

def hash
  #vector comes from GNV
  [@vector,@vat_splitted].hash
end

#inspect ⇒ Object 



87
88
89
 
# File 'lib/vatcalc/service_element.rb', line 87

def inspect
  "#<#{self.class.name} vat_splitted:#{vat_splitted} gross:#{gross} net: #{net} vat:#{vat} currency: #{@currency}>"
end