cff 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 330c0177c6b7fed7915ddeddbc8ba68a9eb9f9e3
-  data.tar.gz: '089cd1ad45d23af25bc1ccbac3b0ffffceedb570'
+SHA256:
+  metadata.gz: 32661be9e23147731575824f34df12b82dfb6f0560af3fd4d8081958f633cac6
+  data.tar.gz: 5b525849ff1e6ff1829d70e657852377c88bf0b6e83dffff96dd6cd660fc029b
 SHA512:
-  metadata.gz: 290ee6b5066a2f5d016ceff0416faf00f8f12df42c72e62b4642efa2a4d5afa64b32fc1a8e7843d3aec8a4165359445e7a2fd940e523a069a6f6509b181797d3
-  data.tar.gz: 0a99851ff3c46441be5fc86d3317bb2bc1828c5f4e5d15dbb8e507541feb9a73e4ff751a7fbd9355a8097ae42db3ac9bfb38428bd28aa5b981b8cb42a74b4cb9
+  metadata.gz: c1df6fd36b30cdd828d9d80ae183795f9eea5a3691684ed0769bbe75b8bca026ed540611f671341bca8880352f396c727931ceb55865086b8613c016af5a7769
+  data.tar.gz: 0f3afd7def478528b073c4a9454c804731fe6c50cde9acbcdafa0fdc0d6bfba577ca812fcc34fe0b36732f5b1dafebde2b90940f81c6ddf882ac22754b01b419

data/CHANGES.md

@@ -1,5 +1,34 @@
 # Changes log for the Ruby CFF Library
 
+## Version 0.4.0
+
+* Remove unused Util#expand_field method.
+* Changed Model#keywords to be a field type.
+* Model is now a subclass of ModelPart.
+* Document ModelPart and Util just enough.
+* Add Util::normalize_modelpart_array! method.
+* Tighten up checking for empty collections in model.
+* Move the references into the Model fields.
+* Add an in-place actor collection builder method.
+* Move authors and contact to Model fields.
+* Refactor Reference so the actor lists are fields.
+* Remove unused method: Util::build_actor_collection.
+* Remove unused method: Util::expand_array_field.
+* Add rubocop to the development dependencies.
+* Add rubocop configuration files.
+* Add rubocop rake tasks.
+* Many rubocop fixes.
+* Compact ALLOWED_FIELDS lists for consistency.
+* Allow creation of a Reference without a type.
+* Remove unused method: Util.delete_from_hash.
+* Refactor duplicated code into Util.fields_to_hash.
+* Add File#write (instance method).
+* Ensure a model always returns '' for missing fields.
+* Test reading short and minimal CFF files.
+* Cleanup duplicated tests.
+* Don't store dotfiles in the gemfile.
+* Add a CITATION.cff file!
+
 ## Version 0.3.0
 
 * Update badges for new repo location.

data/CITATION.cff

@@ -0,0 +1,21 @@
+cff-version: 1.0.3
+message: If you use ruby-cff in your work, please cite it using the following metadata
+title: Ruby CFF Library
+abstract: This library provides a Ruby interface to manipulate CITATION.cff files
+authors:
+- family-names: Haines
+  given-names: Robert
+  orcid: https://orcid.org/0000-0002-9538-7919
+  affiliation: The University of Manchester, UK
+keywords:
+- ruby
+- credit
+- citation
+- metadata
+- cff
+version: 0.4.0
+doi: 10.5281/zenodo.1184077
+date-released: 2018-07-29
+license: Apache-2.0
+repository-artifact: https://rubygems.org/gems/cff
+repository-code: https://github.com/citation-file-format/ruby-cff

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -12,22 +12,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rdoc/task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubocop/rake_task'
 
-task :default => :test
+task default: :test
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 RDoc::Task.new do |r|
-  r.main = "README.md"
-  r.rdoc_files.include("README.md", "LICENCE", "CHANGES.md", "lib/**/*.rb")
-  r.options << "--markup=markdown"
-  r.options << "--tab-width=2"
+  r.main = 'README.md'
+  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}"
 end
+
+RuboCop::RakeTask.new

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "cff"
+require 'bundler/setup'
+require 'cff'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "cff"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/cff.gemspec

@@ -12,37 +12,39 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cff/version"
+require 'cff/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cff"
+  spec.name          = 'cff'
   spec.version       = CFF::VERSION
-  spec.authors       = ["Robert Haines"]
-  spec.email         = ["robert.haines@manchester.ac.uk"]
+  spec.authors       = ['Robert Haines']
+  spec.email         = ['robert.haines@manchester.ac.uk']
 
-  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/citation-file-format/ruby-cff"
-  spec.license       = "Apache-2.0"
+  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/citation-file-format/ruby-cff'
+  spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^((test|spec|features)/|\.)})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ">= 2.2.0"
+  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_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"
-  spec.add_development_dependency "coveralls", "~> 0.8"
-  spec.add_development_dependency "test_construct", "~> 2.0"
-  spec.add_development_dependency "rdoc", "~> 6.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rdoc', '~> 6.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54'
+  spec.add_development_dependency 'test_construct', '~> 2.0'
 end

data/lib/cff.rb

@@ -12,19 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "date"
-require "yaml"
-require "language_list"
-require "spdx-licenses"
+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"
+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'
 
 # This library provides a Ruby interface to manipulate CITATION.cff files. The
 # primary entry points are Model and File.
@@ -32,5 +32,4 @@ require "cff/file"
 # See the [CITATION.cff documentation](https://citation-file-format.github.io/)
 # for more details.
 module CFF
-
 end

data/lib/cff/entity.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#
+##
 module CFF
 
   # An Entity can represent different types of entities, e.g., a publishing
@@ -21,20 +21,8 @@ module CFF
   class Entity < ModelPart
 
     ALLOWED_FIELDS = [
-      'address',
-      'city',
-      'country',
-      'email',
-      'date-end',
-      'date-start',
-      'fax',
-      'location',
-      'name',
-      'orcid',
-      'post-code',
-      'region',
-      'tel',
-      'website'
+      'address', 'city', 'country', 'email', 'date-end', 'date-start', 'fax',
+      'location', 'name', 'orcid', 'post-code', 'region', 'tel', 'website'
     ].freeze # :nodoc:
 
     # :call-seq:
@@ -42,7 +30,7 @@ module CFF
     #
     # Create a new Entity with the supplied name.
     def initialize(param)
-      if Hash === param
+      if param.is_a?(Hash)
         @fields = param
       else
         @fields = Hash.new('')
@@ -56,9 +44,7 @@ module CFF
     # Set the `date-end` field. If a non-Date object is passed in it will
     # be parsed into a Date.
     def date_end=(date)
-      unless Date === date
-        date = Date.parse(date)
-      end
+      date = Date.parse(date) unless date.is_a?(Date)
 
       @fields['date-end'] = date
     end
@@ -69,12 +55,9 @@ module CFF
     # Set the `date-start` field. If a non-Date object is passed in it will
     # be parsed into a Date.
     def date_start=(date)
-      unless Date === date
-        date = Date.parse(date)
-      end
+      date = Date.parse(date) unless date.is_a?(Date)
 
       @fields['date-start'] = date
     end
-
   end
 end

data/lib/cff/file.rb

@@ -12,14 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#
+##
 module CFF
 
   # File provides direct access to a CFF Model, with the addition of some
   # filesystem utilities.
   class File
 
-    YAML_HEADER = "---\n" # :nodoc:
+    YAML_HEADER = "---\n".freeze # :nodoc:
 
     # :call-seq:
     #   new(title) -> File
@@ -31,9 +31,7 @@ module CFF
     # All methods provided by Model are also available directly on File
     # objects.
     def initialize(param)
-      unless Model === param
-        param = Model.new(param)
-      end
+      param = Model.new(param) unless param.is_a?(Model)
 
       @model = param
     end
@@ -43,7 +41,7 @@ module CFF
     #
     # Read a file and parse it for subsequent manipulation.
     def self.read(file)
-      new(YAML::load_file(file))
+      new(YAML.load_file(file))
     end
 
     # :call-seq:
@@ -52,16 +50,25 @@ module CFF
     #
     # Write the supplied model or yaml string to `file`.
     def self.write(file, cff)
-      unless String === cff
-        cff = cff.to_yaml
-      end
+      cff = cff.to_yaml unless cff.is_a?(String)
 
       ::File.write(file, cff[YAML_HEADER.length...-1])
     end
 
+    # :call-seq:
+    #   write(file)
+    #
+    # Write this CFF File to `file`.
+    def write(file)
+      File.write(file, @model)
+    end
+
     def method_missing(name, *args) # :nodoc:
-      @model.send name, *args
+      @model.respond_to?(name) ? @model.send(name, *args) : super
     end
 
+    def respond_to_missing?(name, *all) # :nodoc:
+      @model.respond_to?(name, *all)
+    end
   end
 end

data/lib/cff/model.rb

@@ -12,55 +12,94 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#
+##
 module CFF
 
   # Model is the core data structure for a CITATION.cff file. It can be
   # accessed direcly, or via File.
-  class Model
-
-    include Util
+  class Model < ModelPart
 
     ALLOWED_FIELDS = [
-      'abstract',
-      'cff-version',
-      'commit',
-      'date-released',
-      'doi',
-      'license',
-      'license-url',
-      'message',
-      'repository',
-      'repository-artifact',
-      'repository-code',
-      'title',
-      'url',
-      'version'
-  ].freeze # :nodoc:
+      'abstract', 'authors', 'cff-version', 'contact', 'commit',
+      'date-released', 'doi', 'keywords', 'license', 'license-url', 'message',
+      'references', 'repository', 'repository-artifact', 'repository-code',
+      'title', 'url', 'version'
+    ].freeze # :nodoc:
 
     # 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"
+    DEFAULT_MESSAGE = 'If you use this software in your work, please cite ' \
+      'it using the following metadata'.freeze
 
     # :call-seq:
     #   new(title) -> Model
     #
     # Initialize a new Model with the supplied title.
     def initialize(param)
-      @authors = []
-      @contact = []
-      @keywords = []
-      @references = []
-
-      if Hash === param
-        build_model(param)
+      if param.is_a?(Hash)
+        @fields = build_model(param)
+        @fields.default = ''
       else
         @fields = Hash.new('')
         @fields['cff-version'] = DEFAULT_SPEC_VERSION
         @fields['message'] = DEFAULT_MESSAGE
         @fields['title'] = param
       end
+
+      %w[authors contact keywords references].each do |field|
+        @fields[field] = [] if @fields[field].empty?
+      end
     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)
+      date = Date.parse(date) unless date.is_a?(Date)
+
+      @fields['date-released'] = date
+    end
+
+    # :call-seq:
+    #   version = version
+    #
+    # Set the `version` field.
+    def version=(version)
+      @fields['version'] = version.to_s
+    end
+
+    def to_yaml # :nodoc:
+      YAML.dump fields, line_width: -1, indentation: 2
+    end
+
+    private
+
+    def fields
+      %w[authors contact references].each do |field|
+        normalize_modelpart_array!(@fields[field])
+      end
+
+      fields_to_hash(@fields)
+    end
+
+    def build_model(fields)
+      build_actor_collection!(fields['authors'] || [])
+      build_actor_collection!(fields['contact'] || [])
+      (fields['references'] || []).map! do |r|
+        Reference.new(r)
+      end
+
+      fields
+    end
+
+    public
+
+    # Some documentation of "hidden" methods is provided here, out of the
+    # way of the main class code.
+
+    ##
+    # :method: authors
     # :call-seq:
     #   authors -> Array
     #
@@ -72,10 +111,18 @@ module CFF
     # ```
     #
     # Authors can be a Person or Entity.
-    def authors
-      @authors
-    end
 
+    ##
+    # :method: authors=
+    # :call-seq:
+    #   authors = array_of_authors -> Array
+    #
+    # Replace the list of authors for this citation.
+    #
+    # Authors can be a Person or Entity.
+
+    ##
+    # :method: contact
     # :call-seq:
     #   contact -> Array
     #
@@ -87,23 +134,18 @@ module CFF
     # ```
     #
     # Contacts can be a Person or Entity.
-    def contact
-      @contact
-    end
 
+    ##
+    # :method: contact=
     # :call-seq:
-    #   date_released = date
+    #   contact = array_of_contacts -> Array
     #
-    # 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
+    # Replace the list of contacts for this citation.
+    #
+    # Contacts can be a Person or Entity.
 
+    ##
+    # :method: keywords
     # :call-seq:
     #   keywords -> Array
     #
@@ -114,11 +156,19 @@ module CFF
     # model.keywords << keyword
     # ```
     #
-    # Keywords will be converted to Strings on output to a CFF file.
-    def keywords
-      @keywords
-    end
+    # Keywords will be converted to Strings on output.
+
+    ##
+    # :method: keywords=
+    # :call-seq:
+    #   keywords = array_of_keywords -> Array
+    #
+    # Replace the list of keywords for this citation.
+    #
+    # Keywords will be converted to Strings on output.
 
+    ##
+    # :method: references
     # :call-seq:
     #   references -> Array
     #
@@ -128,59 +178,12 @@ module CFF
     # ```
     # model.references << reference
     # ```
-    def references
-      @references
-    end
 
+    ##
+    # :method: references=
     # :call-seq:
-    #   version = version
+    #   references = array_of_references -> Array
     #
-    # Set the `version` field.
-    def version=(version)
-      @fields['version'] = version.to_s
-    end
-
-    def to_yaml # :nodoc:
-      YAML.dump fields, :line_width => -1, :indentation => 2
-    end
-
-    def method_missing(name, *args) # :nodoc:
-      n = method_to_field(name.id2name)
-      super unless ALLOWED_FIELDS.include?(n.chomp('='))
-
-      if n.end_with?('=')
-        @fields[n.chomp('=')] = args[0] || ''
-      else
-        @fields[n]
-      end
-    end
-
-    private
-
-    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?
-
-      model
-    end
-
-    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
-
-      @fields = delete_from_hash(fields, 'authors', 'contact', 'keywords', 'references')
-    end
-
+    # Replace the list of references for this citation.
   end
 end