dropcaster 0.0.4 → 0.0.5.rc1

data/dropcaster.gemspec

@@ -1,97 +1,36 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{dropcaster}
-  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-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"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md",
-    "TODO"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "TODO",
-    "VERSION",
-    "bin/dropcaster",
-    "bin/lstags",
-    "doc/infoPane.png",
-    "doc/lyricsPane.png",
-    "doc/sample-channel.yml",
-    "doc/sample-sidecar.yml",
-    "doc/videoPane.png",
-    "dropcaster.gemspec",
-    "lib/dropcaster.rb",
-    "lib/dropcaster/channel.rb",
-    "lib/dropcaster/channel_file_locator.rb",
-    "lib/dropcaster/errors.rb",
-    "lib/dropcaster/hashkeys.rb",
-    "lib/dropcaster/item.rb",
-    "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",
-    "test/unit/test_channel_locator.rb",
-    "test/unit/test_channel_xml.rb",
-    "test/unit/test_item.rb"
-  ]
-  s.homepage = %q{http://nerab.github.com/dropcaster}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.1}
-  s.summary = %q{Simple Podcast Publishing with Dropbox}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    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
-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dropcaster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dropcaster"
+  spec.version       = Dropcaster::VERSION
+  spec.authors       = ["Nicholas E. Rabenau"]
+  spec.email         = ["nerab@gmx.at"]
+  spec.summary       = %q{Simple Podcast Publishing with Dropbox}
+  spec.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.}
+  spec.homepage      = "https://github.com/nerab/dropcaster"
+  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.add_dependency 'ruby-mp3info', '~> 0.8'
+  spec.add_dependency 'activesupport', '~> 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'libxml-ruby', '~> 2.7'
+  spec.add_development_dependency 'guard-minitest', '~> 2.2'
+  spec.add_development_dependency 'guard-bundler', '~> 2.0'
+  spec.add_development_dependency 'libnotify', '~> 0.8'
+  spec.add_development_dependency 'rb-inotify', '~> 0.9'
+  spec.add_development_dependency 'rb-fsevent', '~> 0.9'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4'
+  spec.add_development_dependency 'rb-readline', '~> 0.5'
+end

data/lib/dropcaster/channel.rb

@@ -1,159 +1,195 @@
-require 'erb'
-require 'uri'
-
-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.
-    #
-    # +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, attributes)
-      super(Hash.new)
-
-      # Assert mandatory attributes
-      [:title, :url, :description].each{|attr|
-        raise MissingAttributeError.new(attr) if attributes[attr].blank?
-      }
-
-      self.merge!(attributes)
-      self.explicit = yes_no_or_input(attributes[:explicit])
-      @source_files = Array.new
-
-      if (sources.respond_to?(:each)) # array
-        sources.each{|src|
-          add_files(src)
-        }
-      else
-        # single file or directory
-        add_files(src)
-      end
-
-      # Prepend the image URL with the channel's base to make an absolute URL
-      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', 'channel.rss.erb')
-
-      begin
-        @erb_template = ERB.new(File.new(channel_template), 0, "%<>")
-      rescue Errno::ENOENT => e
-        raise TemplateNotFoundError.new(e.message)
-      end
-    end
-
-    #
-    # Returns this channel as an RSS representation. The actual rendering is done with the help
-    # of an ERB template. By default, it is expected as ../../templates/channel.rss.erb (relative)
-    # to channel.rb.
-    #
-    def to_rss
-      @erb_template.result(binding)
-    end
-
-    #
-    # Returns all items (episodes) of this channel, ordered by newest-first.
-    #
-    def items
-      all_items = Array.new
-      @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
-        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
-        self.enclosures_url << '/' unless self.enclosures_url =~ /\/$/
-        item.url = URI.join(URI.escape(self.enclosures_url), URI.escape(item.file_name))
-
-        all_items << item
-      }
-
-      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)
-        @source_files.concat(Dir.glob(File.join(src, '*.mp3')))
-      else
-        @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
+require 'erb'
+require 'uri'
+
+module Dropcaster
+  #
+  # Represents a podcast feed in the RSS 2.0 format
+  #
+  class Channel
+    include ERB::Util # for h() in the ERB template
+
+    STORAGE_UNITS = %w(Byte KB MB GB TB)
+    MAX_KEYWORD_COUNT = 12
+
+    # 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.
+    #
+    # +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, attributes)
+      # Assert mandatory attributes
+      [:title, :url, :description].each{|attr|
+        raise MissingAttributeError.new(attr) if attributes[attr].blank?
+      }
+
+      @attributes = attributes
+      @attributes[:explicit] = yes_no_or_input(attributes[:explicit])
+      @source_files = Array.new
+
+      # if (sources.respond_to?(:each)) # array
+      if sources.is_a? Array
+        sources.each do |src|
+          add_files(src)
+        end
+      else
+        # single file or directory
+        add_files(sources)
+      end
+
+      # If not absolute, prepend the image URL with the channel's base to make an absolute URL
+      unless @attributes[:image_url].blank? || @attributes[:image_url] =~ /^https?:/
+        Dropcaster.logger.info("Channel image URL '#{@attributes[:image_url]}' is relative, so we prepend it with the channel URL '#{@attributes[:url]}'")
+        @attributes[:image_url] = (URI.parse(@attributes[:url]) + @attributes[:image_url]).to_s
+      end
+
+      # If enclosures_url is not given, take the channel URL as a base.
+      if @attributes[:enclosures_url].blank?
+        Dropcaster.logger.info("No enclosure URL given, using the channel's enclosure URL")
+        @attributes[:enclosures_url] = @attributes[:url]
+      end
+
+      # Warn if keyword count is larger than recommended
+      assert_keyword_count(@attributes[:keywords])
+
+      channel_template = @attributes[:channel_template] || File.join(File.dirname(__FILE__), '..', '..', 'templates', 'channel.rss.erb')
+
+      begin
+        @erb_template = ERB.new(IO.read(channel_template), 0, "%<>")
+      rescue Errno::ENOENT => e
+        raise TemplateNotFoundError.new(e.message)
+      end
+    end
+
+    #
+    # Returns this channel as an RSS representation. The actual rendering is done with the help
+    # of an ERB template. By default, it is expected as ../../templates/channel.rss.erb (relative)
+    # to channel.rb.
+    #
+    def to_rss
+      @erb_template.result(binding)
+    end
+
+    #
+    # Returns all items (episodes) of this channel, ordered by newest-first.
+    #
+    def items
+      all_items = Array.new
+      @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
+        if item.artist.blank?
+          Dropcaster.logger.info("#{src} has no artist, using the channel's author")
+          item.tag.artist = @attributes[: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 = @attributes[:image_url]
+        end
+
+        # construct absolute URL, based on the channel's enclosures_url attribute
+        item.url = (URI.parse(enclosures_url) + item.file_name)
+
+        # Warn if keyword count is larger than recommended
+        assert_keyword_count(item.keywords)
+
+        all_items << item
+      }
+
+      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
+
+    # delegate all unknown methods to @attributes
+    def method_missing(meth, *args)
+      m = meth.id2name
+      if /=$/ =~ m
+        @attributes[m.chop.to_sym] = (args.length < 2 ? args[0] : args)
+      else
+        @attributes[m.to_sym]
+      end
+    end
+
+  private
+    def add_files(src)
+      if File.directory?(src)
+        @source_files.concat(Dir.glob(File.join(src, '*.mp3')))
+      else
+        @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
+
+    #
+    # http://snippets.dzone.com/posts/show/4578
+    #
+    def truncate(string, count = 30)
+    	if string.length >= count
+    		shortened = string[0, count]
+    		splitted = shortened.split(/\s/)
+    		words = splitted.length
+    		splitted[0, words - 1].join(' ') + '...'
+    	else
+    		string
+    	end
+    end
+
+    def assert_keyword_count(keywords)
+      Dropcaster.logger.info("The list of keywords has #{keywords.size} entries, which exceeds the recommended maximum of #{MAX_KEYWORD_COUNT}.") if keywords && MAX_KEYWORD_COUNT < keywords.size
+    end
+  end
+end

data/lib/dropcaster/channel_file_locator.rb

@@ -1,57 +1,57 @@
-module Dropcaster
-  #
-  # Encapsulates the strategy how to find the channel definition file
-  #
-  class ChannelFileLocator
-    class << self
-      #
-      # Locates the channel definition file based on the <tt>sources</tt> directory.
-      #
-      # * If <tt>sources</tt> is a single file name, the channel definition file is expected
-      # as channel.yml in the same directory.
-      #
-      # * If <tt>sources</tt> is a single directory name, the channel definition file is
-      # expected as channel.yml in that directory.
-      #
-      # * If <tt>sources</tt> is an array of file names, the channel definition file is
-      # expected as channel.yml in the directory common to all files. If the files are
-      # located in more than one directory, an AmbiguousSourcesError is raised. In that
-      # case, the caller should specify the channel.yml as command line parameter.
-      #
-      # * If <tt>sources</tt> is an array with more than a single directory name, an
-      # AmbiguousSourcesError is raised. In that case, the caller should specify the
-      # channel.yml as command line parameter.
-      #
-      def locate(sources)
-        channel_source_dir = nil
-
-        if sources.respond_to?(:at)
-          # More than one source given. Check that they are all in the same directory.
-          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.
-            channel_source_dir = distinct_dirs.first
-          else
-            # Since no channel_file was specified at the command line, throw and quit
-            raise AmbiguousSourcesError.new(sources)
-          end
-        else
-          # If a single file or directory is given, use that as source directory where channel.yml is expected.
-          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
+module Dropcaster
+  #
+  # Encapsulates the strategy how to find the channel definition file
+  #
+  class ChannelFileLocator
+    class << self
+      #
+      # Locates the channel definition file based on the <tt>sources</tt> directory.
+      #
+      # * If <tt>sources</tt> is a single file name, the channel definition file is expected
+      # as channel.yml in the same directory.
+      #
+      # * If <tt>sources</tt> is a single directory name, the channel definition file is
+      # expected as channel.yml in that directory.
+      #
+      # * If <tt>sources</tt> is an array of file names, the channel definition file is
+      # expected as channel.yml in the directory common to all files. If the files are
+      # located in more than one directory, an AmbiguousSourcesError is raised. In that
+      # case, the caller should specify the channel.yml as command line parameter.
+      #
+      # * If <tt>sources</tt> is an array with more than a single directory name, an
+      # AmbiguousSourcesError is raised. In that case, the caller should specify the
+      # channel.yml as command line parameter.
+      #
+      def locate(sources)
+        channel_source_dir = nil
+
+        if sources.respond_to?(:at)
+          # More than one source given. Check that they are all in the same directory.
+          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.
+            channel_source_dir = distinct_dirs.first
+          else
+            # Since no channel_file was specified at the command line, throw and quit
+            raise AmbiguousSourcesError.new(sources)
+          end
+        else
+          # If a single file or directory is given, use that as source directory where channel.yml is expected.
+          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

@@ -1,25 +1,25 @@
-module Dropcaster
-  class ConfigurationError < StandardError
-    def initialize(msg)
-      super(msg)
-    end
-  end
-
-  class MissingAttributeError < ConfigurationError
-    def initialize(missingAttribute)
-      super("#{missingAttribute} 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}")
-    end
-  end
-
-  class TemplateNotFoundError < ConfigurationError
-    def initialize(message)
-      super("Unable to load template file: #{message}")
-    end
-  end
-end
+module Dropcaster
+  class ConfigurationError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
+  class MissingAttributeError < ConfigurationError
+    def initialize(missingAttribute)
+      super("#{missingAttribute} 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}")
+    end
+  end
+
+  class TemplateNotFoundError < ConfigurationError
+    def initialize(message)
+      super("Unable to load template file: #{message}")
+    end
+  end
+end