cff 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b6e59d2c810ff7f55fac883fa8febd7bda2928c
-  data.tar.gz: 3e93472087c65a0bf7d57ef038e60ffd48438647
+  metadata.gz: ba4e9410b991789174bfa5cff1b448600aceb46a
+  data.tar.gz: ac13ec2b66c63edeaa5eb721b88fec6a4b7fd0da
 SHA512:
-  metadata.gz: 7e9af9c7e01db4ffda0371ce140e7c8ed338c2d419cf44d786b093e54e479b1e8dc74d17e7581e98a9298ac10a16c559d802788d764a4ce9792f798c253ad684
-  data.tar.gz: 59aaa4928118dfb01fd7617c7b6722bb0a7db3274af945926391cd82325de025ca1a88545972621f08368d4b9765642aecd39d1f8a5f2f3862e92aac2cea587d
+  metadata.gz: 807b056534179b4ae578259ef0c8fcc0a6a07d2782b4b134f9a790e99a682a82c9c632008ac8e76afbdd238b060f13c583b30bdb8b1c30c30a6c471230bf9661
+  data.tar.gz: 2caf814fc16b88fc4d9d70ce664d9a233e258c4460cce6547cca02fe424a5ee4d8d0fcc0bc2309045477901130f0cad97f5fbfce9aaba3b0067ecc4113c1a1b8

data/.travis.yml

@@ -5,6 +5,7 @@ sudo: false
 cache: bundler
 
 rvm:
+  - 2.2.9
   - 2.3.6
   - 2.4.3
   - 2.5.0

data/README.md

@@ -3,6 +3,7 @@
 
 A Ruby library for manipulating CITATION.cff files.
 
+[![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)
@@ -17,9 +18,12 @@ 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 = "0.1.0"
 cff.date_released = Date.today
 cff.authors << CFF::Person.new("Robert", "Haines")
+cff.license = "Apache-2.0"
+cff.keywords << "ruby" << "credit" << "citation"
+cff.repository_artifact = "https://rubygems.org/gems/cff"
 
 CFF::File.write("CITATION.cff", cff)
 ```
@@ -31,10 +35,16 @@ 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-18
+date-released: 2018-02-24
+license: Apache-2.0
+repository-artifact: https://rubygems.org/gems/cff
 authors:
 - family-names: Haines
   given-names: Robert
+keywords:
+- ruby
+- credit
+- citation
 ```
 
 ### Licence

data/cff.gemspec

@@ -25,6 +25,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.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -33,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.2.0"
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/cff.rb

@@ -16,6 +16,8 @@ require "date"
 require "yaml"
 
 require "cff/version"
+require "cff/util"
+require "cff/model-part"
 require "cff/person"
 require "cff/entity"
 require "cff/model"

data/lib/cff/entity.rb

@@ -18,17 +18,62 @@ module CFF
   # An Entity can represent different types of entities, e.g., a publishing
   # company, or conference. Like a Person, an Entity might have a number of
   # roles, such as author, contact, editor, etc.
-  class Entity
+  class Entity < ModelPart
 
-    attr_reader :fields # :nodoc:
+    ALLOWED_FIELDS = [
+      'address',
+      'city',
+      'country',
+      'email',
+      'date-end',
+      'date-start',
+      'fax',
+      'location',
+      'name',
+      'orcid',
+      'post-code',
+      'region',
+      'tel',
+      'website'
+    ].freeze # :nodoc:
 
     # :call-seq:
     #   new(name) -> Entity
     #
     # Create a new Entity with the supplied name.
-    def initialize(name)
-      @fields = Hash.new('')
-      @fields['name'] = name
+    def initialize(param)
+      if Hash === param
+        super(param)
+      else
+        @fields = Hash.new('')
+        @fields['name'] = param
+      end
+    end
+
+    # :call-seq:
+    #   date_end = date
+    #
+    # 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
+
+      @fields['date-end'] = date
+    end
+
+    # :call-seq:
+    #   date_start = date
+    #
+    # 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
+
+      @fields['date-start'] = date
     end
 
   end

data/lib/cff/file.rb

@@ -60,9 +60,7 @@ module CFF
     end
 
     def method_missing(name, *args) # :nodoc:
-      super unless Model::ALLOWED_METHODS.include?(name)
-
-      @model.send name, args
+      @model.send name, *args
     end
 
   end

data/lib/cff/model-part.rb

@@ -0,0 +1,41 @@
+# 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
+
+  # :stopdoc:
+  class ModelPart
+    include Util
+
+    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('='))
+
+      if n.end_with?('=')
+        @fields[n.chomp('=')] = args[0] || ''
+      else
+        @fields[n]
+      end
+    end
+
+  end
+  # :startdoc:
+end

data/lib/cff/model.rb

@@ -19,15 +19,24 @@ module CFF
   # accessed direcly, or via File.
   class Model
 
-    ALLOWED_METHODS = [
-      :cff_version,
-      :date_released,
-      :message,
-      :message=,
-      :title,
-      :title=,
-      :version
-    ] # :nodoc:
+    include Util
+
+    ALLOWED_FIELDS = [
+      'abstract',
+      'cff-version',
+      'commit',
+      'date-released',
+      'doi',
+      'license',
+      'license-url',
+      'message',
+      '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"
@@ -37,16 +46,18 @@ module CFF
     #
     # Initialize a new Model with the supplied title.
     def initialize(param)
+      @authors = []
+      @contact = []
+      @keywords = []
+
       if Hash === param
-        @fields = param
+        build_model(param)
       else
         @fields = Hash.new('')
         @fields['cff-version'] = DEFAULT_SPEC_VERSION
         @fields['message'] = DEFAULT_MESSAGE
         @fields['title'] = param
       end
-
-      @authors = []
     end
 
     # :call-seq:
@@ -64,6 +75,21 @@ module CFF
       @authors
     end
 
+    # :call-seq:
+    #   contact -> Array
+    #
+    # Return the list of contacts for this citation. To add a contact to the
+    # list, use:
+    #
+    # ```
+    # model.contact << contact
+    # ```
+    #
+    # Contacts can be a Person or Entity.
+    def contact
+      @contact
+    end
+
     # :call-seq:
     #   date_released = date
     #
@@ -77,6 +103,21 @@ module CFF
       @fields['date-released'] = date
     end
 
+    # :call-seq:
+    #   keywords -> Array
+    #
+    # Return the list of keywords for this citation. To add a keyword to the
+    # list, use:
+    #
+    # ```
+    # model.keywords << keyword
+    # ```
+    #
+    # Keywords will be converted to Strings on output to a CFF file.
+    def keywords
+      @keywords
+    end
+
     # :call-seq:
     #   version = version
     #
@@ -87,17 +128,17 @@ module CFF
 
     def to_yaml # :nodoc:
       fields = @fields.dup
-      fields['authors'] = @authors.reject do |a|
-        !a.respond_to?(:fields)
-      end.map { |a| a.fields }
+      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
 
     def method_missing(name, *args) # :nodoc:
-      super unless ALLOWED_METHODS.include?(name)
-
       n = method_to_field(name.id2name)
+      super unless ALLOWED_FIELDS.include?(n.chomp('='))
+
       if n.end_with?('=')
         @fields[n.chomp('=')] = args[0] || ''
       else
@@ -107,8 +148,24 @@ module CFF
 
     private
 
-    def method_to_field(name)
-      name.gsub('_', '-')
+    def build_model(fields)
+      build_entity_collection(@authors, fields['authors'])
+      build_entity_collection(@contact, fields['contact'])
+      @keywords = fields['keywords']
+
+      @fields = delete_from_hash(fields, 'authors', 'contact', 'keywords')
+    end
+
+    def build_entity_collection(field, source)
+      source.each do |s|
+        field << (s.has_key?('given-names') ? Person.new(s) : Entity.new(s))
+      end
+    end
+
+    def array_field_to_yaml(field)
+      field.reject do |f|
+        !f.respond_to?(:fields)
+      end.map { |f| f.fields }
     end
 
   end

data/lib/cff/person.rb

@@ -17,18 +17,38 @@ 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.
-  class Person
+  class Person < ModelPart
 
-    attr_reader :fields # :nodoc:
+    ALLOWED_FIELDS = [
+      'address',
+      'affiliation',
+      'city',
+      'country',
+      'email',
+      'family-names',
+      'fax',
+      'given-names',
+      'name-particle',
+      'name-suffix',
+      'orcid',
+      'post-code',
+      'region',
+      'tel',
+      'website'
+    ].freeze # :nodoc:
 
     # :call-seq:
     #   new(given_name, family_name) -> Person
     #
     # Create a new Person with the supplied given and family names.
-    def initialize(given, family)
-      @fields = Hash.new('')
-      @fields['family-names'] = family
-      @fields['given-names'] = given
+    def initialize(param, *more)
+      if Hash === param
+        super(param)
+      else
+        @fields = Hash.new('')
+        @fields['family-names'] = more[0]
+        @fields['given-names'] = param
+      end
     end
 
   end

data/lib/cff/util.rb

@@ -0,0 +1,41 @@
+# 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
+
+  # Utility methods useful throughout the rest of the CFF library.
+  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
+
+end

data/lib/cff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,11 +116,14 @@ files:
 - lib/cff.rb
 - lib/cff/entity.rb
 - lib/cff/file.rb
+- lib/cff/model-part.rb
 - lib/cff/model.rb
 - lib/cff/person.rb
+- lib/cff/util.rb
 - lib/cff/version.rb
 homepage: https://github.com/hainesr/ruby-cff
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -130,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="