relaton-ccsds 1.16.3 → 1.18.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 04acb04f4b67b4c455bbf9406090419eb77c3ad03c7f0cd44c0c83e19c6a2bba
4
- data.tar.gz: 37a89024ff34103d7e36d5d554ae30d27a6d306bb0448caea2363e94d3603420
3
+ metadata.gz: efd143c553800769e10ba7be5adf05c59bbe474a82516ba0fd98bed9c9f3aa11
4
+ data.tar.gz: dd239396db57ab224ec4126af84621025987472dfa7f7359fe2511ae22256a0b
5
5
  SHA512:
6
- metadata.gz: 859719c12454ad67c2b1614ac4ff9c65bb2b1b7d0abcb1c778ff8b593441f715ed26ad0af1084f95beff4531a84ff76b2a305124112838d5232bc74e0fb2b624
7
- data.tar.gz: 777d29e9a4e150220bcc75836cbc9f5dab248bc0a07a17c0b86632752d9227e09fec328074f14a163c5ed005dbe33c7cd2d971dae55c7bab5f68be8f1286f3a9
6
+ metadata.gz: 061ec98c3f16bab7582da30241f62c2c5b9b8d7ebc3eff0cf0dd8364672352d8b05b90813c267270a361322cfafc47768967be4b142b03436ad1e4e004869711
7
+ data.tar.gz: a5ebfa3f3f6156e40e3959bc5d484b207894b4a05b39a8c831cbdb4ece0e0ef1bc3816fa752b95f74668ab88a3118d68d77b2cab1e853c486d4a47a5c8575765
@@ -10,4 +10,4 @@ on:
10
10
 
11
11
  jobs:
12
12
  rake:
13
- uses: relaton/support/.github/workflows/rake.yml@master
13
+ uses: relaton/support/.github/workflows/rake.yml@main
@@ -17,7 +17,7 @@ on:
17
17
 
18
18
  jobs:
19
19
  release:
20
- uses: relaton/support/.github/workflows/release.yml@master
20
+ uses: relaton/support/.github/workflows/release.yml@main
21
21
  with:
22
22
  next_version: ${{ github.event.inputs.next_version }}
23
23
  secrets:
data/README.adoc CHANGED
@@ -54,7 +54,7 @@ item = hits[0].doc
54
54
  [source,ruby]
55
55
  ----
56
56
  item.to_xml
57
- => "<bibitem id="CCSDS230.2-G-1" schema-version="v1.2.4">
57
+ => "<bibitem id="CCSDS230.2-G-1" schema-version="v1.2.8">
58
58
  <fetched>2023-08-25</fetched>
59
59
  <title format="text/plain" language="en" script="Latn">Next Generation Uplink</title>
60
60
  <uri type="pdf">https://public.ccsds.org/Pubs/230x2g1.pdf</uri>
@@ -66,7 +66,7 @@ With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and ad
66
66
  [source,ruby]
67
67
  ----
68
68
  item.to_xml bibdata: true
69
- => "<bibdata schema-version="v1.2.4">
69
+ => "<bibdata schema-version="v1.2.8">
70
70
  <fetched>2023-08-25</fetched>
71
71
  <title format="text/plain" language="en" script="Latn">Next Generation Uplink</title>
72
72
  <uri type="pdf">https://public.ccsds.org/Pubs/230x2g1.pdf</uri>
@@ -95,8 +95,89 @@
95
95
  <ref name="pagebreak"/>
96
96
  <ref name="hr"/>
97
97
  <ref name="bookmark"/>
98
+ <ref name="amend"/>
98
99
  </choice>
99
100
  </define>
101
+ <define name="amend">
102
+ <element name="amend">
103
+ <ref name="AmendType"/>
104
+ </element>
105
+ </define>
106
+ <define name="AmendType">
107
+ <optional>
108
+ <attribute name="id">
109
+ <data type="ID"/>
110
+ </attribute>
111
+ </optional>
112
+ <attribute name="change">
113
+ <choice>
114
+ <value>add</value>
115
+ <value>modify</value>
116
+ <value>delete</value>
117
+ <value>replace</value>
118
+ </choice>
119
+ </attribute>
120
+ <optional>
121
+ <attribute name="path"/>
122
+ </optional>
123
+ <optional>
124
+ <attribute name="path_end"/>
125
+ </optional>
126
+ <optional>
127
+ <attribute name="title"/>
128
+ </optional>
129
+ <optional>
130
+ <element name="location">
131
+ <zeroOrMore>
132
+ <choice>
133
+ <ref name="locality"/>
134
+ <ref name="localityStack"/>
135
+ </choice>
136
+ </zeroOrMore>
137
+ </element>
138
+ </optional>
139
+ <optional>
140
+ <element name="description">
141
+ <zeroOrMore>
142
+ <ref name="BasicBlock"/>
143
+ </zeroOrMore>
144
+ </element>
145
+ </optional>
146
+ <optional>
147
+ <element name="newcontent">
148
+ <optional>
149
+ <attribute name="id">
150
+ <data type="ID"/>
151
+ </attribute>
152
+ </optional>
153
+ <zeroOrMore>
154
+ <ref name="BasicBlock"/>
155
+ </zeroOrMore>
156
+ </element>
157
+ </optional>
158
+ <zeroOrMore>
159
+ <ref name="classification"/>
160
+ </zeroOrMore>
161
+ <zeroOrMore>
162
+ <ref name="contributor"/>
163
+ </zeroOrMore>
164
+ </define>
165
+ <define name="classification">
166
+ <element name="classification">
167
+ <ref name="classification_tag"/>
168
+ <ref name="classification_value"/>
169
+ </element>
170
+ </define>
171
+ <define name="classification_tag">
172
+ <element name="tag">
173
+ <text/>
174
+ </element>
175
+ </define>
176
+ <define name="classification_value">
177
+ <element name="value">
178
+ <text/>
179
+ </element>
180
+ </define>
100
181
  <define name="paragraph">
101
182
  <element name="p">
102
183
  <ref name="ParagraphType"/>
@@ -346,6 +427,8 @@
346
427
  <ref name="keyword"/>
347
428
  <ref name="xref"/>
348
429
  <ref name="hyperlink"/>
430
+ <ref name="index"/>
431
+ <ref name="index-xref"/>
349
432
  </choice>
350
433
  </oneOrMore>
351
434
  </element>
@@ -623,6 +706,8 @@
623
706
  <ref name="eref"/>
624
707
  <ref name="xref"/>
625
708
  <ref name="hyperlink"/>
709
+ <ref name="index"/>
710
+ <ref name="index-xref"/>
626
711
  </choice>
627
712
  </zeroOrMore>
628
713
  </element>
@@ -636,6 +721,8 @@
636
721
  <ref name="eref"/>
637
722
  <ref name="xref"/>
638
723
  <ref name="hyperlink"/>
724
+ <ref name="index"/>
725
+ <ref name="index-xref"/>
639
726
  </choice>
640
727
  </zeroOrMore>
641
728
  </element>
@@ -648,6 +735,8 @@
648
735
  <ref name="eref"/>
649
736
  <ref name="xref"/>
650
737
  <ref name="hyperlink"/>
738
+ <ref name="index"/>
739
+ <ref name="index-xref"/>
651
740
  </choice>
652
741
  </zeroOrMore>
653
742
  </element>
@@ -655,7 +744,11 @@
655
744
  <define name="keyword">
656
745
  <element name="keyword">
657
746
  <zeroOrMore>
658
- <ref name="PureTextElement"/>
747
+ <choice>
748
+ <ref name="PureTextElement"/>
749
+ <ref name="index"/>
750
+ <ref name="index-xref"/>
751
+ </choice>
659
752
  </zeroOrMore>
660
753
  </element>
661
754
  </define>
@@ -676,7 +769,11 @@
676
769
  <define name="strike">
677
770
  <element name="strike">
678
771
  <zeroOrMore>
679
- <ref name="PureTextElement"/>
772
+ <choice>
773
+ <ref name="PureTextElement"/>
774
+ <ref name="index"/>
775
+ <ref name="index-xref"/>
776
+ </choice>
680
777
  </zeroOrMore>
681
778
  </element>
682
779
  </define>
@@ -699,27 +796,36 @@
699
796
  </define>
700
797
  <define name="ruby">
701
798
  <element name="ruby">
702
- <zeroOrMore>
703
- <choice>
704
- <ref name="PureTextElement"/>
705
- <ref name="rp"/>
706
- <ref name="rt"/>
707
- </choice>
708
- </zeroOrMore>
799
+ <choice>
800
+ <ref name="ruby_pronunciation"/>
801
+ <ref name="ruby_annotation"/>
802
+ </choice>
803
+ <choice>
804
+ <text/>
805
+ <ref name="ruby"/>
806
+ </choice>
709
807
  </element>
710
808
  </define>
711
- <define name="rp">
712
- <element name="rp">
713
- <zeroOrMore>
714
- <ref name="PureTextElement"/>
715
- </zeroOrMore>
809
+ <define name="ruby_pronunciation">
810
+ <element name="pronunciation">
811
+ <attribute name="value"/>
812
+ <optional>
813
+ <attribute name="script"/>
814
+ </optional>
815
+ <optional>
816
+ <attribute name="lang"/>
817
+ </optional>
716
818
  </element>
717
819
  </define>
718
- <define name="rt">
719
- <element name="rt">
720
- <zeroOrMore>
721
- <ref name="PureTextElement"/>
722
- </zeroOrMore>
820
+ <define name="ruby_annotation">
821
+ <element name="annotation">
822
+ <attribute name="value"/>
823
+ <optional>
824
+ <attribute name="script"/>
825
+ </optional>
826
+ <optional>
827
+ <attribute name="lang"/>
828
+ </optional>
723
829
  </element>
724
830
  </define>
725
831
  <define name="br">
@@ -898,44 +1004,49 @@
898
1004
  -->
899
1005
  <define name="image">
900
1006
  <element name="image">
901
- <attribute name="id">
902
- <data type="ID"/>
1007
+ <ref name="Image"/>
1008
+ </element>
1009
+ </define>
1010
+ <define name="Image">
1011
+ <attribute name="id">
1012
+ <data type="ID"/>
1013
+ </attribute>
1014
+ <attribute name="src">
1015
+ <data type="anyURI"/>
1016
+ </attribute>
1017
+ <attribute name="mimetype"/>
1018
+ <optional>
1019
+ <attribute name="filename"/>
1020
+ </optional>
1021
+ <optional>
1022
+ <attribute name="width">
1023
+ <ref name="ImageSize"/>
903
1024
  </attribute>
904
- <attribute name="src">
1025
+ </optional>
1026
+ <optional>
1027
+ <attribute name="height">
1028
+ <ref name="ImageSize"/>
1029
+ </attribute>
1030
+ </optional>
1031
+ <optional>
1032
+ <attribute name="alt"/>
1033
+ </optional>
1034
+ <optional>
1035
+ <attribute name="title"/>
1036
+ </optional>
1037
+ <optional>
1038
+ <attribute name="longdesc">
905
1039
  <data type="anyURI"/>
906
1040
  </attribute>
907
- <attribute name="mimetype"/>
908
- <optional>
909
- <attribute name="filename"/>
910
- </optional>
911
- <optional>
912
- <attribute name="width">
913
- <choice>
914
- <data type="int"/>
915
- <value>auto</value>
916
- </choice>
917
- </attribute>
918
- </optional>
919
- <optional>
920
- <attribute name="height">
921
- <choice>
922
- <data type="int"/>
923
- <value>auto</value>
924
- </choice>
925
- </attribute>
926
- </optional>
927
- <optional>
928
- <attribute name="alt"/>
929
- </optional>
930
- <optional>
931
- <attribute name="title"/>
932
- </optional>
933
- <optional>
934
- <attribute name="longdesc">
935
- <data type="anyURI"/>
936
- </attribute>
937
- </optional>
938
- </element>
1041
+ </optional>
1042
+ </define>
1043
+ <define name="ImageSize">
1044
+ <choice>
1045
+ <data type="string">
1046
+ <param name="pattern">\d+([.]\d+)?(%?)</param>
1047
+ </data>
1048
+ <value>auto</value>
1049
+ </choice>
939
1050
  </define>
940
1051
  <define name="video">
941
1052
  <element name="video">
@@ -9,11 +9,42 @@
9
9
  -->
10
10
  <include href="biblio.rng">
11
11
  <define name="BibData">
12
- <ref name="BibliographicItem"/>
12
+ <ref name="StandardBibliographicItem"/>
13
13
  <optional>
14
14
  <ref name="ext"/>
15
15
  </optional>
16
16
  </define>
17
+ <define name="docrelation">
18
+ <element name="relation">
19
+ <attribute name="type">
20
+ <ref name="DocRelationType"/>
21
+ </attribute>
22
+ <optional>
23
+ <element name="description">
24
+ <ref name="FormattedString"/>
25
+ </element>
26
+ </optional>
27
+ <element name="bibitem">
28
+ <ref name="StandardReducedBibliographicItem"/>
29
+ </element>
30
+ <choice>
31
+ <zeroOrMore>
32
+ <ref name="locality"/>
33
+ </zeroOrMore>
34
+ <zeroOrMore>
35
+ <ref name="localityStack"/>
36
+ </zeroOrMore>
37
+ </choice>
38
+ <choice>
39
+ <zeroOrMore>
40
+ <ref name="sourceLocality"/>
41
+ </zeroOrMore>
42
+ <zeroOrMore>
43
+ <ref name="sourceLocalityStack"/>
44
+ </zeroOrMore>
45
+ </choice>
46
+ </element>
47
+ </define>
17
48
  </include>
18
49
  <define name="ext">
19
50
  <element name="ext">
@@ -161,4 +192,16 @@
161
192
  </optional>
162
193
  </element>
163
194
  </define>
195
+ <define name="StandardBibliographicItem">
196
+ <ref name="BibliographicItem"/>
197
+ <zeroOrMore>
198
+ <ref name="amend"/>
199
+ </zeroOrMore>
200
+ </define>
201
+ <define name="StandardReducedBibliographicItem">
202
+ <ref name="ReducedBibliographicItem"/>
203
+ <zeroOrMore>
204
+ <ref name="amend"/>
205
+ </zeroOrMore>
206
+ </define>
164
207
  </grammar>
data/grammars/biblio.rng CHANGED
@@ -241,6 +241,9 @@
241
241
  </element>
242
242
  </define>
243
243
  <define name="FullNameType">
244
+ <optional>
245
+ <ref name="name_abbreviation"/>
246
+ </optional>
244
247
  <choice>
245
248
  <group>
246
249
  <zeroOrMore>
@@ -266,6 +269,11 @@
266
269
  <ref name="variantname"/>
267
270
  </zeroOrMore>
268
271
  </define>
272
+ <define name="name_abbreviation">
273
+ <element name="abbreviation">
274
+ <ref name="LocalizedString"/>
275
+ </element>
276
+ </define>
269
277
  <define name="prefix">
270
278
  <element name="prefix">
271
279
  <ref name="LocalizedString"/>
@@ -348,6 +356,9 @@
348
356
  <zeroOrMore>
349
357
  <ref name="contact"/>
350
358
  </zeroOrMore>
359
+ <optional>
360
+ <ref name="logo"/>
361
+ </optional>
351
362
  </element>
352
363
  </define>
353
364
  <define name="orgname">
@@ -366,6 +377,21 @@
366
377
  </choice>
367
378
  </element>
368
379
  </define>
380
+ <define name="logo">
381
+ <element name="logo">
382
+ <ref name="image"/>
383
+ </element>
384
+ </define>
385
+ <define name="depiction">
386
+ <element name="depiction">
387
+ <optional>
388
+ <attribute name="scope"/>
389
+ </optional>
390
+ <zeroOrMore>
391
+ <ref name="image"/>
392
+ </zeroOrMore>
393
+ </element>
394
+ </define>
369
395
  <define name="NameWithVariants">
370
396
  <element name="primary">
371
397
  <ref name="LocalizedString"/>
@@ -752,6 +778,9 @@
752
778
  <optional>
753
779
  <ref name="validity"/>
754
780
  </optional>
781
+ <optional>
782
+ <ref name="depiction"/>
783
+ </optional>
755
784
  </define>
756
785
  <define name="ReducedBibliographicItem">
757
786
  <optional>
@@ -849,6 +878,9 @@
849
878
  <optional>
850
879
  <ref name="validity"/>
851
880
  </optional>
881
+ <optional>
882
+ <ref name="depiction"/>
883
+ </optional>
852
884
  </define>
853
885
  <define name="btitle">
854
886
  <element name="title">
@@ -942,6 +974,7 @@
942
974
  <value>obsoleted</value>
943
975
  <value>confirmed</value>
944
976
  <value>updated</value>
977
+ <value>corrected</value>
945
978
  <value>issued</value>
946
979
  <value>transmitted</value>
947
980
  <value>copied</value>
@@ -1,14 +1,9 @@
1
1
  module RelatonCcsds
2
2
  class BibliographicItem < RelatonBib::BibliographicItem
3
- DOCTYPES = %w[standard practice report specification record].freeze
4
-
5
3
  attr_reader :technology_area
6
4
 
7
5
  # @param technology_area [String, nil]
8
6
  def initialize(**args)
9
- if args[:doctype] && !DOCTYPES.include?(args[:doctype])
10
- Util.warn "WARNING: Invalid doctype: `#{args[:doctype]}`"
11
- end
12
7
  @technology_area = args.delete(:technology_area)
13
8
  super
14
9
  end
@@ -27,7 +22,7 @@ module RelatonCcsds
27
22
  super do |builder|
28
23
  if opts[:bibdata] && (doctype || editorialgroup || technology_area)
29
24
  ext = builder.ext do |b|
30
- b.doctype doctype if doctype
25
+ doctype&.to_xml b
31
26
  editorialgroup&.to_xml b
32
27
  b.send(:"technology-area", technology_area) if technology_area
33
28
  end
@@ -56,7 +56,7 @@ module RelatonCcsds
56
56
 
57
57
  def parse_doctype
58
58
  /^CCSDS\s[\d.]+-(?<type>\w+)/ =~ @doc["Document_x0020_Number"]
59
- DOCTYPES[type&.to_sym]
59
+ DocumentType.new type: DOCTYPES[type&.to_sym]
60
60
  end
61
61
 
62
62
  def parse_date
@@ -0,0 +1,16 @@
1
+ module RelatonCcsds
2
+ class DocumentType < RelatonBib::DocumentType
3
+ # DOCTYPES = %w[standard practice report specification record].freeze
4
+
5
+ def initialize(type:, abbreviation: nil)
6
+ # check_type type
7
+ super
8
+ end
9
+
10
+ # def check_type(type)
11
+ # return if DOCTYPES.include? type
12
+
13
+ # Util.warn "WARNING: invalid doctype: `#{type}`"
14
+ # end
15
+ end
16
+ end
@@ -1,21 +1,25 @@
1
1
  module RelatonCcsds
2
- class HashConverter < RelatonBib::HashConverter
3
- class << self
4
- # @param args [Hash]
5
- # @return [Hash]
6
- def hash_to_bib(args)
7
- ret = super
8
- return unless ret
2
+ module HashConverter
3
+ include RelatonBib::HashConverter
4
+ extend self
5
+ # @param args [Hash]
6
+ # @return [Hash]
7
+ def hash_to_bib(args)
8
+ ret = super
9
+ return unless ret
9
10
 
10
- ret[:technology_area] = ret[:ext][:technology_area] if ret[:ext]
11
- ret
12
- end
11
+ ret[:technology_area] = ret[:ext][:technology_area] if ret[:ext]
12
+ ret
13
+ end
14
+
15
+ # @param item_hash [Hash]
16
+ # @return [RelatonCie::BibliographicItem]
17
+ def bib_item(item_hash)
18
+ BibliographicItem.new(**item_hash)
19
+ end
13
20
 
14
- # @param item_hash [Hash]
15
- # @return [RelatonCie::BibliographicItem]
16
- def bib_item(item_hash)
17
- BibliographicItem.new(**item_hash)
18
- end
21
+ def create_doctype(**args)
22
+ DocumentType.new(**args)
19
23
  end
20
24
  end
21
25
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RelatonCcsds
4
- VERSION = "1.16.3"
4
+ VERSION = "1.18.0"
5
5
  end
data/lib/relaton_ccsds.rb CHANGED
@@ -7,6 +7,7 @@ require_relative "relaton_ccsds/version"
7
7
  require_relative "relaton_ccsds/bibliographic_item"
8
8
  require_relative "relaton_ccsds/config"
9
9
  require_relative "relaton_ccsds/util"
10
+ require_relative "relaton_ccsds/document_type"
10
11
  require_relative "relaton_ccsds/bibliography"
11
12
  require_relative "relaton_ccsds/hit"
12
13
  require_relative "relaton_ccsds/hit_collection"
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
25
25
 
26
26
  # Uncomment to register a new dependency of your gem
27
27
  spec.add_dependency "mechanize", "~> 2.7"
28
- spec.add_dependency "relaton-bib", "~> 1.16.0"
28
+ spec.add_dependency "relaton-bib", "~> 1.18.0"
29
29
  spec.add_dependency "relaton-index", "~> 0.2.0"
30
30
 
31
31
  # For more information and examples about making a new gem, check out our
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: relaton-ccsds
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.3
4
+ version: 1.18.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ribose Inc.
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2023-10-07 00:00:00.000000000 Z
11
+ date: 2024-01-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: mechanize
@@ -30,14 +30,14 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 1.16.0
33
+ version: 1.18.0
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 1.16.0
40
+ version: 1.18.0
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: relaton-index
43
43
  requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,7 @@ files:
79
79
  - lib/relaton_ccsds/config.rb
80
80
  - lib/relaton_ccsds/data_fetcher.rb
81
81
  - lib/relaton_ccsds/data_parser.rb
82
+ - lib/relaton_ccsds/document_type.rb
82
83
  - lib/relaton_ccsds/hash_converter.rb
83
84
  - lib/relaton_ccsds/hit.rb
84
85
  - lib/relaton_ccsds/hit_collection.rb