dropcaster 0.0.6 → 1.2.0

data/lib/dropcaster/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dropcaster
   class ConfigurationError < StandardError
     def initialize(msg)
@@ -6,14 +8,14 @@ module Dropcaster
   end
 
   class MissingAttributeError < ConfigurationError
-    def initialize(missingAttribute)
-      super("#{missingAttribute} is a mandatory channel attribute, but it is missing.")
+    def initialize(missing_attribute)
+      super("#{missing_attribute} is a mandatory channel attribute, but it is missing.")
     end
   end
 
   class AmbiguousSourcesError < ConfigurationError
-    def initialize(ambiguousSources)
-      super("The list of sources is ambiguous. Can't derive common directory from these: #{ambiguousSources.inspect}")
+    def initialize(ambiguous_sources)
+      super("The list of sources is ambiguous. Can't derive common directory from these: #{ambiguous_sources.inspect}")
     end
   end
 

data/lib/dropcaster/item.rb

@@ -1,31 +1,37 @@
+# frozen_string_literal: true
+
+require 'pathname'
 require 'mp3info'
 require 'digest/sha1'
+require 'dropcaster/logging'
 
 module Dropcaster
   class Item
-    attr_reader :file_name, :tag, :tag2, :duration, :file_size, :uuid, :pub_date, :pub_date, :lyrics
-    attr_accessor :artist, :image_url, :url, :keywords
+    include Logging
+
+    attr_reader :file_path, :tag, :tag2, :duration, :file_size, :uuid, :pub_date, :lyrics
+    attr_accessor :image_url, :url, :keywords
 
-    def initialize(file_path, options = nil)
-      Mp3Info.open(file_path){|mp3info|
-        @file_name = Pathname.new(File.expand_path(file_path)).relative_path_from(Pathname.new(Dir.pwd)).cleanpath.to_s
+    def initialize(file_path, options=nil)
+      Mp3Info.open(file_path) { |mp3info|
+        @file_path = Pathname.new(File.expand_path(file_path)).relative_path_from(Pathname.new(Dir.pwd)).cleanpath
         @tag = mp3info.tag
         @tag2 = mp3info.tag2
         @duration = mp3info.length
-        if @tag2["ULT"]
-          @lyrics = {};
-          @tag2["ULT"].split(/\x00/).drop(1).each_slice(2) { |k, v| @lyrics[k] = v }
+        if @tag2['ULT']
+          @lyrics = {}
+          @tag2['ULT'].split(/\x00/).drop(1).each_slice(2) { |k, v| @lyrics[k] = v }
         end
       }
 
-      @file_size = File.new(@file_name).stat.size
-      @uuid = Digest::SHA1.hexdigest(File.read(file_name))
+      @file_size = File.new(file_path).stat.size
+      @uuid = Digest::SHA1.hexdigest(File.read(file_path))
 
-      unless tag2.TDR.blank?
-        @pub_date = DateTime.parse(tag2.TDR)
+      if tag2.TRDA.blank?
+        logger.info("#{file_path} has no pub date set, using the file's modification time")
+        @pub_date = Time.parse(File.new(file_path).mtime.to_s)
       else
-        Dropcaster.logger.info("#{file_path} has no pub date set, using the file's modification time")
-        @pub_date = DateTime.parse(File.new(file_name).mtime.to_s)
+        @pub_date = Time.parse(tag2.TRDA)
       end
     end
   end

data/lib/dropcaster/log_formatter.rb

@@ -1,6 +1,16 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module Dropcaster
+  module Logging
+    attr_writer :logger
+
+    def logger
+      @logger ||= NullLogger.new
+    end
+  end
+
   class LogFormatter < Logger::Formatter
     def call(severity, time, program_name, message)
       "#{severity}: #{message}\n"

data/lib/dropcaster/logging.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'null_logger'
+
+module Dropcaster
+  module Logging
+    attr_writer :logger
+
+    def logger
+      @logger ||= NullLogger.new
+    end
+  end
+end

data/lib/dropcaster/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dropcaster
-  VERSION = '0.0.6'
+  VERSION = '1.2.0'
 end

data/templates/channel.html.erb

@@ -26,12 +26,9 @@
   <h1>Episodes</h1>
   <% items.each{|item| %>
     <div class="item" id="<%= h(item.uuid) %>">
-      <h1><%= item.tag.title || item.tag2.TIT2%></h1>
-    <% unless item.tag2.SUBTITLE.blank? %>
-      <h2><%= h(item.tag2.SUBTITLE) %></h2>
-    <% end %>
-    <% unless item.tag2.TT3.blank? %>
-      <p><%= h(item.tag2.TT3) %></p>
+      <h1><%= h(item.tag.title || item.file_path.to_s) %></h1>
+    <% unless item.tag2.TT3.blank? && item.tag2.TIT3.blank? %>
+      <p><%= h(item.tag2.TT3 || item.tag2.TIT3) %></p>
     <% end %>
       <img src="<%= item.image_url %>"/>
       <p>Download: <a href="<%= item.url %>">MP3</a> (<%= humanize_time(item.duration.to_i) %>, <%= humanize_size(item.file_size) %>)</p>

data/templates/channel.rss.erb

@@ -45,14 +45,15 @@
   <% end %>
   <% items.each{|item| %>
     <item>
-      <title><%= item.tag.title || item.tag2.TIT2%></title>
-      <itunes:author><%= h(item.tag2.TP1 || item.tag2.TPE1) %></itunes:author>
-    <% unless item.tag2.TT3.blank? %>
-      <itunes:subtitle><%= h(truncate(item.tag2.TT3, 50)) %></itunes:subtitle>
-      <itunes:summary><%= h(item.tag2.TT3) %></itunes:summary>
+      <title><%= h(item.tag.title || item.file_path.to_s) %></title>
+      <itunes:author><%= h(item.tag.artist) %></itunes:author>
+    <% unless item.tag2.TT3.blank? && item.tag2.TIT3.blank? %>
+      <itunes:subtitle><%= h(truncate(item.tag2.TT3 || item.tag2.TIT3, 50)) %></itunes:subtitle>
+      <itunes:summary><%= h(item.tag2.TT3 || item.tag2.TIT3) %></itunes:summary>
     <% end %>
       <itunes:image href="<%= item.image_url %>"/>
       <enclosure url="<%= item.url %>" length="<%= item.file_size %>" type="audio/mp3"/>
+      <link><%= item.url %></link>
       <guid isPermaLink="false"><%= h(item.uuid) %></guid>
       <pubDate><%= h(item.pub_date.to_formatted_s(:rfc822)) %></pubDate>
       <itunes:duration><%= item.duration.to_i %></itunes:duration>

data/test/Vagrantfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
@@ -9,7 +11,7 @@ Vagrant.configure(2) do |config|
     vb.memory = '256'
   end
 
-  %w(1.9.1 2.0 2.1 2.2).each do |version|
+  %w[1.9.1 2.0 2.1 2.2].each do |version|
     ruby = "ruby#{version}"
     name = "ruby-#{version.tr('.', '-')}"
 

data/test/bin/vagrant-status

@@ -1,15 +1,22 @@
 #!/usr/bin/env ruby
-#
+# frozen_string_literal: true
+
 require 'csv'
 
-headers = [
-  'timestamp', # is a Unix timestamp in UTC of when the message was printed.
-  'target',    # is the target of the following output. This is empty if the message is related to Vagrant globally. Otherwise, this is generally a machine name so you can relate output to a specific machine when multi-VM is in use.
-  'type',      # is the type of machine-readable message being outputted. There are a set of standard types which are covered later.
-  'data',      # is zero or more comma-separated values associated with the prior type. The exact amount and meaning of this data is type-dependent, so you must read the documentation associated with the type to understand fully.
-]
+HEADERS = [
+  # Unix timestamp in UTC of when the message was printed.
+  'timestamp',
+  # is the target of the following output. This is empty if the message is related to Vagrant globally. Otherwise, this is generally a machine name so you can relate output to a
+  # specific machine when multi-VM is in use.
+  'target',
+  # is the type of machine-readable message being outputted. There are a set of standard types which are covered later.
+  'type',
+  # is zero or more comma-separated values associated with the prior type. The exact amount and meaning of this data is
+  # type-dependent, so you must read the documentation associated with the type to understand fully.
+  'data'
+].freeze
 
-types = [
+TYPES = [
   'box-name',          # Name of a box installed into Vagrant.
   'box-provider',      # Provider for an installed box.
   'cli-command',       # A subcommand of vagrant that is available.
@@ -17,8 +24,8 @@ types = [
   'provider-name',     # The provider name of the target machine. targeted
   'state',             # The state ID of the target machine. targeted
   'state-human-long',  # Human-readable description of the state of the machine. This is the long version, and may be a paragraph or longer. targeted
-  'state-human-short', # Human-readable description of the state of the machine. This is the short version, limited to at most a sentence. targeted
-]
+  'state-human-short'  # Human-readable description of the state of the machine. This is the short version, limited to at most a sentence. targeted
+].freeze
 
 module Vagrant
   Box = Struct.new(:name, :provider)
@@ -40,31 +47,30 @@ virtual_machines = Hash.new do |vms, target|
   vms[target] = Vagrant::VM.new(target)
 end
 
-CSV.new(ARGF, headers: headers).each do |message|
+CSV.new(ARGF, headers: HEADERS).each do |message|
   vm = virtual_machines[message['target']]
   data = message['data'].split('%!(VAGRANT_COMMA)')
 
   case message['type']
-    when 'box-name'
-      vm.box.name = data
-    when 'box-provider'
-      vm.box.provider = data
-    when 'state'
-      vm.state.id = data
-    when 'state-human-long'
-      vm.state.long = data
-    when 'state-human-short'
-      vm.state.short = data
-    when 'cli-command'
-      vm.command = data
-    when 'error-exit'
-      vm.error = Vagrant::Error.new(data[0], data[1])
-    when 'provider-name'
-      vm.provider = data
-    else
-      raise "Unknown type: #{message['type']}"
+  when 'box-name'
+    vm.box.name = data
+  when 'box-provider'
+    vm.box.provider = data
+  when 'state'
+    vm.state.id = data
+  when 'state-human-long'
+    vm.state.long = data
+  when 'state-human-short'
+    vm.state.short = data
+  when 'cli-command'
+    vm.command = data
+  when 'error-exit'
+    vm.error = Vagrant::Error.new(data[0], data[1])
+  when 'provider-name'
+    vm.provider = data
+  else
+    raise "Unknown type: #{message['type']}"
   end
 end
 
-puts virtual_machines.map{|name, vm| name}
-#puts virtual_machines.map{|name, vm| "#{name}: #{vm.state.short}"}
+puts(virtual_machines.map { |name, _| name })

data/test/extensions/windows.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Returns true if we run on a windows platform
 #
 # Sample:
@@ -7,6 +9,6 @@
 # http://snippets.dzone.com/posts/show/2112
 #
 def Kernel.is_windows?
-  processor, platform, *rest = RUBY_PLATFORM.split("-")
+  _, platform, _ = RUBY_PLATFORM.split('-')
   platform == 'mingw32'
 end

data/test/fixtures/test_template.json.erb

@@ -19,10 +19,9 @@
     "categories": ["<% categories.join('\",\"') %>"],
     "explicit" : "<%= explicit %>",
     "items" : [<% items.collect{|item| %>{
-        "title" : "<%= item.tag.title || item.tag2.TIT2 %>",
-        "author" : "<%= item.tag2.TP1 || item.tag2.TPE1 %>",
-        "subtitle" : "<%= item.tag2.SUBTITLE %>",
-        "summary" : "<%= item.tag2.TT3 %>",
+        "title" : "<%= item.tag.title %>",
+        "author" : "<%= item.tag.artist %>",
+        "summary" : "<%= item.tag2.TT3 || item.tag2.TIT3 %>",
         "image" : "<%= item.image_url %>",
         "enclosure" : {
           "url" : "<%= item.url %>",

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 gem 'minitest'
 require 'minitest/autorun'
 require 'dropcaster'
@@ -7,5 +9,6 @@ require_relative 'extensions/windows'
 module DropcasterTest
   FIXTURES_DIR = File.join(File.dirname(__FILE__), 'fixtures')
   FIXTURE_ITUNES_MP3 = File.join(FIXTURES_DIR, 'iTunes.mp3')
-  NS_ITUNES = "itunes:http://www.itunes.com/dtds/podcast-1.0.dtd"
+  NUMBER_OF_MP3_FILES = 3
+  NS_ITUNES = 'itunes:http://www.itunes.com/dtds/podcast-1.0.dtd'
 end

data/test/unit/test_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'helper'
 require 'open3'
 require 'uri'
@@ -14,24 +16,24 @@ class TestApp < TestChannelXML
   APP_SCRIPT = 'ruby bin/dropcaster'
 
   def channel_rss
-    %x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3}]
+    `#{APP_SCRIPT} #{FIXTURES_DIR}`
   end
 
   def test_overwrite_title
     test_title = 'Alice and Bob in Wonderland'
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --title '#{test_title}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --title '#{test_title}'`)
     assert_equal(test_title, channel.find('title').first.content)
   end
 
   def test_overwrite_subtitle
     test_subtitle = 'Tales from another world that is upside down'
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --subtitle '#{test_subtitle}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --subtitle '#{test_subtitle}'`)
     assert_equal(test_subtitle, channel.find('itunes:subtitle').first.content)
   end
 
   def test_overwrite_link
     test_link = 'http://www.example.com/foo/bar'
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --url '#{test_link}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --url '#{test_link}'`)
     assert_equal(test_link, channel.find('link').first.content)
   end
 
@@ -39,14 +41,14 @@ class TestApp < TestChannelXML
     test_link_base = 'http://www.dropbox.com/foo/bar/'
     test_link_file = 'index.html'
     test_link = "#{test_link_base}#{test_link_file}"
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --url '#{test_link}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --url '#{test_link}'`)
     assert_equal(test_link, channel.find('link').first.content)
 
     options = YAML.load_file(File.join(FIXTURES_DIR, Dropcaster::CHANNEL_YML))
     assert_equal(URI.join(test_link_base, options[:image_url]).to_s, channel.find('itunes:image').first['href'])
 
     # check that the item URLs are correct, too
-    item = channel.find("item").first
+    item = channel.find('item').first
     assert(item)
 
     # enclosure
@@ -59,42 +61,43 @@ class TestApp < TestChannelXML
   end
 
   def test_dir_only
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURES_DIR}])
-    assert_equal(1, channel.find('item').size)
+    assert_equal(NUMBER_OF_MP3_FILES, @channel.find('item').size)
   end
 
   def test_overwrite_enclosures_url
     test_enclosures_url = 'http://www.example.com/foo/bar/episodes/'
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --enclosures '#{test_enclosures_url}'])
-    item = channel.find("item").first
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --enclosures '#{test_enclosures_url}'`)
+    item = channel.find('item').first
     assert(item)
     enclosure = item.find('enclosure').first
     assert(enclosure)
-    assert_equal(URI.join(test_enclosures_url,'test/fixtures/iTunes.mp3').to_s, enclosure['url'])
+    assert_equal(URI.join(test_enclosures_url, 'test/fixtures/iTunes.mp3').to_s, enclosure['url'])
   end
 
   def test_overwrite_image_url
     test_image_url = 'http://www.example.com/foo/bar/override.gif'
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --image '#{test_image_url}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --image '#{test_image_url}'`)
     assert_equal(test_image_url, channel.find('itunes:image').first['href'])
 
     # Make sure the items pick up this URL, too
-    item = channel.find("item").first
+    item = channel.find('item').first
     assert(item)
     assert_equal(test_image_url, item.find('itunes:image').first['href'])
   end
 
   def test_overwrite_description
     test_description = 'Testing commandline apps is not that hard.'
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --description '#{test_description}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --description '#{test_description}'`)
     assert_equal(test_description, channel.find('description').first.content)
     assert_equal(test_description, channel.find('itunes:summary', NS_ITUNES).first.content)
   end
 
   def test_no_channel_file
-    Open3.popen3(APP_SCRIPT){|stdin, stdout, stderr|
-      assert_match(/ERROR: No channel file found/, stderr.read)
-    } unless Kernel.is_windows?
+    unless Kernel.is_windows?
+      Open3.popen3(APP_SCRIPT) { |stdin, stdout, stderr|
+        assert_match(/ERROR: No channel file found/, stderr.read)
+      }
+    end
   end
 
   def test_overwrite_all
@@ -102,7 +105,7 @@ class TestApp < TestChannelXML
     test_link = 'http://www.example.com/bar/foot'
     test_description = 'Testing commandline apps is really not that hard.'
 
-    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --title '#{test_title}' --url '#{test_link}' --description '#{test_description}'])
+    channel = channel_node(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --title '#{test_title}' --url '#{test_link}' --description '#{test_description}'`)
 
     assert_equal(test_title, channel.find('title').first.content)
     assert_equal(test_link, channel.find('link').first.content)
@@ -111,9 +114,11 @@ class TestApp < TestChannelXML
   end
 
   def test_channel_template_not_found
-    Open3.popen3("#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --channel-template foo/bar/42"){|stdin, stdout, stderr|
-      assert_match(/Unable to load template file/, stderr.read)
-    } unless Kernel.is_windows?
+    unless Kernel.is_windows?
+      Open3.popen3("#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --channel-template foo/bar/42") { |stdin, stdout, stderr|
+        assert_match(/Unable to load template file/, stderr.read)
+      }
+    end
   end
 
   #
@@ -121,9 +126,9 @@ class TestApp < TestChannelXML
   #
   def test_overwrite_channel_template
     channel_template = File.join(FIXTURES_DIR, 'test_template.json.erb')
-    channel = JSON.parse(%x[#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --channel-template #{channel_template}])
-    assert_equal("All About Everything", channel['channel']['title'])
+    channel = JSON.parse(`#{APP_SCRIPT} #{FIXTURE_ITUNES_MP3} --channel-template #{channel_template}`)
+    assert_equal('All About Everything', channel['channel']['title'])
   end
 
-  # TODO --channel
+  # TODO: --channel
 end