hydra-file_characterization 0.3.2 → 1.1.2

data/Gemfile

@@ -1,4 +1,13 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hydra/file_characterization.gemspec
 gemspec
+
+if ENV['RAILS_VERSION']
+  if ENV['RAILS_VERSION'] == 'edge'
+    gem 'rails', github: 'rails/rails'
+  else
+    gem 'rails', ENV['RAILS_VERSION']
+  end
+end

data/Guardfile

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

data/LICENSE

@@ -1,16 +1,14 @@
-##########################################################################
-#
-# Copyright 2013 Notre Dame
-# Additional copyright may be held by others, as reflected in the commit log
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+Copyright 2013 Notre Dame
+Additional copyright may be held by others, as reflected in the commit history. 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,12 +1,28 @@
-# hydra-file_chracterization [![Version](https://badge.fury.io/rb/hydra-file_characterization.png)](http://badge.fury.io/rb/hydra-file_characterization) [![Build Status](https://travis-ci.org/projecthydra/hydra-file_characterization.png?branch=master)](https://travis-ci.org/projecthydra/hydra-file_characterization) [![Dependency Status](https://gemnasium.com/projecthydra/hydra-file_characterization.png)](https://gemnasium.com/projecthydra/hydra-file_characterization)
+# hydra-file_characterization
 
-Hydra::FileCharacterization as (extracted from Sufia and Hydra::Derivatives)
+Code: [![Version](https://badge.fury.io/rb/hydra-file_characterization.png)](http://badge.fury.io/rb/hydra-file_characterization) [![CircleCI](https://circleci.com/gh/samvera/hydra-file_characterization.svg?style=svg)](https://circleci.com/gh/samvera/hydra-file_characterization) [![Coverage Status](https://coveralls.io/repos/github/samvera/hydra-file_characterization/badge.svg?branch=master)](https://coveralls.io/github/samvera/hydra-file_characterization?branch=master)
 
-## Purpose
+Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md) [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
-To provide a wrapper for file characterization
+Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
 
-## How To Use
+# What is hydra-file_characterization?
+
+Provides a wrapper for file characterization.
+
+## Product Owner & Maintenance
+
+hydra-file_characterization is a Core Component of the Samvera community. The documentation for what this means can be found [here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
+
+### Product Owner
+
+[little9](https://github.com/little9)
+
+# Help
+
+The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).
+
+# Getting Started
 
 If you are using Rails add the following to an initializer (./config/initializers/hydra-file_characterization_config.rb):
 
@@ -16,12 +32,20 @@ Hydra::FileCharacterization.configure do |config|
 end
 ```
 
-You can call a single characterizer…
 ```ruby
-xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits)
+Hydra::FileCharacterization.characterize(File.read(filename), File.basename(filename), :fits)
 ```
 
-…for this particular call, you can specify custom fits path…
+- Why `file.read`? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file.
+- Why `file.basename`? In the case of Fits, the characterization takes cues from the extension name.
+
+You can call a single characterizer...
+
+```ruby
+xml_string = Hydra::FileCharacterization.characterize(File.read("/path/to/my/file.rb"), 'file.rb', :fits)
+```
+
+...for this particular call, you can specify custom fits path...
 
 ```ruby
 xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits) do |config|
@@ -29,7 +53,7 @@ xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.
 end
 ```
 
-…or even make the path callable…
+...or even make the path callable...
 
 ```ruby
 xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits) do |config|
@@ -37,7 +61,7 @@ xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.
 end
 ```
 
-…or even create your custom characterizer on the file…
+...or even create your custom characterizer on the file...
 
 ```ruby
 xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :my_characterizer) do |config|
@@ -51,9 +75,26 @@ You can also call multiple characterizers at the same time.
 fits_xml, ffprobe_xml = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits, :ffprobe)
 ```
 
-* Why `file.read`? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file.
-* Why `file.basename`? In the case of Fits, the characterization takes cues from the extension name.
-
 ## Registering New Characterizers
 
 This is possible by adding a characterizer to the `Hydra::FileCharacterization::Characterizers`' namespace.
+
+## Releasing
+
+1. `bundle install`
+2. Increase the version number in `lib/hydra/file_characterization/version.rb`
+3. Increase the same version number in `.github_changelog_generator`
+4. Update `CHANGELOG.md` by running this command:
+
+  ```
+  github_changelog_generator --user samvera --project hydra-file_characterization --token YOUR_GITHUB_TOKEN_HERE
+  ```
+
+5. Commit these changes to the master branch
+6. Run `rake release`
+
+# Acknowledgments
+
+This software has been developed by and is brought to you by the Samvera community. Learn more at the [Samvera website](http://samvera.org/).
+
+![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)

data/Rakefile

@@ -1 +1,8 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/SUPPORT.md

@@ -0,0 +1,5 @@
+If you would like to report an issue, first search [the list of issues](https://github.com/samvera/hydra-file_characterization/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/hydra-file_characterization/issues/new).
+i
+If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).
+
+You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.

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,24 +13,29 @@ 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 "rspec"
+  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"
   gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency 'rspec_junit_formatter'
 end

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
@@ -26,45 +25,53 @@ module Hydra::FileCharacterization
       @tool_path || self.class.tool_path || convention_based_tool_name
     end
 
+    def logger
+      @logger ||= activefedora_logger || Logger.new(STDERR)
+    end
+
     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
   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,8 +26,8 @@ module Hydra::FileCharacterization
       tool_obj.call
     end
   end
-
 end
 
 require 'hydra/file_characterization/characterizers/fits'
 require 'hydra/file_characterization/characterizers/ffprobe'
+require 'hydra/file_characterization/characterizers/fits_servlet'