cff 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c050f5d10f432c5f693e34a3e357d6f6cb6354a34f1437e2d002d31260a668
-  data.tar.gz: 77a28d90a783419770aa706b033fc16895aa33762b1bf1e8d63f283e949b52b8
+  metadata.gz: 3516244b4f8ca79e358adb6a561ea0d1007590b1fc34686eff2566444e465381
+  data.tar.gz: 6ad965bc59a6acf7cfa1a0737ed97bbd994e4fabdb64551eb7bdef6d32411534
 SHA512:
-  metadata.gz: 20af71ee0317e192bccd3cd2a4e8e2be39c8bab84b9c4c74571968b80d519d292b2b7f2564aa5786fe995fddedfa90edea76058e400bd0971b1d805e0256b9ab
-  data.tar.gz: e38acde51d42a67b37c197c9d03e55fbe2a55ec5f3ee2e2632c1842a6292035831ac55acfd8ded8812bda8dc06d96578b2dcf28870f29f1d6fc0c855df758ba8
+  metadata.gz: 822d9b5f9e260d6bec6bbf9fa2891951b10319feca11f5c899431c86143fcdbde0b874ec9fcd598307ffd5b731578f8979d712375f65cfd7092617e5bd3dcf02
+  data.tar.gz: 122e43d2a21f50b897204e15d4d497cd95cea23a0de1d25a6efc744ca4316e9c5c09fab681e572e8bf66900a4bd40bcbfdf34ecb19e42168c484ca3bbf852d66

data/CHANGES.md

@@ -1,5 +1,16 @@
 # Changes log for the Ruby CFF Library
 
+## 1.1.0
+
+* BibTeX: output months as three letter abbreviations.
+
+## 1.0.1
+
+* Handle missing family or given names for authors.
+* Handle authors with only an alias for a name.
+* Add install instructions to the README.
+* Add a note to the README re output format changes.
+
 ## 1.0.0
 
 * Add `type` to top-level CFF model.

data/CITATION.cff

@@ -1,4 +1,4 @@
-# This CITATION.cff file was created by ruby-cff (v 1.0.0).
+# This CITATION.cff file was created by ruby-cff (v 1.1.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.0
+version: 1.1.0
 doi: 10.5281/zenodo.1184077
-date-released: 2022-10-09
+date-released: 2023-04-10
 license: Apache-2.0
 repository-artifact: https://rubygems.org/gems/cff
 repository-code: https://github.com/citation-file-format/ruby-cff

data/README.md

@@ -5,7 +5,7 @@ A Ruby library for creating, editing, validating and converting CITATION.cff fil
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1184077.svg)](https://doi.org/10.5281/zenodo.1184077)
 [![Gem Version](https://badge.fury.io/rb/cff.svg)](https://badge.fury.io/rb/cff)
-[![Tests](https://github.com/citation-file-format/ruby-cff/actions/workflows/ruby.yml/badge.svg)](https://github.com/citation-file-format/ruby-cff/actions/workflows/ruby.yml)
+[![Tests](https://github.com/citation-file-format/ruby-cff/actions/workflows/tests.yml/badge.svg)](https://github.com/citation-file-format/ruby-cff/actions/workflows/ruby.yml)
 [![Linter](https://github.com/citation-file-format/ruby-cff/actions/workflows/lint.yml/badge.svg)](https://github.com/citation-file-format/ruby-cff/actions/workflows/lint.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 [![Maintainability](https://api.codeclimate.com/v1/badges/6bb4c661bfb4971260ba/maintainability)](https://codeclimate.com/github/citation-file-format/ruby-cff/maintainability)
@@ -21,6 +21,23 @@ See the [CITATION.cff documentation](https://citation-file-format.github.io/) fo
 
 See the [full API documentation](https://citation-file-format.github.io/ruby-cff/) for more details about Ruby CFF.
 
+### Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'cff'
+```
+
+And then execute:
+```shell
+$ bundle
+```
+
+Or install it yourself with:
+```shell
+$ gem install cff
+```
+
 ### Quick start
 
 You can quickly build and save a CFF index like this:
@@ -192,6 +209,8 @@ Due to the different expectations of different publication venues, the citation
 
 From version 1.0.0 onwards, the principles of [semantic versioning](https://semver.org/) are applied when numbering releases with new features or breaking changes.
 
+Minor or stylistic changes to output formats are not considered "breaking" for the purposes of library versioning.
+
 ### Developing Ruby CFF
 
 Please see our [Code of Conduct](https://github.com/citation-file-format/ruby-cff/blob/main/CODE_OF_CONDUCT.md) and our [contributor guidelines](https://github.com/citation-file-format/ruby-cff/blob/main/CONTRIBUTING.md).

data/lib/cff/formatters/apalike.rb

@@ -136,9 +136,25 @@ module CFF
 
         particle =
           author.name_particle.empty? ? '' : "#{author.name_particle} "
-        suffix = author.name_suffix.empty? ? '.' : "., #{author.name_suffix}"
+        suffix = author.name_suffix.empty? ? '' : ", #{author.name_suffix}"
 
-        "#{particle}#{author.family_names}, #{initials(author.given_names)}#{suffix}"
+        "#{particle}#{format_name(author)}#{suffix}"
+      end
+
+      # Format a name using an alias if needs be.
+      # https://blog.apastyle.org/apastyle/2012/02/how-to-cite-pseudonyms.html
+      def self.format_name(author)
+        if author.family_names.empty?
+          if author.given_names.empty?
+            author.alias
+          else
+            author.given_names
+          end
+        elsif author.given_names.empty?
+          author.family_names
+        else
+          "#{author.family_names}, #{initials(author.given_names)}."
+        end
       end
     end
   end

data/lib/cff/formatters/bibtex.rb

@@ -38,7 +38,14 @@ 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
+
+      def self.format(model:, preferred_citation: true) # rubocop:disable Metrics
         model = select_and_check_model(model, preferred_citation)
         return if model.nil?
 
@@ -50,7 +57,7 @@ module CFF
         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 +66,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))
 
@@ -176,6 +184,7 @@ module CFF
 
       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?
 
         particle =
           author.name_particle.empty? ? '' : "#{author.name_particle} "

data/lib/cff/util.rb

@@ -40,9 +40,11 @@ module CFF
       end
     end
 
+    # Currently need to make some sort of guess as to whether an actor
+    # is a Person or Entity. This isn't perfect, but works 99.99% I think.
     def build_actor_collection!(source)
       source.map! do |s|
-        s.has_key?('given-names') ? Person.new(s) : Entity.new(s)
+        s.has_key?('name') ? Entity.new(s) : Person.new(s)
       end
     end
 

data/lib/cff/version.rb

@@ -17,7 +17,7 @@
 ##
 module CFF
   # :nodoc:
-  VERSION = '1.0.0'
+  VERSION = '1.1.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.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Haines
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.23
 signing_key:
 specification_version: 4
 summary: A Ruby library for manipulating CITATION.cff files.