asciidoctor-csl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ce78146d55d20de4621859574c6bbdc2cefa673f8712c7149c0370bc121cf12
+  data.tar.gz: be41bf38def6db2dc0608d6e5d0dbedf50f2abeaa439e78429dc7bf4db11aff0
+SHA512:
+  metadata.gz: 9449c142d9f2b667a8cd73e569eb61b889957ce49ceb9ad9221720f40e0e6870eb4154f9b2bffcd07b8b4db94ce203e0dccdd135781a1418f73358ea57d191cd
+  data.tar.gz: af718af924f6876712b042a24e40112327fddf1ceac50c51cea26c0f3e1e7e3b09139059fca5592189cd24d8a5dde028503def04bd49dbbd83b99409b35eb1eb

data/LICENSE.txt

@@ -0,0 +1,287 @@
+                      EUROPEAN UNION PUBLIC LICENCE v. 1.2
+                      EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
+below) which is provided under the terms of this Licence. Any use of the Work,
+other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work:
+
+        Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+
+- ‘The Licence’: this Licence.
+
+- ‘The Original Work’: the work or software distributed or communicated by the
+  Licensor under this Licence, available as Source Code and also as Executable
+  Code as the case may be.
+
+- ‘Derivative Works’: the works or software that could be created by the
+  Licensee, based upon the Original Work or modifications thereof. This Licence
+  does not define the extent of modification or dependence on the Original Work
+  required in order to classify a work as a Derivative Work; this extent is
+  determined by copyright law applicable in the country mentioned in Article 15.
+
+- ‘The Work’: the Original Work or its Derivative Works.
+
+- ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+- ‘The Executable Code’: any code which has generally been compiled and which is
+  meant to be interpreted by a computer as a program.
+
+- ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+
+- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
+  Licence, or otherwise contributes to the creation of a Derivative Work.
+
+- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+
+- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright vested
+in the Original Work:
+
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case may
+  be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make effective
+the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
+any patents held by the Licensor, to the extent necessary to make use of the
+rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates, in
+a notice following the copyright notice attached to the Work, a repository where
+the Source Code is easily and freely accessible for as long as the Licensor
+continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits from
+any exception or limitation to the exclusive rights of the rights owners in the
+Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and a
+copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of the
+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions on
+the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed under
+a Compatible Licence, this Distribution or Communication can be done under the
+terms of this Compatible Licence. For the sake of this clause, ‘Compatible
+Licence’ refers to the licences listed in the appendix attached to this Licence.
+Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible
+Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work,
+the Licensee will provide a machine-readable copy of the Source Code or indicate
+a repository where this Source will be easily and freely available for as long
+as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade names,
+trademarks, service marks, or names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings
+to the Work are owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis
+and without warranties of any kind concerning the Work, including without
+limitation merchantability, fitness for a particular purpose, absence of defects
+or errors, accuracy, non-infringement of intellectual property rights other than
+copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition
+for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the use
+of the Work, including without limitation, damages for loss of goodwill, work
+stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such damage.
+However, the Licensor will be liable under statutory product liability laws as
+far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional agreement,
+defining obligations or services consistent with this Licence. However, if
+accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor harmless
+for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
+placed under the bottom of a window displaying the text of this Licence or by
+affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this Licence,
+such as the use of the Work, the creation by You of a Derivative Work or the
+Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of electronic
+communication by You (for example, by offering to download the Work from a
+remote location) the distribution channel or media (for example, a website) must
+at least provide to the public the information requested by the applicable law
+regarding the Licensor, the Licence and the way it may be accessible, concluded,
+stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has
+received the Work from the Licensee under the Licence, provided such persons
+remain in full compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of
+this Licence or updated versions of the Appendix, so far this is required and
+reasonable, without reducing the scope of the rights granted by the Licence. New
+versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+
+- any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty on
+  the Functioning of the European Union,
+
+- any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive jurisdiction
+  of the competent court where the Licensor resides or conducts its primary
+  business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+
+- this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+
+- this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
+- Open Software License (OSL) v. 2.1, v. 3.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
+  Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above
+licences without producing a new version of the EUPL, as long as they provide
+the rights granted in Article 2 of this Licence and protect the covered Source
+Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new
+EUPL version.

data/README.adoc

@@ -0,0 +1,116 @@
+= asciidoctor-csl: CSL integration for AsciiDoc
+
+asciidoctor-csl adds CSL integration for AsciiDoc.
+The macros to use are heavily inspired by https://github.com/asciidoctor-contrib/asciidoctor-bibtex[asciidoctor-bibtex].
+It is thus not possible to use both at the same time.
+
+Note: this gem is new and subject to change.
+
+== Use
+
+Loading the extension:
+
+[source,shell]
+----
+asciidoctor -r asciidoctor-csl document.adoc
+----
+
+You need to configure which bibliography file to use, in https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html[CSL-JSON] (`.json`), or as YAML (`.yml` or `.yaml`):
+
+[source,asciidoc]
+----
+= My document
+:csl-file: references.json
+:csl-style: apa
+
+As shown by cite:smith2020[], ...
+
+== References
+
+bibliography::[]
+----
+
+=== Configuration
+
+These document attributes configure the extension:
+
+`csl-file`::
+The bibliography file, relative to the document.
+Required: without it, the macros are not rendered.
+
+`csl-style`::
+The citation style, as the name of a style from https://github.com/citation-style-language/styles[the CSL style repository], e.g. `apa`, `ieee`, or `chicago-notes-bibliography-17th-edition`.
+Defaults to `ieee`.
+
+`csl-lang`::
+The language used for terms such as "p." or "and".
+Defaults to the `lang` attribute of the document, or `en` if that is not set.
+
+=== Citations
+
+`cite:key[]` cites a source.
+Cite multiple sources in one citation with commas: `cite:smith2020,doe2019[]`.
+
+The macro accepts these options:
+
+[cols="1,3"]
+|===
+|Attribute |Description
+
+|locator (1st positional)
+|The location in the source, e.g. `cite:smith2020[12]`.
+Quote values containing a comma: `cite:smith2020["12, 14"]`.
+
+|label (2nd positional)
+|The kind of locator, e.g. `cite:smith2020[3, chapter]`.
+Defaults to `page`.
+Other values are `book`, `column`, `figure`, `folio`, `issue`, `line`, `note`, `opus`, `paragraph`, `part`, `section`, `sub-verbo`, `verse` and `volume` (supports all options from citeproc).
+
+|`prefix`
+|Text placed before the citation, e.g. `cite:smith2020[prefix=see]`.
+
+|`suffix`
+|Text placed after the citation, e.g. `cite:smith2020[suffix=for details]`.
+
+|`link`
+|If the document has a bibliography, each cited item links to its entry.
+Use `link=false` to disable this for a single citation.
+|===
+
+With multiple keys, the locator and suffix apply to the last source, and the prefix to the first.
+Footnotes are supported as well.
+Citations in section titles are not supported.
+
+=== Bibliography
+
+`bibliography::[]` renders the bibliography.
+By default, it only renders the cited sources.
+Use `bibliography::[select=all]` to include everything in the bibliography.
+
+Each entry gets an anchor with the source's key as ID, like `<<smith2020>>`.
+
+=== Single entries
+
+`bibitem:key[]` renders the entry of a single source inline.
+It does not count as a citation: the source is not added to the bibliography and does not affect the numbering.
+
+== Citation Style Language support
+
+The gem supports almost everything that its CSL processor (`citeproc`) supports.
+A few tweaks are done to make it work better with AsciiDoc:
+
+* The gem renders quotes as https://docs.asciidoctor.org/asciidoc/latest/text/quotation-marks-and-apostrophes/["curly"] quotes, so AsciiDoctor will render them. Use a good output template, like https://github.com/niknetniko/asciidoctor-html5s[`asciidoctor-html5s`]
+* The source of the CSL bibliography is parsed as AsciiDoc. This means:
+  - You can add formatting inside your bibliography using AsciiDoc
+  - The gem does not support `citeproc-js`'s default for inline HTML. A straight export from Zotero probably won't work with all AsciiDoc's output formats (but should work when outputting HTML).
+
+== How does it work?
+
+This gem works by using https://github.com/inukshuk/citeproc-ruby[citeproc-ruby] and https://github.com/inukshuk/csl-styles[csl-styles] to render the items.
+It includes a citeproc plugin to render to AsciiDoc natively.
+Otherwise, it is mostly a thin layer between AsciiDoctor and those gems.
+
+== License
+
+This gem is published under the EUPL 1.2.
+See the LICENSE.txt file.

data/lib/asciidoctor-csl/bibitem_macro.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require 'citeproc'
+
+module AsciidoctorCsl
+  # BibitemMacro
+  #
+  # The `bibitem:key1[]` macro.
+  class BibitemMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+    include ::Asciidoctor::Logging
+
+    use_dsl
+
+    named :bibitem
+
+    attr_accessor :processor
+
+    def process(parent, target, _attributes)
+      entry = processor&.render_entry(target)
+      if entry.nil?
+        logger.warn "bibitem: unknown reference: #{target}"
+        return create_inline parent, :quoted, "[#{target}]"
+      end
+
+      create_inline parent, :quoted, entry, attributes: { 'subs' => :normal }
+    end
+  end
+end

data/lib/asciidoctor-csl/bibliography_macro.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+module AsciidoctorCsl
+  # BibliographyBlockMacro
+  #
+  # Provides the bibliography block macro. (bibliography::[select=cited])
+  class BibliographyBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+    include ::Asciidoctor::Logging
+
+    use_dsl
+    named :bibliography
+
+    def blocks
+      @blocks ||= []
+    end
+
+    def render_all?
+      @render_all
+    end
+
+    def process(parent, _target, attrs)
+      case attrs['select']
+      when nil, 'cited' then nil
+      when 'all' then @render_all = true
+      else
+        logger.warn "bibliography: unknown value for select attribute: #{attrs['select']}"
+      end
+
+      block = create_block parent, :open, nil, { 'role' => 'bibliography' }
+      blocks << block
+      block
+    end
+  end
+end

data/lib/asciidoctor-csl/citation_macro.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require 'citeproc'
+
+module AsciidoctorCsl
+  # CitationMacro
+  #
+  # The `cite:key1,key2[locator, label, prefix=..., suffix=..., link=false]` macro.
+  class CitationMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+    include ::Asciidoctor::Logging
+
+    use_dsl
+
+    named :cite
+    name_positional_attributes 'locator', 'label'
+
+    attr_accessor :csl
+
+    # Whether the document has a bibliography with entries to link to.
+    attr_writer :bibliography
+
+    def process(parent, target, attributes)
+      keys = target.split(',').map(&:strip)
+      unknown, known = keys.partition { |key| csl.nil? || !csl.key?(key) }
+
+      logger.warn "cite: unknown references: #{unknown.join(', ')}" unless unknown.empty?
+      return create_inline parent, :quoted, "[#{keys.join(', ')}]" if known.empty?
+
+      items = known.map { |key| { id: key } }
+      items.first[:prefix] = "#{attributes['prefix']} " if attributes['prefix']
+
+      if attributes['locator']
+        items.last[:locator] = attributes['locator']
+        label = attributes['label'] || 'page'
+        unless CiteProc::CitationItem.labels.include?(label.to_sym)
+          allowed = CiteProc::CitationItem.labels.join(', ')
+          logger.warn "cite: unknown locator label '#{label}', expected one of #{allowed}"
+        end
+        items.last[:label] = label
+      end
+
+      items.last[:suffix] = ", #{attributes['suffix']}" if attributes['suffix']
+
+      if csl.nil?
+        logger.warn 'cite: CSL style not found'
+        return nil
+      end
+
+      csl.engine.format.link_citations = @bibliography && attributes['link'] != 'false'
+      text = csl.render(:citation, items)
+      # Support footnote styles
+      text = "footnote:[#{text.gsub(']', '\\]')}]" if csl.engine.style.info.citation_format == :note
+
+      create_inline parent, :quoted, text, attributes: { 'subs' => :normal }
+    end
+  end
+end

data/lib/asciidoctor-csl/citation_processor.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module AsciidoctorCsl
+  # CitationProcessor
+  #
+  # AsciiDoc tree processor for CSL
+  class CitationProcessor < ::Asciidoctor::Extensions::TreeProcessor
+    include ::Asciidoctor::Logging
+
+    def process(document)
+      csl_file = (document.attr 'csl-file').to_s
+      csl_style = ((document.attr 'csl-style') || 'ieee').to_s
+      csl_lang = (document.attr('csl-lang') || document.attr('lang') || 'en').to_s
+
+      return if csl_file.empty?
+
+      # The cite macros
+      cite = document.extensions.inline_macros.map(&:instance).find { |m| m.name == :cite }
+      bibitem = document.extensions.inline_macros.map(&:instance).find { |m| m.name == :bibitem }
+
+      path_to_csl = document.normalize_system_path csl_file, document.base_dir
+      processor = Processor.new path_to_csl, csl_style, csl_lang
+
+      # Collect all cited keys, in appearance order.
+      document.find_by(traverse_documents: true) { |b| prose?(b) }.each do |block|
+        raw_texts(block).each do |text|
+          text.scan(cite.regexp) do
+            match = Regexp.last_match
+            processor.add_citations match[1].split(',') unless match[0].start_with?('\\')
+          end
+        end
+      end
+
+      bibliography = document.extensions.find_block_macro_extension(:bibliography).instance
+      # Make processor finalize macro processing as required.
+      processor.finalize_macro_processing render_all: bibliography.render_all?
+      # Provide the Citeproc renderer
+      cite.csl = processor.citeproc
+      cite.bibliography = !bibliography.blocks.empty?
+      bibitem.processor = processor
+
+      bibliography.blocks.each { |block| parse_content block, processor.build_bibliography_list }
+
+      nil
+    end
+
+    private
+
+    def prose?(block)
+      block.content_model == :simple || block.context == :list_item ||
+        block.context == :table_cell || block.title?
+    end
+
+    def raw_texts(block)
+      texts = []
+      texts << block.instance_variable_get(:@title) if block.title?
+      if %i[list_item table_cell].include?(block.context)
+        texts << block.instance_variable_get(:@text)
+      elsif block.content_model == :simple
+        texts.concat block.lines
+      end
+      texts.compact
+    end
+  end
+end

data/lib/asciidoctor-csl/citeproc_patches.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'citeproc'
+require 'citeproc/ruby'
+
+module AsciidoctorCsl
+  module CiteprocPatches
+    # Leaks suppressed variables into later renders.
+    module SeparateSuppression
+      def initialize_copy(other)
+        super
+        @suppressed = nil
+      end
+    end
+
+    # Wrap each cited item in a cross-reference to its bibliography entry,
+    # leaving the prefix, suffix and delimiters outside the link.
+    module LinkCitations
+      def render_single_citation(item, node)
+        return super unless format.respond_to?(:link_citations) && format.link_citations
+
+        item.suppress! 'author' if item.suppress_author?
+
+        text = render_layout(item, node)
+        text = "<<#{item.id},#{text}>>" unless text.empty?
+        join [item.prefix, text, item.suffix].compact
+      end
+    end
+  end
+end
+
+CiteProc::Item.prepend AsciidoctorCsl::CiteprocPatches::SeparateSuppression
+CiteProc::Ruby::Renderer.prepend AsciidoctorCsl::CiteprocPatches::LinkCitations

data/lib/asciidoctor-csl/csl_renderer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module AsciidoctorCsl
+  # Render CSL directly to AsciiDoc.
+  class Asciidoc < CiteProc::Ruby::Format
+    include ::Asciidoctor::Logging
+
+    PROTECTED_RX = /<<[^,>]+,|\{[\w-]+}|\b[a-z][\w-]*:\S*?\[[^\]]*\]|\[[^\]]*\](?=#)|\+\+\+.*?\+\+\+|\+[^+]+\+/
+    PLACEHOLDER_RX = /\u0000(\d+)\u0000/
+
+    # Whether rendered citations link to their bibliography entry.
+    attr_accessor :link_citations
+
+    def bibliography(bibliography, _locale = nil)
+      bibliography.connector = "\n\n"
+      bibliography
+    end
+
+    def apply_font_style
+      case options[:'font-style']
+      when 'italic', 'oblique'
+        # AsciiDoc does not support oblique, so italicize it.
+        output.replace "__#{output}__"
+      when 'normal' then nil
+      else
+        logger.warn "csl: unsupported font-style '#{options[:'font-style']}'"
+      end
+    end
+
+    def apply_font_variant
+      case options[:'font-variant']
+      when 'small-caps' then output.replace "[.small-caps]###{output}##"
+      when 'normal' then nil
+      else
+        logger.warn "csl: unsupported font-variant '#{options[:'font-variant']}'"
+      end
+    end
+
+    def apply_font_weight
+      case options[:'font-weight']
+      when 'bold' then output.replace "**#{output}**"
+      when 'normal', 'light'
+        # AsciiDoc does not support light font variant, so use normal.
+        nil
+      else
+        logger.warn "csl: unsupported font-weight '#{options[:'font-weight']}'"
+      end
+    end
+
+    def apply_text_decoration
+      case options[:'text-decoration']
+      when 'underline' then output.replace "[.underline]###{output}##"
+      when 'none' then nil
+      else
+        logger.warn "csl: unsupported text-decoration '#{options[:'text-decoration']}'"
+      end
+    end
+
+    def apply_vertical_align
+      case options[:'vertical-align']
+      when 'sup' then output.replace "^#{output.gsub(' ', '{nbsp}')}^"
+      when 'sub' then output.replace "~#{output.gsub(' ', '{nbsp}')}~"
+      when 'baseline' then nil
+      else
+        logger.warn "csl: unsupported vertical-align '#{options[:'vertical-align']}'"
+      end
+    end
+
+    # Replace the AsciiDoc syntax by placeholders without letters, so we only transform actual text.
+    def apply_text_case
+      protected = []
+      output.gsub!(PROTECTED_RX) do
+        protected << Regexp.last_match(0)
+        "\u0000#{protected.size - 1}\u0000"
+      end
+      super
+    ensure
+      output.gsub!(PLACEHOLDER_RX) { protected[Regexp.last_match(1).to_i] } if protected
+    end
+  end
+end

data/lib/asciidoctor-csl/extensions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+require_relative 'processor'
+require_relative 'citation_processor'
+require_relative 'citation_macro'
+require_relative 'bibitem_macro'
+require_relative 'bibliography_macro'
+
+# Register the extensions to asciidoctor
+Asciidoctor::Extensions.register do
+  block_macro AsciidoctorCsl::BibliographyBlockMacro
+  inline_macro AsciidoctorCsl::CitationMacro
+  inline_macro AsciidoctorCsl::BibitemMacro
+  treeprocessor AsciidoctorCsl::CitationProcessor
+end

data/lib/asciidoctor-csl/processor.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+#
+# Manage the current set of citations, the document settings,
+# and main operations.
+#
+
+require 'citeproc/ruby'
+require 'csl/styles'
+require 'json'
+require 'yaml'
+require 'date'
+
+require_relative 'citeproc_patches'
+require_relative 'csl_renderer'
+
+module AsciidoctorCsl
+  # Class used through utility method to hold data about citations for
+  # current document, and run the different steps to add the citations
+  # and bibliography
+  class Processor
+    include ::Asciidoctor::Logging
+
+    # AsciiDoc curved quotes, so the converter decides how quotes look,
+    # consistent with the rest of the document.
+    QUOTE_TERMS = {
+      'open-quote' => '"`',
+      'close-quote' => '`"',
+      'open-inner-quote' => "'`",
+      'close-inner-quote' => "`'"
+    }.freeze
+
+    attr_reader :citeproc
+
+    def initialize(
+      bibliography_file,
+      style = 'ieee',
+      locale = 'en'
+    )
+      raise "File '#{bibliography_file}' is not found" unless FileTest.file? bibliography_file
+
+      @style = style
+      @locale = locale
+
+      # Citations in the order they appear in the document
+      @citations = []
+
+      @citeproc = new_citeproc
+      @bibliography = read_bibliography_file(bibliography_file).to_h { |item| [item['id'].to_s, item] }
+    end
+
+    # Register the appearance of a citation key.
+    def add_citations(keys)
+      @citations.concat keys.map(&:strip)
+    end
+
+    def render_entry(key)
+      return nil unless @bibliography.key?(key)
+
+      entries.render(:bibliography, id: key).first
+    end
+
+    # Finalize citation macro processing and build internal citation list.
+    #
+    # As this function being called, processor will clean up the list of
+    # citation keys to form a correct ordered citation list.
+    def finalize_macro_processing(render_all: false)
+      @citations = @citations.uniq
+
+      keys = render_all ? @citations | @bibliography.keys : @citations
+      @citeproc.import(keys.filter_map { |key| @bibliography[key] })
+
+      @rendered = @citeproc.bibliography
+
+      @rendered.ids.each_with_index do |id, i|
+        @citeproc[id][:'citation-number'] = i + 1
+      end
+      nil
+    end
+
+    def build_bibliography_list
+      @rendered.ids.zip(@rendered.references).flat_map do |id, reference|
+        ["[[#{id}]]#{reference}", '']
+      end
+    end
+
+    private
+
+    def read_bibliography_file(bibliography_file)
+      case File.extname(bibliography_file).downcase
+      when '.json' then JSON.parse(File.read(bibliography_file))
+      when '.yml', '.yaml' then YAML.safe_load_file(bibliography_file, permitted_classes: [Date])
+      else
+        raise "Bibliography file must have .json, .yml, or .yaml extension, got #{File.extname(bibliography_file)}"
+      end
+    end
+
+    def entries
+      @entries ||= new_citeproc.tap { |citeproc| citeproc.import @bibliography.values }
+    end
+
+    def new_citeproc
+      citeproc = CiteProc::Processor.new style: @style, format: :asciidoc, locale: @locale
+      use_asciidoc_quotes citeproc
+      citeproc
+    end
+
+    # Override the quote handling by inserting dynamic AsciiDoc quotes.
+    # That way, AsciiDoc handles the quotes, and it is consistent with the rest of the document.
+    def use_asciidoc_quotes(processor)
+      locale = processor.engine.renderer.locale
+      QUOTE_TERMS.each do |name, value|
+        term = locale.terms.lookup(name)
+        term ? term.set(value) : locale.store(name, value)
+      end
+    end
+  end
+end

data/lib/asciidoctor-csl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AsciidoctorCsl
+  VERSION = '0.1.0'
+end

data/lib/asciidoctor-csl.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'asciidoctor-csl/version'
+require_relative 'asciidoctor-csl/extensions'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-csl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Niko Strijbol
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: csl-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: asciidoctor-csl is an Asciidoctor extension that adds CSL support for
+  AsciiDoc documents.
+email:
+- niko@strijbol.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.adoc
+- lib/asciidoctor-csl.rb
+- lib/asciidoctor-csl/bibitem_macro.rb
+- lib/asciidoctor-csl/bibliography_macro.rb
+- lib/asciidoctor-csl/citation_macro.rb
+- lib/asciidoctor-csl/citation_processor.rb
+- lib/asciidoctor-csl/citeproc_patches.rb
+- lib/asciidoctor-csl/csl_renderer.rb
+- lib/asciidoctor-csl/extensions.rb
+- lib/asciidoctor-csl/processor.rb
+- lib/asciidoctor-csl/version.rb
+homepage: https://github.com/niknetniko/asciidoctor-csl
+licenses:
+- EUPL-1.2
+metadata:
+  source_code_uri: https://github.com/niknetniko/asciidoctor-csl
+  bug_tracker_uri: https://github.com/niknetniko/asciidoctor-csl/issues
+  changelog_uri: https://github.com/niknetniko/asciidoctor-csl/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: An Asciidoctor extension that adds CSL integration to AsciiDoc
+test_files: []