Merge pull request #8025 from CenterForOpenScience/revert-8022-revert-7595-citation

Revert "[REVERT][OSF-3622] Disallow user to choose citation styles with no bibliography section.""

Author: brianjgeiger

osf/migrations/0073_citationstyle_has_bibliography.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.7 on 2017-12-04 14:53
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('osf', '0072_merge_20171128_1018'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='citationstyle',
+            name='has_bibliography',
+            field=models.BooleanField(default=False),
+        ),
+    ]

osf/models/citation.py

@@ -23,6 +23,7 @@ class CitationStyle(BaseModel):
 
     short_title = models.CharField(max_length=2048, null=True, blank=True)
     summary = models.CharField(max_length=4200, null=True, blank=True)  # longest value was 3,812 8/23/2016
+    has_bibliography = models.BooleanField(default=False)
 
     class Meta:
         ordering = ['_id']
@@ -33,4 +34,5 @@ def to_json(self):
             'title': self.title,
             'short_title': self.short_title,
             'summary': self.summary,
+            'has_bibliography': self.has_bibliography
         }

scripts/parse_citation_styles.py

@@ -1,6 +1,24 @@
 #!/usr/bin/env python
 # encoding: utf-8
 
+"""
+This script is modified in this PR (https://github.com/CenterForOpenScience/osf.io/pull/7595)
+to set the corresponding `has_bibliography` flag to `False` for all citation formats whose CSL file do not
+include a bibliography section. As a result, all such citation formats would not show up in OSF
+citation widgets for users to choose.
+
+NOTE:
+As of August 25th, 2017, there are however THREE EXCEPTIONS:
+"Bluebook Law Review", "Bluebook Law Review(2)" and "Bluebook Inline" shares a
+special CSL file ('website/static/bluebook.cls'), in which a bibliography section is defined,
+for rendering bibliographies even though their official CSL files (located in assets folder)
+do not contain a bibliography section.
+The side effect is that, upon parsing all the CSL files in the assets folder, these three citation
+formats are marked as `has_bibliography=False`, preventing them from user selection on the front end.
+Therefore, intervention is needed to manually "turn on" their 'has_bibliography' flag for them to show
+on the citation widget.
+"""
+
 import os
 
 from lxml import etree
@@ -10,7 +28,6 @@
 setup_django()
 from osf.models.citation import CitationStyle
 
-
 def main():
 
     # drop all styles
@@ -32,6 +49,8 @@ def main():
             fields = {
                 '_id': os.path.splitext(os.path.basename(style_file))[0],
                 'title': root.find(selector + 'title').text,
+                'has_bibliography': True if root.find(
+                    '{{{ns}}}{tag}'.format(ns=namespace, tag='bibliography')) is not None else False
             }
 
             # Optional

website/citations/views.py

@@ -21,7 +21,7 @@ def list_citation_styles():
             Q(short_title__icontains=query)
         )
     return {
-        'styles': [style.to_json() for style in citation_styles]
+        'styles': [style.to_json() for style in citation_styles if style.has_bibliography]
     }