Class: Fugit::Duration

Inherits:
Object
  • Object
show all
Defined in:
lib/fugit/duration.rb

Defined Under Namespace

Modules: IsoParser, Parser

Constant Summary collapse

KEYS = 
{
  yea: { a: 'Y', r: 'y', i: 'Y', s: 365 * 24 * 3600, x: 0, l: 'year' },
  mon: { a: 'M', r: 'M', i: 'M', s: 30 * 24 * 3600, x: 1, l: 'month' },
  wee: { a: 'W', r: 'w', i: 'W', s: 7 * 24 * 3600, I: true, l: 'week' },
  day: { a: 'D', r: 'd', i: 'D', s: 24 * 3600, I: true, l: 'day' },
  hou: { a: 'h', r: 'h', i: 'H', s: 3600, I: true, l: 'hour' },
  min: { a: 'm', r: 'm', i: 'M', s: 60, I: true, l: 'minute' },
  sec: { a: 's', r: 's', i: 'S', s: 1, I: true, l: 'second' },
}
SECOND_ROUND =

Round float seconds to 9 decimals when deflating

9

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#h ⇒ Object (readonly)

Returns the value of attribute h.



6
7
8
 
# File 'lib/fugit/duration.rb', line 6

def h
  @h
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



6
7
8
 
# File 'lib/fugit/duration.rb', line 6

def options
  @options
end

#original ⇒ Object (readonly)

Returns the value of attribute original.



6
7
8
 
# File 'lib/fugit/duration.rb', line 6

def original
  @original
end

Class Method Details

.common_rewrite_dur(t) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/fugit/duration.rb', line 50

def common_rewrite_dur(t)

  t
    .subgather(nil)
    .inject({}) { |h, tt|
      v = tt.string; v = v.index('.') ? v.to_f : v.to_i
        # drops ending ("y", "m", ...) by itself
      h[tt.name] = (h[tt.name] || 0) + v
      h }
end

.do_parse(s, opts = {}) ⇒ Object 



40
41
42
43
44
 
# File 'lib/fugit/duration.rb', line 40

def do_parse(s, opts={})

  parse(s, opts) ||
  fail(ArgumentError.new("not a duration #{s.inspect}"))
end

.new(s) ⇒ Object 



10
11
12
13
 
# File 'lib/fugit/duration.rb', line 10

def new(s)

  parse(s)
end

.parse(s, opts = {}) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/fugit/duration.rb', line 15

def parse(s, opts={})

  return s if s.is_a?(self)

  original = s

  s = "#{s}s" if s.is_a?(Numeric)

  return nil unless s.is_a?(String)

  s = s.strip
#p [ original, s ]; Raabro.pp(Parser.parse(s, debug: 3), colours: true)

  h =
    if opts[:iso]
      IsoParser.parse(opts[:stricter] ? s : s.upcase)
    elsif opts[:plain]
      Parser.parse(s)
    else
      Parser.parse(s) || IsoParser.parse(opts[:stricter] ? s : s.upcase)
    end

  h ? self.allocate.send(:init, original, opts, h) : nil
end

.to_iso_s(o) ⇒ Object 



47
 
# File 'lib/fugit/duration.rb', line 47

def to_iso_s(o); do_parse(o).deflate.to_iso_s; end

.to_long_s(o, opts = {}) ⇒ Object 



48
 
# File 'lib/fugit/duration.rb', line 48

def to_long_s(o, opts={}); do_parse(o).deflate.to_long_s(opts); end

.to_plain_s(o) ⇒ Object 



46
 
# File 'lib/fugit/duration.rb', line 46

def to_plain_s(o); do_parse(o).deflate.to_plain_s; end

Instance Method Details

#==(o) ⇒ Object Also known as: eql? 



279
280
281
282
 
# File 'lib/fugit/duration.rb', line 279

def ==(o)

  o.is_a?(Fugit::Duration) && o.h == @h
end

#add(a) ⇒ Object Also known as: + 



253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/fugit/duration.rb', line 253

def add(a)

  case a
  when Numeric then add_numeric(a)
  when Fugit::Duration then add_duration(a)
  when String then add_duration(self.class.parse(a))
  when ::Time, EtOrbi::EoTime then add_to_time(a)
  else fail ArgumentError.new(
    "cannot add #{a.class} instance to a Fugit::Duration")
  end
end

#add_duration(d) ⇒ Object 



214
215
216
217
218
219
 
# File 'lib/fugit/duration.rb', line 214

def add_duration(d)

  params = d.h.inject(@h.dup) { |h, (k, v)| h[k] = (h[k] || 0) + v; h }

  self.class.allocate.init(nil, {}, params)
end

#add_numeric(n) ⇒ Object 



206
207
208
209
210
211
212
 
# File 'lib/fugit/duration.rb', line 206

def add_numeric(n)

  h = @h.dup
  h[:sec] = (h[:sec] || 0) + n.to_i

  self.class.allocate.init(nil,{}, h)
end

#add_to_time(t) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/fugit/duration.rb', line 221

def add_to_time(t)

  t = ::EtOrbi.make_time(t)

  INFLA_KEYS.each do |k, a|

    v = @h[k]; next unless v

    t = t + v * a[:s]
  end

  NON_INFLA_KEYS.each do |k, a|

    v = @h[k]; next unless v
    at = [ t.year, t.month, t.day, t.hour, t.min, t.sec ]

    at[a[:x]] += v

    if at[1] > 12
      n, m = at[1] / 12, at[1] % 12
      at[0], at[1] = at[0] + n, m
    elsif at[1] < 1
      n, m = -at[1] / 12, -at[1] % 12
      at[0], at[1] = at[0] - n, m
    end

    t = ::EtOrbi.make_time(at, t.zone)
  end

  t
end

#deflate(options = {}) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/fugit/duration.rb', line 161

def deflate(options={})

  id = inflate
  h = id.h.dup
  s = h.delete(:sec) || 0

  keys = INFLA_KEYS

  mon = options[:month]
  yea = options[:year]
  keys = keys.dup if mon || yea

  if mon
    mon = 30 if mon == true
    mon = "#{mon}d" if mon.is_a?(Integer)
    keys.unshift([ :mon, { s: Fugit::Duration.parse(mon).to_sec } ])
  end
  if yea
    yea = 365 if yea == true
    yea = "#{yea}d" if yea.is_a?(Integer)
    keys.unshift([ :yea, { s: Fugit::Duration.parse(yea).to_sec } ])
  end

  keys[0..-2].each do |k, v|

    vs = v[:s]; next if s < vs

    h[k] = (h[k] || 0) + s.to_i / vs
    s = s % vs
  end

  h[:sec] = s.is_a?(Integer) ? s : s.round(SECOND_ROUND)

  self.class.allocate.init(@original, {}, h)
end

#drop_seconds ⇒ Object

Returns a copy of this duration, omitting its seconds.



297
298
299
300
301
302
303
304
 
# File 'lib/fugit/duration.rb', line 297

def drop_seconds

  h = @h.dup
  h.delete(:sec)
  h[:min] = 0 if h.empty?

  self.class.allocate.init(nil, { literal: true }, h)
end

#hash ⇒ Object 



285
286
287
288
 
# File 'lib/fugit/duration.rb', line 285

def hash

  @h.hash
end

#inflate ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/fugit/duration.rb', line 141

def inflate

  params =
    @h.inject({ sec: 0 }) { |h, (k, v)|
      a = KEYS[k]
      if a[:I]
        h[:sec] += (v * a[:s])
      else
        h[k] = v
      end
      h
    }

  self.class.allocate.init(@original, {}, params)
end

#next_time(from = ::EtOrbi::EoTime.now) ⇒ Object 



290
291
292
293
 
# File 'lib/fugit/duration.rb', line 290

def next_time(from=::EtOrbi::EoTime.now)

  add(from)
end

#opposite ⇒ Object Also known as: -@ 



197
198
199
200
201
202
 
# File 'lib/fugit/duration.rb', line 197

def opposite

  params = @h.inject({}) { |h, (k, v)| h[k] = -v; h }

  self.class.allocate.init(nil, {}, params)
end

#subtract(a) ⇒ Object Also known as: - 



266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/fugit/duration.rb', line 266

def subtract(a)

  case a
  when Numeric then add_numeric(-a)
  when Fugit::Duration then add_duration(-a)
  when String then add_duration(-self.class.parse(a))
  when ::Time, ::EtOrbi::EoTime then add_to_time(a)
  else fail ArgumentError.new(
    "cannot subtract #{a.class} instance to a Fugit::Duration")
  end
end

#to_h ⇒ Object

For now, let’s alias to #h



126
 
# File 'lib/fugit/duration.rb', line 126

def to_h; h; end

#to_iso_s ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fugit/duration.rb', line 88

def to_iso_s

  t = false

  s = StringIO.new
  s << 'P'

  KEYS.each_with_index do |(k, a), i|
    v = @h[k]; next unless v
    if i > 3 && t == false
      t = true
      s << 'T'
    end
    s << v.to_s; s << a[:i]
  end

  s.string
end

#to_long_s(opts = {}) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/fugit/duration.rb', line 107

def to_long_s(opts={})

  s = StringIO.new
  adn = [ false, 'no' ].include?(opts[:oxford]) ? ' and ' : ', and '

  a = @h.to_a
  while kv = a.shift
    k, v = kv
    aa = KEYS[k]
    s << v.to_i
    s << ' '; s << aa[:l]; s << 's' if v > 1
    s << (a.size == 1 ? adn : ', ') if a.size > 0
  end

  s.string
end

#to_plain_s ⇒ Object 



85
 
# File 'lib/fugit/duration.rb', line 85

def to_plain_s; _to_s(:a); end

#to_rufus_h ⇒ Object 



128
129
130
131
 
# File 'lib/fugit/duration.rb', line 128

def to_rufus_h

  KEYS.inject({}) { |h, (ks, kh)| v = @h[ks]; h[kh[:r].to_sym] = v if v; h }
end

#to_rufus_s ⇒ Object 



86
 
# File 'lib/fugit/duration.rb', line 86

def to_rufus_s; _to_s(:r); end

#to_sec ⇒ Object

Warning: this is an “approximation”, months are 30 days and years are 365 days, …



136
137
138
139
 
# File 'lib/fugit/duration.rb', line 136

def to_sec

  KEYS.inject(0) { |s, (k, a)| v = @h[k]; next s unless v; s += v * a[:s] }
end