edtf 4.1.1 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +40 -0
- data/README.md +448 -260
- data/UPGRADING.md +227 -0
- data/lib/edtf/bitmask.rb +277 -0
- data/lib/edtf/builder.rb +177 -0
- data/lib/edtf/date.rb +435 -284
- data/lib/edtf/date_time.rb +285 -11
- data/lib/edtf/epoch.rb +107 -67
- data/lib/edtf/grammar.rb +118 -0
- data/lib/edtf/interval.rb +124 -254
- data/lib/edtf/iso.rb +1136 -0
- data/lib/edtf/iso.y +490 -0
- data/lib/edtf/legacy.rb +1888 -0
- data/lib/edtf/legacy.y +625 -0
- data/lib/edtf/parser.rb +249 -1985
- data/lib/edtf/period.rb +199 -0
- data/lib/edtf/season.rb +160 -146
- data/lib/edtf/set.rb +180 -56
- data/lib/edtf/version.rb +1 -1
- data/lib/edtf.rb +43 -30
- metadata +15 -28
- data/lib/edtf/compatibility.rb +0 -6
- data/lib/edtf/extensions.rb +0 -11
- data/lib/edtf/parser.y +0 -666
- data/lib/edtf/uncertainty.rb +0 -100
- data/lib/edtf/unknown.rb +0 -25
data/lib/edtf/set.rb
CHANGED
|
@@ -1,97 +1,221 @@
|
|
|
1
1
|
module EDTF
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
# EDTF supports two kinds of sets:
|
|
4
|
+
# choice lists, meaning one date out of a list (EDTF::Set, [...]),
|
|
5
|
+
# or inclusive lists (EDTF::List, {...}).
|
|
6
|
+
# Both share their member handling through this module.
|
|
7
|
+
#
|
|
8
|
+
# Sets remember which members were specified as a range;
|
|
9
|
+
# ranges are however enumerated for membership tests:
|
|
10
|
+
#
|
|
11
|
+
# list = EDTF('{1667,1668,1670..1672}')
|
|
12
|
+
# list.values.length -> 3
|
|
13
|
+
# list.map(&:year) -> [1667, 1668, 1670, 1671, 1672]
|
|
14
|
+
#
|
|
15
|
+
# list.include? EDTF('1671') -> true
|
|
16
|
+
# list.include? EDTF('1669') -> false
|
|
17
|
+
#
|
|
18
|
+
# Sets also feature #earlier? and #later?:
|
|
19
|
+
# an open start (..1667) or end (1672..) without bound.
|
|
20
|
+
module Members
|
|
6
21
|
include Enumerable
|
|
7
|
-
|
|
22
|
+
# After Enumerable, so ActiveSupport's Enumerable#as_json doesn't win.
|
|
23
|
+
include Period
|
|
24
|
+
|
|
25
|
+
attr_reader :values
|
|
26
|
+
|
|
27
|
+
# An empty set has no open start or end.
|
|
28
|
+
def initialize(*values, earlier: false, later: false)
|
|
29
|
+
@values = values.map { |value| coerce_member(value) }.freeze
|
|
30
|
+
@earlier = !empty? && !!earlier
|
|
31
|
+
@later = !empty? && !!later
|
|
32
|
+
check_members
|
|
33
|
+
freeze
|
|
34
|
+
end
|
|
8
35
|
|
|
9
|
-
|
|
36
|
+
def earlier?
|
|
37
|
+
@earlier
|
|
38
|
+
end
|
|
10
39
|
|
|
11
|
-
|
|
40
|
+
def later?
|
|
41
|
+
@later
|
|
42
|
+
end
|
|
12
43
|
|
|
44
|
+
def empty?
|
|
45
|
+
values.empty?
|
|
46
|
+
end
|
|
13
47
|
|
|
14
|
-
def
|
|
15
|
-
|
|
16
|
-
@choice, @later, @earlier = false, false, false
|
|
48
|
+
def precision
|
|
49
|
+
members.first&.precision
|
|
17
50
|
end
|
|
18
51
|
|
|
19
|
-
def
|
|
20
|
-
|
|
52
|
+
def begin
|
|
53
|
+
members.map(&:begin).min unless earlier? || empty?
|
|
21
54
|
end
|
|
22
55
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
define_method("#{m}!") do
|
|
26
|
-
send("#{m}=", true)
|
|
27
|
-
self
|
|
28
|
-
end
|
|
56
|
+
def end
|
|
57
|
+
members.map(&:end).max unless later? || empty?
|
|
29
58
|
end
|
|
30
59
|
|
|
31
|
-
def
|
|
32
|
-
return
|
|
33
|
-
return false if empty?
|
|
60
|
+
def with(**changes)
|
|
61
|
+
return self if changes.empty?
|
|
34
62
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
(
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
end
|
|
63
|
+
check_keys!(changes, %i[values earlier later])
|
|
64
|
+
|
|
65
|
+
self.class.new(
|
|
66
|
+
*changes.fetch(:values, values),
|
|
67
|
+
earlier: changes.fetch(:earlier, earlier?),
|
|
68
|
+
later: changes.fetch(:later, later?)
|
|
69
|
+
)
|
|
43
70
|
end
|
|
44
|
-
alias member? include?
|
|
45
71
|
|
|
46
|
-
|
|
47
|
-
|
|
72
|
+
# Yields each member, enumerating ranges.
|
|
73
|
+
def each(&block)
|
|
74
|
+
return to_enum(:each) unless block_given?
|
|
75
|
+
|
|
76
|
+
values.each do |value|
|
|
77
|
+
if value.is_a?(Range)
|
|
78
|
+
value.each(&block)
|
|
79
|
+
else
|
|
80
|
+
yield value
|
|
81
|
+
end
|
|
82
|
+
end
|
|
48
83
|
self
|
|
49
84
|
end
|
|
50
85
|
|
|
51
|
-
def
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
86
|
+
def cover?(other)
|
|
87
|
+
!empty? && super
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Returns true if other is one of the (enumerated) members,
|
|
91
|
+
# like Enumerable#include?; ranges are tested by their bounds.
|
|
92
|
+
# Beyond an open start or end ([..1760], {1760..}),
|
|
93
|
+
# every period of the same precision is included,
|
|
94
|
+
# although #each yields only the members as written;
|
|
95
|
+
# like (..5).include?(3) for a beginless Ruby range.
|
|
96
|
+
def include?(other)
|
|
97
|
+
return false if empty?
|
|
98
|
+
|
|
99
|
+
precision = Period.precision(other)
|
|
100
|
+
matched = values.any? { |value|
|
|
101
|
+
if value.is_a?(Range)
|
|
102
|
+
value.begin.precision == precision && value.cover?(other)
|
|
103
|
+
else
|
|
104
|
+
value == other
|
|
105
|
+
end
|
|
106
|
+
}
|
|
107
|
+
return true if matched
|
|
108
|
+
|
|
109
|
+
first, last = members.first, members.last
|
|
110
|
+
(earlier? && first.precision == precision && other <= first) ||
|
|
111
|
+
(later? && last.precision == precision && other >= last)
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Returns a Ruby Set of the enumerated members.
|
|
115
|
+
def to_set
|
|
116
|
+
if earlier? || later?
|
|
117
|
+
raise RangeError, "cannot enumerate the open set #{edtf}"
|
|
57
118
|
end
|
|
119
|
+
|
|
120
|
+
::Set.new(to_a)
|
|
58
121
|
end
|
|
59
122
|
|
|
60
123
|
def edtf
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
124
|
+
content = values.map { |value|
|
|
125
|
+
if value.is_a?(Range)
|
|
126
|
+
"#{value.begin.edtf}..#{value.end.edtf}"
|
|
127
|
+
else
|
|
128
|
+
value.edtf
|
|
129
|
+
end
|
|
130
|
+
}
|
|
131
|
+
return wrap('') if content.empty?
|
|
132
|
+
|
|
133
|
+
wrap("#{'..' if earlier?}#{content.join(',')}#{'..' if later?}")
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
protected
|
|
137
|
+
|
|
138
|
+
def state
|
|
139
|
+
[values, earlier?, later?]
|
|
64
140
|
end
|
|
65
141
|
|
|
66
|
-
|
|
67
|
-
|
|
142
|
+
private
|
|
143
|
+
|
|
144
|
+
# Open starts and ends sort like open interval ends.
|
|
145
|
+
def keys
|
|
146
|
+
[earlier? ? [-2] : super[0], later? ? [2] : super[1], rank]
|
|
68
147
|
end
|
|
69
148
|
|
|
70
|
-
|
|
71
|
-
|
|
149
|
+
# The members as written, with ranges as their two ends.
|
|
150
|
+
def members
|
|
151
|
+
values.flat_map { |value|
|
|
152
|
+
value.is_a?(Range) ? [value.begin, value.end] : [value]
|
|
153
|
+
}
|
|
72
154
|
end
|
|
73
155
|
|
|
74
|
-
|
|
156
|
+
# As in the grammar: members are dates, decades or centuries;
|
|
157
|
+
# open ends and ranges are plain dates, ranges of one precision.
|
|
158
|
+
def check_members
|
|
159
|
+
invalid = members.find { |member|
|
|
160
|
+
!member.is_a?(Date) && !member.is_a?(Epoch)
|
|
161
|
+
}
|
|
162
|
+
if invalid
|
|
163
|
+
raise ArgumentError, "invalid #{self.class} member: #{invalid.edtf}"
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
ranges = values.grep(Range)
|
|
167
|
+
ends = [(values.first if earlier?), (values.last if later?)].compact
|
|
168
|
+
bounds = ends + ranges.flat_map { |r| [r.begin, r.end] }
|
|
169
|
+
|
|
170
|
+
unless bounds.all? { |v| plain?(v) }
|
|
171
|
+
raise ArgumentError, 'open ends and ranges must be plain dates'
|
|
172
|
+
end
|
|
75
173
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
174
|
+
unless ranges.all? { |r| r.begin.precision == r.end.precision }
|
|
175
|
+
raise ArgumentError, 'ranges must have one precision'
|
|
176
|
+
end
|
|
79
177
|
end
|
|
80
178
|
|
|
81
|
-
|
|
179
|
+
def plain?(value)
|
|
180
|
+
value.instance_of?(Date) && value.year.abs <= 9999 &&
|
|
181
|
+
value.significant.nil? &&
|
|
182
|
+
[value.uncertain, value.approximate, value.unspecified].all?(&:zero?)
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
def coerce_member(value)
|
|
186
|
+
case value
|
|
187
|
+
when Period
|
|
188
|
+
value
|
|
189
|
+
when ::Date
|
|
190
|
+
EDTF(value)
|
|
191
|
+
when Range
|
|
192
|
+
coerce_member(value.begin)..coerce_member(value.end)
|
|
193
|
+
else
|
|
194
|
+
raise ArgumentError, "invalid #{self.class} member: #{value.inspect}"
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
end
|
|
82
198
|
|
|
83
|
-
|
|
199
|
+
# One of a set: [1667,1668,1670..1672].
|
|
200
|
+
class Set
|
|
201
|
+
include Members
|
|
84
202
|
|
|
85
203
|
private
|
|
86
204
|
|
|
87
|
-
def
|
|
88
|
-
|
|
89
|
-
p[-1,0] = '..' if earlier?
|
|
90
|
-
p[-1,0] = string unless string.empty?
|
|
91
|
-
p[-1,0] = '..' if later?
|
|
92
|
-
p.join
|
|
205
|
+
def wrap(content)
|
|
206
|
+
"[#{content}]"
|
|
93
207
|
end
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# All members of a set: {1667,1668,1670..1672}.
|
|
211
|
+
class List
|
|
212
|
+
include Members
|
|
94
213
|
|
|
214
|
+
private
|
|
215
|
+
|
|
216
|
+
def wrap(content)
|
|
217
|
+
"{#{content}}"
|
|
218
|
+
end
|
|
95
219
|
end
|
|
96
220
|
|
|
97
221
|
end
|
data/lib/edtf/version.rb
CHANGED
data/lib/edtf.rb
CHANGED
|
@@ -1,38 +1,29 @@
|
|
|
1
1
|
require 'date'
|
|
2
2
|
require 'time'
|
|
3
|
-
|
|
4
|
-
autoload :Rational, 'rational'
|
|
5
|
-
|
|
6
|
-
require 'forwardable'
|
|
7
|
-
require 'enumerator'
|
|
8
3
|
require 'set'
|
|
9
4
|
|
|
10
|
-
require 'active_support'
|
|
11
|
-
require 'active_support/core_ext/date/calculations'
|
|
12
|
-
require 'active_support/core_ext/date_time/calculations'
|
|
13
|
-
require 'active_support/core_ext/time/calculations'
|
|
14
|
-
|
|
15
|
-
require 'active_support/core_ext/date/conversions'
|
|
16
|
-
|
|
17
|
-
require 'edtf/compatibility'
|
|
18
|
-
|
|
19
5
|
require 'edtf/version'
|
|
20
|
-
require 'edtf/
|
|
6
|
+
require 'edtf/bitmask'
|
|
7
|
+
require 'edtf/period'
|
|
21
8
|
require 'edtf/date'
|
|
22
9
|
require 'edtf/date_time'
|
|
23
10
|
require 'edtf/epoch'
|
|
24
11
|
require 'edtf/season'
|
|
25
12
|
require 'edtf/interval'
|
|
26
13
|
require 'edtf/set'
|
|
27
|
-
require 'edtf/
|
|
14
|
+
require 'edtf/grammar'
|
|
15
|
+
require 'edtf/iso'
|
|
16
|
+
require 'edtf/legacy'
|
|
28
17
|
require 'edtf/parser'
|
|
29
|
-
require 'edtf/
|
|
18
|
+
require 'edtf/builder'
|
|
30
19
|
|
|
31
20
|
# = EDTF-Ruby
|
|
32
21
|
#
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
#
|
|
22
|
+
# Implements the Extended Date/Time Format (EDTF) in ISO 8601-2.
|
|
23
|
+
#
|
|
24
|
+
# Every EDTF string stands for a period of time (see EDTF::Period):
|
|
25
|
+
# dates (EDTF::Date, a Ruby Date), date-times (EDTF::DateTime, a Ruby Time),
|
|
26
|
+
# decades and centuries, seasons, intervals, sets and lists.
|
|
36
27
|
#
|
|
37
28
|
# To parse EDTF strings use `EDTF.parse` or `EDTF()`.
|
|
38
29
|
#
|
|
@@ -40,14 +31,15 @@ module EDTF
|
|
|
40
31
|
|
|
41
32
|
module_function
|
|
42
33
|
|
|
43
|
-
def parse(input, options
|
|
44
|
-
parse!(input, options)
|
|
34
|
+
def parse(input, **options)
|
|
35
|
+
parse!(input, **options)
|
|
45
36
|
rescue
|
|
46
37
|
nil
|
|
47
38
|
end
|
|
48
39
|
|
|
49
|
-
def parse!(input,
|
|
50
|
-
|
|
40
|
+
def parse!(input, centuries: nil, **options)
|
|
41
|
+
centuries = !options[:strict] if centuries.nil?
|
|
42
|
+
Builder.build(Parser.new(**options).parse!(input), centuries: centuries)
|
|
51
43
|
end
|
|
52
44
|
|
|
53
45
|
def legacy?(input)
|
|
@@ -59,17 +51,38 @@ end
|
|
|
59
51
|
module Kernel
|
|
60
52
|
private
|
|
61
53
|
|
|
62
|
-
# Converts value to an EDTF object
|
|
63
|
-
#
|
|
64
|
-
#
|
|
54
|
+
# Converts any value to an EDTF object if possible.
|
|
55
|
+
# Raises an ArgumentError for invalid strings or parse results,
|
|
56
|
+
# and a TypeError for values that cannot be converted at all.
|
|
65
57
|
def EDTF(value)
|
|
66
58
|
case value
|
|
67
59
|
when String
|
|
68
60
|
EDTF.parse!(value)
|
|
69
|
-
when
|
|
70
|
-
value
|
|
71
|
-
when
|
|
61
|
+
when Hash
|
|
62
|
+
EDTF::Builder.build(value)
|
|
63
|
+
when EDTF::Period
|
|
72
64
|
value
|
|
65
|
+
when Time, ::DateTime
|
|
66
|
+
time = value.to_time
|
|
67
|
+
|
|
68
|
+
unless (time.utc_offset % 60).zero?
|
|
69
|
+
raise ArgumentError,
|
|
70
|
+
"offset #{time.strftime('%::z')} is not in whole minutes"
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
EDTF::DateTime.new(
|
|
74
|
+
time.year,
|
|
75
|
+
time.month,
|
|
76
|
+
time.day,
|
|
77
|
+
time.hour,
|
|
78
|
+
time.min,
|
|
79
|
+
time.sec + time.subsec,
|
|
80
|
+
offset: time.utc_offset / 60)
|
|
81
|
+
# Days after their calendar's reform (Ruby's default: Italy, 1582)
|
|
82
|
+
# are Gregorian; earlier ones keep their calendar and digits.
|
|
83
|
+
when ::Date
|
|
84
|
+
calendar = value.gregorian? ? nil : value.start
|
|
85
|
+
EDTF::Date.new(value.year, value.month, value.day, calendar: calendar)
|
|
73
86
|
else
|
|
74
87
|
raise TypeError, "can't convert #{value.class} into EDTF"
|
|
75
88
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: edtf
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 5.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sylvester Keil
|
|
@@ -10,26 +10,6 @@ bindir: bin
|
|
|
10
10
|
cert_chain: []
|
|
11
11
|
date: 1980-01-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
|
-
- !ruby/object:Gem::Dependency
|
|
14
|
-
name: activesupport
|
|
15
|
-
requirement: !ruby/object:Gem::Requirement
|
|
16
|
-
requirements:
|
|
17
|
-
- - ">="
|
|
18
|
-
- !ruby/object:Gem::Version
|
|
19
|
-
version: '3.0'
|
|
20
|
-
- - "<"
|
|
21
|
-
- !ruby/object:Gem::Version
|
|
22
|
-
version: '9.0'
|
|
23
|
-
type: :runtime
|
|
24
|
-
prerelease: false
|
|
25
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
26
|
-
requirements:
|
|
27
|
-
- - ">="
|
|
28
|
-
- !ruby/object:Gem::Version
|
|
29
|
-
version: '3.0'
|
|
30
|
-
- - "<"
|
|
31
|
-
- !ruby/object:Gem::Version
|
|
32
|
-
version: '9.0'
|
|
33
13
|
- !ruby/object:Gem::Dependency
|
|
34
14
|
name: racc
|
|
35
15
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -48,24 +28,31 @@ description: A Ruby implementation of the Extended Date/Time Format (EDTF).
|
|
|
48
28
|
executables: []
|
|
49
29
|
extensions: []
|
|
50
30
|
extra_rdoc_files:
|
|
31
|
+
- CHANGELOG.md
|
|
51
32
|
- LICENSE
|
|
52
33
|
- README.md
|
|
34
|
+
- UPGRADING.md
|
|
53
35
|
files:
|
|
36
|
+
- CHANGELOG.md
|
|
54
37
|
- LICENSE
|
|
55
38
|
- README.md
|
|
39
|
+
- UPGRADING.md
|
|
56
40
|
- lib/edtf.rb
|
|
57
|
-
- lib/edtf/
|
|
41
|
+
- lib/edtf/bitmask.rb
|
|
42
|
+
- lib/edtf/builder.rb
|
|
58
43
|
- lib/edtf/date.rb
|
|
59
44
|
- lib/edtf/date_time.rb
|
|
60
45
|
- lib/edtf/epoch.rb
|
|
61
|
-
- lib/edtf/
|
|
46
|
+
- lib/edtf/grammar.rb
|
|
62
47
|
- lib/edtf/interval.rb
|
|
48
|
+
- lib/edtf/iso.rb
|
|
49
|
+
- lib/edtf/iso.y
|
|
50
|
+
- lib/edtf/legacy.rb
|
|
51
|
+
- lib/edtf/legacy.y
|
|
63
52
|
- lib/edtf/parser.rb
|
|
64
|
-
- lib/edtf/
|
|
53
|
+
- lib/edtf/period.rb
|
|
65
54
|
- lib/edtf/season.rb
|
|
66
55
|
- lib/edtf/set.rb
|
|
67
|
-
- lib/edtf/uncertainty.rb
|
|
68
|
-
- lib/edtf/unknown.rb
|
|
69
56
|
- lib/edtf/version.rb
|
|
70
57
|
homepage: https://github.com/inukshuk/edtf-ruby
|
|
71
58
|
licenses:
|
|
@@ -81,7 +68,7 @@ rdoc_options:
|
|
|
81
68
|
- "--main"
|
|
82
69
|
- README.md
|
|
83
70
|
- "--exclude"
|
|
84
|
-
- lib/edtf/
|
|
71
|
+
- lib/edtf/(iso|legacy).rb
|
|
85
72
|
require_paths:
|
|
86
73
|
- lib
|
|
87
74
|
required_ruby_version: !ruby/object:Gem::Requirement
|
|
@@ -95,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
95
82
|
- !ruby/object:Gem::Version
|
|
96
83
|
version: '0'
|
|
97
84
|
requirements: []
|
|
98
|
-
rubygems_version: 4.0.
|
|
85
|
+
rubygems_version: 4.0.24
|
|
99
86
|
specification_version: 4
|
|
100
87
|
summary: Extended Date/Time Format for Ruby.
|
|
101
88
|
test_files: []
|
data/lib/edtf/compatibility.rb
DELETED