hydra-file_characterization 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45f7b237836fc29047cfa5977c7a2644f5789059c846da12316f3ddd7aaa881c
-  data.tar.gz: 2c3e32837e473c11ef863993aa87c7874e07cf41504690bda7adc94e5c443341
+  metadata.gz: c5d7bfac9adb8dec899a9e598255637841aaeba51754c56ac52f4e6eda93f5d1
+  data.tar.gz: f5cd50a069ada9dede312853101cdb463cbd722db331d418ae18cb7fe2641e6f
 SHA512:
-  metadata.gz: 3fcd0bee8d7b702a15a207a0ca07f65d7dc05e00ad1d13c537c1072fa12ded45236e2f301d89dd6eea74ec0b9260bc075e5bf340cce81e1f3eb886978ee5cb78
-  data.tar.gz: 8edf19cab005e79a44b18edc1e4a6b086c30ac20d4fa251fdf036b95660d13d055cf17f2fa37cac7040314c7790f277bb37e45af2463bcd91d7dc2c6857c1bad
+  metadata.gz: 9d478b249740cbf248f0ea4e053541d9169104920040bb2e563018bee9c0b58ac3419e07b2c937f4e4ae6015a6c4be11a712a9a6fd3a1825d7ba0d0528f16a30
+  data.tar.gz: 97d13c1f85ca53511a707d5e5338fcbc72c6405bc85bd99b3beaacd34e4faad735a04362f90a948c03cb1700de9145487b81c96d9fc57488a32647f84378d834

data/.circleci/config.yml

@@ -38,6 +38,7 @@ jobs:
           command: |
             echo "export PATH=$HOME/fits:$PATH" >> $BASH_ENV
             source $BASH_ENV
+      - samvera/rubocop
       - samvera/parallel_rspec
 
 workflows:

data/.github_changelog_generator

@@ -1,2 +1,2 @@
 unreleased=true
-future-release=1.1.1
+future-release=1.1.2

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - spec/lib/hydra/file_characterization_spec.rb
+    - vendor/bundle/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,92 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-06-10 16:20:03 -0400 using RuboCop version 0.85.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, AutoCorrect, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/hydra/file_characterization.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 293
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 50
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.rake'
+    - 'Capfile'
+    - 'config/deploy/*'
+    - 'lib/hydra-file_characterization.rb'
+
+# Offense count: 2
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/lib/hydra/file_characterization/to_temp_file_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/lib/hydra/file_characterization/to_temp_file_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 9
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/lib/hydra/file_characterization/characterizer_spec.rb'
+    - 'spec/lib/hydra/file_characterization/characterizers/ffprobe_spec.rb'
+    - 'spec/lib/hydra/file_characterization/characterizers/fit_servlet_spec.rb'
+    - 'spec/lib/hydra/file_characterization/characterizers/fits_spec.rb'
+    - 'spec/lib/hydra/file_characterization/characterizers_spec.rb'
+    - 'spec/lib/hydra/file_characterization/to_temp_file_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Exclude:
+    - 'lib/hydra/file_characterization.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/hydra/file_characterization/characterizers.rb'

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Changelog
 
-## [1.1.1](https://github.com/samvera/hydra-file_characterization/tree/1.1.1) (2020-06-10)
+## [1.1.2](https://github.com/samvera/hydra-file_characterization/tree/1.1.2) (2020-06-10)
 
-[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.1.0...1.1.1)
+[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.1.1...1.1.2)
+
+**Merged pull requests:**
+
+- Enforce samvera style rules [\#49](https://github.com/samvera/hydra-file_characterization/pull/49) ([bess](https://github.com/bess))
+
+## [v1.1.1](https://github.com/samvera/hydra-file_characterization/tree/v1.1.1) (2020-06-10)
+
+[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.1.0...v1.1.1)
 
 **Closed issues:**
 
@@ -12,6 +20,7 @@
 
 **Merged pull requests:**
 
+- Prep for 1.1.1 release [\#48](https://github.com/samvera/hydra-file_characterization/pull/48) ([bess](https://github.com/bess))
 - Adding Ruby 2.7.z and Rails 6.y.z releases to the CircleCI build configuration [\#46](https://github.com/samvera/hydra-file_characterization/pull/46) ([jrgriffiniii](https://github.com/jrgriffiniii))
 - Update CircleCI Ruby and Rails versions [\#43](https://github.com/samvera/hydra-file_characterization/pull/43) ([botimer](https://github.com/botimer))
 - Updates the CircleCI configuration to test against Rails release 5.1.7 and Ruby releases 2.6.3, 2.5.5, and 2.4.6 [\#42](https://github.com/samvera/hydra-file_characterization/pull/42) ([jrgriffiniii](https://github.com/jrgriffiniii))

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hydra/file_characterization.gemspec

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require 'rspec/core'
 require 'rspec/core/rake_task'

data/hydra-file_characterization.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hydra/file_characterization/version'
@@ -12,23 +13,24 @@ Gem::Specification.new do |gem|
     "Sue Richeson",
     "Rajesh Balekai"
   ]
-  gem.email         = [
+  gem.email = [
     "jatr@kb.dk",
     "jeremy.n.friesen@gmail.com",
     "spr7b@virginia.edu",
     "rbalekai@gmail.com"
   ]
-  gem.description   = %q{To provide a wrapper for file characterization}
-  gem.summary       = %q{To provide a wrapper for file characterization}
+  gem.description   = 'To provide a wrapper for file characterization'
+  gem.summary       = 'To provide a wrapper for file characterization'
   gem.homepage      = "https://github.com/projecthydra/hydra-file_characterization"
   gem.license = "APACHE2"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
   gem.add_dependency "activesupport", ">= 3.0.0"
+  gem.add_development_dependency 'bixby', '~> 3.0.0'
   gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'github_changelog_generator'
   gem.add_development_dependency "guard"

data/lib/hydra-file_characterization.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require "hydra/file_characterization"

data/lib/hydra/file_characterization.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "hydra/file_characterization/version"
 require "hydra/file_characterization/exceptions"
 require "hydra/file_characterization/to_temp_file"
@@ -6,7 +7,6 @@ require "hydra/file_characterization/characterizers"
 require "active_support/configurable"
 
 module Hydra
-
   module_function
 
   # A convenience method
@@ -15,7 +15,6 @@ module Hydra
   end
 
   module FileCharacterization
-
     class << self
       attr_accessor :configuration
     end
@@ -66,7 +65,7 @@ module Hydra
       tool_names = Array(tool_names).flatten.compact
       custom_paths = {}
       yield(custom_paths) if block_given?
-      
+
       tool_outputs = run_characterizers(content, filename, tool_names, custom_paths)
       tool_names.size == 1 ? tool_outputs.first : tool_outputs
     end
@@ -76,50 +75,47 @@ module Hydra
       yield(configuration)
     end
 
-    private
-
-      # Break up a list of arguments into two possible lists:
-      #   option1:  [String] content, [String] filename, [Array] tool_names
-      #   option2:  [File] content, [Array] tool_names
-      # In the case of option2, derive the filename from the file's path  
-      # @return [String, File], [String], [Array]
-      def self.extract_arguments(args)
-        content = args.shift
-        filename = if content.is_a?(File) && !args[0].is_a?(String)
-          File.basename(content.path)
-        else
-           args.shift
-        end
-        tool_names = args
-        return content, filename, tool_names
+    # Break up a list of arguments into two possible lists:
+    #   option1:  [String] content, [String] filename, [Array] tool_names
+    #   option2:  [File] content, [Array] tool_names
+    # In the case of option2, derive the filename from the file's path
+    # @return [String, File], [String], [Array]
+    def self.extract_arguments(args)
+      content = args.shift
+      filename = if content.is_a?(File) && !args[0].is_a?(String)
+                   File.basename(content.path)
+                 else
+                   args.shift
       end
+      tool_names = args
+      [content, filename, tool_names]
+    end
 
-      # @param [File, String] content Either an open file or a string. If a string is passed
-      #                               a temp file will be created
-      # @param [String] filename Used in creating a temp file name
-      # @param [Array<Symbol>] tool_names A list of symbols referencing the characerization tools to run
-      # @param [Hash] custom_paths The paths to the executables of the tool.
-      def self.run_characterizers(content, filename, tool_names, custom_paths)
-        if content.is_a? File
-          run_characterizers_on_file(content, tool_names, custom_paths)
-        else 
-          FileCharacterization::ToTempFile.open(filename, content) do |f|
-            run_characterizers_on_file(f, tool_names, custom_paths)
-          end
+    # @param [File, String] content Either an open file or a string. If a string is passed
+    #                               a temp file will be created
+    # @param [String] filename Used in creating a temp file name
+    # @param [Array<Symbol>] tool_names A list of symbols referencing the characerization tools to run
+    # @param [Hash] custom_paths The paths to the executables of the tool.
+    def self.run_characterizers(content, filename, tool_names, custom_paths)
+      if content.is_a? File
+        run_characterizers_on_file(content, tool_names, custom_paths)
+      else
+        FileCharacterization::ToTempFile.open(filename, content) do |f|
+          run_characterizers_on_file(f, tool_names, custom_paths)
         end
       end
+    end
 
-      def self.run_characterizers_on_file(f, tool_names, custom_paths)
-        tool_names.map do |tool_name|
-           FileCharacterization.characterize_with(tool_name, f.path, custom_paths[tool_name])
-        end
+    def self.run_characterizers_on_file(f, tool_names, custom_paths)
+      tool_names.map do |tool_name|
+        FileCharacterization.characterize_with(tool_name, f.path, custom_paths[tool_name])
       end
+    end
 
     class Configuration
       def tool_path(tool_name, tool_path)
         Hydra::FileCharacterization.characterizer(tool_name).tool_path = tool_path
       end
     end
-
   end
 end

data/lib/hydra/file_characterization/characterizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'hydra/file_characterization/exceptions'
 require 'open3'
 require 'active_support/core_ext/class/attribute'
@@ -15,9 +16,7 @@ module Hydra::FileCharacterization
     end
 
     def call
-      unless File.exists?(filename)
-        raise Hydra::FileCharacterization::FileNotFoundError.new("File: #{filename} does not exist.")
-      end
+      raise Hydra::FileCharacterization::FileNotFoundError, "File: #{filename} does not exist." unless File.exist?(filename)
 
       post_process(output)
     end
@@ -32,47 +31,47 @@ module Hydra::FileCharacterization
 
     protected
 
-      # Override this method if you want your processor to mutate the
-      # raw output
-      def post_process(raw_output)
-        raw_output
-      end
+    # Override this method if you want your processor to mutate the
+    # raw output
+    def post_process(raw_output)
+      raw_output
+    end
 
-      def convention_based_tool_name
-        self.class.name.split("::").last.downcase
-      end
+    def convention_based_tool_name
+      self.class.name.split("::").last.downcase
+    end
 
-      def internal_call
-        stdin, stdout, stderr, wait_thr = popen3(command)
-        begin
-          out = stdout.read
-          err = stderr.read
-          exit_status = wait_thr.value
-          raise "Unable to execute command \"#{command}\"\n#{err}" unless exit_status.success?
-          out
-        ensure
-          stdin.close
-          stdout.close
-          stderr.close
-        end
+    def internal_call
+      stdin, stdout, stderr, wait_thr = popen3(command)
+      begin
+        out = stdout.read
+        err = stderr.read
+        exit_status = wait_thr.value
+        raise "Unable to execute command \"#{command}\"\n#{err}" unless exit_status.success?
+        out
+      ensure
+        stdin.close
+        stdout.close
+        stderr.close
       end
+    end
 
-      def command
-        raise NotImplementedError, "Method #command should be overriden in child classes"
-      end
+    def command
+      raise NotImplementedError, "Method #command should be overriden in child classes"
+    end
 
     private
 
-      def output
-        if tool_path.respond_to?(:call)
-          tool_path.call(filename)
-        else
-          internal_call
-        end
+    def output
+      if tool_path.respond_to?(:call)
+        tool_path.call(filename)
+      else
+        internal_call
       end
+    end
 
-      def activefedora_logger
-        ActiveFedora::Base.logger if defined? ActiveFedora
-      end
+    def activefedora_logger
+      ActiveFedora::Base.logger if defined? ActiveFedora
+    end
   end
 end

data/lib/hydra/file_characterization/characterizers.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
 module Hydra::FileCharacterization
   module Characterizers
   end
 
   module_function
+
   def characterizer(tool_name)
     characterizer_name = characterizer_name_from(tool_name)
     if Characterizers.const_defined?(characterizer_name)
       Characterizers.const_get(characterizer_name)
     else
-      raise ToolNotFoundError.new(tool_name)
+      raise ToolNotFoundError, tool_name
     end
   end
 
   def characterizer_name_from(tool_name)
-    tool_name.to_s.gsub(/(?:^|_)([a-z])/) { $1.upcase }
+    tool_name.to_s.gsub(/(?:^|_)([a-z])/) { Regexp.last_match(1).upcase }
   end
 
   def characterize_with(tool_name, path_to_file, path_to_tool)
@@ -24,7 +26,6 @@ module Hydra::FileCharacterization
       tool_obj.call
     end
   end
-
 end
 
 require 'hydra/file_characterization/characterizers/fits'

data/lib/hydra/file_characterization/characterizers/ffprobe.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
 require 'hydra/file_characterization/exceptions'
 require 'hydra/file_characterization/characterizer'
 
 module Hydra::FileCharacterization::Characterizers
   class Ffprobe < Hydra::FileCharacterization::Characterizer
-
     protected
+
     def command
       "#{tool_path} -i \"#{filename}\" -print_format xml -show_streams -v quiet"
     end
-
   end
 end

data/lib/hydra/file_characterization/characterizers/fits.rb

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
 require 'hydra/file_characterization/exceptions'
 require 'hydra/file_characterization/characterizer'
 require 'logger'
 module Hydra::FileCharacterization::Characterizers
   class Fits < Hydra::FileCharacterization::Characterizer
-
     protected
 
-      def command
-        "#{tool_path} -i \"#{filename}\""
-      end
+    def command
+      "#{tool_path} -i \"#{filename}\""
+    end
 
-      # Remove any non-XML output that precedes the <?xml> tag
-      # See: https://github.com/harvard-lts/fits/issues/20
-      #      https://github.com/harvard-lts/fits/issues/40
-      #      https://github.com/harvard-lts/fits/issues/46
-      def post_process(raw_output)
-        md = /\A(.*)(<\?xml.*)\Z/m.match(raw_output)
-        logger.warn "FITS produced non-xml output: \"#{md[1].chomp}\"" unless md[1].empty?
-        md[2]
-      end
+    # Remove any non-XML output that precedes the <?xml> tag
+    # See: https://github.com/harvard-lts/fits/issues/20
+    #      https://github.com/harvard-lts/fits/issues/40
+    #      https://github.com/harvard-lts/fits/issues/46
+    def post_process(raw_output)
+      md = /\A(.*)(<\?xml.*)\Z/m.match(raw_output)
+      logger.warn "FITS produced non-xml output: \"#{md[1].chomp}\"" unless md[1].empty?
+      md[2]
+    end
   end
 end

data/lib/hydra/file_characterization/characterizers/fits_servlet.rb

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
 require 'hydra/file_characterization/exceptions'
 require 'hydra/file_characterization/characterizer'
 require 'logger'
 module Hydra::FileCharacterization::Characterizers
   class FitsServlet < Hydra::FileCharacterization::Characterizer
-
     protected
 
-      def command
-        "curl -k -F datafile=@#{filename} #{ENV['FITS_SERVLET_URL']}/examine"
-      end
+    def command
+      "curl -k -F datafile=@#{filename} #{ENV['FITS_SERVLET_URL']}/examine"
+    end
 
-      # Remove any non-XML output that precedes the <?xml> tag
-      # See: https://github.com/harvard-lts/fits/issues/20
-      #      https://github.com/harvard-lts/fits/issues/40
-      #      https://github.com/harvard-lts/fits/issues/46
-      def post_process(raw_output)
-        md = /\A(.*)(<\?xml.*)\Z/m.match(raw_output)
-        logger.warn "FITS produced non-xml output: \"#{md[1].chomp}\"" unless md[1].empty?
-        md[2]
-      end
+    # Remove any non-XML output that precedes the <?xml> tag
+    # See: https://github.com/harvard-lts/fits/issues/20
+    #      https://github.com/harvard-lts/fits/issues/40
+    #      https://github.com/harvard-lts/fits/issues/46
+    def post_process(raw_output)
+      md = /\A(.*)(<\?xml.*)\Z/m.match(raw_output)
+      logger.warn "FITS produced non-xml output: \"#{md[1].chomp}\"" unless md[1].empty?
+      md[2]
+    end
   end
 end

data/lib/hydra/file_characterization/exceptions.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 module Hydra::FileCharacterization
-
   class FileNotFoundError < RuntimeError
   end
 
@@ -8,5 +8,4 @@ module Hydra::FileCharacterization
       super("Unable to find Hydra::FileCharacterization tool with name :#{tool_name}")
     end
   end
-
 end

data/lib/hydra/file_characterization/to_temp_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'open3'
 require 'tempfile'
 
@@ -16,7 +17,7 @@ module Hydra::FileCharacterization
     end
 
     def call(data)
-      f = Tempfile.new([File.basename(filename),File.extname(filename)])
+      f = Tempfile.new([File.basename(filename), File.extname(filename)])
       begin
         f.binmode
         if data.respond_to? :read
@@ -32,6 +33,5 @@ module Hydra::FileCharacterization
         f.unlink
       end
     end
-
   end
-end
+end

data/lib/hydra/file_characterization/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Hydra
   module FileCharacterization
-    VERSION = "1.1.1"
+    VERSION = "1.1.2"
   end
 end

data/spec/lib/hydra/file_characterization/characterizer_spec.rb

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 module Hydra::FileCharacterization
   describe Characterizer do
+    subject { characterizer }
     let(:filename) { __FILE__ }
     let(:instance_tool_path) { nil }
     let(:class_tool_path) { nil }
 
-    let(:characterizer) { Hydra::FileCharacterization::Characterizer.new(filename, instance_tool_path) }
-    subject { characterizer }
-    around(:each) do |example|
-      Hydra::FileCharacterization::Characterizer.tool_path = class_tool_path
+    let(:characterizer) { described_class.new(filename, instance_tool_path) }
+    around do |example|
+      described_class.tool_path = class_tool_path
       example.run
-      Hydra::FileCharacterization::Characterizer.tool_path = nil
+      described_class.tool_path = nil
     end
 
     context 'call' do
       context 'with missing file' do
         let(:filename) { '/dev/path/to/bogus/file' }
-        it 'should raise FileNotFoundError' do
+        it 'raises FileNotFoundError' do
           expect { subject.call }.to raise_error(FileNotFoundError)
         end
       end
 
       context 'with a callable tool path' do
-        let(:class_tool_path) { lambda { |filename| [filename, :output] }}
-        it 'should raise FileNotFoundError' do
+        let(:class_tool_path) { ->(filename) { [filename, :output] } }
+        it 'raises FileNotFoundError' do
           expect(subject.call).to eq [filename, :output]
         end
       end

data/spec/lib/hydra/file_characterization/characterizers/ffprobe_spec.rb

@@ -1,19 +1,16 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'hydra/file_characterization/characterizers/ffprobe'
 
 module Hydra::FileCharacterization::Characterizers
-
   describe Ffprobe do
-
-    subject { Ffprobe.new(filename) }
+    subject { described_class.new(filename) }
 
     describe 'invalidFile' do
       let(:filename) { fixture_file('nofile.pdf') }
-      it "should raise an error if the path does not contain the file" do
-        expect {subject.call}.to raise_error(Hydra::FileCharacterization::FileNotFoundError)
+      it "raises an error if the path does not contain the file" do
+        expect { subject.call }.to raise_error(Hydra::FileCharacterization::FileNotFoundError)
       end
     end
-
   end
-
 end

data/spec/lib/hydra/file_characterization/characterizers/fit_servlet_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'hydra/file_characterization/characterizers/fits_servlet'
 
@@ -27,7 +28,7 @@ module Hydra::FileCharacterization::Characterizers
 
       context 'zip file should be characterized not its contents' do
         let(:filename) { fixture_file('archive.zip') }
-        it { is_expected.to include(%(<identity format="ZIP Format" mimetype="application/zip"))}
+        it { is_expected.to include(%(<identity format="ZIP Format" mimetype="application/zip")) }
       end
     end
 
@@ -41,7 +42,8 @@ module Hydra::FileCharacterization::Characterizers
           'READBOX seen=true
 <?xml version="1.0" encoding="UTF-8"?>
 <fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="0.8.2" timestamp="15/09/14 10:00 AM">
-<identification/></fits>')
+<identification/></fits>'
+        )
       end
 
       let(:filename) { fixture_file('brendan_behan.jpeg') }
@@ -58,7 +60,8 @@ module Hydra::FileCharacterization::Characterizers
           '2015-10-15 17:14:25,761 ERROR [main] ToolBelt:79 - Thread 1 error initializing edu.harvard.hul.ois.fits.tools.droid.Droid: edu.harvard.hul.ois.fits.exceptions.FitsToolException  Message: DROID cannot run under Java 8
 <?xml version="1.0" encoding="UTF-8"?>
 <fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="0.8.2" timestamp="15/09/14 10:00 AM">
-<identification/></fits>')
+<identification/></fits>'
+        )
       end
 
       let(:filename) { fixture_file('brendan_behan.jpeg') }

data/spec/lib/hydra/file_characterization/characterizers/fits_spec.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'hydra/file_characterization/characterizers/fits'
 
 module Hydra::FileCharacterization::Characterizers
   describe Fits do
-    let(:fits) { Fits.new(filename) }
+    let(:fits) { described_class.new(filename) }
 
     describe "#call", unless: ENV['TRAVIS'] do
       subject { fits.call }
@@ -27,7 +28,7 @@ module Hydra::FileCharacterization::Characterizers
 
       context 'zip file should be characterized not its contents' do
         let(:filename) { fixture_file('archive.zip') }
-        it { is_expected.to include(%(<identity format="ZIP Format" mimetype="application/zip"))}
+        it { is_expected.to include(%(<identity format="ZIP Format" mimetype="application/zip")) }
       end
     end
 
@@ -41,7 +42,8 @@ module Hydra::FileCharacterization::Characterizers
           'READBOX seen=true
 <?xml version="1.0" encoding="UTF-8"?>
 <fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="0.8.2" timestamp="15/09/14 10:00 AM">
-<identification/></fits>')
+<identification/></fits>'
+        )
       end
 
       let(:filename) { fixture_file('brendan_behan.jpeg') }
@@ -58,7 +60,8 @@ module Hydra::FileCharacterization::Characterizers
           '2015-10-15 17:14:25,761 ERROR [main] ToolBelt:79 - Thread 1 error initializing edu.harvard.hul.ois.fits.tools.droid.Droid: edu.harvard.hul.ois.fits.exceptions.FitsToolException  Message: DROID cannot run under Java 8
 <?xml version="1.0" encoding="UTF-8"?>
 <fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="0.8.2" timestamp="15/09/14 10:00 AM">
-<identification/></fits>')
+<identification/></fits>'
+        )
       end
 
       let(:filename) { fixture_file('brendan_behan.jpeg') }

data/spec/lib/hydra/file_characterization/characterizers_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'hydra/file_characterization/characterizers'
 
@@ -7,36 +8,35 @@ module Hydra::FileCharacterization
 
     describe 'with :fits tool_name' do
       let(:tool_name) { :fits }
-      it { should eq(Characterizers::Fits) }
+      it { is_expected.to eq(Characterizers::Fits) }
     end
 
     describe 'with :ffprobe tool_name' do
       let(:tool_name) { :ffprobe }
-      it { should eq(Characterizers::Ffprobe) }
+      it { is_expected.to eq(Characterizers::Ffprobe) }
     end
 
     context '.characterize_with' do
+      subject { Hydra::FileCharacterization.characterize_with(tool_name, filename, tool_path) }
       let(:tool_name) { :fits }
       let(:filename) { __FILE__ }
       let(:tool_path) { nil }
-      subject { Hydra::FileCharacterization.characterize_with(tool_name, filename, tool_path) }
 
       context 'with callable tool_path and missing tool name' do
-        let(:tool_path) { lambda {|filename| [filename, :tool_path]} }
+        let(:tool_path) { ->(filename) { [filename, :tool_path] } }
         let(:tool_name) { :chunky_salsa }
-        it { should eq [filename, :tool_path] }
+        it { is_expected.to eq [filename, :tool_path] }
       end
 
       context 'with missing tool name and non-callable tool_path' do
         let(:tool_name) { :chunky_salsa }
         let(:tool_path) { '/path' }
-        it 'should raise exception' do
-          expect {
+        it 'raises exception' do
+          expect do
             subject
-          }.to raise_error(ToolNotFoundError)
+          end.to raise_error(ToolNotFoundError)
         end
       end
     end
-
   end
-end
+end

data/spec/lib/hydra/file_characterization/to_temp_file_spec.rb

@@ -1,10 +1,9 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'hydra/file_characterization/to_temp_file'
 
 module Hydra::FileCharacterization
-
   describe 'ToTempFile' do
-
     let(:content) { "This is the content of the file." }
     let(:filename) { "hello.rb" }
 
@@ -44,6 +43,5 @@ module Hydra::FileCharacterization
         end
       end
     end
-
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -6,7 +7,7 @@
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
 GEM_ROOT = File.expand_path("../../", __FILE__)
-$:.unshift File.join(GEM_ROOT, "lib")
+$LOAD_PATH.unshift File.join(GEM_ROOT, "lib")
 
 require 'coveralls'
 Coveralls.wear!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-file_characterization
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - James Treacy
 - Jeremy Friesen
 - Sue Richeson
 - Rajesh Balekai
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2020-06-10 00:00:00.000000000 Z
@@ -27,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +153,8 @@ files:
 - ".github_changelog_generator"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -178,7 +193,7 @@ homepage: https://github.com/projecthydra/hydra-file_characterization
 licenses:
 - APACHE2
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.0.pre1
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: To provide a wrapper for file characterization
 test_files:

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-bundler_args: --without debug
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-rvm:
-  - 2.4.1