dropcaster 0.0.6 → 1.2.0

data/bin/lstags

@@ -1,51 +1,52 @@
 #!/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"
+  warn "#{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
   Mp3Info.open(file_name) do |mp3info|
     puts 'ID3v1 tags:'
-    mp3info.tag.keys.each{|key|
+    mp3info.tag.each_key do |key|
       puts "  #{key} => #{mp3info.tag.send(key)}"
-    }
+    end
     puts
     puts 'ID3v2 tags:'
-    mp3info.tag2.keys.each{|key|
+    mp3info.tag2.each_key do |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 do |b|
+          print format('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
+        end
+        puts
+      else
+        puts "  #{key} => #{mp3info.tag2.send(key)}"
       end
-    }
+    end
   end
-  puts "Modification date: #{File.new(file_name).mtime}"
+  # rubocop:enable Metrics/BlockLength
 
-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,37 +1,48 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+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.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.authors       = ['Nicholas E. Rabenau']
+  spec.email         = ['nerab@gmx.at']
+  spec.summary       = 'Simple Podcast Publishing with Dropbox'
+  spec.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.'
+  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.require_paths = ['lib']
 
-  spec.add_dependency 'ruby-mp3info'
   spec.add_dependency 'activesupport'
   spec.add_dependency 'bundler'
+  spec.add_dependency 'nokogiri'
+  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 'bundler', '>= 2.1'
+  spec.add_development_dependency 'faraday'
+  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-nav'
-  spec.add_development_dependency 'pry-stack_explorer'
-  spec.add_development_dependency 'rb-readline'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'rb-inotify'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/dropcaster.rb

@@ -1,17 +1,12 @@
-$:.unshift File.dirname(__FILE__)
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler/setup'
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
 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 'dropcaster/errors'
-require 'dropcaster/log_formatter'
 require 'dropcaster/channel'
 require 'dropcaster/item'
 require 'dropcaster/channel_file_locator'
@@ -19,12 +14,4 @@ require 'dropcaster/version'
 
 module Dropcaster
   CHANNEL_YML = 'channel.yml'
-
-  mattr_accessor :logger
-
-  unless @@logger
-    @@logger = Logger.new(STDERR)
-    @@logger.level = Logger::WARN
-    @@logger.formatter = LogFormatter.new
-  end
 end

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))
       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")
+        if item.tag.artist.blank?
+          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 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, *)
+      (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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'octokit'
+
+module Dropcaster
+  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
+
+    def contributor_summary(contributor)
+      contributions = contributor.contributions
+      "#{contributor_link(contributor)} (#{contributions} contribution#{contributions == 1 ? '' : 's'})"
+    end
+
+    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