blacklight-citeproc 0.0.4 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/.env +3 -0
  3. data/.github/workflows/test.yml +25 -0
  4. data/.internal_test_app/solr/conf/_rest_managed.json +3 -0
  5. data/.internal_test_app/solr/conf/admin-extra.html +31 -0
  6. data/.internal_test_app/solr/conf/currency.xml +67 -0
  7. data/.internal_test_app/solr/conf/email_url_types.txt +2 -0
  8. data/.internal_test_app/solr/conf/lang/contractions_ca.txt +8 -0
  9. data/.internal_test_app/solr/conf/lang/contractions_fr.txt +15 -0
  10. data/.internal_test_app/solr/conf/lang/contractions_ga.txt +5 -0
  11. data/.internal_test_app/solr/conf/lang/contractions_it.txt +23 -0
  12. data/.internal_test_app/solr/conf/lang/hyphenations_ga.txt +5 -0
  13. data/.internal_test_app/solr/conf/lang/stemdict_nl.txt +6 -0
  14. data/.internal_test_app/solr/conf/lang/stoptags_ja.txt +420 -0
  15. data/.internal_test_app/solr/conf/lang/stopwords_ar.txt +125 -0
  16. data/.internal_test_app/solr/conf/lang/stopwords_bg.txt +193 -0
  17. data/.internal_test_app/solr/conf/lang/stopwords_ca.txt +220 -0
  18. data/.internal_test_app/solr/conf/lang/stopwords_cz.txt +172 -0
  19. data/.internal_test_app/solr/conf/lang/stopwords_da.txt +110 -0
  20. data/.internal_test_app/solr/conf/lang/stopwords_de.txt +294 -0
  21. data/.internal_test_app/solr/conf/lang/stopwords_el.txt +78 -0
  22. data/.internal_test_app/solr/conf/lang/stopwords_en.txt +54 -0
  23. data/.internal_test_app/solr/conf/lang/stopwords_es.txt +356 -0
  24. data/.internal_test_app/solr/conf/lang/stopwords_eu.txt +99 -0
  25. data/.internal_test_app/solr/conf/lang/stopwords_fa.txt +313 -0
  26. data/.internal_test_app/solr/conf/lang/stopwords_fi.txt +97 -0
  27. data/.internal_test_app/solr/conf/lang/stopwords_fr.txt +186 -0
  28. data/.internal_test_app/solr/conf/lang/stopwords_ga.txt +110 -0
  29. data/.internal_test_app/solr/conf/lang/stopwords_gl.txt +161 -0
  30. data/.internal_test_app/solr/conf/lang/stopwords_hi.txt +235 -0
  31. data/.internal_test_app/solr/conf/lang/stopwords_hu.txt +211 -0
  32. data/.internal_test_app/solr/conf/lang/stopwords_hy.txt +46 -0
  33. data/.internal_test_app/solr/conf/lang/stopwords_id.txt +359 -0
  34. data/.internal_test_app/solr/conf/lang/stopwords_it.txt +303 -0
  35. data/.internal_test_app/solr/conf/lang/stopwords_ja.txt +127 -0
  36. data/.internal_test_app/solr/conf/lang/stopwords_lv.txt +172 -0
  37. data/.internal_test_app/solr/conf/lang/stopwords_nl.txt +119 -0
  38. data/.internal_test_app/solr/conf/lang/stopwords_no.txt +194 -0
  39. data/.internal_test_app/solr/conf/lang/stopwords_pt.txt +253 -0
  40. data/.internal_test_app/solr/conf/lang/stopwords_ro.txt +233 -0
  41. data/.internal_test_app/solr/conf/lang/stopwords_ru.txt +243 -0
  42. data/.internal_test_app/solr/conf/lang/stopwords_sv.txt +133 -0
  43. data/.internal_test_app/solr/conf/lang/stopwords_th.txt +119 -0
  44. data/.internal_test_app/solr/conf/lang/stopwords_tr.txt +212 -0
  45. data/.internal_test_app/solr/conf/lang/userdict_ja.txt +29 -0
  46. data/.internal_test_app/solr/conf/mapping-ISOLatin1Accent.txt +246 -0
  47. data/.internal_test_app/solr/conf/protwords.txt +21 -0
  48. data/.internal_test_app/solr/conf/schema.xml +408 -0
  49. data/.internal_test_app/solr/conf/scripts.conf +24 -0
  50. data/.internal_test_app/solr/conf/solrconfig.xml +1287 -0
  51. data/.internal_test_app/solr/conf/spellings.txt +2 -0
  52. data/.internal_test_app/solr/conf/stopwords.txt +14 -0
  53. data/.internal_test_app/solr/conf/stopwords_en.txt +58 -0
  54. data/.internal_test_app/solr/conf/synonyms.txt +13 -0
  55. data/.internal_test_app/solr/conf/update-script.js +115 -0
  56. data/.internal_test_app/solr/conf/velocity/browse.vm +32 -0
  57. data/.internal_test_app/solr/conf/velocity/dropit.js +0 -0
  58. data/.internal_test_app/solr/conf/velocity/facet_doc_type.vm +2 -0
  59. data/.internal_test_app/solr/conf/velocity/facet_text_shingles.vm +12 -0
  60. data/.internal_test_app/solr/conf/velocity/facets.vm +24 -0
  61. data/.internal_test_app/solr/conf/velocity/footer.vm +29 -0
  62. data/.internal_test_app/solr/conf/velocity/head.vm +290 -0
  63. data/.internal_test_app/solr/conf/velocity/hit.vm +77 -0
  64. data/.internal_test_app/solr/conf/velocity/img/english_640.png +0 -0
  65. data/.internal_test_app/solr/conf/velocity/img/france_640.png +0 -0
  66. data/.internal_test_app/solr/conf/velocity/img/germany_640.png +0 -0
  67. data/.internal_test_app/solr/conf/velocity/img/globe_256.png +0 -0
  68. data/.internal_test_app/solr/conf/velocity/jquery.tx3-tag-cloud.js +0 -0
  69. data/.internal_test_app/solr/conf/velocity/js/dropit.js +97 -0
  70. data/.internal_test_app/solr/conf/velocity/js/jquery.autocomplete.js +763 -0
  71. data/.internal_test_app/solr/conf/velocity/js/jquery.tx3-tag-cloud.js +70 -0
  72. data/.internal_test_app/solr/conf/velocity/layout.vm +42 -0
  73. data/.internal_test_app/solr/conf/velocity/macros.vm +16 -0
  74. data/.internal_test_app/solr/conf/velocity/mime_type_lists.vm +68 -0
  75. data/.internal_test_app/solr/conf/velocity/results.vm +20 -0
  76. data/.internal_test_app/solr/conf/velocity/results_list.vm +21 -0
  77. data/.internal_test_app/solr/conf/xslt/example.xsl +132 -0
  78. data/.internal_test_app/solr/conf/xslt/example_atom.xsl +67 -0
  79. data/.internal_test_app/solr/conf/xslt/example_rss.xsl +66 -0
  80. data/.internal_test_app/solr/conf/xslt/luke.xsl +337 -0
  81. data/.rubocop.yml +4 -0
  82. data/.rubocop_todo.yml +40 -0
  83. data/Dockerfile +43 -0
  84. data/Gemfile +5 -0
  85. data/LICENSE.md +21 -0
  86. data/README.md +3 -0
  87. data/Rakefile +8 -0
  88. data/app/controllers/blacklight/citeproc/citation_controller.rb +45 -40
  89. data/app/models/concerns/blacklight/document/bibtex.rb +37 -35
  90. data/bin/entrypoint.sh +8 -0
  91. data/blacklight-citeproc.gemspec +19 -19
  92. data/config/routes.rb +2 -0
  93. data/docker-compose.yml +33 -0
  94. data/lib/blacklight/citeproc/engine.rb +2 -0
  95. data/lib/blacklight/citeproc/version.rb +3 -1
  96. data/lib/blacklight/citeproc.rb +2 -0
  97. data/lib/generators/blacklight/citeproc/install_generator.rb +20 -15
  98. metadata +119 -40
@@ -0,0 +1,337 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!--
3
+ Licensed to the Apache Software Foundation (ASF) under one or more
4
+ contributor license agreements. See the NOTICE file distributed with
5
+ this work for additional information regarding copyright ownership.
6
+ The ASF licenses this file to You under the Apache License, Version 2.0
7
+ (the "License"); you may not use this file except in compliance with
8
+ the License. You may obtain a copy of the License at
9
+
10
+ http://www.apache.org/licenses/LICENSE-2.0
11
+
12
+ Unless required by applicable law or agreed to in writing, software
13
+ distributed under the License is distributed on an "AS IS" BASIS,
14
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ See the License for the specific language governing permissions and
16
+ limitations under the License.
17
+ -->
18
+
19
+
20
+ <!--
21
+ Display the luke request handler with graphs
22
+ -->
23
+ <xsl:stylesheet
24
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
25
+ xmlns="http://www.w3.org/1999/xhtml"
26
+ version="1.0"
27
+ >
28
+ <xsl:output
29
+ method="html"
30
+ encoding="UTF-8"
31
+ media-type="text/html; charset=UTF-8"
32
+ doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN"
33
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
34
+ />
35
+
36
+ <xsl:variable name="title">Solr Luke Request Handler Response</xsl:variable>
37
+
38
+ <xsl:template match="/">
39
+ <html xmlns="http://www.w3.org/1999/xhtml">
40
+ <head>
41
+ <link rel="stylesheet" type="text/css" href="solr-admin.css"/>
42
+ <link rel="icon" href="favicon.ico" type="image/ico"/>
43
+ <link rel="shortcut icon" href="favicon.ico" type="image/ico"/>
44
+ <title>
45
+ <xsl:value-of select="$title"/>
46
+ </title>
47
+ <xsl:call-template name="css"/>
48
+
49
+ </head>
50
+ <body>
51
+ <h1>
52
+ <xsl:value-of select="$title"/>
53
+ </h1>
54
+ <div class="doc">
55
+ <ul>
56
+ <xsl:if test="response/lst[@name='index']">
57
+ <li>
58
+ <a href="#index">Index Statistics</a>
59
+ </li>
60
+ </xsl:if>
61
+ <xsl:if test="response/lst[@name='fields']">
62
+ <li>
63
+ <a href="#fields">Field Statistics</a>
64
+ <ul>
65
+ <xsl:for-each select="response/lst[@name='fields']/lst">
66
+ <li>
67
+ <a href="#{@name}">
68
+ <xsl:value-of select="@name"/>
69
+ </a>
70
+ </li>
71
+ </xsl:for-each>
72
+ </ul>
73
+ </li>
74
+ </xsl:if>
75
+ <xsl:if test="response/lst[@name='doc']">
76
+ <li>
77
+ <a href="#doc">Document statistics</a>
78
+ </li>
79
+ </xsl:if>
80
+ </ul>
81
+ </div>
82
+ <xsl:if test="response/lst[@name='index']">
83
+ <h2><a name="index"/>Index Statistics</h2>
84
+ <xsl:apply-templates select="response/lst[@name='index']"/>
85
+ </xsl:if>
86
+ <xsl:if test="response/lst[@name='fields']">
87
+ <h2><a name="fields"/>Field Statistics</h2>
88
+ <xsl:apply-templates select="response/lst[@name='fields']"/>
89
+ </xsl:if>
90
+ <xsl:if test="response/lst[@name='doc']">
91
+ <h2><a name="doc"/>Document statistics</h2>
92
+ <xsl:apply-templates select="response/lst[@name='doc']"/>
93
+ </xsl:if>
94
+ </body>
95
+ </html>
96
+ </xsl:template>
97
+
98
+ <xsl:template match="lst">
99
+ <xsl:if test="parent::lst">
100
+ <tr>
101
+ <td colspan="2">
102
+ <div class="doc">
103
+ <xsl:call-template name="list"/>
104
+ </div>
105
+ </td>
106
+ </tr>
107
+ </xsl:if>
108
+ <xsl:if test="not(parent::lst)">
109
+ <div class="doc">
110
+ <xsl:call-template name="list"/>
111
+ </div>
112
+ </xsl:if>
113
+ </xsl:template>
114
+
115
+ <xsl:template name="list">
116
+ <xsl:if test="count(child::*)>0">
117
+ <table>
118
+ <thead>
119
+ <tr>
120
+ <th colspan="2">
121
+ <p>
122
+ <a name="{@name}"/>
123
+ </p>
124
+ <xsl:value-of select="@name"/>
125
+ </th>
126
+ </tr>
127
+ </thead>
128
+ <tbody>
129
+ <xsl:choose>
130
+ <xsl:when
131
+ test="@name='histogram'">
132
+ <tr>
133
+ <td colspan="2">
134
+ <xsl:call-template name="histogram"/>
135
+ </td>
136
+ </tr>
137
+ </xsl:when>
138
+ <xsl:otherwise>
139
+ <xsl:apply-templates/>
140
+ </xsl:otherwise>
141
+ </xsl:choose>
142
+ </tbody>
143
+ </table>
144
+ </xsl:if>
145
+ </xsl:template>
146
+
147
+ <xsl:template name="histogram">
148
+ <div class="doc">
149
+ <xsl:call-template name="barchart">
150
+ <xsl:with-param name="max_bar_width">50</xsl:with-param>
151
+ <xsl:with-param name="iwidth">800</xsl:with-param>
152
+ <xsl:with-param name="iheight">160</xsl:with-param>
153
+ <xsl:with-param name="fill">blue</xsl:with-param>
154
+ </xsl:call-template>
155
+ </div>
156
+ </xsl:template>
157
+
158
+ <xsl:template name="barchart">
159
+ <xsl:param name="max_bar_width"/>
160
+ <xsl:param name="iwidth"/>
161
+ <xsl:param name="iheight"/>
162
+ <xsl:param name="fill"/>
163
+ <xsl:variable name="max">
164
+ <xsl:for-each select="int">
165
+ <xsl:sort data-type="number" order="descending"/>
166
+ <xsl:if test="position()=1">
167
+ <xsl:value-of select="."/>
168
+ </xsl:if>
169
+ </xsl:for-each>
170
+ </xsl:variable>
171
+ <xsl:variable name="bars">
172
+ <xsl:value-of select="count(int)"/>
173
+ </xsl:variable>
174
+ <xsl:variable name="bar_width">
175
+ <xsl:choose>
176
+ <xsl:when test="$max_bar_width &lt; ($iwidth div $bars)">
177
+ <xsl:value-of select="$max_bar_width"/>
178
+ </xsl:when>
179
+ <xsl:otherwise>
180
+ <xsl:value-of select="$iwidth div $bars"/>
181
+ </xsl:otherwise>
182
+ </xsl:choose>
183
+ </xsl:variable>
184
+ <table class="histogram">
185
+ <tbody>
186
+ <tr>
187
+ <xsl:for-each select="int">
188
+ <td>
189
+ <xsl:value-of select="."/>
190
+ <div class="histogram">
191
+ <xsl:attribute name="style">background-color: <xsl:value-of select="$fill"/>; width: <xsl:value-of select="$bar_width"/>px; height: <xsl:value-of select="($iheight*number(.)) div $max"/>px;</xsl:attribute>
192
+ </div>
193
+ </td>
194
+ </xsl:for-each>
195
+ </tr>
196
+ <tr>
197
+ <xsl:for-each select="int">
198
+ <td>
199
+ <xsl:value-of select="@name"/>
200
+ </td>
201
+ </xsl:for-each>
202
+ </tr>
203
+ </tbody>
204
+ </table>
205
+ </xsl:template>
206
+
207
+ <xsl:template name="keyvalue">
208
+ <xsl:choose>
209
+ <xsl:when test="@name">
210
+ <tr>
211
+ <td class="name">
212
+ <xsl:value-of select="@name"/>
213
+ </td>
214
+ <td class="value">
215
+ <xsl:value-of select="."/>
216
+ </td>
217
+ </tr>
218
+ </xsl:when>
219
+ <xsl:otherwise>
220
+ <xsl:value-of select="."/>
221
+ </xsl:otherwise>
222
+ </xsl:choose>
223
+ </xsl:template>
224
+
225
+ <xsl:template match="int|bool|long|float|double|uuid|date">
226
+ <xsl:call-template name="keyvalue"/>
227
+ </xsl:template>
228
+
229
+ <xsl:template match="arr">
230
+ <tr>
231
+ <td class="name">
232
+ <xsl:value-of select="@name"/>
233
+ </td>
234
+ <td class="value">
235
+ <ul>
236
+ <xsl:for-each select="child::*">
237
+ <li>
238
+ <xsl:apply-templates/>
239
+ </li>
240
+ </xsl:for-each>
241
+ </ul>
242
+ </td>
243
+ </tr>
244
+ </xsl:template>
245
+
246
+ <xsl:template match="str">
247
+ <xsl:choose>
248
+ <xsl:when test="@name='schema' or @name='index' or @name='flags'">
249
+ <xsl:call-template name="schema"/>
250
+ </xsl:when>
251
+ <xsl:otherwise>
252
+ <xsl:call-template name="keyvalue"/>
253
+ </xsl:otherwise>
254
+ </xsl:choose>
255
+ </xsl:template>
256
+
257
+ <xsl:template name="schema">
258
+ <tr>
259
+ <td class="name">
260
+ <xsl:value-of select="@name"/>
261
+ </td>
262
+ <td class="value">
263
+ <xsl:if test="contains(.,'unstored')">
264
+ <xsl:value-of select="."/>
265
+ </xsl:if>
266
+ <xsl:if test="not(contains(.,'unstored'))">
267
+ <xsl:call-template name="infochar2string">
268
+ <xsl:with-param name="charList">
269
+ <xsl:value-of select="."/>
270
+ </xsl:with-param>
271
+ </xsl:call-template>
272
+ </xsl:if>
273
+ </td>
274
+ </tr>
275
+ </xsl:template>
276
+
277
+ <xsl:template name="infochar2string">
278
+ <xsl:param name="i">1</xsl:param>
279
+ <xsl:param name="charList"/>
280
+
281
+ <xsl:variable name="char">
282
+ <xsl:value-of select="substring($charList,$i,1)"/>
283
+ </xsl:variable>
284
+ <xsl:choose>
285
+ <xsl:when test="$char='I'">
286
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='I']"/> - </xsl:when>
287
+ <xsl:when test="$char='T'">
288
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='T']"/> - </xsl:when>
289
+ <xsl:when test="$char='S'">
290
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='S']"/> - </xsl:when>
291
+ <xsl:when test="$char='M'">
292
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='M']"/> - </xsl:when>
293
+ <xsl:when test="$char='V'">
294
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='V']"/> - </xsl:when>
295
+ <xsl:when test="$char='o'">
296
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='o']"/> - </xsl:when>
297
+ <xsl:when test="$char='p'">
298
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='p']"/> - </xsl:when>
299
+ <xsl:when test="$char='O'">
300
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='O']"/> - </xsl:when>
301
+ <xsl:when test="$char='L'">
302
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='L']"/> - </xsl:when>
303
+ <xsl:when test="$char='B'">
304
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='B']"/> - </xsl:when>
305
+ <xsl:when test="$char='C'">
306
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='C']"/> - </xsl:when>
307
+ <xsl:when test="$char='f'">
308
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='f']"/> - </xsl:when>
309
+ <xsl:when test="$char='l'">
310
+ <xsl:value-of select="/response/lst[@name='info']/lst/str[@name='l']"/> -
311
+ </xsl:when>
312
+ </xsl:choose>
313
+
314
+ <xsl:if test="not($i>=string-length($charList))">
315
+ <xsl:call-template name="infochar2string">
316
+ <xsl:with-param name="i">
317
+ <xsl:value-of select="$i+1"/>
318
+ </xsl:with-param>
319
+ <xsl:with-param name="charList">
320
+ <xsl:value-of select="$charList"/>
321
+ </xsl:with-param>
322
+ </xsl:call-template>
323
+ </xsl:if>
324
+ </xsl:template>
325
+ <xsl:template name="css">
326
+ <style type="text/css">
327
+ <![CDATA[
328
+ td.name {font-style: italic; font-size:80%; }
329
+ .doc { margin: 0.5em; border: solid grey 1px; }
330
+ .exp { display: none; font-family: monospace; white-space: pre; }
331
+ div.histogram { background: none repeat scroll 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;}
332
+ table.histogram { width: auto; vertical-align: bottom; }
333
+ table.histogram td, table.histogram th { text-align: center; vertical-align: bottom; border-bottom: 1px solid #ff9933; width: auto; }
334
+ ]]>
335
+ </style>
336
+ </xsl:template>
337
+ </xsl:stylesheet>
data/.rubocop.yml ADDED
@@ -0,0 +1,4 @@
1
+ inherit_from: .rubocop_todo.yml
2
+
3
+ AllCops:
4
+ TargetRubyVersion: 2.7
data/.rubocop_todo.yml ADDED
@@ -0,0 +1,40 @@
1
+ # This configuration was generated by
2
+ # `rubocop --auto-gen-config`
3
+ # on 2022-05-09 22:37:34 UTC using RuboCop version 1.29.0.
4
+ # The point is for the user to remove these configuration records
5
+ # one by one as the offenses are removed from the code base.
6
+ # Note that changes in the inspected code, or installation of new
7
+ # versions of RuboCop, may require this file to be generated again.
8
+
9
+ # Offense count: 1
10
+ Lint/MissingSuper:
11
+ Exclude:
12
+ - 'app/controllers/blacklight/citeproc/citation_controller.rb'
13
+
14
+ # Offense count: 2
15
+ # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
16
+ Metrics/AbcSize:
17
+ Max: 28
18
+
19
+ # Offense count: 2
20
+ # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
21
+ Metrics/MethodLength:
22
+ Max: 24
23
+
24
+ # Offense count: 4
25
+ # Configuration parameters: AllowedConstants.
26
+ Style/Documentation:
27
+ Exclude:
28
+ - 'spec/**/*'
29
+ - 'test/**/*'
30
+ - 'app/controllers/blacklight/citeproc/citation_controller.rb'
31
+ - 'app/models/concerns/blacklight/document/bibtex.rb'
32
+ - 'lib/blacklight/citeproc.rb'
33
+ - 'lib/generators/blacklight/citeproc/install_generator.rb'
34
+
35
+ # Offense count: 1
36
+ # This cop supports safe auto-correction (--auto-correct).
37
+ # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
38
+ # URISchemes: http, https
39
+ Layout/LineLength:
40
+ Max: 123
data/Dockerfile ADDED
@@ -0,0 +1,43 @@
1
+ FROM ruby:2.6.5-alpine
2
+
3
+ ARG RAILS_VERSION
4
+ ARG BLACKLIGHT_VERSION
5
+
6
+ RUN apk add --update --no-cache \
7
+ bash \
8
+ build-base \
9
+ gcompat \
10
+ git \
11
+ libxml2-dev \
12
+ libxslt-dev \
13
+ nodejs \
14
+ sqlite-dev \
15
+ tzdata \
16
+ yarn
17
+
18
+ RUN mkdir /app
19
+ RUN mkdir /gem
20
+
21
+ RUN adduser -D blacklight
22
+ RUN chown -R blacklight /app /gem
23
+
24
+ USER blacklight
25
+
26
+ RUN gem install bundler && \
27
+ bundle config build.nokogiri --use-system-libraries && \
28
+ gem install rails -v $RAILS_VERSION
29
+
30
+ COPY --chown=blacklight . /gem
31
+
32
+ RUN rails new /app
33
+ WORKDIR /app
34
+ RUN echo "gem 'blacklight', '$BLACKLIGHT_VERSION'" >> Gemfile
35
+ RUN echo "gem 'blacklight-citeproc', path: '/gem'" >> Gemfile
36
+ RUN bundle install && \
37
+ bundle exec rails generate blacklight:install --devise && \
38
+ rails generate blacklight:citeproc:install && \
39
+ rails webpacker:install
40
+
41
+ COPY --chown=blacklight ./bin/entrypoint.sh bin/entrypoint.sh
42
+
43
+ CMD ["bin/entrypoint.sh"]
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ gemspec
data/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Jane Sandberg
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -84,3 +84,6 @@ en:
84
84
  apa: APA 6th Edition
85
85
  ```
86
86
 
87
+ ## Development
88
+
89
+ You can get a very simple blacklight app that uses this gem by running `docker-compose up -d`.
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task default: :spec
@@ -1,58 +1,63 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'bibtex'
2
4
  require 'citeproc'
5
+ require 'citeproc/ruby'
3
6
  require 'csl/styles'
4
7
 
5
- module Blacklight::Citeproc
6
- class BadConfigError < StandardError
7
- end
8
+ module Blacklight
9
+ module Citeproc
10
+ class BadConfigError < StandardError
11
+ end
8
12
 
9
- class CitationController < ApplicationController
10
- include Blacklight::Searchable
13
+ class CitationController < ApplicationController
14
+ include Blacklight::Bookmarks
15
+ include Blacklight::Searchable
11
16
 
12
- def initialize
13
- @processors = []
14
- @citations = []
17
+ def initialize
18
+ @processors = []
19
+ @citations = []
20
+ format = ::CiteProc::Ruby::Formats::Html.new bib_container: 'div', bib_entry: 'p'
15
21
 
16
- throw BadConfigError, 'Catalog controller needs a config.citeproc section' unless blacklight_config.citeproc
17
- @config = blacklight_config.citeproc
18
- @config[:styles].each do |style|
19
- @processors << ::CiteProc::Processor.new(format: 'html', style: style)
22
+ throw BadConfigError, 'Catalog controller needs a config.citeproc section' unless blacklight_config.citeproc
23
+ @config = blacklight_config.citeproc
24
+ @config[:styles].each do |style|
25
+ @processors << ::CiteProc::Processor.new(format: format, style: style)
26
+ end
20
27
  end
21
- end
22
28
 
23
- def print_single
24
- _, document = search_service.fetch(params[:id])
25
- bibtex = ::BibTeX::Bibliography.new
26
- bibtex << document.export_as(:bibtex)
29
+ def print_single
30
+ _, document = search_service.fetch(params[:id])
31
+ bibtex = ::BibTeX::Bibliography.new
32
+ bibtex << document.export_as(:bibtex)
27
33
 
28
- @processors.each do |processor|
29
- processor.import bibtex.to_citeproc
30
- citation = processor.render(:bibliography, id: params[:id]).first.tr('{}', '')
31
- @citations << {citation: citation.html_safe, label: processor.options[:style]}
34
+ @processors.each do |processor|
35
+ processor.import bibtex.to_citeproc
36
+ citation = processor.render(:bibliography, id: params[:id]).first.tr('{}', '')
37
+ @citations << { citation: citation.html_safe, label: processor.options[:style] }
38
+ end
39
+ render layout: false
32
40
  end
33
- render layout: false
34
- end
35
41
 
36
- def print_multiple ids
37
- _, documents = search_service.fetch(ids)
38
- bibtex = ::BibTeX::Bibliography.new
39
- documents.each do |document|
40
- bibtex << document.export_as(:bibtex)
42
+ def print_multiple(ids)
43
+ _, documents = search_service.fetch(ids)
44
+ bibtex = ::BibTeX::Bibliography.new
45
+ documents.each do |document|
46
+ bibtex << document.export_as(:bibtex)
47
+ end
48
+
49
+ @processors.each do |processor|
50
+ processor.import bibtex.to_citeproc
51
+ @citations << { citation: processor.bibliography.join.html_safe, label: processor.options[:style] }
52
+ end
53
+ render :print_single, layout: false
41
54
  end
42
55
 
43
- @processors.each do |processor|
44
- processor.import bibtex.to_citeproc
45
- bibliography = processor.render(:bibliography)
46
- @citations << {citation: bibliography.html_safe, label: processor.options[:style]}
56
+ def print_bookmarks
57
+ bookmarks = token_or_current_or_guest_user.bookmarks
58
+ bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
59
+ print_multiple bookmark_ids
47
60
  end
48
- render :print_single, layout: false
49
61
  end
50
-
51
- def print_bookmarks
52
- bookmarks = token_or_current_or_guest_user.bookmarks
53
- bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
54
- print_multiple bookmark_ids
55
- end
56
-
57
62
  end
58
63
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # This is a document extension meant to be mixed into a
2
4
  # Blacklight::Solr::Document class, such as SolrDocument. It provides support
3
5
  # for creating bibtex format from a Solr document.
@@ -11,46 +13,46 @@
11
13
 
12
14
  require 'bibtex'
13
15
 
14
- module Blacklight::Document::Bibtex
15
- def self.extended(document)
16
- Blacklight::Document::Bibtex.register_export_formats(document)
17
- end
18
-
19
- def self.register_export_formats(document)
20
- document.will_export_as(:bibtex, "application/x-bibtex")
21
- end
22
-
23
- def export_as_bibtex
24
- config = ::CatalogController.blacklight_config.citeproc
16
+ module Blacklight
17
+ module Document
18
+ module Bibtex
19
+ def self.extended(document)
20
+ Blacklight::Document::Bibtex.register_export_formats(document)
21
+ end
25
22
 
26
- entry = ::BibTeX::Entry.new
27
- entry.type = :book
28
- entry.key = self.id
29
- entry.title = self.first config[:fields][:title]
30
- multiple_valued_fields = %i{author editor}
31
- multiple_valued_fields.each do |field|
32
- entry.send("#{field}=", self.fetch(config[:fields][field])) if self.has? config[:fields][field]
33
- end
23
+ def self.register_export_formats(document)
24
+ document.will_export_as(:bibtex, 'application/x-bibtex')
25
+ end
34
26
 
35
- single_valued_fields = %i{address annote booktitle chapter doi edition how_published institution
36
- journal key month note number organization pages publisher school series url volume year}
37
- single_valued_fields.each do |field|
38
- entry.send("#{field}=", self.first(config[:fields][field])) if self.has? config[:fields][field]
39
- end
27
+ def export_as_bibtex
28
+ config = ::CatalogController.blacklight_config.citeproc
29
+
30
+ entry = ::BibTeX::Entry.new
31
+ entry.type = :book
32
+ entry.key = id
33
+ entry.title = first config[:fields][:title]
34
+ multiple_valued_fields = %i[author editor]
35
+ multiple_valued_fields.each do |field|
36
+ entry.send("#{field}=", fetch(config[:fields][field])) if has? config[:fields][field]
37
+ end
38
+
39
+ single_valued_fields = %i[address annote booktitle chapter doi edition how_published institution
40
+ journal key month note number organization pages publisher school series url volume year]
41
+ single_valued_fields.each do |field|
42
+ entry.send("#{field}=", first(config[:fields][field])) if has? config[:fields][field]
43
+ end
44
+
45
+ entry
46
+ end
40
47
 
41
- return entry
42
- end
48
+ private
43
49
 
44
- private
45
- def bibtex_type config
46
- config[:format][:mappings].each do |bibtex, solr|
47
- if solr.include? self.first config[:format][:field]
48
- return bibtex
50
+ def bibtex_type(config)
51
+ config[:format][:mappings].each do |bibtex, solr|
52
+ return bibtex if solr.include? first config[:format][:field]
53
+ end
54
+ config[:format][:default_format] || :book
49
55
  end
50
56
  end
51
- default_type = config[:format][:default_format] || :book
52
- return default_type
53
57
  end
54
-
55
58
  end
56
-