dragonfly_audio 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a170d383f614e2e631182e1f7b46e83c99ae0d6
-  data.tar.gz: c7ef98a7e4fb7de069928e98a0f87f22da054322
+  metadata.gz: ea5b12c33329b64884570596ad8e06ffd530f830
+  data.tar.gz: a13834b59b263db518b796b8b7765fac83201883
 SHA512:
-  metadata.gz: e6ddcbf3f71a510e4ac002ce582a93f477eb5ab5e3cc28b2ab6bf86b457c5360b75d3863c984cc9997985749dd45d5e445db6be7d132fab5f434d8a940516a95
-  data.tar.gz: c822ee6493eab379b2634d52769f3937764e78b7f66163fc705bc3956246e89d00e6d87a152cc1d01e167988040b353f2da92c96a5ce25898e4d757c8ebe1039
+  metadata.gz: 4febcf182f5c3874e6010d52c3a7ec686f30f33a51b1a1469e02a7133ece2ff6766e800755e37fb3f8136b259546353861dd695f056ba04753a802b1fdd9a688
+  data.tar.gz: 3c79cf398b489981b612a87282b1554e5aa24897096d5db35aadd02ef8c93451b50ba1a925cbb556c8e03223c0e211faee0fec301827d8c427789c56680fbf48

data/.gitignore

@@ -1 +1,2 @@
 .DS_Store
+pkg

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 2.2.5
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install -y libtag1-dev
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    dragonfly_audio (0.0.1)
+    dragonfly_audio (0.0.2)
       dragonfly (~> 1.0)
       taglib-ruby
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.4.0)
     coderay (1.1.0)
     dragonfly (1.0.12)
       addressable (~> 2.3)
@@ -34,12 +34,9 @@ GEM
       rb-inotify (>= 0.9)
     lumberjack (1.0.9)
     method_source (0.8.2)
-    mini_portile (0.6.2)
     minitest (5.8.1)
-    multi_json (1.11.2)
+    multi_json (1.12.1)
     nenv (0.2.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
     notiffany (0.0.8)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -47,14 +44,14 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.6.4)
+    rack (2.0.1)
     rake (10.4.2)
     rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
     shellany (0.0.1)
     slop (3.6.0)
-    taglib-ruby (0.7.0)
+    taglib-ruby (0.7.1)
     thor (0.19.1)
 
 PLATFORMS
@@ -66,5 +63,7 @@ DEPENDENCIES
   guard
   guard-minitest
   minitest
-  nokogiri
   rake
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -2,7 +2,7 @@
 # More info at https://github.com/guard/guard#readme
 
 guard :minitest do
-  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/.+_test\.rb$})
-  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
 end

data/README.md

@@ -1,5 +1,7 @@
 # Dragonfly Audio
 
+[![Build Status](https://travis-ci.org/tomasc/dragonfly_audio.svg)](https://travis-ci.org/tomasc/dragonfly_audio) [![Gem Version](https://badge.fury.io/rb/dragonfly_audio.svg)](http://badge.fury.io/rb/dragonfly_audio) [![Coverage Status](https://img.shields.io/coveralls/tomasc/dragonfly_audio.svg)](https://coveralls.io/r/tomasc/mongoid_recurring)
+
 Wraps common audio-related tasks into [Dragonfly](http://markevans.github.io/dragonfly) analysers and processors.
 
 ## Installation
@@ -18,6 +20,8 @@ Or install it yourself as:
 
 ## Dependencies
 
+This gem uses [taglib-ruby](https://github.com/robinst/taglib-ruby) to read and write meta data and properties of audio files.
+
 ## Usage
 
 Add the `:audio` plugin to your Dragonfly config block:
@@ -30,8 +34,48 @@ end
 
 ## Analysers
 
+### audio_properties
+
+Reads properties and tags of an audio file:
+
+```ruby
+audio.audio_properties
+
+# => {
+#   title: 'The Ship Was Sailing',
+#   artist: 'Vito Ricci',
+#   album: 'Music From Memory',
+#   year: '1985',
+#   track: 7
+#   genre: 'Ambient',
+#   comment: 'This Music was originally composed for "The Memory Theatre of Gulio Camillo" by Matthew Maguire. A Creation production premiered at La Mama Spring 1985 thanks to Bonnie for not laughing to Justin for laughing to Jon Gordron for electronic bondage produced by Jonathan Mann for Pangea Productions recorded 8/85 at Chiens Interdits Studio in a big cover production by Ann Rower cover design by Paul Leone * all compositions by Vito Ricci * play it loud',
+#   length: 345,
+#   bitrate: 192,
+#   channels: 2,
+#   sample_rate: 44_100
+# }
+```
+
 ## Processors
 
+### tag
+
+Sets the file's meta information:
+
+```ruby
+audio.tag(artist: 'Ariel Kalma', album: 'Le Temps Des Moissons', track: 'Bakafrika')
+```
+
+Permissible properties:
+* album
+* artist
+* comment
+* genre
+* tag
+* title
+* track
+* year
+
 ## Contributing
 
 1. Fork it ( https://github.com/tomasc/dragonfly_audio/fork )

data/dragonfly_audio.gemspec

@@ -4,26 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dragonfly_audio/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dragonfly_audio"
+  spec.name          = 'dragonfly_audio'
   spec.version       = DragonflyAudio::VERSION
-  spec.authors       = ["Tomas Celizna", "Asger Behncke Jacobsen"]
-  spec.email         = ["tomas.celizna@gmail.com", "asger@8kilo.com"]
-  spec.summary       = %q{Wraps common audio-related tasks into Dragonfly analysers and processors.}
-  spec.homepage      = "https://github.com/tomasc/dragonfly_audio"
-  spec.license       = "MIT"
+  spec.authors       = ['Tomas Celizna', 'Asger Behncke Jacobsen']
+  spec.email         = ['tomas.celizna@gmail.com', 'asger@8kilo.com']
+  spec.summary       = 'Wraps common audio-related tasks into Dragonfly analysers and processors.'
+  spec.homepage      = 'https://github.com/tomasc/dragonfly_audio'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "dragonfly", "~> 1.0"
-  spec.add_dependency "taglib-ruby"
+  spec.add_dependency 'dragonfly', '~> 1.0'
+  spec.add_dependency 'taglib-ruby'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "nokogiri"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest'
 end

data/lib/dragonfly_audio/analysers/audio_properties.rb

@@ -5,42 +5,31 @@ 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
 
-      def call content
+      def call(content)
         taglib_fileref(content)
       end
 
       private # =============================================================
 
-      def taglib_fileref temp_object
+      def taglib_fileref(content)
         res = {}
-        TagLib::FileRef.open(temp_object.path) do |fileref|
+        TagLib::FileRef.open(content.path) do |fileref|
           unless fileref.null?
 
-            # TODO: simplify me!
-            tag = fileref.tag
-            res.merge! title: tag.title
-            res.merge! artist: tag.artist
-            res.merge! album: tag.album
-            res.merge! year: tag.year
-            res.merge! tag: tag.year
-            res.merge! track: tag.track
-            res.merge! genre: tag.genre
-            res.merge! comment: tag.comment
+            TAGS.each do |tag_name|
+              res[tag_name] = fileref.tag.send(tag_name)
+            end
 
-            prop = fileref.audio_properties
-            res.merge! length: prop.length
-            res.merge! bitrate: prop.bitrate
-            res.merge! channels: prop.channels
-            res.merge! sample_rate: prop.sample_rate
-
-            # prop.merge! %w(title artist album year track genre comment).inject({}) { |res, att| { att => fileref.tag.send(att) } }
-            # prop.merge! length: fileref.audio_properties.length
+            AUDIO_PROPS.each do |prop_name|
+              res[prop_name] = fileref.audio_properties.send(prop_name)
+            end
           end
         end
         res
       end
-
     end
   end
 end

data/lib/dragonfly_audio/plugin.rb

@@ -1,56 +1,22 @@
 require 'dragonfly_audio/analysers/audio_properties'
+require 'dragonfly_audio/processors/tag'
 
 module DragonflyAudio
   class Plugin
-
-    def call app, opts={}
+    def call(app, _opts = {})
       app.add_analyser :audio_properties, DragonflyAudio::Analysers::AudioProperties.new
 
-      app.add_analyser :title do |content|
-        content.analyse(:audio_properties)[:title]
-      end
-
-      app.add_analyser :artist do |content|
-        content.analyse(:audio_properties)[:artist]
-      end
-
-      app.add_analyser :album do |content|
-        content.analyse(:audio_properties)[:album]
-      end
-
-      app.add_analyser :year do |content|
-        content.analyse(:audio_properties)[:year]
-      end
-
-      app.add_analyser :track do |content|
-        content.analyse(:audio_properties)[:track]
-      end
-
-      app.add_analyser :genre do |content|
-        content.analyse(:audio_properties)[:genre]
+      [
+        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
       end
 
-      app.add_analyser :comment do |content|
-        content.analyse(:audio_properties)[:comment]
-      end
-
-      app.add_analyser :length do |content|
-        content.analyse(:audio_properties)[:length]
-      end
-
-      app.add_analyser :bitrate do |content|
-        content.analyse(:audio_properties)[:bitrate]
-      end
-
-      app.add_analyser :channels do |content|
-        content.analyse(:audio_properties)[:channels]
-      end
-
-      app.add_analyser :sample_rate do |content|
-        content.analyse(:audio_properties)[:sample_rate]
-      end
+      app.add_processor :tag, DragonflyAudio::Processors::Tag.new
     end
-
   end
 end
 

data/lib/dragonfly_audio/processors/tag.rb

@@ -0,0 +1,29 @@
+require 'taglib'
+
+# IMPORTANT: See http://robinst.github.io/taglib-ruby/
+
+module DragonflyAudio
+  module Processors
+    class Tag
+      PERMISSIBLE_PROPERTIES = DragonflyAudio::Analysers::AudioProperties::TAGS
+
+      def call(content, properties)
+        clean_properties = properties.delete_if { |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
+        end
+
+        content.update(tempfile)
+      end
+    end
+  end
+end

data/lib/dragonfly_audio/version.rb

@@ -1,3 +1,3 @@
 module DragonflyAudio
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'.freeze
 end

data/test/dragonfly_audio/analysers/audio_properties_test.rb

@@ -0,0 +1,50 @@
+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
+end

data/test/dragonfly_audio/plugin_test.rb

@@ -2,17 +2,28 @@ 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 'analysers' do
       it 'adds #audio_properties' do
         audio.must_respond_to :audio_properties
       end
+
+      [
+        DragonflyAudio::Analysers::AudioProperties::TAGS,
+        DragonflyAudio::Analysers::AudioProperties::AUDIO_PROPS
+      ].flatten.each do |analyser|
+        it "adds ##{analyser}" do
+          audio.must_respond_to analyser
+        end
+      end
     end
 
+    describe 'processors' do
+      it 'adds #tag' do
+        audio.must_respond_to :tag
+      end
+    end
   end
 end

data/test/dragonfly_audio/processors/tag_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+describe DragonflyAudio::Processors::Tag do
+  let(:app) { test_app.configure_with(:audio) }
+  let(:processor) { DragonflyAudio::Processors::Tag.new }
+  let(:analyser) { DragonflyAudio::Analysers::AudioProperties.new }
+  let(:audio) { Dragonfly::Content.new(app, SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
+
+  let(:artist) { 'Elvis Presley' }
+  let(:title) { 'Hound Dawg' }
+
+  before { processor.call(audio, artist: artist, title: title) }
+
+  describe 'properties' do
+    it 'sets the artist tag property' do
+      analyser.call(audio)[:artist].must_equal artist
+    end
+
+    it 'sets the title tag property' do
+      analyser.call(audio)[:title].must_equal title
+    end
+  end
+end

data/test/test_helper.rb

@@ -7,15 +7,11 @@ require 'minitest/spec'
 require 'dragonfly'
 require 'dragonfly_audio'
 
-# ---------------------------------------------------------------------
-
 SAMPLES_DIR = Pathname.new(File.expand_path('../../samples', __FILE__))
 
-# ---------------------------------------------------------------------
-
-def test_app name=nil
+def test_app(name = nil)
   app = Dragonfly::App.instance(name)
   app.datastore = Dragonfly::MemoryDataStore.new
-  app.secret = "test secret"
+  app.secret = 'test secret'
   app
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_audio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tomas Celizna
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -67,20 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  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'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -142,9 +129,12 @@ files:
 - lib/dragonfly_audio.rb
 - lib/dragonfly_audio/analysers/audio_properties.rb
 - lib/dragonfly_audio/plugin.rb
+- lib/dragonfly_audio/processors/tag.rb
 - lib/dragonfly_audio/version.rb
 - samples/BroadmoorSirenTest.mp3
+- test/dragonfly_audio/analysers/audio_properties_test.rb
 - test/dragonfly_audio/plugin_test.rb
+- test/dragonfly_audio/processors/tag_test.rb
 - test/test_helper.rb
 homepage: https://github.com/tomasc/dragonfly_audio
 licenses:
@@ -166,10 +156,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Wraps common audio-related tasks into Dragonfly analysers and processors.
 test_files:
+- test/dragonfly_audio/analysers/audio_properties_test.rb
 - test/dragonfly_audio/plugin_test.rb
+- test/dragonfly_audio/processors/tag_test.rb
 - test/test_helper.rb