youtube-dl.rb 0.2.2.2015.10.16 → 0.2.3.2015.10.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3086452fd3e50b0fd72e0df944c69f071dfe240f
-  data.tar.gz: 8c0e663fd1310dbe0b9c2c277f77a9ed4c2e3fad
+  metadata.gz: f84b679cf5fdaf07df79d63a0bea60581437e7f6
+  data.tar.gz: d47c54582881bdbda2c16b2fc5791a6c1b5a4d48
 SHA512:
-  metadata.gz: b3cc0018c4d67f375da27d78b584cea026a75fd6b08651258abf207a672dd9e0559dc17e22e7cfe0b5a615b35dbbadfe1427b5fd322c2ae091e7cefecd7b9578
-  data.tar.gz: f83bc8820db4d65070b0673f763ded3d72b62260e9b431ec9c4f5061954553d37b7b52e5f22fe6cd35bc7999180079c6a02ed0d6daad0e1ea310b5313d768fc5
+  metadata.gz: 793a6beeb1db594fb23557188bd285420463c4b56d7117e10361209e2f2860ab961e59dd4d3aec569dbba6bee220c70cba10fb57e2471f71ace2b222de68b2f4
+  data.tar.gz: 3a1e7c289112aee97560df754618bbb1c08811c95557f6f9bb83eca52b0fa1232435fe0f1ad7f2d115c75182c7c962b79dabc902841a810b26738fa279006f29

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/LineLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 22
+
+Metrics/MethodLength:
+  Max: 14
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,135 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-19 08:34:35 -0400 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'test/youtube-dl/runner_test.rb'
+    - 'test/youtube-dl/support_test.rb'
+    - 'test/youtube-dl_test.rb'
+
+# Offense count: 1
+Lint/Debugger:
+  Exclude:
+    - 'tmp/parse_formats.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/DeprecatedClassMethods:
+  Exclude:
+    - 'test/youtube-dl/runner_test.rb'
+    - 'test/youtube-dl/support_test.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AccessModifierIndentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'test/youtube-dl/output_test.rb'
+    - 'test/youtube-dl/runner_test.rb'
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'lib/youtube-dl/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundAccessModifier:
+  Exclude:
+    - 'lib/youtube-dl/video.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/youtube-dl/output.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/youtube-dl/output.rb'
+    - 'lib/youtube-dl/runner.rb'
+    - 'lib/youtube-dl/support.rb'
+    - 'lib/youtube-dl/video.rb'
+
+# Offense count: 2
+# Configuration parameters: Exclude.
+Style/FileName:
+  Exclude:
+    - 'lib/youtube-dl.rb'
+    - 'test/youtube-dl_test.rb'
+
+# Offense count: 1
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/youtube-dl.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/youtube-dl/support.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'test/youtube-dl_test.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'test/test_helper.rb'
+    - 'tmp/parse_formats.rb'
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false

data/Rakefile

@@ -1,27 +1,27 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.pattern = "test/**/*_test.rb"
+  t.pattern = 'test/**/*_test.rb'
 end
 
-task :default => [:test]
+task default: [:test]
 
 namespace :binaries do
   def get_binaries(version)
-    puts "Updating python script"
+    puts 'Updating python script'
     system("wget -O ./vendor/bin/youtube-dl https://yt-dl.org/downloads/#{version}/youtube-dl")
-    puts "Updating Windows EXE"
+    puts 'Updating Windows EXE'
     system("wget -O ./vendor/bin/youtube-dl.exe https://yt-dl.org/downloads/#{version}/youtube-dl.exe")
   end
 
-  desc "Get latest binaries"
+  desc 'Get latest binaries'
   task :latest do
     get_binaries('latest')
   end
 
-  desc "Get binaries for specific version (run with `rake binaries:version[2015.07.07]`)"
-  task :version, [:ver] do |t, a|
+  desc 'Get binaries for specific version (run with `rake binaries:version[2015.07.07]`)'
+  task :version, [:ver] do |_t, a|
     get_binaries(a[:ver])
   end
 end

data/lib/youtube-dl.rb

@@ -16,7 +16,8 @@ module YoutubeDL
   #
   # @param urls [String, Array] URLs to download
   # @param options [Hash] Downloader options
-  def download(urls, options={})
+  # @return [YoutubeDL::Video, Array] Video model or array of Video models
+  def download(urls, options = {})
     if urls.is_a? Array
       urls.map { |url| YoutubeDL::Video.get(url, options) }
     else

data/lib/youtube-dl/options.rb

@@ -1,15 +1,13 @@
 module YoutubeDL
-
   # Option and configuration getting, setting, and storage, and all that
   class Options
-
-    # [Hash] key value storage object
+    # @return [Hash] key value storage object
     attr_accessor :store
 
     # Options initializer
     #
     # @param options [Hash] a hash of options
-    def initialize(options={})
+    def initialize(options = {})
       if options.is_a? Hash
         @store = options
       else
@@ -28,6 +26,7 @@ module YoutubeDL
     # Iterate through the paramized keys and values.
     #
     # @yield [paramized_key, value]
+    # @return [Object] @store
     #
     # TODO: Enumerable?
     def each_paramized
@@ -39,6 +38,7 @@ module YoutubeDL
     # Iterate through the keys and their paramized counterparts.
     #
     # @yield [key, paramized_key]
+    # @return [Object] @store
     def each_paramized_key
       @store.each_key do |key|
         yield(key, paramize(key))
@@ -64,6 +64,7 @@ module YoutubeDL
     #
     # @param key [Object] key
     # @param value [Object] value
+    # @return [Object] whatever Hash#= returns
     def []=(key, value)
       @store[key.to_sym] = value
     end
@@ -74,7 +75,7 @@ module YoutubeDL
     # @param args [Array] list of arguments passed
     # @param block [Proc] implicit block given
     # @return [Object] the value of method in the options store
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &_block)
       if method.to_s.include? '='
         method = method.to_s.tr('=', '').to_sym
         @store[method] = args.first
@@ -100,6 +101,8 @@ module YoutubeDL
     end
 
     # Symbolizes and sanitizes keys in the option store
+    #
+    # @return [Object] @store
     def sanitize_keys!
       # Symbolize
       manipulate_keys! { |key_name| key_name.is_a?(Symbol) ? key_name : key_name.to_sym }
@@ -112,18 +115,19 @@ module YoutubeDL
     #
     # @return [YoutubeDL::Options] Options with sanitized keys.
     def sanitize_keys
-      safe_copy = self.dup
+      safe_copy = dup
       safe_copy.sanitize_keys!
       safe_copy
     end
 
     private
+
     # Helper function to convert option keys into command-line-friendly parameters
     #
     # @param key [Symbol, String] key to paramize
     # @return [String] paramized key
     def paramize(key)
-      key.to_s.tr("_", '-')
+      key.to_s.tr('_', '-')
     end
   end
 end

data/lib/youtube-dl/output.rb

@@ -1,9 +1,7 @@
 module YoutubeDL
-
   # A class of voodoo methods for parsing youtube-dl output
   class Output
-
-    # [String] Whatever youtube-dl spat out.
+    # @return [String] Whatever youtube-dl spat out.
     attr_accessor :output
 
     # Initialize output parser

data/lib/youtube-dl/runner.rb

@@ -1,19 +1,18 @@
 module YoutubeDL
-
   # Utility class for running and managing youtube-dl
   class Runner
     include YoutubeDL::Support
 
-    # [String] URL to download
+    # @return [String] URL to download
     attr_accessor :url
 
-    # [YoutubeDL::Options] Options access.
+    # @return [YoutubeDL::Options] Options access.
     attr_accessor :options
 
-    # [String] Executable path
+    # @return [String] Executable path
     attr_reader :executable_path
 
-    # [String] Executable name to use
+    # @return [String] Executable name to use
     attr_accessor :executable
 
     # Command Line runner initializer
@@ -64,7 +63,17 @@ module YoutubeDL
     end
     alias_method :download, :run
 
-  private
+    # Options configuration.
+    # Just aliases to options.configure
+    #
+    # @yield [config] options
+    # @param a [Array] arguments to pass to options#configure
+    # @param b [Proc] block to pass to options#configure
+    def configure(*a, &b)
+      options.configure(*a, &b)
+    end
+
+    private
 
     # Parses options and converts them to Cocaine's syntax
     #

data/lib/youtube-dl/support.rb

@@ -1,8 +1,6 @@
 module YoutubeDL
-
   # Some support methods and glue logic.
   module Support
-
     # Returns a usable youtube-dl executable (system or vendor)
     #
     # @param exe [String] Executable to search for
@@ -49,12 +47,12 @@ module YoutubeDL
     def which(cmd)
       exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each { |ext|
+        exts.each do |ext|
           exe = File.join(path, "#{cmd}#{ext}")
           return exe if File.executable?(exe) && !File.directory?(exe)
-        }
+        end
       end
-      return nil
+      nil
     end
   end
 end

data/lib/youtube-dl/version.rb

@@ -1,3 +1,5 @@
 module YoutubeDL
-  VERSION = "0.2.2.2015.10.16"
+  # Semantic Version as well as the bundled binary version.
+  # "(semver)(pre-release)(binary-version)"
+  VERSION = '0.2.3.2015.10.24'
 end

data/lib/youtube-dl/video.rb

@@ -1,5 +1,4 @@
 module YoutubeDL
-
   # Video model for using and downloading a single video.
   class Video < Runner
     class << self
@@ -11,23 +10,22 @@ module YoutubeDL
       # @param url [String] URL to use and download
       # @param options [Hash] Options to pass in
       # @return [YoutubeDL::Video] new Video model
-      def download(url, options={})
+      def download(url, options = {})
         video = new(url, options)
         video.download
         video
       end
-
       alias_method :get, :download
     end
 
-    # [YoutubeDL::Options] Download Options for the last download
+    # @return [YoutubeDL::Options] Download Options for the last download
     attr_reader :download_options
 
     # Instantiate new model
     #
     # @param url [String] URL to initialize with
     # @param options [Hash] Options to populate the everything with
-    def initialize(url, options={})
+    def initialize(url, options = {})
       @url = url
       @options = YoutubeDL::Options.new(options)
     end
@@ -48,16 +46,20 @@ module YoutubeDL
       @formats ||= YoutubeDL::Output.new(cocaine_line("--list-formats #{quoted(url)}").run).supported_formats
     end
 
+    # Parses the last downloaded output for a filename and returns it.
+    #
     # @return [String] Filename downloaded to
     def filename
       @filename ||= YoutubeDL::Output.new(@last_download_output).filename
     end
 
-  private
+    private
+
     # Add in other default options here.
     def runner_options
       {
-        no_color: true
+        color: false,
+        progress: false
       }.merge(@options)
     end
   end

data/test/youtube-dl/runner_test.rb

@@ -73,4 +73,14 @@ describe YoutubeDL::Runner do
       assert File.exists? TEST_FILENAME
     end
   end
+
+  describe '#configure' do
+    it 'should update configuration options' do
+      @runner.configure do |c|
+        c.output = TEST_FILENAME
+      end
+
+      assert_equal TEST_FILENAME, @runner.options.output
+    end
+  end
 end

data/test/youtube-dl/video_test.rb

@@ -66,7 +66,9 @@ describe YoutubeDL::Video do
     end
 
     it 'should be an Array of Hashes' do
-      assert_instance_of Hash, @formats.first
+      @formats.each do |f|
+        assert_instance_of Hash, f
+      end
     end
 
     it 'should have a hash size of 4' do
@@ -86,4 +88,17 @@ describe YoutubeDL::Video do
       end
     end
   end
+
+  describe '#filename' do
+    before do
+      @video.options.configure do |c|
+        c.output = TEST_FILENAME
+      end
+    end
+
+    it 'should be able to get the filename from the output' do
+      @video.download
+      assert_equal TEST_FILENAME, @video.filename
+    end
+  end
 end

data/youtube-dl.rb.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'youtube-dl/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "youtube-dl.rb"
+  spec.name          = 'youtube-dl.rb'
   spec.version       = YoutubeDL::VERSION
-  spec.authors       = ["sapslaj", "xNightMare"]
-  spec.email         = ["saps.laj@gmail.com"]
-  spec.summary       = %q{youtube-dl wrapper for Ruby}
-  spec.description   = %q{in the spirit of pygments.rb and MiniMagick, youtube-dl.rb is a command line wrapper for the python script youtube-dl}
-  spec.homepage      = "https://github.com/layer8x/youtube-dl.rb"
-  spec.license       = "MIT"
+  spec.authors       = %w(sapslaj xNightMare)
+  spec.email         = ['saps.laj@gmail.com']
+  spec.summary       = 'youtube-dl wrapper for Ruby'
+  spec.description   = 'in the spirit of pygments.rb and MiniMagick, youtube-dl.rb is a command line wrapper for the python script youtube-dl'
+  spec.homepage      = 'https://github.com/layer8x/youtube-dl.rb'
+  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 "cocaine", ">=0.5.4"
+  spec.add_dependency 'cocaine', '>=0.5.4'
 
-  spec.add_development_dependency "bundler", ">= 1.6"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "m"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.8.1"
-  spec.add_development_dependency "purdytest"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'm'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8.1'
+  spec.add_development_dependency 'purdytest'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youtube-dl.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.2.2015.10.16
+  version: 0.2.3.2015.10.24
 platform: ruby
 authors:
 - sapslaj
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -132,6 +132,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt