stash-wrapper 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b9b2b3b3b61546cb479b5641e250d4494daee32
-  data.tar.gz: 88c5ce1cab8a9868b69b0905cb848346b3bebe33
+  metadata.gz: ffbc971060572311562d5cddea48605f7c6d152f
+  data.tar.gz: 80c7a4e1e610b4f945dfded51cb3f6835362d62e
 SHA512:
-  metadata.gz: ca3ccf0129d471e5d3c92625784cdc03d4221c9691ea943e75ff73f354773c7082d92425cc16e6545056036165b9d9062376e20dd2044a5f43ae1de3830ab26c
-  data.tar.gz: 93c73e6f99e009f811618145daa9b90820d094257b17f39cafac5f5c934584ab81d4efdc5a6c124e41a406c0aa5e41568e2f679d34f7b0154cf8349c9074c18d
+  metadata.gz: 692b374270d158d5e7c45fc3e7ca3b5fda1c43df8d465e28171977fd332063eb8264527eb245174719314b9be0393edc439d4c2f720fb0a3f1ccb5870486fd64
+  data.tar.gz: c35a351a76d85e7f25d843a169fd7acc15a28a073f94eb23bd2c04e6afe01e05f16bea9e903d610cb3c4026c32554e725640a01ef20779dff88f2dd16a3f5098

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.1.2 (31 March 2016)
+
+- Add convenience method `Embargo.none` to create a no-embargo embargo element
+- Make `StashAdministrative` (and thereby `StashWrapper`) default to `Embargo.none`
+  if no `Embargo` is provided
+
 # 0.1.1 (16 March 2016)
 
 - Fix gem metadata

data/lib/stash/wrapper/embargo.rb

@@ -24,6 +24,13 @@ module Stash
         self.start_date = start_date
         self.end_date = end_date
       end
+
+      # Creates a new `Embargo` instance of type {EmbargoType::NONE} with the current date as start and end.
+      # @return [Embargo]
+      def self.none
+        today = Date.today
+        new(type: EmbargoType::NONE, period: EmbargoType::NONE.value, start_date: today, end_date: today)
+      end
     end
 
   end

data/lib/stash/wrapper/module_info.rb

@@ -5,7 +5,7 @@ module Stash
     NAME = 'stash-wrapper'
 
     # The version of this gem
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'

data/lib/stash/wrapper/stash_administrative.rb

@@ -18,14 +18,14 @@ module Stash
       #
       # @param version [Version] the version
       # @param license [License] the license
-      # @param embargo [Embargo] the embargo. Note that per the schema,
-      #   an `<st:embargo>` element is required even if there is no embargo
-      #   on the dataset (in which case it should use {EmbargoType::NONE}).
+      # @param embargo [Embargo, nil] the embargo information. If no `Embargo`
+      #   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:, inventory: nil)
+      def initialize(version:, license:, embargo: nil, inventory: nil)
         self.version = version
         self.license = license
-        self.embargo = embargo
+        self.embargo = embargo || Embargo.none
         self.inventory = inventory
       end
     end

data/lib/stash/wrapper/stash_wrapper.rb

@@ -29,13 +29,13 @@ module Stash
       # @param identifier [Identifier] the identifier
       # @param version [Version] the version
       # @param license [License] the license
-      # @param embargo [Embargo] the embargo. Note that per the schema,
-      #   an `<st:embargo>` element is required even if there is no embargo
-      #   on the dataset (in which case it should use {EmbargoType::NONE}).
+      # @param embargo [Embargo, nil] the embargo information. If no `Embargo`
+      #   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
       # @param descriptive_elements [Array<REXML::Element>] the encapsulated
       #   XML metadata
-      def initialize(identifier:, version:, license:, embargo:, inventory: nil, descriptive_elements:) # rubocop:disable Metrics/ParameterLists
+      def initialize(identifier:, version:, license:, embargo: nil, inventory: nil, descriptive_elements:) # rubocop:disable Metrics/ParameterLists
         self.identifier = identifier
         self.stash_administrative = StashAdministrative.new(
           version: version,

data/spec/unit/stash/wrapper/embargo_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Stash
+  module Wrapper
+    describe Embargo do
+      describe 'none' do
+        it "returns a no-embargo #{Embargo}" do
+          embargo = Embargo.none
+          expect(embargo).to be_an(Embargo)
+          expect(embargo.type).to eq(EmbargoType::NONE)
+          expect(embargo.period).to eq('none')
+          today = Date.today
+          expect(embargo.start_date).to eq(today)
+          expect(embargo.end_date).to eq(today)
+        end
+      end
+    end
+  end
+end

data/spec/unit/stash/wrapper/stash_administrative_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Stash
+  module Wrapper
+    describe StashAdministrative do
+      describe '#initialize' do
+        it 'defaults to no embargo' do
+          admin = StashAdministrative.new(
+            version: Version.new(number: 1, date: Date.new(2013, 8, 18), note: 'Sample wrapped Datacite document'),
+            license: License::CC_BY,
+            inventory: Inventory.new(
+              files: [
+                StashFile.new(pathname: 'HSRC_MasterSampleII.dat', size_bytes: 12_345, mime_type: 'text/plain')
+              ])
+          )
+          embargo = admin.embargo
+          expect(embargo).to be_an(Embargo)
+          expect(embargo.type).to eq(EmbargoType::NONE)
+          expect(embargo.period).to eq('none')
+          today = Date.today
+          expect(embargo.start_date).to eq(today)
+          expect(embargo.end_date).to eq(today)
+        end
+      end
+    end
+  end
+end

data/spec/unit/stash/wrapper/stash_wrapper_spec.rb

@@ -136,6 +136,28 @@ module Stash
         end
       end
 
+      describe '#initialize' do
+        it 'defaults to no embargo' do
+          wrapper = StashWrapper.new(
+            identifier: Identifier.new(type: IdentifierType::DOI, value: '10.14749/1407399498'),
+            version: Version.new(number: 1, date: Date.new(2013, 8, 18), note: 'Sample wrapped Datacite document'),
+            license: License::CC_BY,
+            inventory: Inventory.new(
+              files: [
+                StashFile.new(pathname: 'HSRC_MasterSampleII.dat', size_bytes: 12_345, mime_type: 'text/plain')
+              ]),
+            descriptive_elements: []
+          )
+          embargo = wrapper.embargo
+          expect(embargo).to be_an(Embargo)
+          expect(embargo.type).to eq(EmbargoType::NONE)
+          expect(embargo.period).to eq('none')
+          today = Date.today
+          expect(embargo.start_date).to eq(today)
+          expect(embargo.end_date).to eq(today)
+        end
+      end
+
       describe '#save_to_xml' do
 
         describe 'namespace handling' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stash-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typesafe_enum
@@ -205,6 +205,8 @@ files:
 - spec/data/wrapper/wrapper-2.xml
 - spec/rspec_custom_matchers.rb
 - spec/spec_helper.rb
+- spec/unit/stash/wrapper/embargo_spec.rb
+- spec/unit/stash/wrapper/stash_administrative_spec.rb
 - spec/unit/stash/wrapper/stash_wrapper_spec.rb
 - stash-wrapper.gemspec
 homepage: http://github.com/CDLUC3/stash-wrapper
@@ -241,5 +243,7 @@ test_files:
 - spec/data/wrapper/wrapper-2.xml
 - spec/rspec_custom_matchers.rb
 - spec/spec_helper.rb
+- spec/unit/stash/wrapper/embargo_spec.rb
+- spec/unit/stash/wrapper/stash_administrative_spec.rb
 - spec/unit/stash/wrapper/stash_wrapper_spec.rb
 has_rdoc: