merritt-manifest 0.1.0

data/spec/unit/merritt/manifest/object_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'ostruct'
+require 'tempfile'
+
+module Merritt
+  describe Manifest::Object do
+
+    describe 'sample' do
+
+      attr_reader :files
+      attr_reader :manifest
+
+      before(:each) do
+        @files = [
+          {
+            file_url: 'http://merritt.cdlib.org/samples/4blocks.jpg',
+            hash_algorithm: 'md5',
+            hash_value: '0b21c6d48e815dd537d42dc1cfac0111',
+            file_name: '4blocks.jpg'
+          },
+          {
+            file_url: 'http://merritt.cdlib.org/samples/4blocks.txt',
+            hash_algorithm: 'md5',
+            hash_value: 'ed04a855f89f31f8dc8e9bb946f5f159',
+            file_name: '4blocks.txt'
+          }
+        ].map { |h| OpenStruct.new(h) }
+        @manifest = Manifest::Object.new(files: files)
+      end
+
+      describe :write_to_string do
+        it 'writes an object manifest' do
+          path = '4blocks.checkm'
+          expected = File.read("spec/data/#{path}")
+          actual = manifest.write_to_string
+          if actual != expected
+            now = Time.now.to_i
+            FileUtils.mkdir('tmp') unless File.directory?('tmp')
+            File.open("tmp/#{now}-expected-#{path}", 'w') { |f| f.write(expected) }
+            File.open("tmp/#{now}-actual-#{path}", 'w') { |f| f.write(actual) }
+          end
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe :write_to_file do
+        it 'writes to a file' do
+          file = Tempfile.new('manifest.checkm')
+          begin
+            manifest.write_to(file)
+            file.close
+            actual = IO.read(file.path)
+            path = '4blocks.checkm'
+            expected = File.read("spec/data/#{path}")
+            actual = manifest.write_to_string
+            if actual != expected
+              now = Time.now.to_i
+              FileUtils.mkdir('tmp') unless File.directory?('tmp')
+              File.open("tmp/#{now}-expected-#{path}", 'w') { |f| f.write(expected) }
+              File.open("tmp/#{now}-actual-#{path}", 'w') { |f| f.write(actual) }
+            end
+          ensure
+            file.delete
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/merritt/manifest_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+module Merritt
+  describe Manifest do
+
+    attr_reader :dataone_profile
+
+    before(:each) do
+      @dataone_profile = 'http://uc3.cdlib.org/registry/ingest/manifest/mrt-dataone-manifest'
+    end
+
+    describe :new do
+      it 'creates a new manifest' do
+        manifest = Manifest.new(profile: dataone_profile)
+        expect(manifest).to be_a(Manifest)
+      end
+
+      describe :conformance do
+        it 'defaults to CheckM 0.7' do
+          manifest = Manifest.new(profile: dataone_profile)
+          expect(manifest.conformance).to eq('checkm_0.7')
+        end
+      end
+
+      describe :profile do
+        it 'accepts a string' do
+          profile_str = dataone_profile
+          manifest = Manifest.new(profile: profile_str)
+          expect(manifest.profile).to eq(URI.parse(profile_str))
+        end
+
+        it 'accepts a URI' do
+          profile = URI.parse(dataone_profile)
+          manifest = Manifest.new(profile: profile)
+          expect(manifest.profile).to eq(profile)
+        end
+
+        it 'requires a profile' do
+          expect { Manifest.new }.to raise_error(ArgumentError)
+        end
+
+        it 'requires profile to be a URL' do
+          expect { Manifest.new(profile: 'elvis') }.to raise_error(ArgumentError)
+        end
+
+        it 'requires a Merritt manifest profile' do
+          profile = 'http://example.org/my-profile'
+          expect { Manifest.new(profile: profile) }.to raise_error(ArgumentError)
+        end
+      end
+
+      describe :prefixes do
+        it 'defaults to empty' do
+          manifest = Manifest.new(profile: dataone_profile)
+          prefixes = manifest.prefixes
+          expect(prefixes).to be_a(Hash)
+          expect(prefixes).to be_empty
+        end
+
+        it 'normalizes keys to symbols and values to URIs' do
+          in_prefixes = {
+            :mrt => URI('http://merritt.cdlib.org/terms#'),
+            'dom' => 'http://uc3.cdlib.org/ontology/dataonem',
+            :nfo => 'http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#'
+          }
+          manifest = Manifest.new(profile: dataone_profile, prefixes: in_prefixes)
+          out_prefixes = manifest.prefixes
+          expect(out_prefixes.size).to eq(in_prefixes.size)
+          expect(out_prefixes[:mrt]).to eq(in_prefixes[:mrt])
+          expect(out_prefixes[:dom]).to eq(URI(in_prefixes['dom']))
+          expect(out_prefixes[:nfo]).to eq(URI(in_prefixes[:nfo]))
+        end
+      end
+
+      describe :fields do
+        it 'defaults to empty' do
+          manifest = Manifest.new(profile: dataone_profile)
+          fields = manifest.fields
+          expect(fields).to be_an(Array)
+          expect(fields).to be_empty
+        end
+
+        it 'accepts a list of fields' do
+          in_fields = %w[dom:scienceMetadataFile dom:scienceMetadataFormat dom:scienceDataFile mrt:mimeType]
+          manifest = Manifest.new(
+            profile: dataone_profile,
+            fields: in_fields,
+            prefixes: {
+              mrt: 'http://merritt.cdlib.org/terms#',
+              dom: 'http://uc3.cdlib.org/ontology/dataonem'
+            }
+          )
+          out_fields = manifest.fields
+          expect(out_fields.size).to eq(in_fields.size)
+          expect(out_fields).to eq(in_fields)
+          expect(out_fields).not_to be(in_fields)
+        end
+      end
+
+      describe :entries do
+        it 'accepts a list of entries' do
+
+          in_entries = [
+            {
+              'dom:scienceMetadataFile' => 'mrt-datacite.xml',
+              'dom:scienceMetadataFormat' => 'http://datacite.org/schema/kernel-3.1',
+              'dom:scienceDataFile' => 'Laney_300394_Exempt_Determination_Letter.pdf',
+              'mrt:mimeType' => 'application/pdf'
+            },
+            {
+              'dom:scienceMetadataFile' => 'mrt-oaidc.xml',
+              'dom:scienceMetadataFormat' => 'http://dublincore.org/schemas/xmls/qdc/2008/02/11/qualifieddc.xsd',
+              'dom:scienceDataFile' => 'Laney_300394_Exempt_Determination_Letter.pdf',
+              'mrt:mimeType' => 'application/pdf'
+            }
+          ]
+
+          manifest = Manifest.new(
+            profile: dataone_profile,
+            fields: %w[dom:scienceMetadataFile dom:scienceMetadataFormat dom:scienceDataFile mrt:mimeType],
+            prefixes: {
+              mrt: 'http://merritt.cdlib.org/terms#',
+              dom: 'http://uc3.cdlib.org/ontology/dataonem'
+            },
+            entries: in_entries
+          )
+
+          out_entries = manifest.entries
+          expect(out_entries).to eq(in_entries)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: merritt-manifest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Moles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typesafe_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Merritt manifest generation library
+email:
+- david.moles@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/emacs.xml"
+- ".idea/encodings.xml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/sbt.xml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/merritt.rb
+- lib/merritt/manifest.rb
+- lib/merritt/manifest/data_one.rb
+- lib/merritt/manifest/fields.rb
+- lib/merritt/manifest/file.rb
+- lib/merritt/manifest/module_info.rb
+- lib/merritt/manifest/object.rb
+- lib/merritt/util.rb
+- merritt-manifest.gemspec
+- merritt-manifest.iml
+- spec/.rubocop.yml
+- spec/data/4blocks.checkm
+- spec/data/mrt-dataone-manifest.txt
+- spec/data/sampleBatchOfContainers.checkm
+- spec/data/sampleBatchOfFiles.checkm
+- spec/data/sampleBatchOfManifests.checkm
+- spec/spec_helper.rb
+- spec/unit/merritt/manifest/data_one_spec.rb
+- spec/unit/merritt/manifest/fields_spec.rb
+- spec/unit/merritt/manifest/object_spec.rb
+- spec/unit/merritt/manifest_spec.rb
+homepage: http://github.com/merritt-manifest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Merritt manifest generation library
+test_files:
+- spec/.rubocop.yml
+- spec/data/4blocks.checkm
+- spec/data/mrt-dataone-manifest.txt
+- spec/data/sampleBatchOfContainers.checkm
+- spec/data/sampleBatchOfFiles.checkm
+- spec/data/sampleBatchOfManifests.checkm
+- spec/spec_helper.rb
+- spec/unit/merritt/manifest/data_one_spec.rb
+- spec/unit/merritt/manifest/fields_spec.rb
+- spec/unit/merritt/manifest/object_spec.rb
+- spec/unit/merritt/manifest_spec.rb