hydra-file_characterization 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b75ad5f0b18e047cebdb796c7f8ba98cd992a019
+  data.tar.gz: f53ac70d926460f8f3ec8b827ee5673fe07784a2
+SHA512:
+  metadata.gz: 77cd1a59aa05a2ad96531b48e5191df939c84a4e15a67417c11c852860972ed02bf51d869b1d08ee98740210c4a211d48a0521e8d086e81fa3d3f944069b09b2
+  data.tar.gz: 28acf276a405e40d53d0101459be9b27f70bf3f7602251c992ff9f1deb0525901f20e6fb8776fa6d93d9d2dd3bc7a61635830330c113b05c0f59b86c8f06c42c

data/README.md

@@ -15,16 +15,18 @@ How others are using the extract_metadata method
 
 - ~~Given a filename, characterize the file and return a raw XML stream~~
 - ~~Provide method for converting a StringIO and original file name to a temp file with comparable, then running the characterizer against the tempfile~~
-- ~~Provide a configuration option for the fits path; This would be the default for the characterizer
+- ~~Provide a configuration option for the fits path; This would be the default for the characterizer~~
 - Update existing Sufia implementation
   - Deprecrate Hydra::Derivatives direct method call
   - Instead call the characterizer with the content
 - Allow characterization services to be chained together
-  - ~~This would involve renaming the Characterizer to something else (i.e. Characterizers::Fits)
+  - ~~This would involve renaming the Characterizer to something else (i.e. Characterizers::Fits)~~
 - Provide an ActiveFedora Datastream that maps the raw XML stream to a datastructure
 
 ## How to configure path to fits tool
 
-- In your application code use the following line to configure the path to fits
-Hydra::FileCharacterization::Characterizers::Fits.tool_path = '/path/to/fits'
+If you are using Rails add the following to an initializer (./config/initializers/hydra-file_characterization_config.rb):
 
+    Hydra::FileCharacterization.configure do |config|
+      config.tool_path(:fits, '/path/to/fits')
+    end

data/lib/hydra/file_characterization.rb

@@ -22,8 +22,22 @@ module Hydra
   module FileCharacterization
 
     class Configuration
-      include ActiveSupport::Configurable
-      config_accessor :tool_path
+      def configure
+        yield(self)
+      end
+
+      def tool_path(tool_name, tool_path)
+        Hydra::FileCharacterization.characterizer(tool_name).tool_path = tool_path
+      end
+    end
+
+    module_function
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure(&block)
+      configuration.configure(&block)
     end
   end
 end

data/lib/hydra/file_characterization/characterizer.rb

@@ -38,7 +38,7 @@ module Hydra::FileCharacterization
     end
 
     def tool_path
-      raise NotImplementedError, "Method #tool_path should be overriden in child classes"
+      self.class.tool_path || (raise Hydra::FileCharacterization::UnspecifiedToolPathError.new(self.class))
     end
   end
 end

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

@@ -1,3 +1,4 @@
+require 'hydra/file_characterization/exceptions'
 require 'hydra/file_characterization/characterizer'
 module Hydra::FileCharacterization::Characterizers
   class Fits < Hydra::FileCharacterization::Characterizer
@@ -7,8 +8,5 @@ module Hydra::FileCharacterization::Characterizers
       "#{tool_path} -i \"#{filename}\""
     end
 
-    def tool_path
-      self.class.tool_path || (raise "No Tool Path Given")
-    end
   end
 end

data/lib/hydra/file_characterization/exceptions.rb

@@ -1,5 +1,11 @@
 module Hydra::FileCharacterization
 
+  class UnspecifiedToolPathError < RuntimeError
+    def initialize(tool_class)
+      super("Unspecified tool path for #{tool_class}")
+    end
+  end
+
   class FileNotFoundError < RuntimeError
   end
 

data/lib/hydra/file_characterization/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module FileCharacterization
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/spec/lib/hydra/file_characterization_spec.rb

@@ -39,25 +39,25 @@ module Hydra
 
   end
 
-  module FileCharacterization
+  describe FileCharacterization do
 
-    describe Configuration do
-      subject { Configuration.new }
-      let (:expected_fits_path) {"string"}
-      before(:each) do
-        subject.tool_path = expected_fits_path
+    describe '.configure' do
+      let(:content) { "class Test; end\n" }
+      let(:filename) { 'test.rb' }
+      around do |example|
+        old_tool_path = Hydra::FileCharacterization::Characterizers::Fits.tool_path
+        example.run
+        Hydra::FileCharacterization::Characterizers::Fits.tool_path = old_tool_path
       end
-      its(:config) {should have_key :tool_path}
-      its(:tool_path) {should == expected_fits_path}
-    end
 
-    describe 'preliminary integration' do
-      let (:tempfile) { ToTempFile.new("This is the content of the file.", 'test.rb')}
-      it '#call' do
-        tempfile.call do |f|
-          @fits_output = Characterizers::Fits.new(f.path ).call
+      it 'without configuration' do
+        Hydra::FileCharacterization.configure do |config|
+          config.tool_path(:fits, nil)
         end
-        expect(@fits_output).to include '<identity format="Plain text" mimetype="text/plain"'
+
+        expect {
+          Hydra.characterize(content, filename, :fits)
+        }.to raise_error(Hydra::FileCharacterization::UnspecifiedToolPathError)
       end
     end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-file_characterization
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - James Treacy
@@ -17,65 +16,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: To provide a wrapper for file characterization
@@ -118,27 +109,26 @@ files:
 homepage: https://github.com/projecthydra/hydra-file_characterization
 licenses:
 - APACHE2
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: To provide a wrapper for file characterization
 test_files:
 - spec/fixtures/archive.zip