1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
# et-orbi
[](https://github.com/floraison/et-orbi/actions)
[](http://badge.fury.io/rb/et-orbi)
Time zones for [fugit](https://github.com/floraison/fugit) and for [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler). Urbi et Orbi.
`EtOrbi::EoTime` instances quack like Ruby `Time` instances, but their `#zone` returns a `TZInfo::TimeZone` instance.
Getting `EoTime` instances:
```ruby
require 'et-orbi'
EtOrbi.now
# => #<EtOrbi::EoTime:0x007f94d94 ...>
EtOrbi.now('Asia/Singapore')
# => #<EtOrbi::EoTime:0x39c96e48 @time=nil, @zone=#<TZInfo::DataTimezone: Asia/Singapore>...>
EtOrbi.parse('2017-12-13 13:00:00 America/Jamaica')
# => #<EtOrbi::EoTime:0x007f94d90 @zone=#<TZInfo::DataTimezone: America/Jamaica>...>
EtOrbi.make_time(Time.now)
# => #<EtOrbi::EoTime:0x007f94d91 ...>
EtOrbi.make_time(2017, 1, 31, 12, 'Europe/Moscow').to_debug_s
# => 'ot 2017-01-31 12:00:00 +03:00 dst:false'
EtOrbi::EoTime.new(0, 'UTC').to_s
# => "1970-01-01 00:00:00 +0000"
EtOrbi::EoTime.new(0, 'Europe/Moscow').to_s
# => "1970-01-01 03:00:00 +0300"
EtOrbi::EoTime.new(0, 'Europe/Moscow').to_zs
# => "1970-01-01 03:00:00 Europe/Moscow" # "be precise in your speech"
EtOrbi.parse('1970-01-01 03:00:00 Europe/Moscow')
# => #<EtOrbi::EoTime:0x00007fa4bc83fcd0
# @seconds=0.0, @zone=#<TZInfo::DataTimezone: Europe/Moscow>, @time=nil>
```
More about `EtOrbi::EoTime` instances:
```ruby
eot = EtOrbi::EoTime.new(0, 'Europe/Moscow')
eot.to_local_time.class # => Time
eot.to_local_time.to_s # => "1970-01-01 09:00:00 +0900" (at least on my system)
# For the rest, EtOrbi::EoTime mimics ::Time
```
Helper methods:
```ruby
require 'et-orbi'
EtOrbi.get_tzone('Europe/Vilnius')
# => #<TZInfo::DataTimezone: Europe/Vilnius>
EtOrbi.local_tzone
# => #<TZInfo::TimezoneProxy: Asia/Tokyo>
EtOrbi.platform_info
# => "(etz:nil,tnz:\"JST\",tzid:nil,rv:\"2.2.6\",rp:\"x86_64-darwin14\",eov:\"1.0.1\",
# rorv:nil,astz:nil,debian:nil,centos:nil,osx:\"Asia/Tokyo\")"
#
# etz: ENV['TZ']
# tnz: Time.now.zone
# tzid: defined?(TZInfo::Data)
# rv: RUBY_VERSION
# rp: RUBY_PLATFORM
# eov: EtOrbi::VERSION
# rorv: Rails::VERSION::STRING
# astz: ActiveSupport provided Time.zone
```
### #rweek and #rday (clarification et-orbi 1.4.0)
`EoTime#rweek` and `#rday` are mostly used in [fugit](https://github.com/floraison/fugit) for its [modulo extension](https://github.com/floraison/fugit?tab=readme-ov-file#the-modulo-extension).
By default (since et-orbi 1.4.0), the "reference week" for et-orbi
starts on Monday 2018-12-31, its `#rweek` 0 and `#rday` 0
```ruby
class EtOrbi::EoTime;
def rr; [ strftime('%A'), rweek, rday ]; end
end
EtOrbi.rweek_ref # => '2018-12-31'
# rw rd
EtOrbi.parse('2018-12-29').rr # => [ "Saturday", -1, -2 ]
EtOrbi.parse('2018-12-30').rr # => [ "Sunday", -1, -1 ]
EtOrbi.parse('2018-12-31').rr # => [ "Monday", 0, 0 ]
```
Users living in the US, in Canada, or in the Philippines where the week start on Sunday can tune their et-orbi:
```ruby
class EtOrbi::EoTime;
def rr; [ strftime('%A'), rweek, rday ]; end
end
EtOrbi.rweek_ref = :sunday
EtOrbi.rweek_ref # => '2018-12-30'
# rw rd
EtOrbi.parse('2018-12-29').rr # => [ "Saturday", -1, -1 ]
EtOrbi.parse('2018-12-30').rr # => [ "Sunday", 0, 0 ]
EtOrbi.parse('2018-12-31').rr # => [ "Monday", 0, 1 ]
```
You can set the `rweek_ref` to `:sunday`, `:saturday`, `:monday`, or `:iso`, `:us`, or `:default`.
`:sunday` and `:us` are equivalent. `:monday`, `:iso`, and `:default` are equivalent.
If you feel like it, you can choose your own reference:
```ruby
class EtOrbi::EoTime;
def rr; [ strftime('%A'), rweek, rday ]; end
end
EtOrbi.rweek_ref = '2025-09-28'
# rw rd
EtOrbi.parse('2018-12-29').rr # => [ "Saturday", -353, -2465 ]
EtOrbi.parse('2018-12-30').rr # => [ "Sunday", -352, -2464 ]
EtOrbi.parse('2018-12-31').rr # => [ "Monday", -352, -2463 ]
```
Before et-orbi 1.4.0, the computation was a bit different, yielding:
```ruby
class EtOrbi::EoTime;
def rr; [ strftime('%A'), rweek, rday ]; end
end
# rw rd
EtOrbi.parse('2018-12-29').rr # => [ "Saturday", 0, -2 ]
EtOrbi.parse('2018-12-30').rr # => [ "Sunday", 0, -1 ]
EtOrbi.parse('2018-12-31').rr # => [ "Monday", 0, 0 ]
EtOrbi.parse('2019-01-01').rr # => [ "Tuesday", 1, 1 ]
```
This change was motivated by [fugit gh-114](https://github.com/floraison/fugit/issues/114).
### Chronic integration
By default, et-orbi relies on [Chronic](https://github.com/mojombo/chronic) to parse strings like "tomorrow" or "friday 1pm", if `Chronic` is present.
```ruby
EtOrbi.parse('tomorrow')
# => #<EtOrbi::EoTime:0x007fbc6aa8a560
# @seconds=1575687600.0,
# @zone=#<TZInfo::TimezoneProxy: Asia/Tokyo>,
# @time=nil>
EtOrbi.parse('tomorrow').to_s
# => "2019-12-07 12:00:00 +0900"
```
This is a poor design choice I replicated from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
Of course this leads to [issues](https://gitlab.com/gitlab-org/gitlab/issues/37014).
It's probably better to have Chronic do its work outside of et-orbi, like in:
```ruby
EtOrbi.parse(Chronic.parse('tomorrow').to_s).to_s
# => "2019-12-07 12:00:00 +0900"
```
If one has Chronic present in their project but doesn't want it to interfere with et-orbi, it can be disabled at `parse` call:
```ruby
EtOrbi.parse('tomorrow')
# => #<EtOrbi::EoTime:0x007ffb5b2a2390
# @seconds=1575687600.0,
# @zone=#<TZInfo::TimezoneProxy: Asia/Tokyo>,
# @time=nil>
EtOrbi.parse('tomorrow', enable_chronic: false)
# ArgumentError: No time information in "tomorrow"
# from /home/jmettraux/w/et-orbi/lib/et-orbi/make.rb:31:in `rescue in parse'
```
or at the et-orbi level:
```ruby
irb(main):007:0> EtOrbi.chronic_enabled = false
# => false
irb(main):008:0> EtOrbi.chronic_enabled?
# => false
EtOrbi.parse('tomorrow')
# ArgumentError: No time information in "tomorrow"
# from /home/jmettraux/w/et-orbi/lib/et-orbi/make.rb:31:in `rescue in parse'
```
### Testing
To run tests, use `proba`:
```
bundle exec proba
```
### Rails?
If Rails is present, `Time.zone` is provided and EtOrbi will use it, unless `ENV['TZ']` is set to a valid timezone name. Setting `ENV['TZ']` to nil can give back precedence to `Time.zone`.
Rails sets its timezone under `config/application.rb`.
## Related projects
### Sister projects
* [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) - a cron/at/in/every/interval in-process scheduler, in fact, it's the father project to this fugit project
* [fugit](https://github.com/floraison/fugit) - Time tools for flor and the floraison project. Cron parsing and occurrence computing. Timestamps and more.
## LICENSE
MIT, see [LICENSE.txt](LICENSE.txt)
|
