cff 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 734e15765062e2b7f6a00f25f89edec38c560be9c06605066dc8999ba6d46128
-  data.tar.gz: 3ad6ed8ff24203d521b356c2f5b73c304e501522f8b43b3aa7b7b890c54d59d9
+  metadata.gz: '0685f4e60680971f1d131ee18722cd4989631cc223a192197a226cf18b8deca4'
+  data.tar.gz: 2bc27bb586bd0056a631b992a1da78befae597d8cc3815f5e124a72aa0e50180
 SHA512:
-  metadata.gz: c873384b8a5dc7daea84ca0f184c457da397c4e21c9fbd64438328343bdd31481bfd7e4c48193fe074e8863961268f0adb72748e0aa73578cfffa80868366f56
-  data.tar.gz: 1a9f094a9d8f7739b6a118fb1b789f54eb58e961eab94fb864a604d3736e9dbf0567031372debba753f68fe4d59f43c348687bb6ab1cf747aba045d7abe267ac
+  metadata.gz: 2b36c030c352a815045c8ee5464f2c445802e99ab44a7caab1503029f785f740673b273949faf530593141497e9948652886d2a2761ea1f8f66cb6707be7bcb5
+  data.tar.gz: 0325a6308c04c27213a16d54fb657f2b94c3fbb554e838ab469d3c10ef737e57bc3150b58e68550605b51aa2b971d5d6560933686d124be74aa746f1fb8c6669

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Changes log for the Ruby CFF Library
 
+## 1.2.0
+
+* Always treat dates as Ruby Date objects.
+* BibTeX: escape special characters ($%&_#{}).
+
+## 1.1.0
+
+* BibTeX: output months as three letter abbreviations.
+
 ## 1.0.1
 
 * Handle missing family or given names for authors.

data/CITATION.cff

@@ -1,4 +1,4 @@
-# This CITATION.cff file was created by ruby-cff (v 1.0.1).
+# This CITATION.cff file was created by ruby-cff (v 1.2.0).
 # Gem: https://rubygems.org/gems/cff
 # CFF: https://citation-file-format.github.io/
 
@@ -21,9 +21,9 @@ keywords:
 - metadata
 - citation file format
 - CFF
-version: 1.0.1
+version: 1.2.0
 doi: 10.5281/zenodo.1184077
-date-released: 2022-11-05
+date-released: 2024-01-19
 license: Apache-2.0
 repository-artifact: https://rubygems.org/gems/cff
 repository-code: https://github.com/citation-file-format/ruby-cff

data/LICENCE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (c) 2018-2022 The Ruby Citation File Format Developers.
+   Copyright (c) 2018-2024 The Ruby Citation File Format Developers.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -203,7 +203,7 @@ cff.to_apalike(preferred_citation: false)
 
 #### A note on citation formats
 
-Due to the different expectations of different publication venues, the citation text may need minor tweaking to be used in specific situations. If you spot a major, or general, error in the output do [let us know](https://github.com/citation-file-format/ruby-cff/issues), but please check against the [BibTex](https://www.bibtex.com/format/) and [APA](https://apastyle.apa.org/style-grammar-guidelines/references) standards first.
+Due to the different expectations of different publication venues, the citation text may need minor tweaking to be used in specific situations. If you spot a major, or general, error in the output do [let us know](https://github.com/citation-file-format/ruby-cff/issues), but please check against the [BibTeX](https://www.bibtex.com/format/) and [APA](https://apastyle.apa.org/style-grammar-guidelines/references) standards first.
 
 ### Library versions
 

data/lib/cff/formatters/bibtex.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2022 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2024 The Ruby Citation File Format Developers.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,19 +38,30 @@ module CFF
         'unpublished' => %w[doi note!]
       }.freeze
 
-      def self.format(model:, preferred_citation: true) # rubocop:disable Metrics/AbcSize
+      # Convert months to three letter abbreviations, as per
+      # https://www.bibtex.com/f/month-field/. Need to downcase from the
+      # built-in set.
+      MONTHS_MAP = Date::ABBR_MONTHNAMES.map do |month|
+        month.downcase unless month.nil?
+      end.freeze
+
+      # We need to escape these characters in titles and names, as per
+      # https://tex.stackexchange.com/questions/34580/escape-character-in-latex
+      ESCAPE_CHARS = Regexp.new(/([&%$#_{}])/)
+
+      def self.format(model:, preferred_citation: true) # rubocop:disable Metrics
         model = select_and_check_model(model, preferred_citation)
         return if model.nil?
 
         values = {}
         values['author'] = actor_list(model.authors)
-        values['title'] = "{#{model.title}}"
+        values['title'] = "{#{l(model.title)}}"
 
         publication_type = bibtex_type(model)
         publication_data_from_model(model, publication_type, values)
 
         month, year = month_and_year_from_model(model)
-        values['month'] = month
+        values['month'] = MONTHS_MAP[month.to_i] unless month.empty?
         values['year'] = year
 
         values['url'] = url(model)
@@ -59,7 +70,8 @@ module CFF
 
         values.reject! { |_, v| v.empty? }
         sorted_values = values.sort.map do |key, value|
-          "#{key} = {#{value}}"
+          value = "{#{value}}" unless key == 'month'
+          "#{key} = #{value}"
         end
         sorted_values.insert(0, generate_citekey(values))
 
@@ -71,7 +83,7 @@ module CFF
       def self.publication_data_from_model(model, type, fields)
         ENTRY_TYPE_MAP[type].each do |field|
           if model.respond_to?(field)
-            fields[field] = model.send(field).to_s
+            fields[field] = l(model.send(field).to_s)
           else
             field = field.chomp('!')
             fields[field] = send("#{field}_from_model", model)
@@ -100,9 +112,9 @@ module CFF
       # BibTeX 'institution' could be grabbed from an author's affiliation, or
       # provided explicitly.
       def self.institution_from_model(model)
-        return model.institution.name unless model.institution.empty?
+        return l(model.institution.name) unless model.institution.empty?
 
-        model.authors.first.affiliation
+        l(model.authors.first.affiliation)
       end
 
       # BibTeX 'school' is CFF 'institution'.
@@ -117,7 +129,7 @@ module CFF
 
       # BibTeX 'booktitle' is CFF 'collection-title'.
       def self.booktitle_from_model(model)
-        model.collection_title
+        l(model.collection_title)
       end
 
       # BibTeX 'editor' is CFF 'editors' or 'editors-series'.
@@ -130,11 +142,11 @@ module CFF
       end
 
       def self.publisher_from_model(model)
-        model.publisher.empty? ? '' : model.publisher.name
+        model.publisher.empty? ? '' : l(model.publisher.name)
       end
 
       def self.series_from_model(model)
-        model.conference.empty? ? '' : model.conference.name
+        model.conference.empty? ? '' : l(model.conference.name)
       end
 
       # If we're citing a conference paper, try and use the date of the
@@ -174,9 +186,9 @@ module CFF
         end
       end
 
-      def self.format_actor(author)
-        return "{#{author.name}}" if author.is_a?(Entity)
-        return author.alias if author.family_names.empty? && author.given_names.empty?
+      def self.format_actor(author) # rubocop:disable Metrics/AbcSize
+        return "{#{l(author.name)}}" if author.is_a?(Entity)
+        return l(author.alias) if author.family_names.empty? && author.given_names.empty?
 
         particle =
           author.name_particle.empty? ? '' : "#{author.name_particle} "
@@ -201,6 +213,12 @@ module CFF
 
         Util.parameterize(reference)
       end
+
+      # Escape a string to preserve special characters in LaTeX output.
+      # Used in many places, so short method name to preserve reading flow.
+      def self.l(string)
+        string.gsub(ESCAPE_CHARS, '\\\\\1')
+      end
     end
   end
 end

data/lib/cff/formatters/formatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2022 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2023 The Ruby Citation File Format Developers.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -67,16 +67,9 @@ module CFF
       end
 
       def self.month_and_year_from_date(value)
-        if value.is_a?(Date)
-          [value.month, value.year].map(&:to_s)
-        else
-          begin
-            date = Date.parse(value.to_s)
-            [date.month, date.year].map(&:to_s)
-          rescue ArgumentError
-            ['', '']
-          end
-        end
+        return ['', ''] unless value.is_a?(Date)
+
+        [value.month, value.year].map(&:to_s)
       end
 
       # CFF 'pages' is the number of pages, which has no equivalent in BibTeX

data/lib/cff/model_part.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2022 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2023 The Ruby Citation File Format Developers.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -59,23 +59,57 @@ module CFF
       symbols.each do |symbol|
         field = symbol.to_s.tr('_', '-')
 
-        class_eval(
-          # def date_end=(date)
-          #   date = (date.is_a?(Date) ? date.dup : Date.parse(date))
-          #
-          #   @fields['date-end'] = date
-          # end
-          <<-END_SETTER, __FILE__, __LINE__ + 1
-            def #{symbol}=(date)
-              date = (date.is_a?(Date) ? date.dup : Date.parse(date))
-
-              @fields['#{field}'] = date
-            end
-          END_SETTER
-        )
+        date_getter(symbol, field)
+        date_setter(symbol, field)
       end
     end
 
+    def self.date_getter(symbol, field)
+      class_eval(
+        # def date_end
+        #   date = @fields['date-end']
+        #   return date if date.is_a?(Date)
+        #
+        #   begin
+        #     Date.parse(date)
+        #   rescue
+        #     ''
+        #   end
+        # end
+        <<-END_GETTER, __FILE__, __LINE__ + 1
+          def #{symbol}
+            date = @fields['#{field}']
+            return date if date.is_a?(Date)
+
+            begin
+              Date.parse(date)
+            rescue
+              ''
+            end
+          end
+        END_GETTER
+      )
+    end
+
+    def self.date_setter(symbol, field)
+      class_eval(
+        # def date_end=(date)
+        #   date = (date.is_a?(Date) ? date.dup : Date.parse(date))
+        #
+        #   @fields['date-end'] = date
+        # end
+        <<-END_SETTER, __FILE__, __LINE__ + 1
+          def #{symbol}=(date)
+            date = (date.is_a?(Date) ? date.dup : Date.parse(date))
+
+            @fields['#{field}'] = date
+          end
+        END_SETTER
+      )
+    end
+
+    private_class_method :date_getter, :date_setter
+
     private
 
     def method_to_field(name)

data/lib/cff/version.rb

@@ -17,7 +17,7 @@
 ##
 module CFF
   # :nodoc:
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
   DEFAULT_SPEC_VERSION = '1.2.0'
   MIN_VALIDATABLE_VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cff
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Robert Haines
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema