Module: Periods::Modules::Period::InstanceMethods

Defined in:
lib/periods/modules/period.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#end_date ⇒ Date (readonly)

Returns the end date of this period.

Returns:

  • (Date) —

    the end date of this period.



20
21
22
 
# File 'lib/periods/modules/period.rb', line 20

def end_date
  @end_date
end

#start_date ⇒ Date (readonly)

Returns the start date of this period.

Returns:

  • (Date) —

    the start date of this period.



16
17
18
 
# File 'lib/periods/modules/period.rb', line 16

def start_date
  @start_date
end

Instance Method Details

#<=>(period) ⇒ Fixnum

Test whether the given period is older, newer or equal to this one.

Returns:

  • (Fixnum) —

    1 if period is older, -1 if newer, 0 if equal.

Since:

  • 0.0.3



74
75
76
77
78
79
80
81
82
 
# File 'lib/periods/modules/period.rb', line 74

def <=>(period)
  if start_date > period.start_date
    1
  elsif start_date < period.start_date
    -1
  else
    0
  end
end

#==(period) ⇒ Boolean

Test whether the given period is equal to this one. A period is considered equal if it has the same start and end date.

Examples:


period1 = Period.new('10.04.2015', '20.05.2015')
period2 = Period.new('10.04.2015', '20.05.2015')
period3 = Period.new('09.04.2015', '20.05.2015')
period1 == period2 # => true
period1 == period3 # => false

Returns:

  • (Boolean) —

    true if period is equal, false otherwise.

Since:

  • 0.0.3



59
60
61
62
63
64
65
 
# File 'lib/periods/modules/period.rb', line 59

def ==(period)
  if period.respond_to?(:start_date) && period.respond_to?(:end_date)
    start_date == period.start_date && end_date == period.end_date
  else
    false
  end
end

#days ⇒ Fixnum

Returns number of days in period.

Examples:


Period.new('10.04.2015', '20.05.2015').days # => 41

Returns:

  • (Fixnum) —

    the number of days in period.

Since:

  • 0.0.3



131
132
133
 
# File 'lib/periods/modules/period.rb', line 131

def days
  end_date.yday - start_date.yday + 1
end

#end_year ⇒ Fixnum

Returns end year of period.

Examples:


Period.new('10.04.2015', '20.05.2016').end_year # => 2016

Returns:

  • (Fixnum) —

    end year of period.

Since:

  • 0.0.3



161
162
163
 
# File 'lib/periods/modules/period.rb', line 161

def end_year
  end_date.year
end

#halfyears ⇒ Halfyear

Returns the halfyears included in this period including the halfyear of the start date of this period. The halfyear of the end date of this period is only included if the halfyear’s end date is before/equal the end date of this period.

Examples:


Period.new('01.01.2015', '31.12.2015').halfyears # => [(Jan-Jun),(Jul-Dec)]
Period.new('17.04.2015', '26.08.2015').halfyears # => []
Period.new('01.01.2015', '31.05.2016').halfyears # => [(Jan-Jun),(Jul-Dec)]
Period.new('01.01.2015', '30.06.2016').halfyears # => [(Jan-Jun),(Jul-Dec),(Jan-Jun)]

Returns:

  • (Halfyear) —

    an array of halfyears included in this period.

Since:

  • 0.0.7



269
270
271
272
273
274
275
276
277
 
# File 'lib/periods/modules/period.rb', line 269

def halfyears
  halfyears = []
  halfyear  = Periods::Halfyear.for(start_date)
  while halfyear.end_date <= end_date
    halfyears << halfyear
    halfyear = halfyear.next
  end
  halfyears
end

#include?(period) ⇒ Boolean

Test whether the given date or period is included in this one.

Examples:


Period.new('10.04.2015', '20.05.2015').include?('10.04.2015') # => true
Period.new('10.04.2015', '20.05.2015').include?('20.05.2015') # => true
Period.new('10.04.2015', '20.05.2015').include?('09.04.2015') # => false
Period.new('10.04.2015', '20.05.2015').include?('21.05.2015') # => false

Period.new('10.04.2015', '20.05.2015').include?(Period.new('10.04.2015', '20.05.2015')) # => true
Period.new('10.04.2015', '20.05.2015').include?(Period.new('15.04.2015', '15.05.2015')) # => true
Period.new('10.04.2015', '20.05.2015').include?(Period.new('09.04.2015', '20.05.2015')) # => false
Period.new('10.04.2015', '20.05.2015').include?(Period.new('10.04.2015', '21.05.2015')) # => false

Returns:

  • (Boolean) —

    true if date or period is included, false otherwise.

Since:

  • 0.0.3



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/periods/modules/period.rb', line 184

def include?(period)
  if period.is_a?(Date)
    start_date <= period && period <= end_date
  elsif period.is_a?(String)
    date = Date.parse(period.to_s)
    start_date <= date && date <= end_date
  elsif period.is_a?(Period)
    start_date <= period.start_date && period.end_date <= end_date
  else
    false
  end
end

#initialize(start_date, end_date = nil) ⇒ Object

Initialize a new period with its start and end date.

Examples:


period = Period.new(Date.new(2015,4,10), Date.new(2015,5,20))
period = Period.new('10.04.2015', '20.05.2015')
period = Period.new(Period.new('10.04.2015', '20.05.2015'))


31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/periods/modules/period.rb', line 31

def initialize(start_date, end_date = nil)
  if start_date.is_a?(Period)
    @start_date = start_date.start_date
    @end_date = start_date.end_date
  elsif end_date.nil?
    raise ArgumentError, "Period is missing end_date, e.g. Period.new(start_date, end_date)."
  else
    @start_date = Date.parse(start_date.to_s)
    @end_date = Date.parse(end_date.to_s)
  end
end

#months ⇒ Month

Returns the months included in this period including the month of the start and end date of this period.

Examples:


Period.new('01.01.2015', '31.12.2015').months # => Jan, Feb, ..., Dec
Period.new('17.04.2015', '26.08.2015').months # => Apr, Mai, Jun, Jul, Aug

Returns:

  • (Month) —

    an array of months included in this period.

Since:

  • 0.0.7



225
226
227
 
# File 'lib/periods/modules/period.rb', line 225

def months
  (Periods::Month.for(start_date)..Periods::Month.for(end_date)).to_a
end

#next ⇒ Period

Returns next period.

Examples:


period = Period.new('10.04.2015', '20.05.2015')
period.next # => 21.05.2015 - 30.06.2015

Returns:

  • (Period) —

    the next period.

See Also:

  • Periods::Modules::Period#previous

Since:

  • 0.0.3



98
99
100
 
# File 'lib/periods/modules/period.rb', line 98

def next
  self.class.new(start_date + days, end_date + days)
end

#previous ⇒ Period

Returns previous period.

Examples:


period = Period.new('10.04.2015', '20.05.2015')
period.previous # => 28.02.2015 - 09.04.2015

Returns:

  • (Period) —

    the previous period.

See Also:

  • Periods::Modules::Period#next

Since:

  • 0.0.3



116
117
118
 
# File 'lib/periods/modules/period.rb', line 116

def previous
  self.class.new(start_date - days, end_date - days)
end

#quarters ⇒ Quarter

Returns the quarters included in this period including the quarter of the start date of this period. The quarter of the end date of this period is only included if the quarter’s end date is before/equal the end date of this period.

Examples:


Period.new('01.01.2015', '31.12.2015').quarters # => [(J,F,M),(A,M,J),(J,A,S),(O,N,D)]
Period.new('17.04.2015', '26.08.2015').quarters # => [(A,M,J) but not (J,A,S)]

Returns:

  • (Quarter) —

    an array of quarters included in this period.

Since:

  • 0.0.7



243
244
245
246
247
248
249
250
251
 
# File 'lib/periods/modules/period.rb', line 243

def quarters
  quarters = []
  quarter  = Periods::Quarter.for(start_date)
  while quarter.end_date <= end_date
    quarters << quarter
    quarter = quarter.next
  end
  quarters
end

#start_year ⇒ Fixnum

Returns start year of period.

Examples:


Period.new('10.04.2015', '20.05.2016').start_year # => 2015

Returns:

  • (Fixnum) —

    start year of period.

Since:

  • 0.0.3



146
147
148
 
# File 'lib/periods/modules/period.rb', line 146

def start_year
  start_date.year
end

#to_s ⇒ String

Return string representation of period.

Examples:


Period.new('10.04.2015', '20.05.2015').to_s # => '10.04.2015 -  20.05.2015'

Returns:

  • (String) —

    the string representation of period.

Since:

  • 0.0.3



208
209
210
 
# File 'lib/periods/modules/period.rb', line 208

def to_s
  "#{start_date.strftime("%d.%m.%Y")} - #{end_date.strftime("%d.%m.%Y")}"
end

#years ⇒ Year

Returns the years included in this period including the year of the start date of this period. The year of the end date of this period is only included if the year’s end date is before/equal the end date of this period.

Examples:


Period.new('01.01.2015', '31.12.2015').halfyears # => [(Jan-Dec)]
Period.new('17.04.2015', '26.08.2015').halfyears # => []
Period.new('01.01.2015', '31.05.2016').halfyears # => [(Jan-Dec)]
Period.new('01.01.2015', '31.12.2016').halfyears # => [(Jan-Dec),(Jan-Dec)]

Returns:

  • (Year) —

    an array of halfyears included in this period.

Since:

  • 0.0.7



295
296
297
298
299
300
301
302
303
 
# File 'lib/periods/modules/period.rb', line 295

def years
  years = []
  year  = Periods::Year.for(start_date)
  while year.end_date <= end_date
    years << year
    year = year.next
  end
  years
end