cff 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba4e9410b991789174bfa5cff1b448600aceb46a
-  data.tar.gz: ac13ec2b66c63edeaa5eb721b88fec6a4b7fd0da
+  metadata.gz: 330c0177c6b7fed7915ddeddbc8ba68a9eb9f9e3
+  data.tar.gz: '089cd1ad45d23af25bc1ccbac3b0ffffceedb570'
 SHA512:
-  metadata.gz: 807b056534179b4ae578259ef0c8fcc0a6a07d2782b4b134f9a790e99a682a82c9c632008ac8e76afbdd238b060f13c583b30bdb8b1c30c30a6c471230bf9661
-  data.tar.gz: 2caf814fc16b88fc4d9d70ce664d9a233e258c4460cce6547cca02fe424a5ee4d8d0fcc0bc2309045477901130f0cad97f5fbfce9aaba3b0067ecc4113c1a1b8
+  metadata.gz: 290ee6b5066a2f5d016ceff0416faf00f8f12df42c72e62b4642efa2a4d5afa64b32fc1a8e7843d3aec8a4165359445e7a2fd940e523a069a6f6509b181797d3
+  data.tar.gz: 0a99851ff3c46441be5fc86d3317bb2bc1828c5f4e5d15dbb8e507541feb9a73e4ff751a7fbd9355a8097ae42db3ac9bfb38428bd28aa5b981b8cb42a74b4cb9

data/CHANGES.md

@@ -0,0 +1,137 @@
+# Changes log for the Ruby CFF Library
+
+## Version 0.3.0
+
+* Update badges for new repo location.
+* Add back the coveralls badge for new repo location.
+* Update gemspec with new repo location.
+* Bump version number for 0.3.0 release.
+* Add a Reference model to represent references.
+* Wire the Reference model into Model and File.
+* Add authors field to Reference.
+* Read the author field properly when parsing a Reference.
+* Remove the ModelPart constructor.
+* Add the DOI badge to the README.
+* Add the simple string fields to Reference.
+* Add format field to Reference.
+* Move duplicated builder methods to Util module.
+* Remove the Util module from the public API.
+* Restrict reference type to the defined set.
+* Add Date type fields to the Reference model.
+* Add contact to the Reference model.
+* Add editors to the Reference model.
+* Add editors-series to the Reference model.
+* Add recipients to the Reference model.
+* Add senders to the Reference model.
+* Add translators to the Reference model.
+* Refactor the Reference#fields method for complexity.
+* Refactor the Model#to_yaml method for complexity.
+* Restrict reference status to the defined set.
+* Add languages to the Reference model.
+* Restrict reference licence to the SPDX Licence List.
+* Rename Util array_to_fields to expand_array_field.
+* Add a Util method expand_field.
+* Correctly read in the actor lists from a file.
+* Update quick start example in the README.
+* Add the integer fields to the Reference model.
+* Refactor Reference#fields to cope with single Entities.
+* Add the singular Entity fields to the Reference model.
+* Add issue-date field to the Reference model.
+* Add the keywords field to the Reference model.
+* Refactor keyword list initialization in Reference.
+* Add patent-states field to the Reference model.
+* Refactor Reference#keywords to be a standard field.
+* Refactor Reference#patent_states to be a field.
+* Extend the tests for Reference after the refactor.
+* Normalize Reference types when they are set.
+* Normalize the Reference status when set.
+* Add a note to the README about versioning.
+* Add a CHANGES file.
+
+## Version 0.2.0
+
+* Add a rubygems version badge to the README.
+* Add older rubies to the CI, but allow failures.
+* Add the licence to the gemspec.
+* Rename the ALLOWED_METHODS list to FIELDS.
+* Send missing methods straight to Model, from File.
+* Fix passing through arguments for missing methods (File).
+* Add a Util module with delete_from_hash as first utility.
+* Move method_to_field to the Util module.
+* Refactor for more complete parsing ability.
+* Freeze the allowed fields constant in Model.
+* Change allowed fields to be more flexible
+* Add abstract to Model.
+* Factor out the process of converting array fields to yaml.
+* Fix test for authors that was split incorrectly.
+* Add contact to Model.
+* Add tests to check capitalized fields are rejected.
+* Refactor model building for maintainability.
+* Add commit to the Model.
+* Add doi to the Model.
+* Add keywords to Model.
+* Fix #11: prevent serialization of empty collections.
+* Add license to Model.
+* Refactor testing simple fields.
+* Add license-url to Model.
+* Simplify parsing the keywords in Model.
+* Refactor testing reading complete CFF file.
+* Add repository* to Model.
+* Add url to Model.
+* Fix #12: typo in README example usage.
+* Add to the quick start example in the README.
+* Create a new base class (ModelPart) for parts of the model.
+* Add ModelPart#method_missing.
+* Add affiliation to Person, and tests for it too.
+* Add address to Entity, and tests for it too.
+* Add accessors for required fields on Person, Entity.
+* Add the rest of the optional fields in Person.
+* Add the rest of the simple fields in Entity.
+* Add the date fields in Entity.
+* Test dates in Entity with text inputs.
+
+## Version 0.1.0
+
+* Add a code of conduct.
+* Add Travis configuration.
+* Add licence text to all source files.
+* Add a Travis badge to the README.
+* Add a CodeClimate badge to the README.
+* Set up coveralls integration.
+* Add a coveralls badge to the README.
+* Add the current CFF spec version as the default.
+* Add a simple model class.
+* Message doesn't need to be passed to new.
+* Add title to model and wire into default message.
+* Add a method to set the message.
+* Remove the default values on ingestion.
+* Swap requires in main cff file.
+* Only set a default message on construction.
+* Add a File class to read and write CFF files.
+* Switch to using standard accessor for message field.
+* Streamline title output tests.
+* Add a set title method to Model and test it.
+* Turn off line wrapping in Model yaml output.
+* Fix #2. Don't include title in the default message.
+* Test that yaml output doesn't include the header.
+* Write cff from a String or Model.
+* Fix #3. Create a File from either a model or title.
+* When testing file loading, compare to yaml directly.
+* Test the message is loaded correctly into a File.
+* Add version to the Model and File APIs.
+* Add date-released to the Model and File APIs.
+* Fix cff_version test.
+* Move the Model class to a Hash-based implementation.
+* Initialize Model with a title or a Hash.
+* Update the File class to use the new Model class.
+* Use a method whitelist for Model and File.
+* Add a Person model to represent authors.
+* Add an Entity model to represent authors.
+
+## About this file
+
+This file is, at least in part, generated by the following command:
+
+```shell
+$ git log --pretty=format:"* %s" --reverse --no-merges <commit-hash>..
+```

data/README.md

@@ -3,10 +3,11 @@
 
 A Ruby library for manipulating CITATION.cff files.
 
+[![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)
-[![Build Status](https://travis-ci.org/hainesr/ruby-cff.svg?branch=master)](https://travis-ci.org/hainesr/ruby-cff)
-[![Maintainability](https://api.codeclimate.com/v1/badges/7eaa3890f17664e10bc6/maintainability)](https://codeclimate.com/github/hainesr/ruby-cff/maintainability)
-[![Coverage Status](https://coveralls.io/repos/github/hainesr/ruby-cff/badge.svg)](https://coveralls.io/github/hainesr/ruby-cff)
+[![Build Status](https://travis-ci.org/citation-file-format/ruby-cff.svg?branch=master)](https://travis-ci.org/citation-file-format/ruby-cff)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6bb4c661bfb4971260ba/maintainability)](https://codeclimate.com/github/citation-file-format/ruby-cff/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/citation-file-format/ruby-cff/badge.svg)](https://coveralls.io/github/citation-file-format/ruby-cff)
 
 ### Synopsis
 
@@ -18,7 +19,7 @@ See the [CITATION.cff documentation](https://citation-file-format.github.io/) fo
 
 ```ruby
 cff = CFF::Model.new("Ruby CFF Library")
-cff.version = "0.1.0"
+cff.version = CFF::VERSION
 cff.date_released = Date.today
 cff.authors << CFF::Person.new("Robert", "Haines")
 cff.license = "Apache-2.0"
@@ -34,8 +35,8 @@ Will produce a file that looks something like this:
 cff-version: 1.0.3
 message: If you use this software in your work, please cite it using the following metadata
 title: Ruby CFF Library
-version: 0.1.0
-date-released: 2018-02-24
+version: 0.3.0
+date-released: 2018-03-04
 license: Apache-2.0
 repository-artifact: https://rubygems.org/gems/cff
 authors:
@@ -47,6 +48,10 @@ keywords:
 - citation
 ```
 
+### Library versions
+
+Until this library reaches version 1.0.0 the API may be subject to breaking changes. When version 1.0.0 is released, then the principles of [semantic versioning](https://semver.org/) will be applied.
+
 ### Licence
 
 [Apache 2.0](http://www.apache.org/licenses/). See LICENCE for details.

data/Rakefile

@@ -26,7 +26,7 @@ end
 
 RDoc::Task.new do |r|
   r.main = "README.md"
-  r.rdoc_files.include("README.md", "LICENCE", "lib/**/*.rb")
+  r.rdoc_files.include("README.md", "LICENCE", "CHANGES.md", "lib/**/*.rb")
   r.options << "--markup=markdown"
   r.options << "--tab-width=2"
   r.options << "-t Ruby CFF Library version #{::CFF::VERSION}"

data/cff.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A Ruby library for manipulating CITATION.cff files."
   spec.description   = "See https://citation-file-format.github.io/ for more info."
-  spec.homepage      = "https://github.com/hainesr/ruby-cff"
+  spec.homepage      = "https://github.com/citation-file-format/ruby-cff"
   spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -36,6 +36,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.2.0"
 
+  spec.add_runtime_dependency "language_list", "~> 1.2"
+  spec.add_runtime_dependency "spdx-licenses", "~> 1.1"
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/cff/entity.rb

@@ -43,7 +43,7 @@ module CFF
     # Create a new Entity with the supplied name.
     def initialize(param)
       if Hash === param
-        super(param)
+        @fields = param
       else
         @fields = Hash.new('')
         @fields['name'] = param

data/lib/cff/model-part.rb

@@ -21,10 +21,6 @@ module CFF
 
     attr_reader :fields
 
-    def initialize(fields)
-      @fields = fields
-    end
-
     def method_missing(name, *args) # :nodoc:
       n = method_to_field(name.id2name)
       super unless self.class::ALLOWED_FIELDS.include?(n.chomp('='))

data/lib/cff/model.rb

@@ -49,6 +49,7 @@ module CFF
       @authors = []
       @contact = []
       @keywords = []
+      @references = []
 
       if Hash === param
         build_model(param)
@@ -118,6 +119,19 @@ module CFF
       @keywords
     end
 
+    # :call-seq:
+    #   references -> Array
+    #
+    # Return the list of references for this citation. To add a reference to the
+    # list, use:
+    #
+    # ```
+    # model.references << reference
+    # ```
+    def references
+      @references
+    end
+
     # :call-seq:
     #   version = version
     #
@@ -127,11 +141,6 @@ module CFF
     end
 
     def to_yaml # :nodoc:
-      fields = @fields.dup
-      fields['authors'] = array_field_to_yaml(@authors) unless @authors.empty?
-      fields['contact'] = array_field_to_yaml(@contact) unless @contact.empty?
-      fields['keywords'] = @keywords.map { |k| k.to_s } unless @keywords.empty?
-
       YAML.dump fields, :line_width => -1, :indentation => 2
     end
 
@@ -148,24 +157,29 @@ module CFF
 
     private
 
-    def build_model(fields)
-      build_entity_collection(@authors, fields['authors'])
-      build_entity_collection(@contact, fields['contact'])
-      @keywords = fields['keywords']
+    def fields
+      model = @fields.dup
+      [
+        ['authors', @authors],
+        ['contact', @contact],
+        ['references', @references]
+      ].each do |field, var|
+        model[field] = expand_array_field(var) unless var.empty?
+      end
+      model['keywords'] = @keywords.map { |k| k.to_s } unless @keywords.empty?
 
-      @fields = delete_from_hash(fields, 'authors', 'contact', 'keywords')
+      model
     end
 
-    def build_entity_collection(field, source)
-      source.each do |s|
-        field << (s.has_key?('given-names') ? Person.new(s) : Entity.new(s))
+    def build_model(fields)
+      build_actor_collection(@authors, fields['authors'])
+      build_actor_collection(@contact, fields['contact'])
+      @keywords = fields['keywords']
+      fields['references'].each do |r|
+        @references << Reference.new(r)
       end
-    end
 
-    def array_field_to_yaml(field)
-      field.reject do |f|
-        !f.respond_to?(:fields)
-      end.map { |f| f.fields }
+      @fields = delete_from_hash(fields, 'authors', 'contact', 'keywords', 'references')
     end
 
   end

data/lib/cff/person.rb

@@ -43,7 +43,7 @@ module CFF
     # Create a new Person with the supplied given and family names.
     def initialize(param, *more)
       if Hash === param
-        super(param)
+        @fields = param
       else
         @fields = Hash.new('')
         @fields['family-names'] = more[0]

data/lib/cff/reference.rb

@@ -0,0 +1,502 @@
+# Copyright (c) 2018 Robert Haines.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+module CFF
+
+  # Reference provides a reference pertaining to the software version or the
+  # software itself, e.g., a software paper describing the abstract concepts of
+  # the software, a paper describing an algorithm that has been implemented in
+  # the software version, etc.
+  class Reference < ModelPart
+
+    ALLOWED_FIELDS = [
+      'abbreviation',
+      'abstract',
+      'collection-doi',
+      'collection-title',
+      'collection-type',
+      'commit',
+      'conference',
+      'copyright',
+      'data-type',
+      'database',
+      'database-provider',
+      'date-accessed',
+      'date-downloaded',
+      'date-published',
+      'date-released',
+      'department',
+      'doi',
+      'edition',
+      'end',
+      'entry',
+      'filename',
+      'institution',
+      'isbn',
+      'issn',
+      'issue',
+      'issue-date',
+      'issue-title',
+      'journal',
+      'keywords',
+      'license',
+      'license-url',
+      'loc-end',
+      'loc-start',
+      'location',
+      'medium',
+      'month',
+      'nihmsid',
+      'notes',
+      'number',
+      'number-volumes',
+      'pages',
+      'patent-states',
+      'pmcid',
+      'publisher',
+      'repository',
+      'repository-code',
+      'repository-artifact',
+      'scope',
+      'section',
+      'start',
+      'status',
+      'thesis-type',
+      'title',
+      'type',
+      'url',
+      'version',
+      'volume',
+      'volume-title',
+      'year',
+      'year-original'
+    ].freeze # :nodoc:
+
+    # The [defined set of reference types](https://citation-file-format.github.io/1.0.3/specifications/#/reference-types).
+    REFERENCE_TYPES = [
+      'art',
+      'article',
+      'audiovisual',
+      'bill',
+      'blog',
+      'book',
+      'catalogue',
+      'conference',
+      'conference-paper',
+      'data',
+      'database',
+      'dictionary',
+      'edited-work',
+      'encyclopedia',
+      'film-broadcast',
+      'generic',
+      'government-document',
+      'grant',
+      'hearing',
+      'historical-work',
+      'legal-case',
+      'legal-rule',
+      'magazine-article',
+      'manual',
+      'map',
+      'multimedia',
+      'music',
+      'newspaper-article',
+      'pamphlet',
+      'patent',
+      'personal-communication',
+      'proceedings',
+      'report',
+      'serial',
+      'slides',
+      'software',
+      'software-code',
+      'software-container',
+      'software-executable',
+      'software-virtual-machine',
+      'sound-recording',
+      'standard',
+      'statute',
+      'thesis',
+      'unpublished',
+      'video',
+      'website'
+    ].freeze
+
+    # The [defined set of reference status types](https://citation-file-format.github.io/1.0.3/specifications/#/status-strings).
+    REFERENCE_STATUS_TYPES = [
+      'abstract',
+      'advance-online',
+      'in-preparation',
+      'in-press',
+      'pre-print',
+      'submitted'
+    ].freeze
+
+    # :call-seq:
+    #   new(title, type) -> Reference
+    #
+    # Create a new Reference with the supplied title and type. If type is not one of the [defined set of reference types](https://citation-file-format.github.io/1.0.3/specifications/#/reference-types), 'generic' will be used by default.
+    def initialize(param, *more)
+      @authors = []
+      @contact = []
+      @editors = []
+      @editors_series = []
+      @recipients = []
+      @senders = []
+      @translators = []
+
+      if Hash === param
+        build_model(param)
+      else
+        @fields = Hash.new('')
+        type = more[0].downcase
+        @fields['type'] = REFERENCE_TYPES.include?(type) ? type : 'generic'
+        @fields['title'] = param
+      end
+
+      [
+        'keywords',
+        'patent-states'
+      ].each { |field| @fields[field] = [] if @fields[field].empty? }
+    end
+
+    # :call-seq:
+    #   authors -> Array
+    #
+    # Return the list of authors for this Reference. To add an author to the
+    # list, use:
+    #
+    # ```
+    # reference.authors << author
+    # ```
+    #
+    # Authors can be a Person or Entity.
+    def authors
+      @authors
+    end
+
+    # :call-seq:
+    #   contact -> Array
+    #
+    # Return the list of contacts for this Reference. To add a contact to the
+    # list, use:
+    #
+    # ```
+    # reference.contact << contact
+    # ```
+    #
+    # Contacts can be a Person or Entity.
+    def contact
+      @contact
+    end
+
+    # :call-seq:
+    #   editors -> Array
+    #
+    # Return the list of editors for this Reference. To add an editor to the
+    # list, use:
+    #
+    # ```
+    # reference.editors << editor
+    # ```
+    #
+    # An editor can be a Person or Entity.
+    def editors
+      @editors
+    end
+
+    # :call-seq:
+    #   editors_series -> Array
+    #
+    # Return the list of series editors for this Reference. To add a series
+    # editor to the list, use:
+    #
+    # ```
+    # reference.editors_series << editor
+    # ```
+    #
+    # An editor can be a Person or Entity.
+    def editors_series
+      @editors_series
+    end
+
+    # :call-seq:
+    #   recipients -> Array
+    #
+    # Return the list of recipients for this Reference. To add a recipient
+    # to the list, use:
+    #
+    # ```
+    # reference.recipients << recipient
+    # ```
+    #
+    # Recipients can be a Person or Entity.
+    def recipients
+      @recipients
+    end
+
+    # :call-seq:
+    #   senders -> Array
+    #
+    # Return the list of senders for this Reference. To add a sender to the
+    # list, use:
+    #
+    # ```
+    # reference.senders << sender
+    # ```
+    #
+    # Senders can be a Person or Entity.
+    def senders
+      @senders
+    end
+
+    # :call-seq:
+    #   translators -> Array
+    #
+    # Return the list of translators for this Reference. To add a translator
+    # to the list, use:
+    #
+    # ```
+    # reference.translators << translator
+    # ```
+    #
+    # Translators can be a Person or Entity.
+    def translators
+      @translators
+    end
+
+    # :call-seq:
+    #   add_language language
+    #
+    # Add a language to this Reference. Input is converted to the ISO 639-3
+    # three letter language code, so `GER` becomes `deu`, `french` becomes
+    # `fra` and `en` becomes `eng`.
+    def add_language(lang)
+      @fields['languages'] = [] if @fields['languages'].empty?
+      lang = LanguageList::LanguageInfo.find(lang)
+      return if lang.nil?
+      lang = lang.iso_639_3
+      @fields['languages'] << lang unless @fields['languages'].include? lang
+    end
+
+    # :call-seq:
+    #   reset_languages
+    #
+    # Reset the list of languages for this Reference to be empty.
+    def reset_languages
+      @fields.delete('languages')
+    end
+
+    # :call-seq:
+    #   languages -> Array
+    #
+    # Return the list of languages associated with this Reference.
+    def languages
+      @fields['languages'].empty? ? [] : @fields['languages'].dup
+    end
+
+    # :call-seq:
+    #   license = license
+    #
+    # Set the license of this Reference. Only licenses that conform to the
+    # [SPDX License List](https://spdx.org/licenses/) will be accepted. If you
+    # need specify a different license you should set `license-url` with a link
+    # to the license instead.
+    def license=(lic)
+      @fields['license'] = lic unless SpdxLicenses.lookup(lic).nil?
+    end
+
+    # :call-seq:
+    #   date_accessed = date
+    #
+    # Set the `date-accessed` field. If a non-Date object is passed in it will
+    # be parsed into a Date.
+    def date_accessed=(date)
+      unless Date === date
+        date = Date.parse(date)
+      end
+
+      @fields['date-accessed'] = date
+    end
+
+    # :call-seq:
+    #   date_downloaded = date
+    #
+    # Set the `date-downloaded` field. If a non-Date object is passed in it will
+    # be parsed into a Date.
+    def date_downloaded=(date)
+      unless Date === date
+        date = Date.parse(date)
+      end
+
+      @fields['date-downloaded'] = date
+    end
+
+    # :call-seq:
+    #   date_published = date
+    #
+    # Set the `date-published` field. If a non-Date object is passed in it will
+    # be parsed into a Date.
+    def date_published=(date)
+      unless Date === date
+        date = Date.parse(date)
+      end
+
+      @fields['date-published'] = date
+    end
+
+    # :call-seq:
+    #   date_released = date
+    #
+    # Set the `date-released` field. If a non-Date object is passed in it will
+    # be parsed into a Date.
+    def date_released=(date)
+      unless Date === date
+        date = Date.parse(date)
+      end
+
+      @fields['date-released'] = date
+    end
+
+    # :call-seq:
+    #   format -> String
+    #
+    # Returns the format of this Reference.
+    def format
+      @fields['format']
+    end
+
+    # :call-seq:
+    #   format = format
+    #
+    # Sets the format of this Reference.
+    def format=(fmt)
+      @fields['format'] = fmt
+    end
+
+    # :call-seq:
+    #   status = status
+    #
+    # Sets the status of this Reference. The status is restricted to a
+    # [defined set of status types](https://citation-file-format.github.io/1.0.3/specifications/#/status-strings).
+    def status=(status)
+      status.downcase!
+      @fields['status'] = status if REFERENCE_STATUS_TYPES.include?(status)
+    end
+
+    # :call-seq:
+    #   type = type
+    #
+    # Sets the type of this Reference. The type is restricted to a
+    # [defined set of reference types](https://citation-file-format.github.io/1.0.3/specifications/#/reference-types).
+    def type=(type)
+      type.downcase!
+      @fields['type'] = type if REFERENCE_TYPES.include?(type)
+    end
+
+    # Override superclass #fields as References contain model parts too.
+    def fields # :nodoc:
+      ref = {}
+
+      @fields.each do |field, value|
+        if value.respond_to?(:map)
+          ref[field] = value.map { |v| v.to_s } unless value.empty?
+        else
+          ref[field] = value.respond_to?(:fields) ? value.fields : value
+        end
+      end
+
+      [
+        ['authors', @authors],
+        ['contact', @contact],
+        ['editors', @editors],
+        ['editors-series', @editors_series],
+        ['recipients', @recipients],
+        ['senders', @senders],
+        ['translators', @translators]
+      ].each do |field, var|
+        ref[field] = expand_array_field(var) unless var.empty?
+      end
+
+      ref
+    end
+
+    private
+
+    def build_model(fields)
+      build_actor_collection(@authors, fields['authors'])
+      build_actor_collection(@contact, fields['contact'])
+      build_actor_collection(@editors, fields['editors'])
+      build_actor_collection(@editors_series, fields['editors-series'])
+      build_actor_collection(@recipients, fields['recipients'])
+      build_actor_collection(@senders, fields['senders'])
+      build_actor_collection(@translators, fields['translators'])
+
+      @fields = delete_from_hash(fields, 'authors', 'contact', 'editors', 'editors-series', 'recipients', 'senders', 'translators')
+    end
+
+    public
+
+    # Some documentation of "hidden" methods is provided here, out of the
+    # way of the main class code.
+
+    ##
+    # :method: keywords
+    # :call-seq:
+    #   keywords -> Array
+    #
+    # Return the list of keywords for this reference. To add a keyword to the
+    # list, use:
+    #
+    # ```
+    # model.keywords << keyword
+    # ```
+    #
+    # Keywords will be converted to Strings on output.
+
+    ##
+    # :method: keywords=
+    # :call-seq:
+    #   keywords = array_of_keywords -> Array
+    #
+    # Replace the list of keywords for this reference.
+    #
+    # Keywords will be converted to Strings on output.
+
+    ##
+    # :method: patent_states
+    # :call-seq:
+    #   patent_states -> Array
+    #
+    # Return the list of patent states for this reference. To add a patent
+    # state to the list, use:
+    #
+    # ```
+    # model.patent_states << patent_state
+    # ```
+    #
+    # Patent states will be converted to Strings on output.
+
+    ##
+    # :method: patent_states=
+    # :call-seq:
+    #   patent_states = array_of_states -> Array
+    #
+    # Replace the list of patent states for this reference.
+    #
+    # Patent states will be converted to Strings on output.
+  end
+end

data/lib/cff/util.rb

@@ -15,27 +15,37 @@
 #
 module CFF
 
+  # :stopdoc:
   # Utility methods useful throughout the rest of the CFF library.
+  # This module is not in the public API.
   module Util
 
-    # :call-seq:
-    #   delete_from_hash(hash, keys...) -> Hash
-    #
-    # Returns a hash that includes everything but the given keys.
     def delete_from_hash(hash, *keys)
       h = hash.dup
       keys.each { |key| h.delete(key) }
       h
     end
 
-    # :call-seq:
-    #   method_to_field(name) -> converted name
-    #
-    # Return the supplied name with underscores converted to dashes.
     def method_to_field(name)
       name.gsub('_', '-')
     end
 
-  end
+    def build_actor_collection(field, source)
+      source.each do |s|
+        field << (s.has_key?('given-names') ? Person.new(s) : Entity.new(s))
+      end
+    end
+
+    def expand_field(field)
+      field.fields if field.respond_to?(:fields)
+    end
 
+    def expand_array_field(field)
+      field.reject do |f|
+        !f.respond_to?(:fields)
+      end.map { |f| f.fields }
+    end
+
+  end
+  # :startdoc:
 end

data/lib/cff/version.rb

@@ -15,6 +15,6 @@
 #
 module CFF
   # :nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
   DEFAULT_SPEC_VERSION = "1.0.3"
 end

data/lib/cff.rb

@@ -14,12 +14,15 @@
 
 require "date"
 require "yaml"
+require "language_list"
+require "spdx-licenses"
 
 require "cff/version"
 require "cff/util"
 require "cff/model-part"
 require "cff/person"
 require "cff/entity"
+require "cff/reference"
 require "cff/model"
 require "cff/file"
 

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: cff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: language_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: spdx-licenses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +133,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGES.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENCE
@@ -119,9 +148,10 @@ files:
 - lib/cff/model-part.rb
 - lib/cff/model.rb
 - lib/cff/person.rb
+- lib/cff/reference.rb
 - lib/cff/util.rb
 - lib/cff/version.rb
-homepage: https://github.com/hainesr/ruby-cff
+homepage: https://github.com/citation-file-format/ruby-cff
 licenses:
 - Apache-2.0
 metadata: {}