cff 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0685f4e60680971f1d131ee18722cd4989631cc223a192197a226cf18b8deca4'
-  data.tar.gz: 2bc27bb586bd0056a631b992a1da78befae597d8cc3815f5e124a72aa0e50180
+  metadata.gz: aa0896639724d0e82551bf84fde9801a00974dac14e120dafa51b53bc07c33cb
+  data.tar.gz: 0ef577895dff069272703c4c063dc5a84e1e484be6c23ce696592803093c43f7
 SHA512:
-  metadata.gz: 2b36c030c352a815045c8ee5464f2c445802e99ab44a7caab1503029f785f740673b273949faf530593141497e9948652886d2a2761ea1f8f66cb6707be7bcb5
-  data.tar.gz: 0325a6308c04c27213a16d54fb657f2b94c3fbb554e838ab469d3c10ef737e57bc3150b58e68550605b51aa2b971d5d6560933686d124be74aa746f1fb8c6669
+  metadata.gz: 63ae9c19849721bb92af374493b8930d75d7bb3bfbbc6e14a8f1fad0bbbf39064c635f5c03f5d2828bc507b33f65dea69d194a640f6be212bf6088fc3238b9f0
+  data.tar.gz: 5101768a4a0ab8de6176ba2506c98ad5efce62f517f34146feaa8a114939e2154f415ac1cdb4162e4b7407c7bdf3e3bdba1f8c7b06c4b5f714b68f620f402bc6

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changes log for the Ruby CFF Library
 
+## 1.3.0
+
+* Abstract out parsing YAML.
+* Turn on underlying support for YAML anchors/aliases.
+
 ## 1.2.0
 
 * Always treat dates as Ruby Date objects.

data/CITATION.cff

@@ -1,4 +1,4 @@
-# This CITATION.cff file was created by ruby-cff (v 1.2.0).
+# This CITATION.cff file was created by ruby-cff (v 1.3.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.2.0
+version: 1.3.0
 doi: 10.5281/zenodo.1184077
-date-released: 2024-01-19
+date-released: 2024-10-26
 license: Apache-2.0
 repository-artifact: https://rubygems.org/gems/cff
 repository-code: https://github.com/citation-file-format/ruby-cff

data/README.md

@@ -122,6 +122,30 @@ CFF::File.open('CITATION.cff') do |cff|
 end
 ```
 
+#### Notes on CFF files with YAML anchors and aliases
+
+Ruby CFF can read files that use YAML anchors and aliases. An anchor (`&<label>`) identifies a section of your file for reuse elsewhere. An alias (`*<label>`) is then used to mark where you want that section to be repeated. In this example, the `&authors` anchor marks an author list for reuse wherever the `*authors` alias is used:
+
+```yaml
+cff-version: 1.2.0
+title: Ruby CFF Library
+authors: &authors
+- family-names: Haines
+  given-names: Robert
+  affiliation: The University of Manchester, UK
+
+...
+
+references:
+  - type: software
+    title: Citation File Format
+    authors: *authors
+```
+
+Ruby uses a single object to represent all aliases of an anchor. This means that once the above has been read in by Ruby CFF, if you add an author to either the top-level author list, or the author list in the reference, the new author will appear in both places. With this in mind, you should only use anchors and aliases where the relationship between sections is such that you are sure that exact repetition will always make sense.
+
+When saving CFF files that use anchors and aliases the underlying YAML library will not preserve their names. For example, if the above is loaded into Ruby CFF and then immediately saved `&authors`/`*authors` will most likely become `&1`/`*1`.
+
 ### Validating CFF files
 
 To quickly validate a file and raise an error on failure, you can use `CFF::File` directly:

data/lib/cff/file.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.
@@ -19,7 +19,6 @@ require_relative 'index'
 require_relative 'version'
 
 require 'date'
-require 'yaml'
 
 ##
 module CFF
@@ -71,9 +70,7 @@ module CFF
       content = ::File.read(file)
       comment = File.parse_comment(content)
 
-      new(
-        file, YAML.safe_load(content, permitted_classes: [Date, Time]), comment
-      )
+      new(file, Util.parse_yaml(content), comment)
     end
 
     # :call-seq:
@@ -91,7 +88,7 @@ module CFF
       if ::File.exist?(file)
         content = ::File.read(file)
         comment = File.parse_comment(content)
-        yaml = YAML.safe_load(content, permitted_classes: [Date, Time])
+        yaml = Util.parse_yaml(content)
       else
         comment = CFF_COMMENT
         yaml = ''

data/lib/cff/index.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.
@@ -25,8 +25,6 @@ require_relative 'schema'
 require_relative 'validatable'
 require_relative 'citable'
 
-require 'yaml'
-
 ##
 module CFF
   # Index is the core data structure for a CITATION.cff file. It can be
@@ -100,7 +98,7 @@ module CFF
     #
     # Read a CFF Index from a String and parse it for subsequent manipulation.
     def self.read(index)
-      new(YAML.safe_load(index, permitted_classes: [Date, Time]))
+      new(Util.parse_yaml(index))
     end
 
     # :call-seq:

data/lib/cff/util.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.
@@ -19,6 +19,7 @@ require_relative 'person'
 require_relative 'version'
 
 require 'rubygems'
+require 'yaml'
 
 ##
 module CFF
@@ -30,6 +31,10 @@ module CFF
 
     module_function
 
+    def parse_yaml(string)
+      YAML.safe_load(string, aliases: true, permitted_classes: [Date, Time])
+    end
+
     def update_cff_version(version)
       return '' if version.nil? || version.empty?
 
@@ -44,6 +49,8 @@ module CFF
     # is a Person or Entity. This isn't perfect, but works 99.99% I think.
     def build_actor_collection!(source)
       source.map! do |s|
+        next s if s.is_a?(Person) || s.is_a?(Entity)
+
         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.2.0'
+  VERSION = '1.3.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.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Robert Haines
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-10-26 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.3.23
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A Ruby library for manipulating CITATION.cff files.