hydra-works 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5992ee7b9f7184fd70053978e0604cd9ed10ccc
-  data.tar.gz: 20f024bb82a6b76da36d5197dc7709879d44c690
+  metadata.gz: 3fe62ca3557324aa1d06b321706bef921ed64768
+  data.tar.gz: afc8ed7122ec5a3902905dca229a5a1768665090
 SHA512:
-  metadata.gz: 76b34210f7d2fbb513108ed8637d0d7b302ee35f205ed9a2333dd479f34d576caf7bc8c3c399724de9100980ebe2a2e18efc6500e437924f41d657735ab9c593
-  data.tar.gz: 3a213fa47a3feafd53474ede6e5b2211ee9706e647694e393655b3744e1b0f8b062a37adc461731561300876b123702ab6a65cf709aafe5f630dc9999187ce1e
+  metadata.gz: 9ca71d423754de86d680ac3e3dd28e7f367c202e5db3a3182e74fafa56ffe9dadcc29b731f9908f6efd97244561e05df7d6bccd5a6c271e492bdf5ac2366431e
+  data.tar.gz: f6ae7e93b05b5cfa69d22a48db2b163a72af5a61033bc88a0869ee25ab706b25843f257c1b7fba33775e99daf7d99cf310ec68c1c9e0ae78d2a3eb1513af9f04

data/.gitignore

@@ -20,3 +20,4 @@ fcrepo4-test-data/
 .DS_Store
 .ruby-gemset
 .ruby-version
+/spec/examples.txt

data/.rspec

@@ -1 +1,2 @@
---colour
+--color
+--require spec_helper

data/lib/hydra/works.rb

@@ -51,6 +51,8 @@ module Hydra
       autoload :UploadFileToFileSet
       autoload :PersistDerivative
       autoload :CharacterizationService
+      autoload :DetermineMimeType
+      autoload :DetermineOriginalName
     end
 
     ActiveFedora::WithMetadata::DefaultMetadataClassFactory.file_metadata_schemas +=

data/lib/hydra/works/services/add_file_to_file_set.rb

@@ -37,43 +37,19 @@ module Hydra::Works
 
       private
 
+        # Persist a new file with its containing file set; otherwise, just save the file itself
         def persist
           if current_file.new_record?
-            # persist current_file and its membership in file_set.files container
             file_set.save
           else
-            # we updated the content of an existing file, so we need to save the file explicitly
             current_file.save
           end
         end
 
         def attach_attributes(file)
           current_file.content = file
-          current_file.original_name = determine_original_name(file)
-          current_file.mime_type = determine_mime_type(file)
-        end
-
-        # Return mime_type based on methods available to file
-        # @param object for mimetype to be determined. Attempts to use methods: :mime_type, :content_type, and :path.
-        def determine_mime_type(file)
-          return file.mime_type if file.respond_to? :mime_type
-          return file.content_type if file.respond_to? :content_type
-          return Hydra::PCDM::GetMimeTypeForFile.call(file.path) if file.respond_to? :path
-          'application/octet-stream'
-        end
-
-        # Return original_name based on methods available to file
-        # @param object for original name to be determined. Attempts to use methods: :original_name, :original_filename, and :path.
-        def determine_original_name(file)
-          if file.respond_to? :original_name
-            file.original_name
-          elsif file.respond_to? :original_filename
-            file.original_filename
-          elsif file.respond_to? :path
-            ::File.basename(file.path)
-          else
-            ''
-          end
+          current_file.original_name = DetermineOriginalName.call(file)
+          current_file.mime_type = DetermineMimeType.call(file, current_file.original_name)
         end
 
         # @param [Symbol, RDF::URI] the type of association or filter to use

data/lib/hydra/works/services/determine_mime_type.rb

@@ -0,0 +1,39 @@
+module Hydra::Works
+  class DetermineMimeType
+    # Determines the mime type for a given file
+    # @param [IO, File, Rack::Multipart::UploadedFile, #read] file
+    # @param [String, NilClass] original_name of the file
+    # @return [String]
+    def self.call(file, original_name = nil)
+      new(file, original_name).determine_mime_type
+    end
+
+    attr_reader :file, :original_name
+
+    def initialize(file, original_name)
+      @file = file
+      @original_name = original_name
+    end
+
+    def determine_mime_type
+      return file.mime_type if mime_type?
+      return file.content_type if content_type?
+      mime_type_from_name_or_path || 'application/octet-stream'
+    end
+
+    def mime_type_from_name_or_path
+      return Hydra::PCDM::GetMimeTypeForFile.call(original_name) if original_name.present?
+      return Hydra::PCDM::GetMimeTypeForFile.call(file.path) if file.respond_to?(:path)
+    end
+
+    private
+
+      def mime_type?
+        file.respond_to?(:mime_type) && file.mime_type.present?
+      end
+
+      def content_type?
+        file.respond_to?(:content_type) && file.content_type.present?
+      end
+  end
+end

data/lib/hydra/works/services/determine_original_name.rb

@@ -0,0 +1,13 @@
+module Hydra::Works
+  class DetermineOriginalName
+    # Determines the original name for a given file
+    # @param [IO, File, Rack::Multipart::UploadedFile, #read] file
+    # @return [String]
+    def self.call(file)
+      return file.original_name if file.respond_to?(:original_name)
+      return file.original_filename if file.respond_to?(:original_filename)
+      return ::File.basename(file.path) if file.respond_to?(:path)
+      ''
+    end
+  end
+end

data/lib/hydra/works/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Works
-    VERSION = '0.13.0'.freeze
+    VERSION = '0.14.0'.freeze
   end
 end

data/spec/hydra/works/services/add_file_to_file_set_spec.rb

@@ -54,7 +54,7 @@ describe Hydra::Works::AddFileToFileSet do
   end
 
   context 'when the file does not support any of the methods' do
-    let(:file3) { double('file') }
+    let(:file3) { instance_double(File) }
     before do
       allow(file3).to receive(:read).and_return('')
       allow(file3).to receive(:size).and_return(0)
@@ -67,10 +67,10 @@ describe Hydra::Works::AddFileToFileSet do
     end
   end
 
-  context 'file responds to :path but not to :mime_type nor :original_name' do
-    it 'defaults to Hydra::PCDM for mimetype and ::File for basename.' do
-      expect(Hydra::PCDM::GetMimeTypeForFile).to receive(:call).with(file.path)
-      expect(::File).to receive(:basename).with(file.path)
+  context 'when determining mime type and name' do
+    it 'uses services to assign the values' do
+      expect(Hydra::Works::DetermineOriginalName).to receive(:call).with(file)
+      expect(Hydra::Works::DetermineMimeType).to receive(:call).with(file, nil)
       described_class.call(file_set, file, type)
     end
   end

data/spec/hydra/works/services/determine_mime_type_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Hydra::Works::DetermineMimeType do
+  let(:original_name) { nil }
+  let(:file) { File.open(File.join(fixture_path, 'sample-file.pdf')) }
+
+  subject { described_class.call(file, original_name) }
+
+  context "when file has :mime_type" do
+    before { allow(file).to receive(:mime_type).and_return("mime_type") }
+    it { is_expected.to eq("mime_type") }
+  end
+
+  context "when file has :content_type" do
+    before { allow(file).to receive(:content_type).and_return("content_type") }
+    it { is_expected.to eq("content_type") }
+  end
+
+  context "when file has :path" do
+    it { is_expected.to eq("application/pdf") }
+  end
+
+  context "when an original_name is supplied" do
+    let(:original_name) { "some-other-file.txt" }
+    it { is_expected.to eq("text/plain") }
+  end
+
+  context "when an empty original_name is supplied" do
+    let(:original_name) { "" }
+    it { is_expected.to eq("application/pdf") }
+  end
+
+  context "when all else fails" do
+    before do
+      allow(file).to receive(:respond_to?).with(:mime_type).and_return(false)
+      allow(file).to receive(:respond_to?).with(:content_type).and_return(false)
+      allow(file).to receive(:respond_to?).with(:path).and_return(false)
+    end
+    it { is_expected.to eq("application/octet-stream") }
+  end
+end

data/spec/hydra/works/services/determine_original_name_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Hydra::Works::DetermineOriginalName do
+  let(:file) { File.open(File.join(fixture_path, 'sample-file.pdf')) }
+
+  subject { described_class.call(file) }
+
+  context "when file has :original_name" do
+    before { allow(file).to receive(:original_name).and_return("original_name") }
+    it { is_expected.to eq("original_name") }
+  end
+
+  context "when file has :original_filename" do
+    before { allow(file).to receive(:original_filename).and_return("original_filename") }
+    it { is_expected.to eq("original_filename") }
+  end
+
+  context "when file has :path" do
+    it { is_expected.to eq("sample-file.pdf") }
+  end
+
+  context "when all else fails" do
+    before do
+      allow(file).to receive(:respond_to?).with(:original_name).and_return(false)
+      allow(file).to receive(:respond_to?).with(:original_filename).and_return(false)
+      allow(file).to receive(:respond_to?).with(:path).and_return(false)
+    end
+    it { is_expected.to be_empty }
+  end
+end

data/spec/hydra/works/services/virus_checker_service_spec.rb

@@ -7,7 +7,7 @@ describe Hydra::Works::VirusCheckerService do
 
   context '.file_has_virus?' do
     it 'is a convenience method' do
-      mock_object = double(file_has_virus?: true)
+      mock_object = instance_double(described_class, file_has_virus?: true)
       allow(described_class).to receive(:new).and_return(mock_object)
       described_class.file_has_virus?(file)
       expect(mock_object).to have_received(:file_has_virus?)

data/spec/spec_helper.rb

@@ -28,18 +28,75 @@ Dir['./spec/support/**/*.rb'].each { |f| require f }
 # HttpLogger.log_headers = true
 
 RSpec.configure do |config|
-  config.color = true
-  config.tty = true
-
   # Uncomment the following line to get errors and backtrace for deprecation warnings
   # config.raise_errors_for_deprecations!
 
-  # Use the specified formatter
-  config.formatter = :progress
-
   config.before :each do |example|
     ActiveFedora::Cleaner.clean! unless example.metadata[:no_clean]
   end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end
 
 def fixture_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-works
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hydra-pcdm
@@ -227,6 +227,8 @@ files:
 - lib/hydra/works/not_file_set_validator.rb
 - lib/hydra/works/services/add_file_to_file_set.rb
 - lib/hydra/works/services/characterization_service.rb
+- lib/hydra/works/services/determine_mime_type.rb
+- lib/hydra/works/services/determine_original_name.rb
 - lib/hydra/works/services/persist_derivative.rb
 - lib/hydra/works/services/upload_file_to_file_set.rb
 - lib/hydra/works/services/virus_checker_service.rb
@@ -282,6 +284,8 @@ files:
 - spec/hydra/works/models/work_spec.rb
 - spec/hydra/works/services/add_file_to_file_set_spec.rb
 - spec/hydra/works/services/characterization_service_spec.rb
+- spec/hydra/works/services/determine_mime_type_spec.rb
+- spec/hydra/works/services/determine_original_name_spec.rb
 - spec/hydra/works/services/persist_derivatives_spec.rb
 - spec/hydra/works/services/upload_file_spec.rb
 - spec/hydra/works/services/virus_checker_service_spec.rb
@@ -318,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Fundamental repository data model for hydra
@@ -356,6 +360,8 @@ test_files:
 - spec/hydra/works/models/work_spec.rb
 - spec/hydra/works/services/add_file_to_file_set_spec.rb
 - spec/hydra/works/services/characterization_service_spec.rb
+- spec/hydra/works/services/determine_mime_type_spec.rb
+- spec/hydra/works/services/determine_original_name_spec.rb
 - spec/hydra/works/services/persist_derivatives_spec.rb
 - spec/hydra/works/services/upload_file_spec.rb
 - spec/hydra/works/services/virus_checker_service_spec.rb