dragonfly_audio 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d080095980104ba97c2ebe424891df08198092ff
-  data.tar.gz: 71a21130019f82955d4034d05b454eb3605b55e2
+SHA256:
+  metadata.gz: 17a5552c98592630886d4acb067c52b0a33653e70ffbd0142371fba98226effa
+  data.tar.gz: 2e469efa5870480edc30235a10a0bc80e13e57d0a5defd6a3bfea5f8fc7e9d7a
 SHA512:
-  metadata.gz: 150152ae15c6466071cb724b548827076d6af6c7b23b949feb35b80d1556973e1ba279a79079a62591218560d3cd04a8d094114a4eb4ed2b5c155e98e9f5d72c
-  data.tar.gz: 7821e3dbaa412fb908fdbbeafe25cfb6c11d6ef2de927a86b19045c5d69c1e81f1db46d3608258a9f0620ab3499b406d67ec1b52f9bc51f672282683ddae53f8
+  metadata.gz: 8be5fc0f587ecadd4e3593699b18388824852f25bce06677e6e65c81065a59579bc1eaf9d34b2814d2dde3a4ec08b9da71020845a96513f9f91061ad01ee6019
+  data.tar.gz: 8aa38d5d282294eacfb3550ab51bad5f3369f96859c24aa839596034911f951da887968c4e585f83fe945d4b5b328f5c3f910a0e953bcbab99bbea7ab4595f59

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.0.0
+
+* add `SUPPORTED_FORMATS` and and raise errors when not matching
+* add more thorough tests for supported formats
+
 ## 0.0.3
 
 * `AlbumArt` processor (courtesy of @asgerb)

data/Gemfile.lock

@@ -1,17 +1,19 @@
 PATH
   remote: .
   specs:
-    dragonfly_audio (0.0.3)
+    dragonfly_audio (1.0.0)
       dragonfly (~> 1.0)
       taglib-ruby
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    builder (3.2.3)
     coderay (1.1.0)
-    dragonfly (1.1.3)
+    dragonfly (1.1.5)
       addressable (~> 2.3)
       multi_json (~> 1.0)
       rack (>= 1.3)
@@ -36,7 +38,12 @@ GEM
     lumberjack (1.0.9)
     method_source (0.8.2)
     minitest (5.8.1)
-    multi_json (1.12.1)
+    minitest-reporters (1.2.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_json (1.13.1)
     nenv (0.2.0)
     notiffany (0.0.8)
       nenv (~> 0.1)
@@ -45,12 +52,13 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (2.0.5)
-    rack (2.0.3)
+    public_suffix (3.0.2)
+    rack (2.0.5)
     rake (10.4.2)
     rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
+    ruby-progressbar (1.9.0)
     shellany (0.0.1)
     slop (3.6.0)
     taglib-ruby (0.7.1)
@@ -65,7 +73,8 @@ DEPENDENCIES
   guard
   guard-minitest
   minitest
+  minitest-reporters
   rake
 
 BUNDLED WITH
-   1.14.6
+   1.16.1

data/README.md

@@ -32,6 +32,14 @@ Dragonfly.app.configure do
 end
 ```
 
+## Supported Formats
+
+List of supported formats is available as:
+
+```ruby
+DragonflyAudio::SUPPORTED_FORMATS # => ["aif", "aiff", …]
+```
+
 ## Analysers
 
 ### audio_properties
@@ -84,7 +92,7 @@ Sets the file's album art:
 audio.album_art('path_to_file')
 ```
 
-Note thate this oly works for mp3 files.
+Note that this only works for mp3 files.
 
 ## Contributing
 

data/dragonfly_audio.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
 end

data/lib/dragonfly_audio.rb

@@ -2,6 +2,8 @@ require 'dragonfly'
 require 'dragonfly_audio/plugin'
 require 'dragonfly_audio/version'
 
-Dragonfly.app.configure do
-  plugin :audio
+module DragonflyAudio
+  class UnsupportedFormat < RuntimeError; end
+
+  SUPPORTED_FORMATS = %w[aif aiff fla flac m4a mp4 mp4a mp4s mp3 mpga oga ogg ogx wav].freeze
 end

data/lib/dragonfly_audio/analysers/audio_properties.rb

@@ -5,29 +5,20 @@ require 'taglib'
 module DragonflyAudio
   module Analysers
     class AudioProperties
-      TAGS = %i(title artist album year track genre comment).freeze
-      AUDIO_PROPS = %i(length bitrate channels sample_rate).freeze
+      TAGS = %w[title artist album year track genre comment].freeze
+      AUDIO_PROPS = %w[length bitrate channels sample_rate].freeze
 
       def call(content)
-        taglib_fileref(content)
-      end
-
-      private # =============================================================
+        return {} unless SUPPORTED_FORMATS.include?(content.ext)
 
-      def taglib_fileref(content)
         res = {}
-        TagLib::FileRef.open(content.path) do |fileref|
-          unless fileref.null?
 
-            TAGS.each do |tag_name|
-              res[tag_name] = fileref.tag.send(tag_name)
-            end
-
-            AUDIO_PROPS.each do |prop_name|
-              res[prop_name] = fileref.audio_properties.send(prop_name)
-            end
-          end
+        TagLib::FileRef.open(content.path) do |fileref|
+          return if fileref.null?
+          TAGS.each { |n| res[n] = fileref.tag.send(n) }
+          AUDIO_PROPS.each { |n| res[n] = fileref.audio_properties.send(n) }
         end
+
         res
       end
     end

data/lib/dragonfly_audio/plugin.rb

@@ -1,23 +1,23 @@
 require 'dragonfly_audio/analysers/audio_properties'
+
 require 'dragonfly_audio/processors/tag'
 require 'dragonfly_audio/processors/album_art'
 
 module DragonflyAudio
   class Plugin
-    def call(app, _opts = {})
-      app.add_analyser :audio_properties, DragonflyAudio::Analysers::AudioProperties.new
+    def call(app, options = {})
+      app.add_analyser :audio_properties, Analysers::AudioProperties.new
+
+      Analysers::AudioProperties::TAGS.each do |name|
+        app.add_analyser(name) { |c| c.analyse(:audio_properties)[name] }
+      end
 
-      [
-        DragonflyAudio::Analysers::AudioProperties::TAGS,
-        DragonflyAudio::Analysers::AudioProperties::AUDIO_PROPS
-      ].flatten.each do |analyser|
-        app.add_analyser analyser do |content|
-          content.analyse(:audio_properties)[analyser]
-        end
+      Analysers::AudioProperties::AUDIO_PROPS.each do |name|
+        app.add_analyser(name) { |c| c.analyse(:audio_properties)[name] }
       end
 
-      app.add_processor :tag, DragonflyAudio::Processors::Tag.new
-      app.add_processor :album_art, DragonflyAudio::Processors::AlbumArt.new
+      app.add_processor :tag, Processors::Tag.new
+      app.add_processor :album_art, Processors::AlbumArt.new
     end
   end
 end

data/lib/dragonfly_audio/processors/album_art.rb

@@ -6,9 +6,9 @@ require 'rack'
 module DragonflyAudio
   module Processors
     class AlbumArt
-      def call(content, properties)
-        return unless content.mime_type == 'audio/mpeg'
-        return unless album_art_file = properties
+      def call(content, album_art_file)
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+        # raise UnsupportedFormat unless content.mime_type == 'audio/mpeg'
 
         tempfile = content.temp_object
 

data/lib/dragonfly_audio/processors/tag.rb

@@ -5,21 +5,21 @@ require 'taglib'
 module DragonflyAudio
   module Processors
     class Tag
-      PERMISSIBLE_PROPERTIES = DragonflyAudio::Analysers::AudioProperties::TAGS
+      PERMISSIBLE_PROPERTIES = Analysers::AudioProperties::TAGS
 
       def call(content, properties)
-        clean_properties = properties.delete_if { |key, _| !PERMISSIBLE_PROPERTIES.include?(key) }
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+
+        # stringify keys
+        properties = properties.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v }
+        properties = properties.select { |key, _| PERMISSIBLE_PROPERTIES.include?(key) }
 
         tempfile = Dragonfly::TempObject.new(content.tempfile)
 
         TagLib::FileRef.open(tempfile.path) do |file|
-          unless file.null?
-            tag = file.tag
-            clean_properties.each do |key, value|
-              tag.send("#{key}=", value)
-            end
-            file.save
-          end
+          return if file.null?
+          properties.each { |k, v| file.tag.send("#{k}=", v) }
+          file.save
         end
 
         content.update(tempfile)

data/lib/dragonfly_audio/version.rb

@@ -1,3 +1,3 @@
 module DragonflyAudio
-  VERSION = '0.0.3'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/test/dragonfly_audio/analysers/audio_properties_test.rb

@@ -2,49 +2,17 @@ require 'test_helper'
 
 describe DragonflyAudio::Analysers::AudioProperties do
   let(:app) { test_app.configure_with(:audio) }
-  let(:audio) { app.fetch_file(SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
-
-  it 'analyses "album" property' do
-    audio.audio_properties[:album].must_equal 'Album XYZ'
-  end
-
-  it 'analyses "artist" property' do
-    audio.audio_properties[:artist].must_equal 'Artist'
-  end
-
-  it 'analyses "bitrate" property' do
-    audio.audio_properties[:bitrate].must_equal 192
-  end
-
-  it 'analyses "channels" property' do
-    audio.audio_properties[:channels].must_equal 2
-  end
-
-  it 'analyses "comment" property' do
-    audio.audio_properties[:comment].must_equal '   Comment    '
-  end
-
-  it 'analyses "genre" property' do
-    audio.audio_properties[:genre].must_equal 'Dance'
-  end
-
-  it 'analyses "length" property' do
-    audio.audio_properties[:length].must_equal 156
-  end
-
-  it 'analyses "sample_rate" property' do
-    audio.audio_properties[:sample_rate].must_equal 44_100
-  end
-
-  it 'analyses "title" property' do
-    audio.audio_properties[:title].must_equal 'SongTitle'
-  end
-
-  it 'analyses "track" property' do
-    audio.audio_properties[:track].must_equal 0
-  end
-
-  it 'analyses "year" property' do
-    audio.audio_properties[:year].must_equal 0
-  end
+  let(:content) { app.fetch_file(SAMPLES_DIR.join('sample.mp3')) }
+
+  it { content.audio_properties['album'].must_equal 'Album XYZ' }
+  it { content.audio_properties['artist'].must_equal 'Artist' }
+  it { content.audio_properties['bitrate'].must_equal 192 }
+  it { content.audio_properties['channels'].must_equal 2 }
+  it { content.audio_properties['comment'].must_equal '   Comment    ' }
+  it { content.audio_properties['genre'].must_equal 'Dance' }
+  it { content.audio_properties['length'].must_be :>, 150 }
+  it { content.audio_properties['sample_rate'].must_equal 44_100 }
+  it { content.audio_properties['title'].must_equal 'SongTitle' }
+  it { content.audio_properties['track'].must_equal 0 }
+  it { content.audio_properties['year'].must_equal 0 }
 end

data/test/dragonfly_audio/plugin_test.rb

@@ -1,29 +1,23 @@
 require 'test_helper'
 
-module DragonflyAudio
-  describe Plugin do
-    let(:app) { test_app.configure_with(:audio) }
-    let(:audio) { app.fetch_file(SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
+describe DragonflyAudio::Plugin do
+  let(:app) { test_app.configure_with(:audio) }
+  let(:content) { app.fetch_file(SAMPLES_DIR.join('sample.mp3')) }
 
-    describe 'analysers' do
-      it 'adds #audio_properties' do
-        audio.must_respond_to :audio_properties
-      end
+  describe 'analysers' do
+    it { content.must_respond_to :audio_properties }
 
-      [
-        DragonflyAudio::Analysers::AudioProperties::TAGS,
-        DragonflyAudio::Analysers::AudioProperties::AUDIO_PROPS
-      ].flatten.each do |analyser|
-        it "adds ##{analyser}" do
-          audio.must_respond_to analyser
-        end
-      end
+    DragonflyAudio::Analysers::AudioProperties::TAGS.each do |analyser|
+      it { content.must_respond_to analyser }
     end
 
-    describe 'processors' do
-      it 'adds #tag' do
-        audio.must_respond_to :tag
-      end
+    DragonflyAudio::Analysers::AudioProperties::AUDIO_PROPS.each do |analyser|
+      it { content.must_respond_to analyser }
     end
   end
+
+  describe 'processors' do
+    it { content.must_respond_to :album_art }
+    it { content.must_respond_to :tag }
+  end
 end

data/test/dragonfly_audio/processors/album_art_test.rb

@@ -2,23 +2,26 @@ require 'test_helper'
 
 describe DragonflyAudio::Processors::AlbumArt do
   let(:app) { test_app.configure_with(:audio) }
-  let(:processor) { DragonflyAudio::Processors::AlbumArt.new }
-  let(:audio) { Dragonfly::Content.new(app, SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
+  let(:content) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample.mp3')) }
   let(:image) { Dragonfly::Content.new(app, SAMPLES_DIR.join('album.jpg')) }
+  let(:processor) { DragonflyAudio::Processors::AlbumArt.new }
 
   let(:artist) { 'Elvis Presley' }
   let(:title) { 'Hound Dawg' }
 
-  before { processor.call(audio, image.file.path) }
+  before { processor.call(content, image.file.path) }
 
   describe 'properties' do
-    it 'sets the album art' do
-      TagLib::MPEG::File.open(audio.file.path) do |file|
-        tag = file.id3v2_tag
-
-        cover = tag.frame_list('APIC').first
-        cover.picture.must_equal image.data
+    let(:picture) do
+      TagLib::MPEG::File.open(content.file.path) do |file|
+        file.id3v2_tag.frame_list('APIC').first.picture
       end
     end
+
+    it { picture.must_equal image.data }
+  end
+
+  describe 'tempfile has extension' do
+    it { content.tempfile.path.must_match /\.mp3\z/i }
   end
 end

data/test/dragonfly_audio/processors/tag_test.rb

@@ -2,22 +2,21 @@ require 'test_helper'
 
 describe DragonflyAudio::Processors::Tag do
   let(:app) { test_app.configure_with(:audio) }
-  let(:processor) { DragonflyAudio::Processors::Tag.new }
+  let(:content) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample.mp3')) }
   let(:analyser) { DragonflyAudio::Analysers::AudioProperties.new }
-  let(:audio) { Dragonfly::Content.new(app, SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
+  let(:processor) { DragonflyAudio::Processors::Tag.new }
 
   let(:artist) { 'Elvis Presley' }
   let(:title) { 'Hound Dawg' }
 
-  before { processor.call(audio, artist: artist, title: title) }
+  before { processor.call(content, artist: artist, title: title) }
 
   describe 'properties' do
-    it 'sets the artist tag property' do
-      analyser.call(audio)[:artist].must_equal artist
-    end
+    it { analyser.call(content)['artist'].must_equal artist }
+    it { analyser.call(content)['title'].must_equal title }
+  end
 
-    it 'sets the title tag property' do
-      analyser.call(audio)[:title].must_equal title
-    end
+  describe 'tempfile has extension' do
+    it { content.tempfile.path.must_match /\.mp3\z/i }
   end
 end

data/test/test_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 
 require 'minitest'
 require 'minitest/autorun'
+require 'minitest/reporters'
 require 'minitest/spec'
 
 require 'dragonfly'
@@ -9,9 +10,11 @@ require 'dragonfly_audio'
 
 SAMPLES_DIR = Pathname.new(File.expand_path('../../samples', __FILE__))
 
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
 def test_app(name = nil)
-  app = Dragonfly::App.instance(name)
-  app.datastore = Dragonfly::MemoryDataStore.new
-  app.secret = 'test secret'
-  app
+  Dragonfly::App.instance(name).tap do |app|
+    app.datastore = Dragonfly::MemoryDataStore.new
+    app.secret = 'test secret'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_audio
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Tomas Celizna
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tomas.celizna@gmail.com
@@ -133,8 +147,8 @@ files:
 - lib/dragonfly_audio/processors/album_art.rb
 - lib/dragonfly_audio/processors/tag.rb
 - lib/dragonfly_audio/version.rb
-- samples/BroadmoorSirenTest.mp3
 - samples/album.jpg
+- samples/sample.mp3
 - test/dragonfly_audio/analysers/audio_properties_test.rb
 - test/dragonfly_audio/plugin_test.rb
 - test/dragonfly_audio/processors/album_art_test.rb
@@ -160,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Wraps common audio-related tasks into Dragonfly analysers and processors.