hydra-derivatives 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2760dd208eaff0215533b8885e35b115a78f1f4f
-  data.tar.gz: cdeab3f70511982e5440ad348856c0f51f7bc626
+  metadata.gz: 74b15261c78629ff97614bc0090102ceed0c5fa7
+  data.tar.gz: 268d962f2ea5607db494c67455878d8cb8eab25d
 SHA512:
-  metadata.gz: d8f7ec3e514d6d8b2e9aca347e1b2cff3e669e2d3de44bcdf24afd12790262f886d0b5ffb206c8ecea72b72d6151d850b0e7d65a2e5a092154c05b1eeff522f3
-  data.tar.gz: 0d15fefd69e56e2afc29806d3201e1787f9e00d41ef973bce43b57ca23965247f379346138caf6570d797573a1521db656f2b1d38ef3c5f358726e0e0d88f5c5
+  metadata.gz: 5c7c0aa06d5fd7059e4bb9886d2f241ff5a7f00508941bb7650907464e0a3d59e1d884fddc61208068930a263c420e952534bb91c5931deadd896695ba8fd607
+  data.tar.gz: 5b5b6f7800798afe8dd7688638bdf88f643c6990d1cb0dad011d2f36c54238f2fc48e97f5fdaef6664d84daca620ed0b9ac9a0d8b2b0c0a51eeab843a7ecd84e

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 tmp/
 jetty/
+pkg/

data/README.md

@@ -2,3 +2,35 @@ hydra-derivatives
 =================
 
 Derivative generation for hydra
+
+If you have an ActiveFedora class like this:
+```ruby
+    class GenericFile < ActiveFedora::Base
+        include Hydra::Derivatives
+        
+        has_file_datastream :content
+        attr_accessor :mime_type
+
+        makes_derivatives_of :content, when: :mime_type, is_one_of: ['image/tiff', 'image/jpeg],
+             derivatives: { :thumbnail => {size: "200x150>", datastream: 'thumbnail'} }
+        makes_derivatives_of :content, when: :mime_type, is: 'application/pdf',
+             derivatives: { :thumbnail => {size: "338x493", datastream: 'thumbnail'} }
+        makes_derivatives_of :content, when: :mime_type, is_one_of: ['video/mpeg', 'video/avi'],
+             derivatives: { :webm => {format: "webm", datastream: 'webm'}, :mp4 => {format: "mp4", datastream: 'mp4'} }, processors: :video
+        makes_derivatives_of :content, when: :mime_type, is_one_of: ['audio/wav', 'audio/mpeg'],
+             derivatives: {  :mp3 => {format: 'mp3', datastream: 'mp3'}, :ogg => {format: 'ogg', datastream: 'ogg'} }, processors: :audio
+    end
+```
+
+And you add some content to it:
+
+```ruby
+   obj = GenericFile.new
+   obj.content.content = File.open(...)
+   obj.mime_type = 'image/tiff'
+   obj.save
+```
+
+Then when you call `obj.create_derivatives` a new datastream, called 'thumbnail' will have been created, with a downsized image in it.
+
+We recommend you run `obj.create_derivatives` in a background worker, because some derivative creation (especially videos) can take a long time.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/hydra/derivatives.rb

@@ -74,13 +74,14 @@ module Hydra
     class TransformationDirective
       attr_accessor :differentiator, :selector, :derivatives, :processors
       # @param [Hash] args the options 
-      # @option args [Symbol] :based_on the method that holds the differentiator column
-      # @option args [String, Array] :when activates this set of derivatives when the the differentiator column is includes one of these. 
+      # @option args [Symbol] :when the method that holds the differentiator column
+      # @option args [String, Array] :is_one_of activates this set of derivatives when the the differentiator column is includes one of these. 
+      # @option args [String, Array] :is alias for :is_one_of 
       # @option args [Hash] :derivatives the derivatives to be produced
       # @option args [Symbol, Array] :processors the processors to run to produce the derivatives 
       def initialize(args)
-        self.differentiator = args[:based_on]
-        self.selector = args[:when]
+        self.differentiator = args[:when]
+        self.selector = args[:is_one_of] || args[:is]
         self.derivatives = args[:derivatives]
         self.processors = args[:processors]
       end
@@ -93,15 +94,16 @@ module Hydra
     module ClassMethods
       # @param [Symbol, String] datastream the datastream to operate on
       # @param [Hash] args the options 
-      # @option args [Symbol] :based_on the method that holds the differentiator column
-      # @option args [String, Array] :when activates this set of derivatives when the the differentiator column is includes one of these. 
+      # @option args [Symbol] :when the method that holds the differentiator column
+      # @option args [String, Array] :is_one_of activates this set of derivatives when the the differentiator column is includes one of these. 
+      # @option args [String, Array] :is alias for :is_one_of 
       # @option args [Hash] :derivatives the derivatives to be produced
       # @option args [Symbol, Array] :processors the processors to run to produce the derivatives 
       # @example
-      #    makes_derivatives_of :content, based_on: :mime_type, when: 'text/pdf',
+      #    makes_derivatives_of :content, when: :mime_type, is: 'text/pdf',
       #        derivatives: { :text => { :quality => :better }, processors: [:ocr]}
       #
-      #    makes_derivatives_of :content, based_on: :mime_type, when: ['image/png', 'image/jpg'],
+      #    makes_derivatives_of :content, when: :mime_type, is_one_of: ['image/png', 'image/jpg'],
       #        derivatives: { :medium => "300x300>", :thumb => "100x100>" }
       def makes_derivatives_of(datastream, args = {})
         self.transformation_scheme ||= {}

data/lib/hydra/derivatives/ffmpeg.rb

@@ -14,9 +14,11 @@ module Hydra
 
       def process
         directives.each do |name, args| 
-          raise ArgumentError, "You must provide the :format you want to transcode into. You provided #{args}" unless args[:format]
+          format = args[:format]
+          raise ArgumentError, "You must provide the :format you want to transcode into. You provided #{args}" unless format
           # TODO if the source is in the correct format, we could just copy it and skip transcoding.
-          encode_datastream(output_datastream_id(name), args[:format], new_mime_type(args[:format]), options_for(args[:format]))
+          output_datastream_name = args[:datastream] || output_datastream_id(name)
+          encode_datastream(output_datastream_name, format, new_mime_type(format), options_for(format))
         end
       end
 

data/spec/units/transcoding_spec.rb

@@ -14,10 +14,10 @@ describe "Transcoder" do
       delegate :mime_type, :to => :characterization, :unique => true
       has_file_datastream 'content', type: ContentDatastream
 
-      makes_derivatives_of :content, based_on: :mime_type, when: 'application/pdf',
+      makes_derivatives_of :content, when: :mime_type, is_one_of: 'application/pdf',
             derivatives: { :thumb => "100x100>" }
 
-      makes_derivatives_of :content, based_on: :mime_type, when: 'audio/wav',
+      makes_derivatives_of :content, when: :mime_type, is_one_of: 'audio/wav',
             derivatives: { :mp3 => {format: 'mp3'}, :ogg => {format: 'ogg'} }, processors: :audio
 
       # -g 30 enforces keyframe generation every second (30fps)
@@ -25,10 +25,10 @@ describe "Transcoder" do
       # -acodec is the audio codec
       size_attributes = "-s 320x240"
       audio_attributes = "-ac 2 -ab 96k -ar 44100"
-      makes_derivatives_of :content, based_on: :mime_type, when: 'video/avi',
+      makes_derivatives_of :content, when: :mime_type, is: 'video/avi',
             derivatives: { :mp4 => {format: 'mp4'}, :webm => {format: 'webm'} }, processors: :video
 
-      makes_derivatives_of :content, based_on: :mime_type, when: ['image/png', 'image/jpg'],
+      makes_derivatives_of :content, when: :mime_type, is_one_of: ['image/png', 'image/jpg'],
              derivatives: { :medium => "300x300>", :thumb => "100x100>" }
       
     end

data/spec/units/video_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Hydra::Derivatives::Video do
+  describe "when arguments are passed as a hash" do
+    describe "and datastream is provided as an argument" do
+      let(:directives) {{ :thumb => {format: "webm", datastream: 'thumbnail'} }}
+      subject { Hydra::Derivatives::Video.new(double(:obj), 'content', directives)}
+      it "should create a datastream with the specified name" do
+        subject.should_receive(:encode_datastream).with("thumbnail", "webm", 'video/webm', "-s 320x240 -g 30 -b:v 345k -acodec libvorbis -ac 2 -ab 96k -ar 44100")
+        subject.process
+
+      end
+    end
+
+    describe "and datastream is not provided as an argument" do
+      let(:directives) {{ :thumb => {format: "webm"} }}
+      subject { Hydra::Derivatives::Video.new(double(:obj), 'content', directives)}
+      it "should create a datastream and infer the name" do
+        subject.should_receive(:encode_datastream).with("content_thumb", "webm", 'video/webm', "-s 320x240 -g 30 -b:v 345k -acodec libvorbis -ac 2 -ab 96k -ar 44100")
+        subject.process
+
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-derivatives
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,7 @@ files:
 - spec/spec_helper.rb
 - spec/units/image_spec.rb
 - spec/units/transcoding_spec.rb
+- spec/units/video_spec.rb
 homepage: https://github.com/projecthydra/hydra-derivatives
 licenses:
 - APACHE2
@@ -178,3 +179,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/units/image_spec.rb
 - spec/units/transcoding_spec.rb
+- spec/units/video_spec.rb
+has_rdoc: