cff 0.8.0 → 1.0.0

data/lib/cff/validatable.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,25 +14,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative 'errors'
+require_relative 'schema'
+
 require 'json_schema'
 
 ##
 module CFF
-
   # Methods to validate CFF files/models against a formal schema.
   module Validatable
-
-    # :nodoc:
-    SCHEMA = JsonSchema.parse!(SCHEMA_FILE)
+    SCHEMA = JsonSchema.parse!(SCHEMA_FILE) # :nodoc:
 
     # :call-seq:
     #   validate!(fail_fast: false)
     #
-    # Validate a CFF file or model and raise a ValidationError upon failure.
-    # If an error is raised it will contain the detected validation failures
-    # for further inspection. Setting `fail_fast` to true will fail validation
-    # at the first detected failure, rather than gathering and returning all
-    # failures.
+    # Validate a CFF file or model (Index) and raise a ValidationError upon
+    # failure. If an error is raised it will contain the detected validation
+    # failures for further inspection. Setting `fail_fast` to true will fail
+    # validation at the first detected failure, rather than gathering and
+    # returning all failures.
     def validate!(fail_fast: false)
       result = validate(fail_fast: fail_fast)
       return if result[0]
@@ -43,9 +43,9 @@ module CFF
     # :call-seq:
     #   validate(fail_fast: false) -> Array
     #
-    # Validate a CFF file or model and return an array with the result. The
-    # result array is a two-element array, with `true`/`false` at index 0 to
-    # indicate pass/fail, and an array of errors at index 1 (if any).
+    # Validate a CFF file or model (Index) and return an array with the result.
+    # The result array is a two-element array, with `true`/`false` at index 0
+    # to indicate pass/fail, and an array of errors at index 1 (if any).
     # Setting `fail_fast` to true will fail validation at the first detected
     # failure, rather than gathering and returning all failures.
     def validate(fail_fast: false)

data/lib/cff/version.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.
@@ -17,7 +17,7 @@
 ##
 module CFF
   # :nodoc:
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
   DEFAULT_SPEC_VERSION = '1.2.0'
   MIN_VALIDATABLE_VERSION = '1.2.0'
 end

data/lib/cff.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,34 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'date'
-require 'json'
-require 'yaml'
-
-require 'language_list'
-
 # This library provides a Ruby interface to manipulate CITATION.cff files. The
-# primary entry points are Model and File.
+# primary entry points are Index and File.
 #
 # See the [CITATION.cff documentation](https://citation-file-format.github.io/)
 # for more details.
-module CFF
-  SCHEMA_PATH = ::File.join(__dir__, 'schema', '1.2.0.json') # :nodoc:
-  SCHEMA_FILE = JSON.parse(::File.read(SCHEMA_PATH))         # :nodoc:
-end
+module CFF; end
 
-require 'cff/version'
-require 'cff/errors'
-require 'cff/util'
-require 'cff/licensable'
-require 'cff/validatable'
-require 'cff/model_part'
-require 'cff/person'
-require 'cff/entity'
-require 'cff/identifier'
-require 'cff/reference'
-require 'cff/model'
-require 'cff/file'
-require 'cff/formatter/formatter'
-require 'cff/formatter/apa_formatter'
-require 'cff/formatter/bibtex_formatter'
+require_relative 'cff/file'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cff
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Haines
 - The Ruby Citation File Format Developers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.20.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.20.4
 - !ruby/object:Gem::Dependency
   name: language_list
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: 5.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: 5.16.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,84 +73,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: 6.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: 6.4.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.35.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.18.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.18.3
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +189,7 @@ files:
 - CHANGES.md
 - CITATION.cff
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENCE
 - README.md
@@ -197,22 +198,26 @@ files:
 - bin/setup
 - cff.gemspec
 - lib/cff.rb
+- lib/cff/citable.rb
 - lib/cff/entity.rb
 - lib/cff/errors.rb
 - lib/cff/file.rb
-- lib/cff/formatter/apa_formatter.rb
-- lib/cff/formatter/bibtex_formatter.rb
-- lib/cff/formatter/formatter.rb
+- lib/cff/formatters.rb
+- lib/cff/formatters/all.rb
+- lib/cff/formatters/apalike.rb
+- lib/cff/formatters/bibtex.rb
+- lib/cff/formatters/formatter.rb
 - lib/cff/identifier.rb
+- lib/cff/index.rb
 - lib/cff/licensable.rb
-- lib/cff/model.rb
 - lib/cff/model_part.rb
 - lib/cff/person.rb
 - lib/cff/reference.rb
+- lib/cff/schema.rb
+- lib/cff/schemas/1.2.0.json
 - lib/cff/util.rb
 - lib/cff/validatable.rb
 - lib/cff/version.rb
-- lib/schema/1.2.0.json
 homepage: https://github.com/citation-file-format/ruby-cff
 licenses:
 - Apache-2.0
@@ -221,7 +226,8 @@ metadata:
   changelog_uri: https://github.com/citation-file-format/ruby-cff/blob/main/CHANGES.md
   documentation_uri: https://citation-file-format.github.io/ruby-cff/
   source_code_uri: https://github.com/citation-file-format/ruby-cff
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -236,8 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A Ruby library for manipulating CITATION.cff files.
 test_files: []

data/lib/cff/formatter/apa_formatter.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright (c) 2018-2021 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.
-# 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
-  # Generates an APALIKE citation string
-  class ApaFormatter < Formatter # :nodoc:
-
-    def self.format(model:, preferred_citation: true) # rubocop:disable Metrics/AbcSize
-      model = select_and_check_model(model, preferred_citation)
-      return if model.nil?
-
-      output = []
-      output << combine_authors(
-        model.authors.map { |author| format_author(author) }
-      )
-
-      _, year = month_and_year_from_model(model)
-      output << "(#{year})" unless year.empty?
-
-      version = " (Version #{model.version})" unless model.version.to_s.empty?
-      output << "#{model.title}#{version}#{software_label(model)}"
-      output << publication_data_from_model(model)
-      output << url(model)
-
-      output.reject(&:empty?).join('. ')
-    end
-
-    def self.publication_data_from_model(model)
-      return '' unless model.respond_to?(:journal)
-
-      vol = "#{model.volume}(#{model.issue})" unless model.volume.to_s.empty?
-
-      [model.journal, vol, model.start.to_s].reject(&:empty?).join(', ')
-    end
-
-    # Prefer a DOI over the other URI options.
-    def self.url(model)
-      model.doi.empty? ? super : "https://doi.org/#{model.doi}"
-    end
-
-    def self.software_label(model)
-      return '' if model.is_a?(Reference) && !model.type.include?('software')
-
-      ' [Computer software]'
-    end
-
-    def self.combine_authors(authors)
-      return authors[0].chomp('.') if authors.length == 1
-
-      "#{authors[0..-2].join(', ')}, & #{authors[-1]}".chomp('.')
-    end
-
-    def self.format_author(author)
-      return author.name if author.is_a?(Entity)
-
-      particle =
-        author.name_particle.empty? ? '' : "#{author.name_particle} "
-      suffix = author.name_suffix.empty? ? '.' : "., #{author.name_suffix}"
-
-      "#{particle}#{author.family_names}, #{initials(author.given_names)}#{suffix}"
-    end
-  end
-end

data/lib/cff/formatter/bibtex_formatter.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright (c) 2018-2021 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.
-# 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
-  # Generates an BibTex citation string
-  class BibtexFormatter < Formatter # :nodoc:
-
-    def self.format(model:, preferred_citation: true) # rubocop:disable Metrics/AbcSize
-      model = select_and_check_model(model, preferred_citation)
-      return if model.nil?
-
-      values = {}
-      values['author'] = combine_authors(
-        model.authors.map { |author| format_author(author) }
-      )
-      values['title'] = "{#{model.title}}"
-
-      publication_data_from_model(model, values)
-
-      month, year = month_and_year_from_model(model)
-      values['month'] = month
-      values['year'] = year
-
-      values['url'] = url(model)
-
-      values.reject! { |_, v| v.empty? }
-      sorted_values = values.sort.map do |key, value|
-        "#{key} = {#{value}}"
-      end
-      sorted_values.insert(0, generate_reference(values))
-
-      "@#{bibtex_type(model)}{#{sorted_values.join(",\n")}\n}"
-    end
-
-    # Get various bits of information about the reference publication.
-    # Reference: https://www.bibtex.com/format/
-    def self.publication_data_from_model(model, fields)
-      %w[doi journal volume].each do |field|
-        fields[field] = model.send(field).to_s if model.respond_to?(field)
-      end
-
-      # BibTeX 'number' is CFF 'issue'.
-      fields['number'] = model.issue.to_s if model.respond_to?(:issue)
-
-      fields['pages'] = pages_from_model(model)
-    end
-
-    # CFF 'pages' is the number of pages, which has no equivalent in BibTeX.
-    # Reference: https://www.bibtex.com/f/pages-field/
-    def self.pages_from_model(model)
-      return '' if !model.respond_to?(:start) || model.start.to_s.empty?
-
-      start = model.start.to_s
-      finish = model.end.to_s
-      if finish.empty?
-        start
-      else
-        start == finish ? start : "#{start}--#{finish}"
-      end
-    end
-
-    # Do what we can to map between CFF reference types and bibtex types.
-    # Reference: https://www.bibtex.com/e/entry-types/
-    def self.bibtex_type(model)
-      return 'misc' unless model.is_a?(Reference)
-
-      case model.type
-      when 'article', 'book', 'manual', 'unpublished'
-        model.type
-      when 'conference', 'proceedings'
-        'proceedings'
-      when 'conference-paper'
-        'inproceedings'
-      when 'magazine-article', 'newspaper-article'
-        'article'
-      when 'pamphlet'
-        'booklet'
-      else
-        'misc'
-      end
-    end
-
-    def self.format_author(author)
-      return "{#{author.name}}" if author.is_a?(Entity)
-
-      particle =
-        author.name_particle.empty? ? '' : "#{author.name_particle} "
-
-      [
-        "#{particle}#{author.family_names}",
-        author.name_suffix,
-        author.given_names
-      ].reject(&:empty?).join(', ')
-    end
-
-    def self.combine_authors(authors)
-      authors.join(' and ')
-    end
-
-    def self.generate_reference(fields)
-      [
-        fields['author'].split(',', 2)[0].tr(' -', '_'),
-        fields['title'].split[0..2],
-        fields['year']
-      ].compact.join('_').tr('-$£%&(){}+!?/\\:;\'"~#', '')
-    end
-  end
-end

data/lib/cff/formatter/formatter.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright (c) 2018-2021 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.
-# 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
-  # Formatter base class
-  class Formatter # :nodoc:
-
-    def self.select_and_check_model(model, preferred_citation)
-      if preferred_citation && model.preferred_citation.is_a?(Reference)
-        model = model.preferred_citation
-      end
-
-      # Safe to assume valid `Model`s and `Reference`s will have these fields.
-      model.authors.empty? || model.title.empty? ? nil : model
-    end
-
-    def self.initials(name)
-      name.split.map { |part| part[0].capitalize }.join('. ')
-    end
-
-    # Prefer `repository_code` over `url`
-    def self.url(model)
-      model.repository_code.empty? ? model.url : model.repository_code
-    end
-
-    def self.month_and_year_from_model(model)
-      if model.respond_to?(:year)
-        result = [model.month, model.year].map(&:to_s)
-
-        return result unless result.any?(&:empty?)
-      end
-
-      month_and_year_from_date(model.date_released)
-    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
-    end
-  end
-end