cff 0.9.0 → 1.0.0

data/lib/cff/identifier.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2021 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2022 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.
@@ -14,9 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative 'model_part'
+require_relative 'schema'
+
 ##
 module CFF
-
   # An Identifier represents an identifier in a CITATION.cff file.
   #
   # Identifier implements all of the fields listed in the
@@ -29,11 +31,13 @@ module CFF
   # * `type`
   # * `value`
   class Identifier < ModelPart
-
-    ALLOWED_FIELDS = ['description', 'type', 'value'].freeze # :nodoc:
+    ALLOWED_FIELDS = # :nodoc:
+      SCHEMA_FILE['definitions']['identifier']['anyOf'].first['properties'].keys.dup.freeze
 
     # The [defined set of identifier types](https://github.com/citation-file-format/citation-file-format/blob/main/README.md#identifier-type-strings).
-    IDENTIFIER_TYPES = ['doi', 'url', 'swh', 'other'].freeze
+    IDENTIFIER_TYPES = SCHEMA_FILE['definitions']['identifier']['anyOf'].map do |id|
+      id['properties']['type']['enum'].first
+    end.freeze
 
     # :call-seq:
     #   new -> Identifier
@@ -44,15 +48,16 @@ module CFF
     # Create a new Identifier with the optionally supplied type and value.
     # If the supplied type is invalid, then neither the type or value are set.
     def initialize(param = nil, *more)
+      super()
+
       if param.is_a?(Hash)
         @fields = param
-        @fields.default = ''
       else
-        @fields = Hash.new('')
+        @fields = {}
 
         unless param.nil?
           self.type = param
-          @fields['value'] = more[0] unless @fields['type'].empty?
+          @fields['value'] = more[0] unless @fields['type'].nil?
         end
       end
 

data/lib/cff/{model.rb → index.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2021 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2022 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.
@@ -14,19 +14,31 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative 'util'
+require_relative 'model_part'
+require_relative 'entity'
+require_relative 'identifier'
+require_relative 'licensable'
+require_relative 'person'
+require_relative 'reference'
+require_relative 'schema'
+require_relative 'validatable'
+require_relative 'citable'
+
+require 'yaml'
+
 ##
 module CFF
-
-  # Model is the core data structure for a CITATION.cff file. It can be
+  # Index is the core data structure for a CITATION.cff file. It can be
   # accessed direcly, or via File.
   #
-  # Model implements all of the fields listed in the
+  # Index implements all of the fields listed in the
   # [CFF standard](https://citation-file-format.github.io/). Complex
   # fields - `authors`, `contact`, `identifiers`, `keywords`,
-  # `preferred-citation` and `references` - are documented below. All other
-  # fields are simple strings and can be set as such. A field which has not
-  # been set will return the empty string. The simple fields are (with defaults
-  # in parentheses):
+  # `preferred-citation`, `references` and `type` - are documented below. All
+  # other fields are simple strings and can be set as such. A field which has
+  # not been set will return the empty string. The simple fields are (with
+  # defaults in parentheses):
   #
   # * `abstract`
   # * `cff_version`
@@ -43,63 +55,63 @@ module CFF
   # * `title`
   # * `url`
   # * `version`
-  class Model < ModelPart
-
+  class Index < ModelPart
+    include Citable
     include Licensable
     include Validatable
 
-    ALLOWED_FIELDS = [
-      'abstract', 'authors', 'cff-version', 'contact', 'commit',
-      'date-released', 'doi', 'identifiers', 'keywords', 'license',
-      'license-url', 'message', 'preferred-citation', 'references',
-      'repository', 'repository-artifact', 'repository-code', 'title',
-      'url', 'version'
-    ].freeze # :nodoc:
+    ALLOWED_FIELDS = SCHEMA_FILE['properties'].keys.freeze # :nodoc:
+
+    # The allowed CFF [types](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#type).
+    MODEL_TYPES = SCHEMA_FILE['properties']['type']['enum'].dup.freeze
 
     # The default message to use if none is explicitly set.
     DEFAULT_MESSAGE = 'If you use this software in your work, please cite ' \
                       'it using the following metadata'
 
+    attr_date :date_released
+
     # :call-seq:
-    #   new(title) -> Model
-    #   new(title) { |model| block } -> Model
+    #   new(title) -> Index
+    #   new(title) { |index| block } -> Index
     #
-    # Initialize a new Model with the supplied title.
+    # Initialize a new Index with the supplied title.
     def initialize(param)
+      super()
+
       if param.is_a?(Hash)
-        @fields = build_model(param)
-        @fields.default = ''
+        @fields = build_index(param)
       else
-        @fields = Hash.new('')
+        @fields = {}
         @fields['cff-version'] = DEFAULT_SPEC_VERSION
         @fields['message'] = DEFAULT_MESSAGE
         @fields['title'] = param
       end
 
       %w[authors contact identifiers keywords references].each do |field|
-        @fields[field] = [] if @fields[field].empty?
+        @fields[field] = [] if @fields[field].nil? || @fields[field].empty?
       end
 
       yield self if block_given?
     end
 
     # :call-seq:
-    #   read(String) -> Model
+    #   read(String) -> Index
     #
-    # Read a CFF Model from a String and parse it for subsequent manipulation.
-    def self.read(model)
-      new(YAML.safe_load(model, permitted_classes: [Date, Time]))
+    # 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]))
     end
 
     # :call-seq:
-    #   open(String) -> Model
-    #   open(String) { |cff| block } -> Model
+    #   open(String) -> Index
+    #   open(String) { |cff| block } -> Index
     #
-    # With no associated block, Model.open is a synonym for ::read. If the
-    # optional code block is given, it will be passed the parsed model as an
-    # argument and the Model will be returned when the block terminates.
-    def self.open(model)
-      cff = Model.read(model)
+    # With no associated block, Index.open is a synonym for ::read. If the
+    # optional code block is given, it will be passed the parsed index as an
+    # argument and the Index will be returned when the block terminates.
+    def self.open(index)
+      cff = Index.read(index)
 
       yield cff if block_given?
 
@@ -107,61 +119,33 @@ module CFF
     end
 
     # :call-seq:
-    #   date_released = date
+    #   type = type
     #
-    # Set the `date-released` field. If a non-Date object is passed in it will
-    # be parsed into a Date.
-    def date_released=(date)
-      date = Date.parse(date) unless date.is_a?(Date)
-
-      @fields['date-released'] = date
+    # Sets the type of this CFF Index. The type is currently restricted to one
+    # of `software` or `dataset`. If this field is not set then you should
+    # assume that the type is `software`.
+    def type=(type)
+      type = type.downcase
+      @fields['type'] = type if MODEL_TYPES.include?(type)
     end
 
     def to_yaml # :nodoc:
       YAML.dump fields, line_width: -1, indentation: 2
     end
 
-    # :call-seq:
-    #   to_apalike(preferred_citation: true) -> String
-    #
-    # Output this Model in an APA-like format. Setting
-    # `preferred_citation: true` will honour the `preferred_citation` field in
-    # the model if one is present (default).
-    #
-    # *Note:* This method assumes that this Model is valid when called.
-    def to_apalike(preferred_citation: true)
-      CFF::ApaFormatter.format(
-        model: self, preferred_citation: preferred_citation
-      )
-    end
-
-    # :call-seq:
-    #   to_bibtex(preferred_citation: true) -> String
-    #
-    # Output this Model in BibTeX format. Setting
-    # `preferred_citation: true` will honour the `preferred_citation` field in
-    # the model if one is present (default).
-    #
-    # *Note:* This method assumes that this Model is valid when called.
-    def to_bibtex(preferred_citation: true)
-      CFF::BibtexFormatter.format(
-        model: self, preferred_citation: preferred_citation
-      )
-    end
-
     private
 
     def fields
       %w[authors contact identifiers references].each do |field|
-        normalize_modelpart_array!(@fields[field])
+        Util.normalize_modelpart_array!(@fields[field])
       end
 
-      fields_to_hash(@fields)
+      Util.fields_to_hash(@fields)
     end
 
-    def build_model(fields) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-      build_actor_collection!(fields['authors'] || [])
-      build_actor_collection!(fields['contact'] || [])
+    def build_index(fields) # rubocop:disable Metrics
+      Util.build_actor_collection!(fields['authors'] || [])
+      Util.build_actor_collection!(fields['contact'] || [])
       (fields['identifiers'] || []).map! do |i|
         Identifier.new(i)
       end
@@ -172,7 +156,7 @@ module CFF
         Reference.new(fields['preferred-citation'])
 
       # Only attempt an update of the `cff-version` field if it is present.
-      fields['cff-version'] &&= update_cff_version(fields['cff-version'])
+      fields['cff-version'] &&= Util.update_cff_version(fields['cff-version'])
 
       fields
     end
@@ -191,7 +175,7 @@ module CFF
     # list, use:
     #
     # ```
-    # model.authors << author
+    # index.authors << author
     # ```
     #
     # Authors can be a Person or Entity.
@@ -214,7 +198,7 @@ module CFF
     # list, use:
     #
     # ```
-    # model.contact << contact
+    # index.contact << contact
     # ```
     #
     # Contacts can be a Person or Entity.
@@ -237,7 +221,7 @@ module CFF
     # the list, use:
     #
     # ```
-    # model.identifiers << identifier
+    # index.identifiers << identifier
     # ```
 
     ##
@@ -256,7 +240,7 @@ module CFF
     # list, use:
     #
     # ```
-    # model.keywords << keyword
+    # index.keywords << keyword
     # ```
     #
     # Keywords will be converted to Strings on output.
@@ -293,7 +277,7 @@ module CFF
     # list, use:
     #
     # ```
-    # model.references << reference
+    # index.references << reference
     # ```
 
     ##

data/lib/cff/licensable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2021 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2022 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.
@@ -14,12 +14,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative 'schema'
+
 ##
 module CFF
-
   # Functionality to add licence(s) to parts of the CFF model.
   module Licensable
-
     LICENSES = SCHEMA_FILE['definitions']['license-enum']['enum'].dup.freeze # :nodoc:
 
     # :call-seq:

data/lib/cff/model_part.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2021 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2022 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.
@@ -14,18 +14,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'date'
+
 ##
 module CFF
-
-  # ModelPart is the superclass of anything that makes up part of the CFF Model.
-  # This includes Model, Person, Entity and Reference.
+  # ModelPart is the superclass of anything that makes up part of the CFF Index.
+  # This includes Index, Person, Entity and Reference.
   #
-  # ModelPart does not provide any methods or fields for the public API.
+  # ModelPart provides only one method for the public API: `empty?`.
   class ModelPart
-
     # :stopdoc:
-    include Util
-
     attr_reader :fields
 
     def method_missing(name, *args)
@@ -35,7 +33,7 @@ module CFF
       if n.end_with?('=')
         @fields[n.chomp('=')] = args[0] || ''
       else
-        @fields[n]
+        @fields[n].nil? ? '' : @fields[n]
       end
     end
 
@@ -43,7 +41,45 @@ module CFF
       n = method_to_field(name.id2name)
       self.class::ALLOWED_FIELDS.include?(n.chomp('=')) || super
     end
-
     # :startdoc:
+
+    # :call-seq:
+    #   empty? -> false
+    #
+    # Define `empty?` for CFF classes so that they can be tested in the
+    # same way as strings and arrays.
+    #
+    # This always returns `false` because CFF classes always return something
+    # from all of their methods.
+    def empty?
+      false
+    end
+
+    def self.attr_date(*symbols) # :nodoc:
+      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
+        )
+      end
+    end
+
+    private
+
+    def method_to_field(name)
+      name.tr('_', '-')
+    end
   end
 end

data/lib/cff/person.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2021 The Ruby Citation File Format Developers.
+# Copyright (c) 2018-2022 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.
@@ -14,9 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative 'model_part'
+require_relative 'schema'
+
 ##
 module CFF
-
   # A Person represents a person in a CITATION.cff file. A Person might have a
   # number of roles, such as author, contact, editor, etc.
   #
@@ -43,12 +45,7 @@ module CFF
   # * `tel`
   # * `website`
   class Person < ModelPart
-
-    ALLOWED_FIELDS = [
-      'address', 'affiliation', 'alias', 'city', 'country', 'email',
-      'family-names', 'fax', 'given-names', 'name-particle', 'name-suffix',
-      'orcid', 'post-code', 'region', 'tel', 'website'
-    ].freeze # :nodoc:
+    ALLOWED_FIELDS = SCHEMA_FILE['definitions']['person']['properties'].keys.freeze # :nodoc:
 
     # :call-seq:
     #   new -> Person
@@ -58,11 +55,12 @@ module CFF
     #
     # Create a new Person with the optionally supplied given and family names.
     def initialize(param = nil, *more)
+      super()
+
       if param.is_a?(Hash)
         @fields = param
-        @fields.default = ''
       else
-        @fields = Hash.new('')
+        @fields = {}
 
         unless param.nil?
           @fields['family-names'] = more[0]