datacite-mapping 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44bc8fb40c07e1508f27ec6da5fefe71e8c28406
-  data.tar.gz: 3ec5ac8144c71ea213111a9b711c61d801cf76d1
+  metadata.gz: c6c6c78e95b15168e1d50cca76a43313c568e96f
+  data.tar.gz: '08f1de9f06449584c9b4bab11139cd0e79882bf0'
 SHA512:
-  metadata.gz: 94be7b6dffca5c5ce26796e9c9149fc0fb3baa8211fd4420f32bc9a8898b931c05df37fe48b2c9fa4a234cf05949500376434511cd54a6c69b70022ab8cc2588
-  data.tar.gz: 0eb19b29c6e37d1c11c3ab9539e22faacbdc8427314a88837600400c22d8d3e7984379f20a0b3f2537da4f6c6e8639209eb8b2e5ce5e0efc8acc8fe734c6c138
+  metadata.gz: 4d2b532ba6cb94d49403bebcef4afb565c7baee59c6ae43725b74fdbd9f6a40dd08ac88e68c2e907db47bab444352dc7c7d52046a2944341ca3df386cf088def
+  data.tar.gz: c69fc51f41731b7fd77692cf70714e8072ebfc0d3f847a24ee345428a2c382a3f2f901c5483c1d0ac26f2b0108c8081f9f4814ee92fe935556f7c84a8019e211

data/.rubocop.yml

@@ -1,8 +1,3 @@
-# Disable compact style check for example.rb
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'example.rb'
-
 # Disable line-length check; it's too easy for the cure to be worse than the disease
 Metrics/LineLength:
   Enabled: False
@@ -11,18 +6,35 @@ Metrics/LineLength:
 Style/Documentation:
   Enabled: false
 
-# Allow one line around class body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundClassBody:
+# Allow one line around class body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
-# Allow one line around module body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundModuleBody:
+# Allow one line around module body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundModuleBody:
   Enabled: false
 
-# Allow one line around block body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundBlockBody:
+# Allow one line around block body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
 # Allow leading underscores for 'internal' accessors
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
+
+# Seriously?
+Style/CommentedKeyword:
+  Enabled: false
+
+# Use DateTime to preserve compatibility
+Style/DateTime:
+  Enabled: false
+
+# Disable some checks in sample code
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'examples/*'
+
+Style/MixinUsage:
+  Exclude:
+    - 'examples/*'

data/.ruby-version

@@ -1 +1 @@
-2.2.5
+2.4.1

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.3.0 (2 January 2018)
+
+- Update to Ruby 2.4.1
+- Update to RuboCop 0.52
+
 ## 0.2.5 (10 January 2017)
 
 - Update to Ruby 2.2.5

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 The Regents of the University of California
+Copyright (c) 2018 The Regents of the University of California
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -46,8 +46,8 @@ abstract.value
 # => "XML example of all DataCite Metadata Schema v4.0 properties."
 ```
 
-Note that Datacite::Mapping uses the `TypesafeEnum` gem to represent controlled vocabularies such
-as [ResourceTypeGeneral](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/Datacite/Mapping/ResourceTypeGeneral)
+Note that Datacite::Mapping uses the [TypesafeEnum](https://github.com/dmolesUC3/typesafe_enum) gem to represent controlled 
+vocabularies such as [ResourceTypeGeneral](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/Datacite/Mapping/ResourceTypeGeneral)
 and [DescriptionType](http://www.rubydoc.info/github/CDLUC3/datacite-mapping/master/Datacite/Mapping/DescriptionType).
 
 ### Writing

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ------------------------------------------------------------
 # RSpec
 
@@ -8,7 +10,7 @@ namespace :spec do
 
   desc 'Run all unit tests'
   RSpec::Core::RakeTask.new(:unit) do |task|
-    task.rspec_opts = %w(--color --format documentation --order default)
+    task.rspec_opts = %w[--color --format documentation --order default]
     task.pattern = 'unit/**/*_spec.rb'
   end
 
@@ -38,7 +40,7 @@ RuboCop::RakeTask.new
 
 desc 'List TODOs (from spec/todo.rb)'
 RSpec::Core::RakeTask.new(:todo) do |task|
-  task.rspec_opts = %w(--color --format documentation --order default)
+  task.rspec_opts = %w[--color --format documentation --order default]
   task.pattern = 'todo.rb'
 end
 
@@ -46,4 +48,4 @@ end
 # Defaults
 
 desc 'Run unit tests, check test coverage, run acceptance tests, check code style'
-task default: [:coverage, :rubocop]
+task default: %i[coverage rubocop]

data/datacite-mapping.gemspec

@@ -1,11 +1,13 @@
-# coding: utf-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'uri'
 require 'datacite/mapping/module_info'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = Datacite::Mapping::NAME
   spec.version       = Datacite::Mapping::VERSION
   spec.authors       = ['David Moles']
@@ -15,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   origin = `git config --get remote.origin.url`.chomp
-  origin_uri = origin.start_with?('http') ? URI(origin) : URI(origin.sub('git@github.com:', 'https://github.com/'))
+  origin_uri = origin.start_with?('http') ? URI(origin) : URI(origin.gsub(%r{git@([^:]+)(.com|.org)[^\/]+}, 'http://\1\2'))
   spec.homepage = URI::HTTP.build(host: origin_uri.host, path: origin_uri.path.chomp('.git')).to_s
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -29,12 +31,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
+  spec.add_development_dependency 'github-markup', '~> 1.4'
   spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'redcarpet', '~> 3.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'simplecov', '~> 0.9.2'
   spec.add_development_dependency 'simplecov-console', '~> 0.2.0'
-  spec.add_development_dependency 'rubocop', '~> 0.32.1'
-  spec.add_development_dependency 'redcarpet', '~> 3.3'
-  spec.add_development_dependency 'github-markup', '~> 1.4'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/examples/reading.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# coding: UTF-8
+# frozen_string_literal: true
 
 require 'datacite/mapping'
 include Datacite::Mapping

data/examples/writing.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'datacite/mapping'
 include Datacite::Mapping

data/lib/datacite/mapping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'rexml/formatters/transitive' # unaccountably, xml/mapping doesn't do this
 require 'xml/mapping_extensions'

data/lib/datacite/mapping/alternate_identifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -19,14 +21,14 @@ module Datacite
       # Sets the type. Cannot be nil.
       # @param val [String] the identifier type
       def type=(val)
-        fail ArgumentError, 'No identifier type provided' unless val
+        raise ArgumentError, 'No identifier type provided' unless val
         @type = val
       end
 
       # Sets the value. Cannot be nil.
       # @param val [String] the value
       def value=(val)
-        fail ArgumentError, 'No identifier value provided' unless val
+        raise ArgumentError, 'No identifier value provided' unless val
         @value = val
       end
 

data/lib/datacite/mapping/contributor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 require 'datacite/mapping/name_identifier'
 
@@ -92,13 +94,13 @@ module Datacite
       end
 
       def name=(value)
-        new_value = value && value.strip
-        fail ArgumentError, 'Name cannot be empty or nil' unless new_value && !new_value.empty?
+        new_value = value&.strip
+        raise ArgumentError, 'Name cannot be empty or nil' unless new_value && !new_value.empty?
         @name = new_value
       end
 
       def type=(value)
-        fail ArgumentError, 'Type cannot be nil' unless value
+        raise ArgumentError, 'Type cannot be nil' unless value
         @type = value
       end
 

data/lib/datacite/mapping/creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping'
 require 'datacite/mapping/read_only_nodes'
 require 'datacite/mapping/name_identifier'
@@ -23,18 +25,18 @@ module Datacite
       end
 
       def name=(value)
-        new_value = value && value.strip
-        fail ArgumentError, 'Name cannot be empty or nil' unless new_value && !new_value.empty?
+        new_value = value&.strip
+        raise ArgumentError, 'Name cannot be empty or nil' unless new_value && !new_value.empty?
         @name = new_value
       end
 
       def given_name=(value)
-        new_value = value && value.strip
+        new_value = value&.strip
         @given_name = new_value
       end
 
       def family_name=(value)
-        new_value = value && value.strip
+        new_value = value&.strip
         @family_name = new_value
       end
 

data/lib/datacite/mapping/date.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 require 'datacite/mapping/date_value'
@@ -67,7 +69,7 @@ module Datacite
       end
 
       def type=(val)
-        fail ArgumentError, 'Date type cannot be nil' unless val
+        raise ArgumentError, 'Date type cannot be nil' unless val
         @type = val
       end
 
@@ -80,14 +82,14 @@ module Datacite
           @range_start, @range_end = parts.map(&:strip).map { |part| DateValue.new(part) unless part == '' }
           # puts "#{val} -> [#{range_start}, #{range_end}]"
         else
-          fail ArgumentError, "Unable to parse date value #{val}"
+          raise ArgumentError, "Unable to parse date value #{val}"
         end
         @value = date_value ? date_value.to_s : "#{range_start}/#{range_end}"
       end
 
       def <=>(other)
         return nil unless other.class == self.class
-        [:date_value, :range_start, :range_end, :type].each do |v|
+        %i[date_value range_start range_end type].each do |v|
           order = send(v) <=> other.send(v)
           return order if order.nonzero?
         end
@@ -102,8 +104,6 @@ module Datacite
         @value
       end
 
-      private
-
       # @!attribute [rw] type
       #  @return [DateType] the type of date. Cannot be nil.
       typesafe_enum_node :type, '@dateType', class: DateType

data/lib/datacite/mapping/date_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -52,12 +54,12 @@ module Datacite
           @nsec = datetime.to_time.nsec
           @zone = datetime.zone
         end
-        fail ArgumentError, "Unable to parse date value '#{val}'" unless @year
+        raise ArgumentError, "Unable to parse date value '#{val}'" unless @year
       end
 
       def <=>(other)
         return nil unless other.class == self.class
-        [:year, :month, :day, :hour, :minute, :sec, :nsec].each do |v|
+        %i[year month day hour minute sec nsec].each do |v|
           order = send(v) <=> other.send(v)
           return order if order.nonzero?
         end

data/lib/datacite/mapping/description.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -88,12 +90,12 @@ module Datacite
       end
 
       def language=(value)
-        @language = value && value.strip
+        @language = value&.strip
       end
 
       def value=(v)
-        new_value = v && v.strip
-        fail ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
+        new_value = v&.strip
+        raise ArgumentError, 'Value cannot be empty or nil' unless new_value && !new_value.empty?
         @value = new_value
       end
 

data/lib/datacite/mapping/empty_filtering_nodes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite

data/lib/datacite/mapping/funding_reference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 
 module Datacite
@@ -28,12 +30,12 @@ module Datacite
       end
 
       def value=(value)
-        fail ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+        raise ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
         @value = value
       end
 
       def type=(value)
-        fail ArgumentError, 'Type cannot be nil' unless value
+        raise ArgumentError, 'Type cannot be nil' unless value
         @type = value
       end
 
@@ -59,7 +61,7 @@ module Datacite
       end
 
       def value=(value)
-        fail ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+        raise ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
         @value = value
       end
 
@@ -93,7 +95,7 @@ module Datacite
       end
 
       def to_s
-        fields = [:name, :identifier, :award_number, :award_title].map { |f| "#{f}: #{send(f)}" }
+        fields = %i[name identifier award_number award_title].map { |f| "#{f}: #{send(f)}" }
         "FundingReference { #{fields.join(', ')} }"
       end
 

data/lib/datacite/mapping/geo_location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping_extensions'
 require 'datacite/mapping/geo_location_point'
 require 'datacite/mapping/geo_location_box'

data/lib/datacite/mapping/geo_location_box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xml/mapping'
 require 'datacite/mapping/geo_location_node'
 
@@ -53,31 +55,31 @@ module Datacite
         when 4
           init_from_array(args)
         else
-          fail ArgumentError, "Can't construct GeoLocationBox from arguments: #{args}"
+          raise ArgumentError, "Can't construct GeoLocationBox from arguments: #{args}"
         end
       end
 
       def south_latitude=(value)
-        fail ArgumentError, 'South latitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid south latitude" unless value >= -90 && value <= 90
+        raise ArgumentError, 'South latitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid south latitude" unless value >= -90 && value <= 90
         @south_latitude = value
       end
 
       def west_longitude=(value)
-        fail ArgumentError, 'West longitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid west longitude" unless value >= -180 && value <= 180
+        raise ArgumentError, 'West longitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid west longitude" unless value >= -180 && value <= 180
         @west_longitude = value
       end
 
       def north_latitude=(value)
-        fail ArgumentError, 'North latitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid north latitude" unless value >= -90 && value <= 90
+        raise ArgumentError, 'North latitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid north latitude" unless value >= -90 && value <= 90
         @north_latitude = value
       end
 
       def east_longitude=(value)
-        fail ArgumentError, 'East longitude cannot be nil' unless value
-        fail ArgumentError, "#{value} is not a valid east longitude" unless value >= -180 && value <= 180
+        raise ArgumentError, 'East longitude cannot be nil' unless value
+        raise ArgumentError, "#{value} is not a valid east longitude" unless value >= -180 && value <= 180
         @east_longitude = value
       end
 
@@ -94,7 +96,7 @@ module Datacite
       #   {GeoLocationBox}
       def <=>(other)
         return nil unless other.class == self.class
-        [:south_latitude, :west_longitude, :north_latitude, :east_longitude].each do |c|
+        %i[south_latitude west_longitude north_latitude east_longitude].each do |c|
           order = send(c) <=> other.send(c)
           return order if order.nonzero?
         end