dropcaster 0.0.8 → 1.0.0

data/Rakefile

@@ -1,16 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rake/clean'
+require 'rubocop/rake_task'
 require 'dropcaster'
 
+RuboCop::RakeTask.new
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'test'
   test.pattern = 'test/**/test_*.rb'
 end
 
-task :default => :test
+task default: %i[rubocop test]
 
 namespace :web do
   file 'website/index.markdown' do |f|
@@ -35,8 +38,8 @@ namespace :web do
   end
   CLOBBER << 'website/contributing.md'
 
-  desc "Generate web page"
-  task :generate => ['website/index.markdown', 'website/vision.markdown', 'website/contributing.md'] do
+  desc 'Generate web page'
+  task generate: ['website/index.markdown', 'website/vision.markdown', 'website/contributing.md'] do
     cd 'website' do
       `bundle exec jekyll build`
     end

data/Vagrantfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 

data/bin/dropcaster

@@ -1,22 +1,24 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'yaml'
+require 'English'
 
-help = <<HELP
-Dropcaster is a podcast feed generator for the command line.
+help = <<~HELP
+  Dropcaster is a podcast feed generator for the command line.
 
-Author: Nicolas E. Rabenau nerab@gmx.at
-Homepage: http://nerab.github.io/dropcaster/
+  Author: Nicolas E. Rabenau nerab@gmx.at
+  Homepage: http://nerab.github.io/dropcaster/
 
-Basic Usage:
+  Basic Usage:
 
-  dropcaster            Prints a podcast feed document for the mp3 files in the current directory.
-  dropcaster [FILE]...  Prints a podcast feed document for FILES
-  dropcaster [DIR]...   Prints a podcast feed document for the mp3 files in DIR
+    dropcaster            Prints a podcast feed document for the mp3 files in the current directory.
+    dropcaster [FILE]...  Prints a podcast feed document for FILES
+    dropcaster [DIR]...   Prints a podcast feed document for the mp3 files in DIR
 
-Options:
+  Options:
 HELP
 
 def usage
@@ -25,105 +27,105 @@ end
 
 require 'optparse'
 require 'dropcaster'
+require 'dropcaster/log_formatter'
 
-options = Hash.new
+options = {}
 options[:auto_detect_channel_file] = true
 
-opts = OptionParser.new do |opts|
+logger = Logger.new(STDERR).tap do |l|
+  l.level = Logger::WARN
+  l.formatter = Dropcaster::LogFormatter.new
+end
+
+# rubocop:disable Metrics/BlockLength
+OptionParser.new do |opts|
   opts.banner = help
 
-  opts.on("--verbose", "Verbose mode - displays additional diagnostic information") do |file|
-    Dropcaster.logger = Logger.new(STDERR)
-    Dropcaster.logger.formatter = Dropcaster::LogFormatter.new
-    Dropcaster.logger.level = Logger::INFO
+  opts.on('--verbose', 'Verbose mode - displays additional diagnostic information') do |file|
+    logger.level = Logger::INFO
   end
 
-  opts.on("--trace", "Verbose mode - displays additional diagnostic information") do |file|
-    Dropcaster.logger = Logger.new(STDERR)
-    Dropcaster.logger.formatter = Dropcaster::LogFormatter.new
-    Dropcaster.logger.level = Logger::DEBUG
+  opts.on('--trace', 'Verbose mode - displays additional diagnostic information') do |file|
+    logger.level = Logger::DEBUG
   end
 
-  opts.on("--channel FILE", "Read the channel definition from FILE instead of channel.yml in the current directory.") do |file|
-    begin
-      Dropcaster.logger.info "Reading channel definition from #{file}"
-      options = YAML.load_file(file).merge(options)
-      options[:auto_detect_channel_file] = false
-    rescue
-      Dropcaster.logger.error "Could not load channel definition. #{$!.message}"
-      Dropcaster.logger.info $!.backtrace
-      exit(1)
-    end
+  opts.on('--channel FILE', 'Read the channel definition from FILE instead of channel.yml in the current directory.') do |file|
+    logger.info "Reading channel definition from #{file}"
+    options = YAML.load_file(file).merge(options)
+    options[:auto_detect_channel_file] = false
+  rescue StandardError
+    logger.error "Could not load channel definition. #{$ERROR_INFO.message}"
+    logger.info $ERROR_INFO.backtrace
+    exit(1)
   end
 
-  opts.on("--title STRING", "Use STRING as the channel's title. Overrides settings read from channel definition file.") do |title|
-    Dropcaster.logger.info "Setting channel title to '#{title}' via command line"
+  opts.on('--title STRING', "Use STRING as the channel's title. Overrides settings read from channel definition file.") do |title|
+    logger.info "Setting channel title to '#{title}' via command line"
     options[:title] = title
   end
 
-  opts.on("--subtitle STRING", "Use STRING as the channel's subtitle. Overrides settings read from channel definition file.") do |subtitle|
-    Dropcaster.logger.info "Setting channel subtitle to '#{subtitle}' via command line"
+  opts.on('--subtitle STRING', "Use STRING as the channel's subtitle. Overrides settings read from channel definition file.") do |subtitle|
+    logger.info "Setting channel subtitle to '#{subtitle}' via command line"
     options[:subtitle] = subtitle
   end
 
-  opts.on("--url URL", "Use URL as the channel's url. Overrides settings read from channel definition file.") do |url|
-    Dropcaster.logger.info "Setting channel URL to '#{url}' via command line"
+  opts.on('--url URL', "Use URL as the channel's url. Overrides settings read from channel definition file.") do |url|
+    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|
-    Dropcaster.logger.info "Setting channel description to '#{description}' via command line"
+  opts.on('--description STRING', "Use STRING as the channel's description. Overrides settings read from channel definition file.") do |description|
+    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|
-    Dropcaster.logger.info "Setting enclosures base URL to '#{enclosures_url}' via command line"
+  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|
+    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|
-    Dropcaster.logger.info "Setting image URL to '#{image_url}' via command line"
+  opts.on('--image URL', "Use URL as the channel's image URL. Overrides settings read from channel definition file.") do |image_url|
+    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|
-    Dropcaster.logger.info "Using'#{file}' as channel template file"
+  opts.on('--channel-template FILE', 'Use FILE as template for generating the channel feed. Overrides the default that comes with Dropcaster.') do |file|
+    logger.info "Using'#{file}' as channel template file"
     options[:channel_template] = file
   end
 
-  opts.on("--version", "Display current version") do
+  opts.on('--version', 'Display current version') do
     puts "#{File.basename(__FILE__)} " + Dropcaster::VERSION
     exit 0
   end
-end
+end.parse!
+# rubocop:enable Metrics/BlockLength
 
-opts.parse!
 sources = ARGV.blank? ? '.' : ARGV
 
 if options[:auto_detect_channel_file]
   # There was no channel file specified, so we try to load channel.yml from sources dir
   channel_file = Dropcaster::ChannelFileLocator.locate(sources)
 
-  if File.exists?(channel_file)
-    Dropcaster.logger.info "Auto-detected channel file at #{channel_file}"
+  if File.exist?(channel_file)
+    logger.info "Auto-detected channel file at #{channel_file}"
     options_from_yaml = YAML.load_file(channel_file)
     options = options_from_yaml.merge(options)
   else
-    Dropcaster.logger.error "No channel file found at #{channel_file})"
-    Dropcaster.logger.info usage
+    logger.error "No channel file found at #{channel_file})"
+    logger.info usage
     exit(1) # No way to continue without a channel definition
   end
 end
 
-Dropcaster.logger.info "Generating the channel with these options: #{options.inspect}"
-
+logger.info "Generating the channel with these options: #{options.inspect}"
 begin
   puts Dropcaster::Channel.new(sources, options).to_rss
-rescue
-  Dropcaster.logger.error $!.message
-  $!.backtrace.each do |line|
-    Dropcaster.logger.debug(line)
+rescue StandardError
+  logger.error $ERROR_INFO.message
+  $ERROR_INFO.backtrace.each do |line|
+    logger.debug(line)
   end
-  Dropcaster.logger.info usage
+  logger.info usage
   exit(1)
 end

data/bin/lstags

@@ -1,51 +1,54 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 unless ARGV.size == 1
   STDERR.puts "#{File.basename(__FILE__)}: Missing required parameter for the mp3 file to process"
   exit(1)
 end
 
-require 'rubygems'
 require 'mp3info'
-
 begin
   file_name = ARGV.first
 
   puts "Listing tags for file: #{file_name}"
 
+  # rubocop:disable Metrics/BlockLength
+  # rubocop:disable Lint/EmptyWhen
   Mp3Info.open(file_name) do |mp3info|
     puts 'ID3v1 tags:'
-    mp3info.tag.keys.each{|key|
+    mp3info.tag.each_key { |key|
       puts "  #{key} => #{mp3info.tag.send(key)}"
     }
     puts
     puts 'ID3v2 tags:'
-    mp3info.tag2.keys.each{|key|
+    mp3info.tag2.each_key { |key|
       case key
-        when 'PIC'
-        when 'APIC'
-          # picture - do not print binary data
-        when 'ULT'
-          print "  ULT => "
-          block_counter = 0
-          mp3info.tag2.ULT.bytes{|b|
-            print "0x%02x " % b.to_i
-            print b > 31 ? " '#{b.chr}' " : " " * 5
-            if (block_counter += 1) > 7 # display in blocks of 8 bytes
-              puts
-              print " " * 9
-              block_counter = 0
-            end
-          }
-          puts
-        else
-          puts "  #{key} => #{mp3info.tag2.send(key)}"
+      when 'PIC'
+      when 'APIC'
+      # picture - do not print binary data
+      when 'ULT'
+        print '  ULT => '
+        block_counter = 0
+        mp3info.tag2.ULT.bytes { |b|
+          print sprintf('0x%02x ', b.to_i)
+          print b > 31 ? " '#{b.chr}' " : ' ' * 5
+          if (block_counter += 1) > 7 # display in blocks of 8 bytes
+            puts
+            print ' ' * 9
+            block_counter = 0
+          end
+        }
+        puts
+      else
+        puts "  #{key} => #{mp3info.tag2.send(key)}"
       end
     }
   end
-  puts "Modification date: #{File.new(file_name).mtime}"
+  # rubocop:enable Metrics/BlockLength
+  # rubocop:enable Lint/EmptyWhen
 
-rescue
-  puts "Error: #{$!.message}"
+  puts "Modification date: #{File.new(file_name).mtime}"
+rescue StandardError
+  puts "Error: #{$ERROR_INFO.message}"
   exit(1)
 end

data/dropcaster.gemspec

@@ -1,10 +1,10 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dropcaster/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'dropcaster'
   spec.version       = Dropcaster::VERSION
@@ -20,22 +20,24 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'ruby-mp3info'
   spec.add_dependency 'activesupport'
   spec.add_dependency 'bundler'
+  spec.add_dependency 'nokogiri', '~> 1.8.2'
+  spec.add_dependency 'null-logger'
+  spec.add_dependency 'ruby-mp3info'
 
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'libxml-ruby'
-  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'github-pages'
   spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'libnotify'
-  spec.add_development_dependency 'rb-inotify'
-  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'libxml-ruby'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'octokit'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rb-readline'
-  spec.add_development_dependency 'github-pages'
-  spec.add_development_dependency 'octokit'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'rb-inotify'
   spec.add_development_dependency 'rubocop'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/dropcaster/channel.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'uri'
+require 'dropcaster/logging'
 
 module Dropcaster
   #
   # Represents a podcast feed in the RSS 2.0 format
   #
   class Channel
+    include Logging
     include ERB::Util # for h() in the ERB template
 
-    STORAGE_UNITS = %w(Byte KB MB GB TB)
+    STORAGE_UNITS = %w[Byte KB MB GB TB].freeze
     MAX_KEYWORD_COUNT = 12
 
     # Instantiate a new Channel object. +sources+ must be present and can be a String or Array
@@ -23,13 +27,13 @@ module Dropcaster
     #
     def initialize(sources, attributes)
       # Assert mandatory attributes
-      [:title, :url, :description].each{|attr|
+      %i[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
+      @source_files = []
 
       # if (sources.respond_to?(:each)) # array
       if sources.is_a? Array
@@ -43,13 +47,13 @@ module Dropcaster
 
       # 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]}'")
+        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")
+        logger.info("No enclosure URL given, using the channel's enclosure URL")
         @attributes[:enclosures_url] = @attributes[:url]
       end
 
@@ -59,7 +63,7 @@ module Dropcaster
       channel_template = @attributes[:channel_template] || File.join(File.dirname(__FILE__), '..', '..', 'templates', 'channel.rss.erb')
 
       begin
-        @erb_template = ERB.new(IO.read(channel_template), 0, "%<>")
+        @erb_template = ERB.new(IO.read(channel_template), 0, '%<>')
       rescue Errno::ENOENT => e
         raise TemplateNotFoundError.new(e.message)
       end
@@ -78,26 +82,25 @@ module Dropcaster
     # Returns all items (episodes) of this channel, ordered by newest-first.
     #
     def items
-      all_items = Array.new
-      @source_files.each{|src|
-
+      all_items = []
+      @source_files.each { |src|
         item = Item.new(src)
 
-        Dropcaster.logger.debug("Adding new item from file #{src}")
+        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")
+          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")
+          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) + URI.encode(item.file_name))
+        item.url = URI.parse(enclosures_url) + item.file_path.each_filename.map { |p| url_encode(p) }.join('/')
 
         # Warn if keyword count is larger than recommended
         assert_keyword_count(item.keywords)
@@ -105,13 +108,13 @@ module Dropcaster
         all_items << item
       }
 
-      all_items.sort{|x, y| y.pub_date <=> x.pub_date}
+      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
+      [[60, :s], [60, :m], [24, :h], [1000, :d]].map { |count, name|
+        if secs.positive?
           secs, n = secs.divmod(count)
           "#{n.to_i}#{name}"
         end
@@ -122,37 +125,43 @@ module Dropcaster
     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
-
+        number  /= 1024**exponent
         unit = STORAGE_UNITS[exponent]
-        return storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
       end
+
+      '%n %u'.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
     end
 
-    # delegate all unknown methods to @attributes
+    #
+    # Delegate all unknown methods to @attributes
+    #
+    # rubocop:disable Style/MethodMissing
     def method_missing(meth, *args)
       m = meth.id2name
-      if /=$/ =~ m
+      if /=$/.match?(m)
         @attributes[m.chop.to_sym] = (args.length < 2 ? args[0] : args)
       else
         @attributes[m.to_sym]
       end
     end
+    # rubocop:enable Style/MethodMissing
+
+    def respond_to_missing?(meth, *)
+      /=$/.match?(meth.id2name) || super
+    end
+
+    private
 
-  private
     def add_files(src)
       if File.directory?(src)
-        @source_files.concat(Dir.glob(File.join(src, '*.mp3')))
+        @source_files.concat(Dir.glob(File.join(src, '*.mp3'), File::FNM_CASEFOLD))
       else
         @source_files << src
       end
@@ -163,12 +172,12 @@ module Dropcaster
     #
     def yes_no_or_input(flag)
       case flag
-        when nil
-          nil
-        when true
-          'Yes'
-        when false
-          'No'
+      when nil
+        nil
+      when true
+        'Yes'
+      when false
+        'No'
       else
         flag
       end
@@ -177,19 +186,21 @@ module Dropcaster
     #
     # 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
+    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
+      if keywords && MAX_KEYWORD_COUNT < keywords.size
+        logger.info("The list of keywords has #{keywords.size} entries, which exceeds the recommended maximum of #{MAX_KEYWORD_COUNT}.")
+      end
     end
   end
 end

data/lib/dropcaster/channel_file_locator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dropcaster
   #
   # Encapsulates the strategy how to find the channel definition file
@@ -27,9 +29,9 @@ 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| dir_or_self(source)}.uniq
+          distinct_dirs = sources.collect { |source| dir_or_self(source) }.uniq
 
-          if 1 == distinct_dirs.size
+          if distinct_dirs.size == 1
             # If all are the in same directory, use that as source directory where channel.yml is expected.
             channel_source_dir = distinct_dirs.first
           else
@@ -40,11 +42,12 @@ module Dropcaster
           # 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
+
+      private
+
       def dir_or_self(source)
         if File.directory?(source)
           source

data/lib/dropcaster/contributors.rb

@@ -1,12 +1,39 @@
+# frozen_string_literal: true
+
 require 'octokit'
 
 module Dropcaster
-  def self.contributors
-    cbtors = Octokit.contributors('nerab/dropcaster', true)
+  class << self
+    def contributors
+      @octokit ||= if ENV.include?('GH_TOKEN')
+                     Octokit::Client.new(access_token: ENV['GH_TOKEN'])
+                   else
+                     Octokit::Client.new
+                   end
+
+      @octokit.contributors('nerab/dropcaster', true).
+        sort { |x, y| y.contributions <=> x.contributions }.
+        map { |c| "* #{contributor_summary(c)}" }.
+        join("\n")
+    end
 
-    cbtors.sort!{|x,y| y.contributions <=> x.contributions }
-    cbtors.map!{|c| "* [#{Octokit.user(c.login).name}](#{c.html_url}) (#{c.contributions} contributions)"}
+    def contributor_summary(contributor)
+      contributions = contributor.contributions
+      "#{contributor_link(contributor)} (#{contributions} contribution#{contributions == 1 ? '' : 's'})"
+    end
 
-    cbtors.join("\n")
+    def contributor_link(contributor)
+      if contributor.type == 'Anonymous'
+        contributor.name.tr('[]', '()')
+      else
+        # rubocop:disable Style/RescueStandardError
+        begin
+          "[#{@octokit.user(contributor.login).name}](#{contributor.html_url})"
+        rescue
+          contributor.login
+        end
+        # rubocop:enable Style/RescueStandardError
+      end
+    end
   end
 end