relaton-bsi 1.16.2 → 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: beee0d1d60affb54c0d473077b8b792271bd773a89462aa9668794a47c8c37b4
4
- data.tar.gz: 3f4a940e53481c52b6ff1d155a0ae1e9cccdc20a768753d59efb042beed7a80b
3
+ metadata.gz: c6a348a80ecad045948f4167cdb7d89524baf1491aea73b10793d31d552bba29
4
+ data.tar.gz: adc33e177fba38c2958fd54929dcbe18de35f9bd9462e415258203b6a8729e68
5
5
  SHA512:
6
- metadata.gz: d890a38ea4d5ba876d4e6e8497347e45bb3067aca5796f8c574a8d7de9e337836655158d9f3ce1ed1d1687c923750ee570b80994ea238be9e32df156bc6fd808
7
- data.tar.gz: c12c4a02bd22a07cd63378de4a2a701df11e119e12717e8e28d74b7c6ce453712c123b8b55a10675f3b78e7bce23aebbc0187bb79ef5366e43aab0de46e7e3a5
6
+ metadata.gz: d25031554cb669eb839b9d4ad603726c3caf31f1c1dbf52243ef5f9d6f5465d743c1ba5813ce0bf9772eb4aa96ff99b2dcddc306848c09a23ef535df9290eb2e
7
+ data.tar.gz: bb4c17e472ef39577c3531512b58dc348f6fc4712732cf68c43723103a2c3041b494ca27ab5c0bcb3e860621007cab81e06bb272290f011c1a649b8197ec8c1f
@@ -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:
@@ -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,12 +1,5 @@
1
1
  module RelatonBsi
2
2
  class BsiBibliographicItem < RelatonIsoBib::IsoBibliographicItem
3
- DOCTYPES = %w[
4
- british-standard draft-for-development published-document privately-subscribed-standard
5
- publicly-available-specification flex-standard international-standard technical-specification
6
- technical-report guide international-workshop-agreement industry-technical-agreement
7
- standard european-workshop-agreement fast-track-standard
8
- ].freeze
9
-
10
3
  SUBDOCTYPES = %w[specification method-of-test method-of-specifying vocabulary code-of-practice].freeze
11
4
 
12
5
  def initialize(**args) # rubocop:disable Metrics/AbcSize
@@ -53,10 +53,10 @@ module RelatonBsi
53
53
  private
54
54
 
55
55
  def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
56
- y = code_parts(code)[:year]
57
- id = year && !y ? "#{code}:#{year}" : code
58
- Util.warn "WARNING: no match found online for `#{id}`. " \
59
- "The code must be exactly like it is on the standards website."
56
+ # y = code_parts(code)[:year]
57
+ # id = year && !y ? "#{code}:#{year}" : code
58
+ # Util.warn "WARNING: no match found online for `#{id}`. " \
59
+ # "The code must be exactly like it is on the standards website."
60
60
  unless missed_years.empty?
61
61
  Util.warn "There was no match for `#{year}`, though there " \
62
62
  "were matches found for `#{missed_years.join('`, `')}`."
@@ -0,0 +1,21 @@
1
+ module RelatonBsi
2
+ class DocumentType < RelatonBib::DocumentType
3
+ DOCTYPES = %w[
4
+ british-standard draft-for-development published-document privately-subscribed-standard
5
+ publicly-available-specification flex-standard international-standard technical-specification
6
+ technical-report guide international-workshop-agreement industry-technical-agreement
7
+ standard european-workshop-agreement fast-track-standard expert-commentary
8
+ ].freeze
9
+
10
+ def initialize(type:, abbreviation: nil)
11
+ check_type type
12
+ super
13
+ end
14
+
15
+ def check_type(type)
16
+ unless DOCTYPES.include? type
17
+ Util.warn "WARNING: invalid doctype: `#{type}`"
18
+ end
19
+ end
20
+ end
21
+ end
@@ -1,16 +1,21 @@
1
1
  module RelatonBsi
2
- class HashConverter < RelatonIsoBib::HashConverter
3
- class << self
4
- private
2
+ module HashConverter
3
+ include RelatonIsoBib::HashConverter
4
+ extend self
5
5
 
6
- #
7
- # Ovverides superclass's method
8
- #
9
- # @param item [Hash]
10
- # @retirn [RelatonBsi::BsiBibliographicItem]
11
- def bib_item(item)
12
- BsiBibliographicItem.new(**item)
13
- end
6
+ private
7
+
8
+ #
9
+ # Ovverides superclass's method
10
+ #
11
+ # @param item [Hash]
12
+ # @retirn [RelatonBsi::BsiBibliographicItem]
13
+ def bib_item(item)
14
+ BsiBibliographicItem.new(**item)
15
+ end
16
+
17
+ def create_doctype(**args)
18
+ DocumentType.new(**args)
14
19
  end
15
20
  end
16
21
  end
@@ -10,7 +10,7 @@ module RelatonBsi
10
10
  end
11
11
 
12
12
  # @param code [String]
13
- # @param date [String, NilClass] year
13
+ # @param date [String, nil] year
14
14
  # @param opts [Hash]
15
15
  # @return [RelatonBsi::BsiBibliographicItem]
16
16
  def get(code, date, opts)
@@ -183,6 +183,10 @@ module RelatonBsi
183
183
  # @return [String] doctype
184
184
  #
185
185
  def fetch_doctype(hit)
186
+ DocumentType.new(type: doctype(hit))
187
+ end
188
+
189
+ def doctype(hit)
186
190
  case hit.hit[:code]
187
191
  when /(^|\s)Flex\s/ then "flex-standard"
188
192
  when /(^|\s)PAS\s/ then "publicly-available-specification"
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RelatonBsi
4
- VERSION = "1.16.2"
4
+ VERSION = "1.18.0"
5
5
  end
data/lib/relaton_bsi.rb CHANGED
@@ -4,6 +4,7 @@ require "relaton_iso_bib"
4
4
  require_relative "relaton_bsi/version"
5
5
  require "relaton_bsi/config"
6
6
  require "relaton_bsi/util"
7
+ require "relaton_bsi/document_type"
7
8
  require "relaton_bsi/bsi_bibliography"
8
9
  require "relaton_bsi/bsi_bibliographic_item"
9
10
  require "relaton_bsi/scrapper"
data/relaton_bsi.gemspec CHANGED
@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
32
32
  spec.add_dependency "algolia", "~> 2.3.0"
33
33
  spec.add_dependency "graphql", "1.13.6"
34
34
  spec.add_dependency "graphql-client", "~> 0.16.0"
35
- spec.add_dependency "relaton-iso-bib", "~> 1.16.0"
35
+ spec.add_dependency "relaton-iso-bib", "~> 1.18.0"
36
36
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: relaton-bsi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.2
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: algolia
@@ -58,14 +58,14 @@ dependencies:
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: 1.16.0
61
+ version: 1.18.0
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: 1.16.0
68
+ version: 1.18.0
69
69
  description: 'RelatonBsi: retrieve BSI Standards for bibliographic use using the BibliographicItem
70
70
  model'
71
71
  email:
@@ -95,6 +95,7 @@ files:
95
95
  - lib/relaton_bsi/bsi_bibliographic_item.rb
96
96
  - lib/relaton_bsi/bsi_bibliography.rb
97
97
  - lib/relaton_bsi/config.rb
98
+ - lib/relaton_bsi/document_type.rb
98
99
  - lib/relaton_bsi/hash_converter.rb
99
100
  - lib/relaton_bsi/hit.rb
100
101
  - lib/relaton_bsi/hit_collection.rb