stash-wrapper 0.1.11.1 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5f8980de3819d980d8e5dd98008f886be978be5
-  data.tar.gz: e75bc9674c28df79152d0cb804cfa5befab17d65
+SHA256:
+  metadata.gz: 8c2df6f3332aaa9d993dfda573f17d9127ac1e902c1f8705ea65a8ba72864208
+  data.tar.gz: 6cf310390b1a80e396e51a12de63107142881c6059731f812030919399eca940
 SHA512:
-  metadata.gz: 8e491506be906942e7f76340db12dfae27f5766cf0381ed5bd0927e05df9ca723a57e566a7b78001d0c3a3ac07c02d59a4503c24f4627efce23f4da3c3d95463
-  data.tar.gz: d14a974affa84689ab014e8492dbe8d7234557b78394d36d68d67cba876baec9ef51230f61db0b4357c19977ac38bfe2a9e051ef9fddc13f1215d3b773eecde1
+  metadata.gz: 915f637e7a4940cd413f852b951c83ef9a3628fec9f39c9a0eaf1f6254ca481bde66bb53c1cdc3282d5885744b4400f1568886748f4191fdf80ca1483aeff25b
+  data.tar.gz: 8f37b259d343d835cfd684852430160b029911a8a8ba8565d316575cdfe1345625cc709377b5e25fce21a21e659896b5de0eb13dc2a73aae23ae840032024e15

data/.gitignore

@@ -27,20 +27,99 @@ db/*.sqlite3
 
 /log/
 
-# IntelliJ
+# Mac OS
+
+.DS_Store
+#### joe made this: http://goel.io/joe
+
+#####=== JetBrains ===#####
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/workspace.xml
+.idea/tasks.xml
+
+# Sensitive or high-churn files:
+.idea/dataSources/
+.idea/dataSources.ids
+.idea/dataSources.xml
+.idea/dataSources.local.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
 
-*.iml
-*.ipr
+# Gradle:
+.idea/gradle.xml
+.idea/libraries
+
+# Mongo Explorer plugin:
+.idea/mongoSettings.xml
+
+## File-based project format:
 *.iws
-*.ids
-.rakeTasks
 
-# Emacs
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
 
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+#####=== Emacs ===#####
+# -*- mode: gitignore; -*-
 *~
-\#*
-.#*
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
 
-# Mac OS
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
 
-.DS_Store

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Run all unit tests with coverage" fullCmd="coverage" taksId="coverage" /><RakeTask description="Run unit tests, check test coverage, check code style" fullCmd="default" taksId="default" /><RakeTask description="Run RuboCop" fullCmd="rubocop" taksId="rubocop" /><RakeGroup description="" fullCmd="" taksId="rubocop"><RakeTask description="Auto-correct RuboCop offenses" fullCmd="rubocop:auto_correct" taksId="auto_correct" /></RakeGroup><RakeTask description="Run all tests" fullCmd="spec" taksId="spec" /><RakeGroup description="" fullCmd="" taksId="spec"><RakeTask description="Run all unit tests" fullCmd="spec:unit" taksId="unit" /><RakeTask description="" fullCmd="spec:all" taksId="all" /></RakeGroup><RakeTask description="" fullCmd="debug_load_path" taksId="debug_load_path" /></RakeGroup></Settings>

data/.rubocop.yml

@@ -1,24 +1,10 @@
-# Disable compact style check for example.rb
+inherit_from: ../.rubocop.yml
+
+# Disable various checks for sample code
 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
-
-# Disable problematic module documentation check (see https://github.com/bbatsov/rubocop/issues/947)
-Style/Documentation:
-  Enabled: false
-
-# Allow one line around class body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-# Allow one line around module body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-# Allow one line around block body (Style/EmptyLines will still disallow two or more)
-Style/EmptyLinesAroundBlockBody:
-  Enabled: false
+Style/MixinUsage:
+  Exclude:
+    - 'example.rb'

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.4.1

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 0.1.12 (14 November 2018)
+
+- Change stash-wrapper namespace URI to https://dash.ucop.edu/stash_wrapper/ and schema location to 
+  https://dash.ucop.edu/stash_wrapper/stash_wrapper.xsd (formerly both URLs were http://dash.cdlib.org/)
+- Update to Ruby 2.4.1
+- Update to Rubocop 0.57.2
+- Update dependencies
+
 # 0.1.11.1 (5 August 2016)
 
 - In `License::CC_BY`, use "Creative Commons Attribution 4.0 International (CC BY 4.0)" 

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 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

@@ -6,7 +6,7 @@
 [![Gem Version](https://img.shields.io/gem/v/stash-wrapper.svg)](https://github.com/CDLUC3/stash-wrapper/releases)
 
 Gem for working with the [Stash](https://github.com/CDLUC3/stash)
-[XML wrapper format](https://dash.cdlib.org/stash_wrapper/stash_wrapper.xsd).
+[XML wrapper format](https://dash.ucop.edu/stash_wrapper/stash_wrapper.xsd).
 
 The `StashWrapper` object graph mostly mirrors the `stash_wrapper` schema, though some
 simpler elements have been collapsed into object attributes. Also, some classes and
@@ -126,7 +126,7 @@ to be nonsensical.
 ### Single file to standard output
 ```
 % gen_stash_wrapper_sample
-<st:stash_wrapper xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://dash.cdlib.org/stash_wrapper/ http://dash.cdlib.org/stash_wrapper/stash_wrapper.xsd' xmlns:st='http://dash.cdlib.org/stash_wrapper/'>
+<st:stash_wrapper xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='https://dash.ucop.edu/stash_wrapper/ https://dash.ucop.edu/stash_wrapper/stash_wrapper.xsd' xmlns:st='https://dash.ucop.edu/stash_wrapper/'>
   <st:identifier type='DOI'>10.21585/def1000001</st:identifier>
   <st:stash_administrative>
     <st:version>

data/Rakefile

@@ -8,7 +8,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
 
@@ -44,4 +44,4 @@ end
 # Defaults
 
 desc 'Run unit tests, check test coverage, check code style'
-task default: [:coverage, :rubocop]
+task default: %i[coverage rubocop]

data/example.rb

@@ -35,7 +35,8 @@ inventory = Inventory.new(
     StashFile.new(
       pathname: 'HSRC_MasterSampleII.sas7bdat', size_bytes: 123_456, mime_type: 'application/x-sas-data'
     )
-  ])
+  ]
+)
 
 datacite_file = 'spec/data/wrapper/wrapper-2-payload.xml'
 datacite_root = REXML::Document.new(File.read(datacite_file)).root

data/lib/stash/wrapper.rb

@@ -1,6 +1,6 @@
 module Stash
-  # Code relating to the {https://dash.cdlib.org/stash_wrapper/ Stash wrapper format}
+  # Code relating to the {https://dash.ucop.edu/stash_wrapper/ Stash wrapper format}
   module Wrapper
-    Dir.glob(File.expand_path('../wrapper/*.rb', __FILE__), &method(:require))
+    Dir.glob(File.expand_path('wrapper/*.rb', __dir__), &method(:require))
   end
 end

data/lib/stash/wrapper/descriptive_node.rb

@@ -8,9 +8,9 @@ module Stash
 
       # See `XML::Mapping::SingleAttributeNode#initialize`
       def initialize(*args)
-        path, *args = super(*args)
+        path, *myargs = super(*args)
         @path = ::XML::XXPath.new(path)
-        args
+        myargs # rubocop:disable Lint/Void
       end
 
       # Extracts the children of this element as an array.

data/lib/stash/wrapper/embargo.rb

@@ -18,14 +18,9 @@ module Stash
       # @param period [String] The embargo period
       # @param start_date [Date] The embargo start date
       # @param end_date [Date] The embargo end date
-      def initialize(type:, period:, start_date:, end_date:) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        fail ArgumentError, "Specified type does not appear to be an EmbargoType: #{type || 'nil'}" unless type && type.is_a?(EmbargoType)
-        fail ArgumentError, "Specified embargo period does not appear to be a non-empty string: #{period.inspect}" if period.to_s.strip.empty?
-        fail ArgumentError, "Specified start date does not appear to be a date: #{start_date || 'nil'}" unless start_date && start_date.respond_to?(:iso8601)
-        fail ArgumentError, "Specified end date does not appear to be a date: #{end_date || 'nil'}" unless end_date && end_date.respond_to?(:iso8601)
-
-        self.type = type
-        self.period = period.to_s
+      def initialize(type:, period:, start_date:, end_date:)
+        self.type = valid_type(type)
+        self.period = valid_period(period)
         self.start_date, self.end_date = valid_range(start_date, end_date)
       end
 
@@ -38,12 +33,27 @@ module Stash
 
       private
 
+      def valid_type(type)
+        return type if type.is_a?(EmbargoType)
+        raise ArgumentError, "Specified type does not appear to be an EmbargoType: #{type || 'nil'}"
+      end
+
+      def valid_period(period)
+        period_str = period.to_s
+        return period_str unless period_str.strip.empty?
+        raise ArgumentError, "Specified embargo period does not appear to be a non-empty string: #{period.inspect}"
+      end
+
       def valid_range(start_date, end_date)
-        if start_date > end_date
-          fail RangeError, "start_date #{start_date} must be <= end_date #{end_date}"
-        else
-          [start_date.to_date, end_date.to_date]
-        end
+        sd = valid_date(start_date)
+        ed = valid_date(end_date)
+        raise RangeError, "start_date #{sd} must be <= end_date #{ed}" if sd > ed
+        [sd.to_date, ed.to_date]
+      end
+
+      def valid_date(date)
+        return date if date && date.respond_to?(:iso8601)
+        raise ArgumentError, "Specified date does not appear to be a date: #{date || 'nil'}"
       end
     end
   end

data/lib/stash/wrapper/embargo_type.rb

@@ -4,7 +4,7 @@ module Stash
   module Wrapper
     # Controlled vocabulary for {Embargo#type}
     class EmbargoType < TypesafeEnum::Base
-      [:NONE, :DOWNLOAD, :DESCRIPTION].each { |t| new t }
+      %i[NONE DOWNLOAD DESCRIPTION].each { |t| new t }
     end
   end
 end

data/lib/stash/wrapper/identifier.rb

@@ -12,11 +12,15 @@ module Stash
 
       # Creates a new {Identifier}
       def initialize(type:, value:)
-        fail ArgumentError, "Identifier type does not appear to be an IdentifierType: #{type || 'nil'}" unless type && type.is_a?(IdentifierType)
-        fail ArgumentError, "Identifier value does not appear to be a non-empty string: #{value.inspect}" if value.to_s.strip.empty?
+        raise ArgumentError, "Identifier type does not appear to be an IdentifierType: #{type || 'nil'}" unless type.is_a?(IdentifierType)
+        raise ArgumentError, "Identifier value does not appear to be a non-empty string: #{value.inspect}" if value.to_s.strip.empty?
         self.type = type
         self.value = value
       end
+
+      def formatted
+        type.format(value)
+      end
     end
 
   end

data/lib/stash/wrapper/identifier_type.rb

@@ -8,6 +8,11 @@ module Stash
       new :DOI, 'DOI'
       new :HANDLE, 'Handle'
       new :URL, 'URL'
+
+      def format(id_value)
+        return id_value if self == URL || self == HANDLE # TODO: is this close enough?
+        "#{value.downcase}:#{id_value}"
+      end
     end
   end
 end

data/lib/stash/wrapper/inventory.rb

@@ -21,9 +21,9 @@ module Stash
       private
 
       def valid_file_array(files)
-        fail ArgumentError, "specified file list does not appear to be an array of StashFiles: #{files.inspect}" unless files.is_a?(Array)
+        raise ArgumentError, "specified file list does not appear to be an array of StashFiles: #{files.inspect}" unless files.is_a?(Array)
         files.each_with_index do |f, i|
-          fail ArgumentError, "files[#{i}] does not appear to be a StashFile: #{f.inspect}" unless f.is_a?(StashFile)
+          raise ArgumentError, "files[#{i}] does not appear to be a StashFile: #{f.inspect}" unless f.is_a?(StashFile)
         end
         files
       end

data/lib/stash/wrapper/license.rb

@@ -15,8 +15,8 @@ module Stash
       # @param uri [URI, String] The license URI
       # @raise [URI::InvalidURIError] if `uri` is a string that is not a valid URI
       def initialize(name:, uri:)
-        fail ArgumentError, "License name does not appear to be a non-empty string: #{name.inspect}" if name.to_s.strip.empty?
-        fail ArgumentError, 'No uri provided' unless uri
+        raise ArgumentError, "License name does not appear to be a non-empty string: #{name.inspect}" if name.to_s.strip.empty?
+        raise ArgumentError, 'No uri provided' unless uri
         self.name = name
         self.uri = ::XML::MappingExtensions.to_uri(uri)
       end

data/lib/stash/wrapper/module_info.rb

@@ -1,13 +1,13 @@
 module Stash
-  # Code relating to the {https://dash.cdlib.org/stash_wrapper/ Stash wrapper format}
+  # Code relating to the {https://dash.ucop.edu/stash_wrapper/ Stash wrapper format}
   module Wrapper
     # The name of this gem
-    NAME = 'stash-wrapper'
+    NAME = 'stash-wrapper'.freeze
 
     # The version of this gem
-    VERSION = '0.1.11.1'
+    VERSION = '0.1.12'.freeze
 
     # The copyright notice for this gem
-    COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'
+    COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'.freeze
   end
 end

data/lib/stash/wrapper/size.rb

@@ -14,10 +14,16 @@ module Stash
       # Creates a new {Size}
       # @param bytes [Integer] the size in bytes
       def initialize(bytes:)
-        fail ArgumentError, "specified file size does not appear to be an integer byte count: #{bytes || 'nil'}" unless bytes.respond_to?(:to_i) && bytes.to_i == bytes
-        self.size = bytes
+        self.size = valid_size(bytes)
         self.unit = SizeUnit::BYTE
       end
+
+      private
+
+      def valid_size(bytes)
+        return bytes if bytes && bytes.respond_to?(:to_i) && bytes == bytes.to_i
+        raise ArgumentError, "specified file size does not appear to be an integer byte count: #{bytes || 'nil'}"
+      end
     end
 
   end

data/lib/stash/wrapper/stash_administrative.rb

@@ -22,17 +22,37 @@ module Stash
       #   is supplied, it will default to an embargo of type {EmbargoType::NONE}
       #   with the current date as start and end.
       # @param inventory [Inventory, nil] the (optional) file inventory
-      def initialize(version:, license:, embargo: nil, inventory: nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        fail ArgumentError, "version does not appear to be a Version object: #{version || 'nil'}" unless version.is_a?(Version)
-        fail ArgumentError, "license does not appear to be a License object: #{license || 'nil'}" unless license.is_a?(License)
-        fail ArgumentError, "embargo does not appear to be an Embargo object: #{embargo || 'nil'}" if embargo unless embargo.is_a?(Embargo)
-        fail ArgumentError, "inventory does not appear to be an Inventory object: #{inventory || 'nil'}" if inventory unless inventory.is_a?(Inventory)
-
-        self.version = version
-        self.license = license
-        self.embargo = embargo || Embargo.none
-        self.inventory = inventory
+      def initialize(version:, license:, embargo: nil, inventory: nil)
+        self.version = valid_version(version)
+        self.license = valid_license(license)
+        self.embargo = valid_embargo(embargo)
+        self.inventory = valid_inventory_or_nil(inventory)
       end
+
+      private
+
+      def valid_version(version)
+        return version if version.is_a?(Version)
+        raise ArgumentError, "version does not appear to be a Version object: #{version || 'nil'}"
+      end
+
+      def valid_license(license)
+        return license if license.is_a?(License)
+        raise ArgumentError, "license does not appear to be a License object: #{license || 'nil'}"
+      end
+
+      def valid_embargo(embargo)
+        return Embargo.none unless embargo
+        return embargo if embargo.is_a?(Embargo)
+        raise ArgumentError, "embargo does not appear to be an Embargo object: #{embargo.inspect}"
+      end
+
+      def valid_inventory_or_nil(inventory)
+        return unless inventory
+        return inventory if inventory.is_a?(Inventory)
+        raise ArgumentError, "inventory does not appear to be an Inventory object: #{inventory || 'nil'}"
+      end
+
     end
   end
 end