dropcaster 0.0.3 → 0.0.4

data/Gemfile

@@ -4,8 +4,10 @@ gem 'ruby-mp3info'
 gem 'activesupport'
 
 group :development do
+  gem "rake", "0.8.7" # http://stackoverflow.com/questions/6085610
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem 'libxml-ruby'
   gem 'rdoc'
+  gem 'json'
 end

data/Gemfile.lock

@@ -7,9 +7,10 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    json (1.5.3)
     libxml-ruby (2.2.1)
     libxml-ruby (2.2.1-x86-mingw32)
-    rake (0.9.2)
+    rake (0.8.7)
     rdoc (3.9.3)
     ruby-mp3info (0.6.15)
 
@@ -21,6 +22,8 @@ DEPENDENCIES
   activesupport
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
+  json
   libxml-ruby
+  rake (= 0.8.7)
   rdoc
   ruby-mp3info

data/README.md

@@ -110,7 +110,7 @@ Advanced features
 =================
 Overriding defaults
 -------------------
-Dropcaster is opinionated software. That means, it makes a number of assumptions about names, files, and directory strictures. Dropcaster will be most easy to use if these assumptions and opinions apply to your way of using the program.
+Dropcaster is opinionated software. That means, it makes a number of assumptions about names, files, and directory structures. Dropcaster will be most simple to use if these assumptions and opinions apply to your way of using the program.
 
 However, it is still possible to override Dropcaster's behavior in many ways. You can, for instance, host your episode files on a different URL than the channel. Instead of writing title, subtitle, etc. to a channel.yml, you may also spedify them on the command line.
 
@@ -118,6 +118,10 @@ In order to find out about all the options, simply run
 
         $ dropcaster --help
 
+Using custom channel templates
+------------------------------
+Dropcaster generates a feed that is suitable for most podcast clients, especially iTunes. It is also possible to customize the channel by supplying an alternative channel template on the command line. Start your own template by copying the default template, or look at the test directory of the dropcaster gem. You can get there by running `gem open dropcaster`.
+
 Sidecar files
 -------------
 You may override the meta data for any episode by providing a YAML file with the same name as the mp3 file, but with an extension of yml or yaml (ususally refered to as [sidecar file](http://en.wikipedia.org/wiki/Sidecar_file)). Any attributes specified in this file override the ID tags in the mp3 file.
@@ -134,10 +138,22 @@ The whole concept of Dropcaster works perfectly fine without Dropbox. Just run t
 
 Episode Identifier (uuid)
 -------------------------
-Dropcaster uses a rather simple approach to uniquely identify the episodes. It simply generates a SHA1 hash of the mp3 file. If it changes, for whatever reason (even if only a tag was changes), the episode will get a new UUID, and any podcatcher will fetch the episode again (which is what you want, in most cases).
+Dropcaster uses a rather simple approach to uniquely identify the episodes. It simply generates a SHA1 hash of the mp3 file. If it changes, for whatever reason (even if only a tag was changed), the episode will get a new UUID, and any podcatcher will fetch the episode again (which is what you want, in most cases).
 
 Modifying the sidecar file does not change the UUID, because it only affects the feed and not the episode itself.
 
+I Don't Like the Output Format that Dropcaster produces
+-------------------------------------------------------
+Dropcaster uses an ERB template to generate the XML feed. The template was written so that it is easy to understand, but not necessarily in a way that would make the output rather nice-looking. That should not be an issue, as long as the XML is correct.
+
+It you prefer a more aesthetically pleasing output, just pipe the output of Dropcaster through `xmllint`, which is part of [libxml](http://xmlsoft.org/), which in turn is one of the prerequisites of the Dropcaster gem, and, as such, installed with Dropcaster):
+
+    dropcaster | xmllint --format -
+
+For writing the output to a file, just redirect the ouput of the above command:
+
+    dropcaster | xmllint --format - > index.rss
+
 Contributing to Dropcaster
 ==========================
 Dropcaster is hosted at [Github](http://github.com/nerab/dropcaster):

data/TODO

@@ -1,9 +1,6 @@
 * Handle channel URLs not ending with a slash (may be required for hosts not discovering an index.html, like Dropbox)
-* In verbose mode, log warnings to STDERR for all the opinionated decisions and fallbacks that Dropcaster takes
-* Allow overriding the path to the ERB template (and document the available template variables)
-* Support a tree of iTunes categories: <itunes:category text="Technology"><itunes:category text="Gadgets"/></itunes:category>
-* If an index.html.erb is present, generate an index.html from it
-  ** In addition to that, if an item.html.erb is present, generate individual html for each item from it and link to it from the index.html
+* Support subtitle and keywords in channel and items
+* If the option for the item template is present (e.g. --item-template templates/item.html.erb), generate individual html pages for each item from it and link to it from the index.html. Leave it off by default.
 * Print warnings when one of the specs from http://www.apple.com/itunes/podcasts/specs.html is violated
 * Allow muting of the iTunes warnings (see above) using a commandline switch
 * Implement sidecar files
@@ -12,3 +9,4 @@
 * Potential optimization for large numbers of mp3 files: If there is an existing index.rss file, do not re-read the information from those files that are still there and still have the same hash value.
 * It feels pretty awkward to refer to the ID3v2 frame names all the time. After all, this is an implementation detail. Maybe we can wrap the frames with a nicer name, but still allow access to the underlying mp3info library? Maybe all we need is some aliasing and / or delegation?
 * Potentially replace the ERB template with Builder::XmlMarkup, see http://builder.rubyforge.org/ (the same that Rails uses)
+* Expose strip_itunes_private as commandline parameter

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/bin/dropcaster

@@ -18,7 +18,6 @@ Basic Usage:
   dropcaster [DIR]...   Prints a podcast feed document for the mp3 files in DIR
 
 Options:
-
 HELP
 
 def usage
@@ -29,55 +28,56 @@ require 'optparse'
 require 'dropcaster'
 
 options = Hash.new
-options[:verbose] = false
 options[:auto_detect_channel_file] = true
 
 opts = OptionParser.new do |opts|
   opts.banner = help
 
   opts.on("--verbose", "Verbose mode - displays additional diagnostic information") do |file|
-    options[:verbose] = true
+    Dropcaster.logger = Logger.new(STDERR)
+    Dropcaster.logger.formatter = Dropcaster::LogFormatter.new
+    Dropcaster.logger.level = Logger::INFO
   end
 
   opts.on("--channel FILE", "Read the channel definition from FILE instead of channel.yml in the current directory.") do |file|
     begin
-      STDERR.puts "Reading channel definition from #{file}" if options[:verbose]
+      Dropcaster.logger.info "Reading channel definition from #{file}"
       options = YAML.load_file(file).merge(options)
       options[:auto_detect_channel_file] = false
     rescue
-      STDERR.puts "Error loading channel definition: #{$!.message}"
-      STDERR.puts $!.backtrace if options[:verbose]
+      Dropcaster.logger.error "Could not load channel definition. #{$!.message}"
+      Dropcaster.logger.info $!.backtrace
       exit(1)
     end
   end
 
   opts.on("--title STRING", "Use STRING as the channel's title. Overrides settings read from channel definition file.") do |title|
-    STDERR.puts "Setting channel title to '#{title}' via command line" if options[:verbose]
+    Dropcaster.logger.info "Setting channel title to '#{title}' via command line"
     options[:title] = title
   end
 
   opts.on("--url URL", "Use URL as the channel's url. Overrides settings read from channel definition file.") do |url|
-    STDERR.puts "Setting channel URL to '#{url}' via command line" if options[:verbose]
+    Dropcaster.logger.info "Setting channel URL to '#{url}' via command line"
     options[:url] = url
   end
 
   opts.on("--description STRING", "Use STRING as the channel's description. Overrides settings read from channel definition file.") do |description|
-    STDERR.puts "Setting channel description to '#{description}' via command line" if options[:verbose]
+    Dropcaster.logger.info "Setting channel description to '#{description}' via command line"
     options[:description] = description
   end
 
   opts.on("--enclosures URL", "Use URL as the base URL for the channel's enclosures. Overrides settings read from channel definition file.") do |enclosures_url|
-    STDERR.puts "Setting enclosures base URL to '#{enclosures_url}' via command line" if options[:verbose]
+    Dropcaster.logger.info "Setting enclosures base URL to '#{enclosures_url}' via command line"
     options[:enclosures_url] = enclosures_url
   end
 
   opts.on("--image URL", "Use URL as the channel's image URL. Overrides settings read from channel definition file.") do |image_url|
-    STDERR.puts "Setting image URL to '#{image_url}' via command line" if options[:verbose]
+    Dropcaster.logger.info "Setting image URL to '#{image_url}' via command line"
     options[:image_url] = image_url
   end
 
   opts.on("--channel-template FILE", "Use FILE as template for generating the channel feed. Overrides the default that comes with Dropcaster.") do |file|
-    STDERR.puts "Using'#{file}' as channel template file" if options[:verbose]
+    Dropcaster.logger.info "Using'#{file}' as channel template file"
     options[:channel_template] = file
   end
 
@@ -95,23 +95,23 @@ if options[:auto_detect_channel_file]
   channel_file = Dropcaster::ChannelFileLocator.locate(sources)
 
   if File.exists?(channel_file)
-    STDERR.puts "Auto-detected channel file at #{channel_file}" if options[:verbose]
+    Dropcaster.logger.info "Auto-detected channel file at #{channel_file}"
     options_from_yaml = YAML.load_file(channel_file)
     options = options_from_yaml.merge(options)
   else
-    STDERR.puts "No #{channel_file} found."
-    STDERR.puts usage
+    Dropcaster.logger.error "No channel file found at #{channel_file})"
+    Dropcaster.logger.info usage
     exit(1) # No way to continue without a channel definition
   end
 end
 
-STDERR.puts "Generating the channel with these options: #{options.inspect}" if options[:verbose]
+Dropcaster.logger.info "Generating the channel with these options: #{options.inspect}"
 
 begin
   puts Dropcaster::Channel.new(sources, options).to_rss
 rescue
-  STDERR.puts $!.message
-  STDERR.puts usage
-  STDERR.puts $!.backtrace if options[:verbose]
+  Dropcaster.logger.error $!.message
+  Dropcaster.logger.debug $!.backtrace
+  Dropcaster.logger.info usage
   exit(1)
 end

data/doc/sample-channel.yml

@@ -69,11 +69,13 @@
 # Examples:
 #   :categories: 'Technology'
 #   :categories: ['Technology', 'Gadgets']
-#   :categories: ['TV & Film', ['Technology', 'Gadgets']]
-
+#   :categories: ['TV & Film', ['Technology', 'Gadgets']]
+#
+# Don't HTML-escape the categories, this will be taken care of by Dropcaster
+#
 :categories: ['Technology', 'Gadgets']
 
 #
 # Yes, No or Clean, see http://www.apple.com/itunes/podcasts/specs.html#explicit
 #
-:explicit: 'No'
+:explicit: No

data/dropcaster.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dropcaster}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["nerab"]
-  s.date = %q{2011-10-13}
+  s.date = %q{2011-10-24}
   s.description = %q{Dropcaster is a podcast feed generator for the command line. It is most simple to use with Dropbox, but works equally well with any other hoster.}
   s.email = %q{nerab@gmx.at}
   s.executables = ["lstags", "dropcaster", "dropcaster", "lstags"]
@@ -41,10 +41,13 @@ Gem::Specification.new do |s|
     "lib/dropcaster/errors.rb",
     "lib/dropcaster/hashkeys.rb",
     "lib/dropcaster/item.rb",
-    "templates/iTunes.rss.erb",
+    "lib/dropcaster/log_formatter.rb",
+    "templates/channel.html.erb",
+    "templates/channel.rss.erb",
     "test/extensions/windows.rb",
     "test/fixtures/channel.yml",
     "test/fixtures/iTunes.mp3",
+    "test/fixtures/test_template.json.erb",
     "test/helper.rb",
     "test/unit/test_app.rb",
     "test/unit/test_channel.rb",
@@ -64,25 +67,31 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<ruby-mp3info>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rake>, ["= 0.8.7"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<libxml-ruby>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
     else
       s.add_dependency(%q<ruby-mp3info>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rake>, ["= 0.8.7"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<libxml-ruby>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
     end
   else
     s.add_dependency(%q<ruby-mp3info>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rake>, ["= 0.8.7"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<libxml-ruby>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
   end
 end
 

data/lib/dropcaster/channel.rb

@@ -6,28 +6,31 @@ module Dropcaster
   # Represents a podcast feed in the RSS 2.0 format
   #
   class Channel < DelegateClass(Hash)
+    include ERB::Util # for h() in the ERB template
     include HashKeys
 
+    STORAGE_UNITS = %w(Byte KB MB GB TB)
+
     # Instantiate a new Channel object. +sources+ must be present and can be a String or Array
     # of Strings, pointing to a one or more directories or MP3 files.
     #
-    # +options+ is a hash with all attributes for the channel. The following attributes are
+    # +attributes+ is a hash with all attributes for the channel. The following attributes are
     # mandatory when a new channel is created:
     #
     # * <tt>:title</tt> - Title (name) of the podcast
     # * <tt>:url</tt> - URL to the podcast
     # * <tt>:description</tt> - Short description of the podcast (a few words)
     #
-    def initialize(sources, options)
+    def initialize(sources, attributes)
       super(Hash.new)
 
-      # Assert mandatory options
+      # Assert mandatory attributes
       [:title, :url, :description].each{|attr|
-        raise MissingAttributeError.new(attr) if options[attr].blank?
+        raise MissingAttributeError.new(attr) if attributes[attr].blank?
       }
 
-      self.merge!(options)
-      self.categories = Array.new
+      self.merge!(attributes)
+      self.explicit = yes_no_or_input(attributes[:explicit])
       @source_files = Array.new
 
       if (sources.respond_to?(:each)) # array
@@ -40,9 +43,18 @@ module Dropcaster
       end
 
       # Prepend the image URL with the channel's base to make an absolute URL
-      self.image_url = URI.join(self.url, self.image_url).to_s unless self.image_url.blank? || self.image_url =~ /^https?:/
+      unless self.image_url.blank? || self.image_url =~ /^https?:/
+        Dropcaster.logger.info("Channel image URL '#{self.image_url}' is relative, so we prepend it with the channel URL '#{self.url}'")
+        self.image_url = URI.join(self.url, self.image_url).to_s
+      end
+
+      # If enclosures_url is not given, take the channel URL as a base.
+      if self.enclosures_url.blank?
+        Dropcaster.logger.info("No enclosure URL given, using the channel's enclosure URL")
+        self.enclosures_url = self.url
+      end
 
-      channel_template = self.channel_template || File.join(File.dirname(__FILE__), '..', '..', 'templates', 'iTunes.rss.erb')
+      channel_template = self.channel_template || File.join(File.dirname(__FILE__), '..', '..', 'templates', 'channel.rss.erb')
 
       begin
         @erb_template = ERB.new(File.new(channel_template), 0, "%<>")
@@ -68,13 +80,20 @@ module Dropcaster
       @source_files.each{|src|
         item = Item.new(src)
 
+        Dropcaster.logger.debug("Adding new item from file #{src}")
+
         # set author and image_url from channel if empty
-        item.tag.artist = self.author if item.artist.blank?
-        item.image_url = self.image_url if item.image_url.blank?
+        if item.artist.blank?
+          Dropcaster.logger.info("#{src} has no artist, using the channel's author")
+          item.tag.artist = self.author
+        end
+
+        if item.image_url.blank?
+          Dropcaster.logger.info("#{src} has no image URL set, using the channel's image URL")
+          item.image_url = self.image_url
+        end
 
         # construct absolute URL, based on the channel's enclosures_url attribute
-        # If enclosures_url is not given, take the channel URL as a base.
-        self.enclosures_url = self.url if self.enclosures_url.blank?
         self.enclosures_url << '/' unless self.enclosures_url =~ /\/$/
         item.url = URI.join(URI.escape(self.enclosures_url), URI.escape(item.file_name))
 
@@ -84,6 +103,37 @@ module Dropcaster
       all_items.sort{|x, y| y.pub_date <=> x.pub_date}
     end
 
+    # from http://stackoverflow.com/questions/4136248
+    def humanize_time(secs)
+      [[60, :s], [60, :m], [24, :h], [1000, :d]].map{ |count, name|
+        if secs > 0
+          secs, n = secs.divmod(count)
+          "#{n.to_i}#{name}"
+        end
+      }.compact.reverse.join(' ')
+    end
+
+    # Fixed version of https://gist.github.com/260184
+    def humanize_size(number)
+      return nil if number.nil?
+
+      storage_units_format = '%n %u'
+
+      if number.to_i < 1024
+        unit = number > 1 ? 'Bytes' : 'Byte'
+        return storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
+      else
+        max_exp  = STORAGE_UNITS.size - 1
+        number   = Float(number)
+        exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
+        exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
+        number  /= 1024 ** exponent
+
+        unit = STORAGE_UNITS[exponent]
+        return storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
+      end
+    end
+
   private
     def add_files(src)
       if File.directory?(src)
@@ -92,5 +142,18 @@ module Dropcaster
         @source_files << src
       end
     end
+
+    #
+    # Deal with Ruby's autoboxing of Yes, No, true, etc values in YAML
+    #
+    def yes_no_or_input(flag)
+      case flag
+        when nil   : nil
+        when true  : 'Yes'
+        when false : 'No'
+      else
+        flag
+      end
+    end
   end
 end

data/lib/dropcaster/channel_file_locator.rb

@@ -27,7 +27,7 @@ module Dropcaster
 
         if sources.respond_to?(:at)
           # More than one source given. Check that they are all in the same directory.
-          distinct_dirs = sources.collect{|source| File.dirname(source)}.uniq
+          distinct_dirs = sources.collect{|source| dir_or_self(source)}.uniq
 
           if 1 == distinct_dirs.size
             # If all are the in same directory, use that as source directory where channel.yml is expected.
@@ -38,11 +38,20 @@ module Dropcaster
           end
         else
           # If a single file or directory is given, use that as source directory where channel.yml is expected.
-          channel_source_dir = File.dirname(sources)
+          channel_source_dir = dir_or_self(sources)
         end
-
+        
         File.join(channel_source_dir, CHANNEL_YML)
       end
+    
+    private
+      def dir_or_self(source)
+        if File.directory?(source)
+          source
+        else
+          File.dirname(source)
+        end
+      end
     end
   end
 end

data/lib/dropcaster/errors.rb

@@ -7,7 +7,7 @@ module Dropcaster
 
   class MissingAttributeError < ConfigurationError
     def initialize(missingAttribute)
-      super("#{missingAttribute} is a mandatory attribute, but it is missing.")
+      super("#{missingAttribute} is a mandatory channel attribute, but it is missing.")
     end
   end
 

data/lib/dropcaster/item.rb

@@ -17,23 +17,27 @@ module Dropcaster
 
       self[:file_size] = File.new(self.file_name).stat.size
       self[:uuid] = Digest::SHA1.hexdigest(File.read(self.file_name))
-      
-      if self.tag2.TDR.blank?
-        self[:pub_date] = DateTime.parse(File.new(self.file_name).mtime.to_s)
-      else
+
+      unless self.tag2.TDR.blank?
         self[:pub_date] = DateTime.parse(self.tag2.TDR)
+      else
+        Dropcaster.logger.info("#{file_path} has no pub date set, using the file's modification time")
+        self[:pub_date] = DateTime.parse(File.new(self.file_name).mtime.to_s)
       end
-      
+
       # Remove iTunes normalization crap (if configured)
-      self.tag2.COM.delete_if{|comment|
-        comment =~ /^( [0-9A-F]{8}){10}$/
-      } if options && options[:strip_itunes_private]
-      
+      if options && options[:strip_itunes_private]
+        Dropcaster.logger.info("Removing iTunes' private normalization information from comments")
+        self.tag2.COM.delete_if{|comment|
+          comment =~ /^( [0-9A-F]{8}){10}$/
+        }
+      end
+
       # Convert lyrics frame into a hash, keyed by the three-letter language code
       if tag2.ULT
         lyrics_parts = tag2.ULT.split(0.chr)
 
-        if lyrics_parts && 3 == lyrics_parts.size        
+        if lyrics_parts && 3 == lyrics_parts.size
           self.lyrics = Hash.new
           self.lyrics[lyrics_parts[1]] = lyrics_parts[2]
         end

data/lib/dropcaster/log_formatter.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+module Dropcaster
+  class LogFormatter < Logger::Formatter
+    def call(severity, time, program_name, message)
+      "#{severity}: #{message}\n"
+    end
+  end
+end

data/lib/dropcaster.rb

@@ -5,8 +5,12 @@ require 'delegate'
 require 'yaml'
 require 'active_support/core_ext/date_time/conversions'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'logger'
+require 'active_support/core_ext/logger'
 
 require 'dropcaster/errors'
+require 'dropcaster/log_formatter'
 require 'dropcaster/hashkeys'
 require 'dropcaster/channel'
 require 'dropcaster/item'
@@ -15,4 +19,12 @@ require 'dropcaster/channel_file_locator'
 module Dropcaster
   VERSION = File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
   CHANNEL_YML = 'channel.yml'
+  
+  mattr_accessor :logger
+  
+  unless @@logger
+    @@logger = Logger.new(STDERR)
+    @@logger.level = Logger::WARN
+    @@logger.formatter = LogFormatter.new
+  end
 end

data/templates/channel.html.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="<%= h(language) %>">
+<head>
+	<meta charset="utf-8"/>
+	<title><%= h(title) %></title>
+	<meta name="generator" content="Dropcaster <%= Dropcaster::VERSION%>"/>
+  <% unless copyright.blank? %>
+	<meta name="copyright" content="<%= h(copyright) %>"/>
+  <% end %>
+  <link rel="canonical" href="<%= h(url) %>"/>
+</head>
+
+<body id="home">
+	<h1><%= h(title) %></h1>
+	<% unless subtitle.blank? %>
+  <h2><%= h(subtitle) %></h2>
+  <% end %>
+  
+  <% unless image_url.blank? %>
+  <img src="<%= image_url %>"/>
+  <% end %>
+  <p><%= h(description) %></p>
+
+  <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>
+    <% 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>
+      <p>Published <%= h(item.pub_date.to_formatted_s(:rfc822)) %></p>
+    <% unless item.keywords.blank? %>
+      <p><%= h(item.keywords) %></p>
+    <% end %>
+    </div>
+  <% } %>
+</body>
+</html>

data/templates/channel.rss.erb

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file generated by Dropcaster <%= Dropcaster::VERSION%> -->
+<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" version="2.0">
+  <channel>
+    <title><%= h(title) %></title>
+    <link><%= h(url) %></link>
+    <description><%= h(description) %></description>
+    <itunes:summary><%= h(description) %></itunes:summary>
+    <% unless language.blank? %>
+    <language><%= h(language) %></language>
+    <% end %>
+    <% unless copyright.blank? %>
+    <copyright><%= h(copyright) %></copyright>
+    <% end %>
+    <% unless subtitle.blank? %>
+    <itunes:subtitle><%= h(subtitle) %></itunes:subtitle>
+    <% end %>
+    <% unless author.blank? %>
+    <itunes:author><%= h(author) %></itunes:author>
+    <% end %>
+    <% unless owner.nil? %>
+    <itunes:owner>
+      <itunes:name><%= h(owner[:name]) %></itunes:name>
+      <itunes:email><%= h(owner[:email]) %></itunes:email>
+    </itunes:owner>
+    <% end %>
+    <% unless image_url.blank? %>
+    <itunes:image href="<%= image_url %>"/>
+    <% end %>
+  <% categories.each{|category| %>
+    <% if category.respond_to?(:each_line) %>
+    <itunes:category text="<%= h(category) %>"/>
+    <% else %>
+    <itunes:category text="<%= h(category.first) %>">
+      <itunes:category text="<%= h(category.last) %>"/>
+    </itunes:category>
+    <% end %>
+  <% } unless categories.blank? %>
+  <% unless explicit.blank? %>
+    <itunes:explicit><%= h(explicit) %></itunes:explicit>
+  <% end %>
+	<generator>Dropcaster <%= Dropcaster::VERSION%></generator>
+  <% 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.SUBTITLE.blank? %>
+      <itunes:subtitle><%= h(item.tag2.SUBTITLE) %></itunes:subtitle>
+    <% end %>
+    <% unless item.tag2.TT3.blank? %>
+      <itunes:summary><%= h(item.tag2.TT3) %></itunes:summary>
+    <% end %>
+      <itunes:image href="<%= item.image_url %>"/>
+      <enclosure url="<%= item.url %>" length="<%= item.file_size %>" type="audio/mp3"/>
+      <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>
+    <% unless item.keywords.blank? %>
+      <itunes:keywords><%= h(item.keywords) %></itunes:keywords>
+    <% end %>
+    </item>
+  <% } %>
+  </channel>
+</rss>

data/test/fixtures/channel.yml

@@ -1,13 +1,15 @@
-:title: 'All About Everything'
-:subtitle: 'A show about everything'
-:url: 'http://www.example.com/podcasts/everything/'
-:language: 'en-us'
-:copyright: '© 2011 John Doe and Family'
-:author: 'John Doe'
-:description: 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our Podcast in the iTunes Store!'
+:title: All About Everything
+:subtitle: A show about everything
+:url: http://www.example.com/podcasts/everything/
+:language: en-us
+:copyright: © 2011 John Doe and Family
+:author: John Doe
+:description: All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our Podcast in the iTunes Store!
 :owner:
-  :name: 'John Doe'
-  :email: 'john.doe@example.com'
-:image_url: 'AllAboutEverything.jpg'
-:categories: ['Technology', 'Gadgets']
-:explicit: 'No'
+  :name: John Doe
+  :email: john.doe@example.com
+:image_url: AllAboutEverything.jpg
+:categories: 
+  - [Technology, Gadgets]
+  - TV & Film
+:explicit: No

data/test/fixtures/test_template.json.erb

@@ -0,0 +1,40 @@
+{  
+  "generator" : {
+    "name" : "Dropcaster",
+    "version" : "<%= Dropcaster::VERSION%>"
+  },
+  "channel" : {
+    "title" : "<%= title %>",
+    "link" : "<%= url %>",
+    "description" : "<%= description %>",
+    "language" : "<%= language %>",
+    "copyright" : "<%= copyright %>",
+    "subtitle" : "<%= subtitle %>",
+    "author" : "<%= author %>",
+    "owner" : {
+      "name" : "<%= owner[:name] %>",
+      "email" : "<%= owner[:email] %>"
+    },
+    "image" : "<%= image_url %>",
+    "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 %>",
+        "image" : "<%= item.image_url %>",
+        "enclosure" : {
+          "url" : "<%= item.url %>",
+          "length" : "<%= item.file_size %>",
+          "type" : "audio/mp3"
+        },
+        "guid" : "<%= item.uuid %>",
+        "pubDate" : "<%= item.pub_date.to_formatted_s(:rfc822) %>",
+        "duration" : "<%= item.duration.to_i %>",
+        "keywords" : "<%= item.keywords %>"
+     }
+<% }.join(',') %>
+    ]
+  }
+}

data/test/unit/test_app.rb

@@ -2,6 +2,7 @@ require 'helper'
 require 'test_channel_xml'
 require 'open3'
 require 'uri'
+require 'json'
 
 #
 # End-to-end test
@@ -28,6 +29,11 @@ class TestApp < TestChannelXML
     assert_equal(test_link, channel.find('link').first.content)
   end
 
+  def test_dir_only
+    channel = channel_node(%x[#{APP_SCRIPT} #{FIXTURES_DIR}])
+    assert_equal(1, 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}'])
@@ -57,21 +63,21 @@ class TestApp < TestChannelXML
 
   def test_no_channel_file
     Open3.popen3(APP_SCRIPT){|stdin, stdout, stderr|
-      assert_match(/No \.\/channel.yml found/, stderr.read)
+      assert_match(/ERROR: No channel file found/, stderr.read)
     } unless Kernel.is_windows?
   end
 
   def test_overwrite_all
-      test_title = 'Bob and Alice in Wonderland'
-      test_link = 'http://www.example.com/bar/foot'
-      test_description = 'Testing commandline apps is really not that hard.'
+    test_title = 'Bob and Alice in Wonderland'
+    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(%x[#{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)
-      assert_equal(test_description, channel.find('description').first.content)
-      assert_equal(test_description, channel.find('itunes:summary', NS_ITUNES).first.content)
+    assert_equal(test_title, channel.find('title').first.content)
+    assert_equal(test_link, channel.find('link').first.content)
+    assert_equal(test_description, channel.find('description').first.content)
+    assert_equal(test_description, channel.find('itunes:summary', NS_ITUNES).first.content)
   end
 
   def test_channel_template_not_found
@@ -80,5 +86,14 @@ class TestApp < TestChannelXML
     } unless Kernel.is_windows?
   end
 
+  #
+  # We supply an alternative channel template that produces JSON, parse it back and make some basic assertions on the results
+  #
+  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'])
+  end
+
   # TODO --channel
 end

data/test/unit/test_channel.rb

@@ -26,7 +26,48 @@ class TestChannel < Test::Unit::TestCase
     assert_equal(@options[:owner][:email], owner[:email])
 
     assert_equal(URI.join(@options[:url], @options[:image_url]).to_s, @channel.image_url)
-    # TODO :categories: ['Technology', 'Gadgets']
-    assert_equal(@options[:explicit], @channel.explicit)
+    
+    categories = @channel.categories
+    assert_equal(@options[:categories], categories)
+  end
+  
+  def test_channel_explicit_yes
+    assert_channel_explicit('Yes', true)
+  end
+  
+  def test_channel_explicit_no
+    assert_channel_explicit('No', false)
+  end
+  
+  def test_channel_explicit_nil
+    assert_channel_explicit(nil, nil)
+  end
+  
+  def test_channel_explicit_clean
+    assert_channel_explicit('Clean', 'Clean')
+  end
+  
+  def assert_channel_explicit(expected, value)
+    @options[:explicit] = value
+    channel = Dropcaster::Channel.new(FIXTURES_DIR, @options)
+    assert_equal(expected, channel.explicit)
+  end
+
+  def test_raise_on_missing_title
+    assert_raises Dropcaster::MissingAttributeError do
+      Dropcaster::Channel.new(FIXTURES_DIR, {:url => 'bar', :description => 'foobar'})
+    end
+  end
+
+  def test_raise_on_missing_url
+    assert_raises Dropcaster::MissingAttributeError do
+      Dropcaster::Channel.new(FIXTURES_DIR, {:title => 'foo', :description => 'foobar'})
+    end
+  end
+
+  def test_raise_on_missing_description
+    assert_raises Dropcaster::MissingAttributeError do
+      Dropcaster::Channel.new(FIXTURES_DIR, {:title => 'foo', :url => 'bar'})
+    end
   end
 end

data/test/unit/test_channel_locator.rb

@@ -36,12 +36,14 @@ class TestChannelLocator < Test::Unit::TestCase
 
   def test_current_directory
     sources = File.join(TestChannelLocator.temp_dir, '.')
-    assert_location(sources)
+    assert_location(Pathname.new(sources).cleanpath) # Cleanup path before we compare
   end
 
   def test_single_directory
-    sources = File.join(TestChannelLocator.temp_dir, 'single_dir')
-    assert_location(sources)
+    source_dir = File.join(TestChannelLocator.temp_dir, 'single_dir')
+    Dir.mkdir(source_dir)
+    expected = File.join(TestChannelLocator.temp_dir, 'single_dir', Dropcaster::CHANNEL_YML)
+    assert_equal(expected, Dropcaster::ChannelFileLocator.locate(source_dir))
   end
 
   def test_array_of_files_same_dir

data/test/unit/test_channel_xml.rb

@@ -46,12 +46,8 @@ class TestChannelXML < Test::Unit::TestCase
     assert_equal('false', guid['isPermaLink'])
     assert_equal('77bf84447c0f69ce4a33a18b0ae1e030b82010de', guid.content)
 
-    assert_equal('Sat, 01 Oct 2011 14:08:20 +0200', item.find('pubDate').first.content)
+    assert_equal('Wed, 05 Oct 2011 21:32:26 +0200', item.find('pubDate').first.content)
     assert_equal('3', item.find('itunes:duration', NS_ITUNES).first.content)
-
-    # Not used in our fixture yet
-    # assert_equal('', item.find('itunes:subtitle', NS_ITUNES).first.content)
-    # assert_equal('', item.find('itunes:keywords', NS_ITUNES).first.content)
   end
 
   def test_attributes_mandatory
@@ -81,7 +77,13 @@ class TestChannelXML < Test::Unit::TestCase
     assert_equal(@options[:owner][:email], owner.find('itunes:email', NS_ITUNES).first.content)
     assert_equal(URI.join(@options[:url], @options[:image_url]).to_s, @channel.find('itunes:image', NS_ITUNES).first['href'])
 
-    # TODO :categories: ['Technology', 'Gadgets']
-    assert_equal(@options[:explicit], @channel.find('itunes:explicit', NS_ITUNES).first.content)
+    categories = @channel.find('itunes:category', NS_ITUNES)
+    assert_not_nil(categories)
+    assert_equal(2, categories.size)
+    assert_equal('Technology', categories.first['text'])
+    assert_equal('Gadgets', categories.first.find('itunes:category', NS_ITUNES).first['text'])
+    assert_equal('TV & Film', categories.last['text'])
+    
+    assert_equal(@options[:explicit] ? 'Yes' : 'No', @channel.find('itunes:explicit', NS_ITUNES).first.content)
   end
 end

data/test/unit/test_item.rb

@@ -11,7 +11,7 @@ class TestItem < Test::Unit::TestCase
     assert_in_delta(3, @item.duration, 0.005)
     assert_equal(58119, @item.file_size)
     assert_equal('77bf84447c0f69ce4a33a18b0ae1e030b82010de', @item.uuid)
-    assert_equal(1317470900, @item.pub_date.to_i)
+    assert_equal(1317843146, @item.pub_date.to_i)
     assert_equal('test/fixtures/iTunes.mp3', @item.file_name)
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dropcaster
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - nerab
@@ -15,12 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-13 00:00:00 +02:00
+date: 2011-10-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +28,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: ruby-mp3info
-  version_requirements: *id001
+  type: :runtime
+  requirement: *id001
   prerelease: false
+  name: ruby-mp3info
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -43,12 +42,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: activesupport
-  version_requirements: *id002
+  type: :runtime
+  requirement: *id002
   prerelease: false
+  name: activesupport
 - !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: *id003
+  prerelease: false
+  name: rake
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -59,12 +74,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  name: bundler
-  version_requirements: *id003
+  type: :development
+  requirement: *id004
   prerelease: false
+  name: bundler
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -75,12 +90,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  name: jeweler
-  version_requirements: *id004
+  type: :development
+  requirement: *id005
   prerelease: false
+  name: jeweler
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -89,12 +104,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: libxml-ruby
-  version_requirements: *id005
+  type: :development
+  requirement: *id006
   prerelease: false
+  name: libxml-ruby
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -103,9 +118,24 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :development
+  requirement: *id007
+  prerelease: false
   name: rdoc
-  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id008
   prerelease: false
+  name: json
 description: Dropcaster is a podcast feed generator for the command line. It is most simple to use with Dropbox, but works equally well with any other hoster.
 email: nerab@gmx.at
 executables: 
@@ -142,10 +172,13 @@ files:
 - lib/dropcaster/errors.rb
 - lib/dropcaster/hashkeys.rb
 - lib/dropcaster/item.rb
-- templates/iTunes.rss.erb
+- lib/dropcaster/log_formatter.rb
+- templates/channel.html.erb
+- templates/channel.rss.erb
 - test/extensions/windows.rb
 - test/fixtures/channel.yml
 - test/fixtures/iTunes.mp3
+- test/fixtures/test_template.json.erb
 - test/helper.rb
 - test/unit/test_app.rb
 - test/unit/test_channel.rb

data/templates/iTunes.rss.erb

@@ -1,57 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- This file was automatically generated by Dropcaster <%= Dropcaster::VERSION%> -->
-<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" version="2.0">
-  <channel>
-    <title><%= title %></title>
-    <link><%= url %></link>
-    <description><%= description %></description>
-    <itunes:summary><%= description %></itunes:summary>
-		<% unless language.blank? %>
-    <language><%= language %></language>
-	  <% end %>
-		<% unless copyright.blank? %>
-    <copyright><%= copyright %></copyright>
-	  <% end %>
-		<% unless subtitle.blank? %>
-    <itunes:subtitle><%= subtitle %></itunes:subtitle>
-	  <% end %>
-		<% unless author.blank? %>
-    <itunes:author><%= author %></itunes:author>
-	  <% end %>
-		<% unless owner.nil? %>
-    <itunes:owner>
-      <itunes:name><%= owner[:name] %></itunes:name>
-      <itunes:email><%= owner[:email] %></itunes:email>
-    </itunes:owner>
-	  <% end %>
-		<% unless image_url.blank? %>
-    <itunes:image href="<%= image_url %>"/>
-	  <% end %>
-  <% categories.each{|category| %>
-    <itunes:category text="<%= category %>"/>
-  <% } %>
-	<% unless explicit.blank? %>
-	  <itunes:explicit><%= explicit %></itunes:explicit>
-  <% end %>
-  <% items.each{|item| %>
-    <item>
-      <title><%= item.tag.title || item.tag2.TIT2%></title>
-      <itunes:author><%= item.tag2.TP1 || item.tag2.TPE1 %></itunes:author>
-		<% unless item.tag2.SUBTITLE.blank? %>
-      <itunes:subtitle><%= item.tag2.SUBTITLE %></itunes:subtitle>
-	  <% end %>
-		<% unless item.tag2.TT3.blank? %>
-      <itunes:summary><%= item.tag2.TT3 %></itunes:summary>
-		<% end %>
-      <itunes:image href="<%= item.image_url %>"/>
-      <enclosure url="<%= item.url %>" length="<%= item.file_size %>" type="audio/mp3"/>
-      <guid isPermaLink="false"><%= item.uuid %></guid>
-      <pubDate><%= item.pub_date.to_formatted_s(:rfc822) %></pubDate>
-      <itunes:duration><%= item.duration.to_i %></itunes:duration>
-		<% unless item.keywords.blank? %>
-      <itunes:keywords><%= item.keywords %></itunes:keywords>
-    <% end %>
-    </item>
-  <% } %>
-  </channel>
-</rss>